Databases
StackOverflow2013
Postsdbo
PO
 

Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>Its all metadata for the <code>Foobar</code> module.</p> <p>The first one is the <code>docstring</code> of the module, that is already explained in <a href="https://stackoverflow.com/questions/1523427/python-what-is-the-common-header-format/1523435#1523435">Peter's answer</a>.</p> <blockquote> <h2><a href="http://web.archive.org/web/20111010053227/http://jaynes.colorado.edu/PythonGuidelines.html#module_formatting" rel="noreferrer">How do I organize my modules (source files)? (Archive)</a></h2> <p><strong>The first line of each file shoud be <code>#!/usr/bin/env python</code>.</strong> This makes it possible to run the file as a script invoking the interpreter implicitly, e.g. in a CGI context.</p> <p><strong><em>Next should be the docstring with a description.</em></strong> 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.</p> <p><strong>All code, including import statements, should follow the docstring.</strong> Otherwise, the docstring will not be recognized by the interpreter, and you will not have access to it in interactive sessions (i.e. through <code>obj.__doc__</code>) or when generating documentation with automated tools.</p> <p><strong>Import built-in modules first, followed by third-party modules, followed by any changes to the path and your own modules.</strong> 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.</p> <p><strong>Next should be authorship information.</strong> This information should follow this format:</p> <pre><code>__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__ = "rob@spot.colorado.edu" __status__ = "Production" </code></pre> <p>Status should typically be one of "Prototype", "Development", or "Production". <code>__maintainer__</code> should be the person who will fix bugs and make improvements if imported. <code>__credits__</code> differs from <code>__author__</code> in that <code>__credits__</code> includes people who reported bug fixes, made suggestions, etc. but did not actually write the code.</p> </blockquote> <p><a href="http://epydoc.sourceforge.net/manual-fields.html#module-metadata-variables" rel="noreferrer">Here</a> you have more information, listing <code>__author__</code>, <code>__authors__</code>, <code>__contact__</code>, <code>__copyright__</code>, <code>__license__</code>, <code>__deprecated__</code>, <code>__date__</code> and <code>__version__</code> as recognized metadata.</p>
    singulars
    1. This table or related slice is empty.
    1. POWhat is the common header format of Python files?
      singulars
      1. PTQuestion
    1. PTAnswer
    1. USCommunity
    1. USEsteban Küber
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. POWhat is the common header format of Python files?
      singulars
      1. PTQuestion
    1. This table or related slice is empty.
    1. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    3. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    1. COCan the creation of the header info somehow be automated for new files?
      singulars
      1. PO
      1. USHauke
    2. COI think all of this metadata after the imports is a bad idea. The parts of this metadata that apply to a single file (eg author, date) are already tracked by source control. Putting an erroneous & out of date copy of the same info in the file itself seems wrong to me. The parts that apply to the whole project (eg licence, versioning) seem better located at a project level, in a file of their own, rather than in every source code file.
      singulars
      1. PO
      1. USJonathan Hartley
    3. COAgree totally with Jonathan Hartley. The next person to inherit the code has three choices: 1) update it all every time he/she edits the code 2) leave it alone, in which case it will be inaccurate 3) delete it all. Option 1 is a waste of their time, especially since they have absolutely zero confidence that the metadata was up to date when they received it. Options 2 and 3 mean that your time in putting it there in the first place was wasted. Solution: save everybody's time and don't put it there.
      singulars
      1. PO
      1. USspookylukey
 

Querying!

 
Guidance
A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload