What is the common header format of Python files?

Its all metadata for the Foobar module.

The first one is the docstring of the module, that is already explained in Peter’s answer.

How do I organize my modules (source files)? (Archive)

The first line of each file shoud be #!/usr/bin/env python. This makes it possible to run the file as a script invoking the interpreter implicitly, e.g. in a CGI context.

Next should be the docstring with a description. If the description is long, the first line should be a short summary that makes sense on its own, separated from the rest by a newline.

All code, including import statements, should follow the docstring. Otherwise, the docstring will not be recognized by the interpreter, and you will not have access to it in interactive sessions (i.e. through obj.__doc__) or when generating documentation with automated tools.

Import built-in modules first, followed by third-party modules, followed by any changes to the path and your own modules. Especially, additions to the path and names of your modules are likely to change rapidly: keeping them in one place makes them easier to find.

Next should be authorship information. This information should follow this format:

__author__ = "Rob Knight, Gavin Huttley, and Peter Maxwell"
__copyright__ = "Copyright 2007, The Cogent Project"
__credits__ = ["Rob Knight", "Peter Maxwell", "Gavin Huttley",
                    "Matthew Wakefield"]
__license__ = "GPL"
__version__ = "1.0.1"
__maintainer__ = "Rob Knight"
__email__ = "[email protected]"
__status__ = "Production"

Status should typically be one of “Prototype”, “Development”, or “Production”. __maintainer__ should be the person who will fix bugs and make improvements if imported. __credits__ differs from __author__ in that __credits__ includes people who reported bug fixes, made suggestions, etc. but did not actually write the code.

Here you have more information, listing __author__, __authors__, __contact__, __copyright__, __license__, __deprecated__, __date__ and __version__ as recognized metadata.

Related Posts:

  1. How to write an inline-comment in Python
  2. Why am I seeing “TypeError: string indices must be integers”?
  3. TypeError: only integer scalar arrays can be converted to a scalar index with 1D numpy indices array
  4. How to emulate a do-while loop?
  5. How to prettyprint a JSON file?
  6. How to install pip with Python 3?
  7. Is there a way to create multiline comments in Python?
  8. pip not recognised as an internal or external command
  9. Import Error: No module named numpy
  10. bash: pip: command not found
  11. Function for Factorial in Python
  12. TypeError: a bytes-like object is required, not ‘str’ when writing to a file in Python3
  13. Writing a pandas DataFrame to CSV file
  14. Purpose of “%matplotlib inline”
  15. How do I update Anaconda?
  16. Converting string into datetime
  17. How do I read CSV data into a record array in NumPy?
  18. How to normalize a NumPy array to a unit vector?
  19. Local variable referenced before assignment?
  20. Clickable link inside message discord.py
  21. DataFrame constructor not properly called! error
  22. OSError: [WinError 193] %1 is not a valid Win32 application
  23. How to download a file over HTTP?
  24. Can’t fix “zipimport.ZipImportError: can’t decompress data; zlib not available” when I type in “python3.6 get-pip.py”
  25. Arrays used as indices must be of integer (or boolean) type
  26. Are static class variables possible in Python?
  27. Why am I getting “LinAlgError: Singular matrix” from grangercausalitytests?
  28. inserting characters at the start and end of a string
  29. Python: SyntaxError: keyword can’t be an expression
  30. “ImportError: no module named ‘requests'” after installing with pip
  31. Append integer to beginning of list in Python
  32. Most efficient way to map function over numpy array
  33. List comprehension on a nested list?
  34. Get total of Pandas column
  35. How do you read from stdin?
  36. Union of two lists in Python
  37. Type error: cannot convert the series to
  38. Reading a binary file with python
  39. How to determine a Python variable’s type?
  40. Could not find a version that satisfies the requirement
  41. How do I get an empty array of any size in python?
  42. How to deep copy a list?
  43. Pandas – DataFrame object is not callable
  44. Start with pyglet or pygame?
  45. Django 2.1.3 Error: __init__() takes 1 positional argument but 2 were given
  46. Python error load JSON code of google API
  47. How to convert IPython notebooks to PDF and HTML?
  48. ‘Jupyter’ is not recognized as an internal or external command
  49. How to print spaces in Python?
  50. installing urllib in Python3.6
  51. What is sys.maxint in Python 3?
  52. TypeError: ‘float’ object has no attribute ‘__getitem__’,python
  53. How to apply a function to two columns of Pandas dataframe
  54. Convert categorical data in pandas dataframe
  55. pandas create new column based on values from other columns / apply a function of multiple columns, row-wise
  56. Parsing HTML using Python
  57. How can I install the latest Anaconda with wget
  58. sqlite3.ProgrammingError: Incorrect number of bindings supplied. The current statement uses 1, and there are 74 supplied
  59. TypeError: ‘int’ object does not support item assignment
  60. Convert datetime to Unix timestamp and convert it back in python
  61. “Divide by zero encountered in log” when not dividing by zero
  62. How to include external Python code to use in other files?
  63. How to print multiple lines of text with Python
  64. How to get a function name as a string?
  65. Substitution Cipher Python
  66. Good ways to “expand” a numpy ndarray?
  67. Python data structure sort list alphabetically
  68. TypeError: ‘numpy.float64’ object does not support item assignment
  69. TypeError: unsupported format string passed to list.__format__
  70. Extract a part of the filepath (a directory) in Python
  71. Python 3.5.1 urllib has no attribute request
  72. Rotating a two-dimensional array in Python
  73. TypeError: sequence item 0: expected string, int found
  74. Why am I getting this unexpected keyword argument TypeError?
  75. Create numpy matrix filled with NaNs
  76. python pandas remove duplicate columns
  77. What is the difference between __str__ and __repr__?
  78. How often does python flush to a file?
  79. How to open every file in a folder
  80. Python iteration over non-sequence
  81. How do I convert a string to a double in Python?
  82. _csv.Error: field larger than field limit (131072)
  83. cmake error ‘the source does not appear to contain CMakeLists.txt’
  84. ubuntu /usr/bin/env: python: No such file or directory
  85. How to completely uninstall python 2.7.13 on Ubuntu 16.04
  86. Calculate weighted average using a pandas/dataframe
  87. Telling Python to save a .txt file to a certain directory on Windows and Mac
  88. Spell Checker for Python
  89. TypeError: coercing to Unicode: need string or buffer, int found
  90. Python MySQLdb not importing
  91. Write a program that asks the user to enter five test scores. Correspond it to a letter grade
  92. Simplify Chained Comparison
  93. How to get POSTed JSON in Flask?
  94. How to fix SSL issue SSL_CTX_use_certificate : ca md too weak on Python Zeep
  95. Paramiko’s SSHClient with SFTP
  96. Package libffi was not found in the pkg-config search path REDHAT6.5
  97. Line is too long. Django PEP8
  98. TypeError: zip argument #2 must support iteration
  99. CS231n: How to calculate gradient for Softmax loss function?
  100. How to create a new database using SQLAlchemy?

Leave a Comment