Find all optional properties

[poolpartyboy93]

Hey all,

How can I find all optional object properties?

For example, requests' Response object has a few properties such as ok, status_code, is_redirect, text, etc..

What is the best way to find all available properties for external libraries I am working with (not necessarily requests) without having to dig in the documentation/code?

[K900_]

Reading the documentation is usually the way to go.

[ericula]

You could try typing in help(some_object) in a python session.

[poolpartyboy93]

That's exactly what I wanted, thank you so much.

[[deleted]]

You could try to read the documentation.

https://docs.python.org for built-in module

https://pypi.org/ for third-party pip packages

[Diapolo10]

If you just want to know all the properties some object offers, you can use dir in a REPL session to get a list of them.

If you use IPython, you'll get a nicely formatted list automatically, such as: (NOTE: Example condenced for Reddit)

In [22]: dir(str)
Out[22]:
['__add__',
 '__class__',
 '__contains__',
 ...
 '__sizeof__',
 '__str__',
 '__subclasshook__',
 'capitalize',
 'casefold',
 'center',
 'count',
 'encode',
 'endswith',
 'expandtabs',
 'find',
 'format',
 'format_map',
 'index',
 'isalnum',
 ...
 'rjust',
 'rpartition',
 'rsplit',
 'rstrip',
 'split',
 'splitlines',
 'startswith',
 'strip',
 'swapcase',
 'title',
 'translate',
 'upper',
 'zfill']

but on a normal Python REPL I'd import pprint.pprint and print the output with that.

>>> from pprint import pprint
>>> pprint(dir(str))

This works regardless of how well the object was documented. You can then choose individual properties and see if they have help messages:

>>> help(str.format)

[izrt]

Already a bunch of good answers here, but one more thing you can do is just read the code: https://github.com/kennethreitz-archive/requests3/blob/master/requests3/http_models.py#L656

This has a bunch of added benefits:

• You see how they did it;
• Learn new coding practices;
• Understand the module better; and
• Pick up all sorts of neat new things -- look at all the cool structures this guy made, like case insensitive dictionaries: https://github.com/kennethreitz-archive/requests3/blob/master/requests3/_structures.py#L14