| Next revision | Previous revision |
| python:python_snippets:getting_help [2024/05/07 05:11] – created jcorona | python:python_snippets:getting_help [Unknown date] (current) – removed - external edit (Unknown date) 127.0.0.1 |
|---|
| ====== Getting Help With Python ====== | |
| |
| You can use the help() function to get information about Python objects, modules, functions, classes, and methods. | |
| |
| For example: | |
| |
| <code python> | |
| help(list) | |
| </code> | |
| |
| Outputs: | |
| <code> | |
| Python 3.11.4 (tags/v3.11.4:d2340ef, Jun 7 2023, 05:45:37) [MSC v.1934 64 bit (AMD64)] on win32 | |
| Type "help", "copyright", "credits" or "license()" for more information. | |
| help(list) | |
| Help on class list in module builtins: | |
| |
| class list(object) | |
| | list(iterable=(), /) | |
| | | |
| | Built-in mutable sequence. | |
| | | |
| | If no argument is given, the constructor creates a new empty list. | |
| | The argument must be an iterable if specified. | |
| | | |
| | Methods defined here: | |
| | | |
| | __add__(self, value, /) | |
| | Return self+value. | |
| | | |
| | __contains__(self, key, /) | |
| | Return key in self. | |
| | | |
| | __delitem__(self, key, /) | |
| | Delete self[key]. | |
| | | |
| | __eq__(self, value, /) | |
| | Return self==value. | |
| | | |
| | __ge__(self, value, /) | |
| | Return self>=value. | |
| | | |
| | __getattribute__(self, name, /) | |
| | Return getattr(self, name). | |
| | | |
| | __getitem__(...) | |
| | x.__getitem__(y) <==> x[y] | |
| | | |
| | __gt__(self, value, /) | |
| | Return self>value. | |
| | | |
| | __iadd__(self, value, /) | |
| | Implement self+=value. | |
| | | |
| | __imul__(self, value, /) | |
| | Implement self*=value. | |
| | | |
| | __init__(self, /, *args, **kwargs) | |
| | Initialize self. See help(type(self)) for accurate signature. | |
| | | |
| | __iter__(self, /) | |
| | Implement iter(self). | |
| | | |
| | __le__(self, value, /) | |
| | Return self<=value. | |
| | | |
| | __len__(self, /) | |
| | Return len(self). | |
| | | |
| | __lt__(self, value, /) | |
| | Return self<value. | |
| | | |
| | __mul__(self, value, /) | |
| | Return self*value. | |
| | | |
| | __ne__(self, value, /) | |
| | Return self!=value. | |
| | | |
| | __repr__(self, /) | |
| | Return repr(self). | |
| | | |
| | __reversed__(self, /) | |
| | Return a reverse iterator over the list. | |
| | | |
| | __rmul__(self, value, /) | |
| | Return value*self. | |
| | | |
| | __setitem__(self, key, value, /) | |
| | Set self[key] to value. | |
| | | |
| | __sizeof__(self, /) | |
| | Return the size of the list in memory, in bytes. | |
| | | |
| | append(self, object, /) | |
| | Append object to the end of the list. | |
| | | |
| | clear(self, /) | |
| | Remove all items from list. | |
| | | |
| | copy(self, /) | |
| | Return a shallow copy of the list. | |
| | | |
| | count(self, value, /) | |
| | Return number of occurrences of value. | |
| | | |
| | extend(self, iterable, /) | |
| | Extend list by appending elements from the iterable. | |
| | | |
| | index(self, value, start=0, stop=9223372036854775807, /) | |
| | Return first index of value. | |
| | | |
| | Raises ValueError if the value is not present. | |
| | | |
| | insert(self, index, object, /) | |
| | Insert object before index. | |
| | | |
| | pop(self, index=-1, /) | |
| | Remove and return item at index (default last). | |
| | | |
| | Raises IndexError if list is empty or index is out of range. | |
| | | |
| | remove(self, value, /) | |
| | Remove first occurrence of value. | |
| | | |
| | Raises ValueError if the value is not present. | |
| | | |
| | reverse(self, /) | |
| | Reverse *IN PLACE*. | |
| | | |
| | sort(self, /, *, key=None, reverse=False) | |
| | Sort the list in ascending order and return None. | |
| | | |
| | The sort is in-place (i.e. the list itself is modified) and stable (i.e. the | |
| | order of two equal elements is maintained). | |
| | | |
| | If a key function is given, apply it once to each list item and sort them, | |
| | ascending or descending, according to their function values. | |
| | | |
| | The reverse flag can be set to sort in descending order. | |
| | | |
| | ---------------------------------------------------------------------- | |
| | Class methods defined here: | |
| | | |
| | __class_getitem__(...) from builtins.type | |
| | See PEP 585 | |
| | | |
| | ---------------------------------------------------------------------- | |
| | Static methods defined here: | |
| | | |
| | __new__(*args, **kwargs) from builtins.type | |
| | Create and return a new object. See help(type) for accurate signature. | |
| | | |
| | ---------------------------------------------------------------------- | |
| | Data and other attributes defined here: | |
| | | |
| | __hash__ = None | |
| </code> | |
| |
| |
| </code> | |