How to document python function parameter types?

How to document python function parameter types?

I know that the parameters can be any object but for the documentation it is quite important to specify what you would expect.

First is how to specify a parameter types like these below?

• str (or use String or string?)
• int
• list
• dict
• function()
• tuple
• object instance of class MyClass

Second, how to specify params that can be of multiple types like a function that can handle a single parameter than can be int or str?

Please use the below example to demonstrate the syntax needed for documenting this with your proposed solution. Mind that it is desired to be able to hyperlink reference to the "Image" class from inside the documentation.

def myMethod(self, name, image):      """      Does something ...        name String: name of the image      image Image: instance of Image Class or a string indicating the filename.        Return True if operation succeeded or False.      """      return True  

Note, you are welcome to suggest the usage of any documentation tool (sphinx, oxygen, ...) as long it is able to deal with the requirements.

Update:

It seams that there is some kind of support for documenting parameter types in doxygen in. general. The code below works but adds an annoying $ to the param name (because it was initially made for php).

    @param str $arg description      @param str|int $arg description  

Answer by Tom for How to document python function parameter types?

Doxygen is great for C++, but if you are working with mostly python code you should give sphinx a try. If you choose sphinx then all you need to do is follow pep8.

Answer by robert for How to document python function parameter types?

If using Python 3, you can use the function annotations described in PEP 3107.

def compile(     source: "something compilable",     filename: "where the compilable thing comes from",     mode: "is this a single statement or a suite?"):  

See also function definitions.

Answer by docu for How to document python function parameter types?

You need to add an exclamation mark at the start of the Python docstring for Doxygen to parse it correctly.

def myMethod(self, name, image):      """!      Does something ...        @param name String: name of the image      @param image Image: instance of Image Class or a string indicating the filename.        @return Return True if operation succeeded or False.      """      return True  

Answer by user147058 for How to document python function parameter types?

Yup, @docu is right - this is the (IMHO best) way to combine both documentation schemes more or less seamlessly. If, on the other hand, you also want to do something like putting text on the doxygen-generated index page, you would add

##  # @mainpage (Sub)Heading for the doxygen-generated index page  # Text that goes right onto the doxygen-generated index page  

somewhere at the beginning of your Python code.

In other words, where doxygen does not expect Python comments, use ## to alert it that there are tags for it. Where it expects Python comments (e.g. at the beginning of functions or classes), use """!.

Answer by Tony Melony for How to document python function parameter types?

There is a better way. We use

def my_method(x, y):      """      my_method description        @type x: int      @param x: An integer        @type y: int|string      @param y: An integer or string        @rtype: string      @return: Returns a sentence with your variables in it      """        return "Hello World! %s, %s" % (x,y)  

That's it. In the PyCharm IDE this helps a lot. It works like a charm ;-)

Fatal error: Call to a member function getElementsByTagName() on a non-object in D:\XAMPP INSTALLASTION\xampp\htdocs\endunpratama9i\www-stackoverflow-info-proses.php on line 72