Can I add comments to a pip requirements file?

python comments pip
lofidevops picture lofidevops · Feb 6, 2012 · Viewed 29.7k times · Source

I'd like to add comments for a few packages in a pip requirements file. (Just to explain why that package is on the list.) Can I do this?

I'm imagining something like

Babel==0.9.5 # translation
CherryPy==3.2.0 # web server
Creoleparser==0.7.1 # wiki formatting
Genshi==0.5.1 # templating

Answer

Alexander Artemenko picture Alexander Artemenko · Feb 6, 2012

Sure, you can, just use #

pip docs:

A line that begins with # is treated as a comment and ignored. Whitespace followed by a # causes the # and the remainder of the line to be treated as a comment.

Related questions

Is there a way to create multiline comments in Python?

I have recently started studying Python, but I couldn't find how to implement multi-line comments. Most languages have block comment symbols like /* */ I tried this in Python, but it throws an error, so this probably is not the correct way. …

Read More
What is the common header format of Python files?

I came across the following header format for Python source files in a document about Python coding guidelines: #!/usr/bin/env python """Foobar.py: Description of what foobar does.""" __author__ = "Barack Obama" __copyright__ = "Copyright 2009, Planet Earth" Is this the standard …

Read More
Why doesn't Python have multiline comments?

OK, I'm aware that triple-quotes strings can serve as multiline comments. For example, """Hello, I am a multiline comment""" and '''Hello, I am a multiline comment''' But technically speaking these are strings, correct? I've googled and read the Python style …

Read More