comment
The comment Python library provides an explicit object for comments.
Install
pip install comment-object
Usage
You can use Comment as a context. It does nothing but expell all comments
from your source code!
from comment import Comment
with Comment("seconds") as c:
DAY = 60 * 60 * 24
Philosophy
A comment should have its scope inside some other code scope.
For example,
DAY = 60 * 60 * 24 # seconds
The comment "# seconds" explains DAY constant that it has the unit second.
The scope of this comment is this one line, inside module scope maybe.
A comment can be replaced with an object which does not have any effects on the code around.
If a comment breaks the principle, then it is not a comment. The coding comment, for example, can be such a type; it should be called a pragma.
License
See LICENSE.txt.
1 maintainer
Metadata
1 maintainer
Release files for comment-object 0.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| comment-object-0.0.0.tar.gz | 2.9 kB | Without provenance | Details for comment-object-0.0.0.tar.gz |
Security for comment-object 0.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
Release files / comment-object-0.0.0.tar.gz
How to use checksums
a368d2ec4b6dcadcfbab41c59c5176bac5db0910b645b639b7e45296d450e698How to use checksums
6df8c039c775c704a1a568e36ac4f453f995ace216b251b51c4cfb97769a999bWhat is trusted publishing?
twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.9.1