.. _l-methods:

Methods
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| method                                                                                                                       | class parent     | truncated documentation                                                                                         |
+==============================================================================================================================+==================+=================================================================================================================+
| :py:meth:`__cmp__ <pymyinstall.installhelper.module_install.ModuleInstall.__cmp__>`                                          | ModuleInstall    | to sort modules                                                                                                 |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :py:meth:`__getattr__ <pymyinstall.installhelper.pip_helper.Distribution.__getattr__>`                                       | Distribution     |                                                                                                                 |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pymyinstall.installhelper.module_install.ModuleInstall.__init__>`                                        | ModuleInstall    |                                                                                                                 |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pymyinstall.installhelper.module_install_page_wheel.HTMLParser4Links.__init__>`                          | HTMLParser4Links | constructor                                                                                                     |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pymyinstall.installhelper.pip_helper.Distribution.__init__>`                                             | Distribution     |                                                                                                                 |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pymyinstall.installhelper.run_cmd._AsyncLineReader.__init__>`                                            | _AsyncLineReader |                                                                                                                 |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :py:meth:`__lt__ <pymyinstall.installhelper.module_install.ModuleInstall.__lt__>`                                            | ModuleInstall    | overload operator ``<``                                                                                         |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <pymyinstall.installhelper.module_install.ModuleInstall.__repr__>`                                        | ModuleInstall    | usual                                                                                                           |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :py:meth:`__str__ <pymyinstall.installhelper.module_install.ModuleInstall.__str__>`                                          | ModuleInstall    | usual                                                                                                           |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :py:meth:`_check_installation <pymyinstall.installhelper.module_install.ModuleInstall._check_installation>`                  | ModuleInstall    | some modules uninstall and install modules with another version number, we try to track that                    |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`as_dict <pymyinstall.installhelper.module_install.ModuleInstall.as_dict>`                                             | ModuleInstall    | returns the members in a dictionary                                                                             |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`copy <pymyinstall.installhelper.module_install.ModuleInstall.copy>`                                                   | ModuleInstall    | copy the module, if version is not None, change the version number                                              |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`download <pymyinstall.installhelper.module_install.ModuleInstall.download>`                                           | ModuleInstall    | Downloads the module without installation.                                                                      |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`eof <pymyinstall.installhelper.run_cmd._AsyncLineReader.eof>`                                                         | _AsyncLineReader |                                                                                                                 |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`extract_version <pymyinstall.installhelper.module_install.ModuleInstall.extract_version>`                             | ModuleInstall    | extract the version from a filename                                                                             |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`get_exewheel_url_link <pymyinstall.installhelper.module_install.ModuleInstall.get_exewheel_url_link>`                 | ModuleInstall    | for windows, get the url of the setup using a webpage                                                           |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`get_exewheel_url_link2 <pymyinstall.installhelper.module_install.ModuleInstall.get_exewheel_url_link2>`               | ModuleInstall    | for windows, get the url of the setup using a webpage                                                           |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`get_installed_classifier <pymyinstall.installhelper.module_install.ModuleInstall.get_installed_classifier>`           | ModuleInstall    | return the classifier of the installed package                                                                  |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`get_installed_license <pymyinstall.installhelper.module_install.ModuleInstall.get_installed_license>`                 | ModuleInstall    | return the license of the installed package                                                                     |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`get_installed_metadata <pymyinstall.installhelper.module_install.ModuleInstall.get_installed_metadata>`               | ModuleInstall    | return the metadata of the installed package                                                                    |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`get_installed_numeric_version <pymyinstall.installhelper.module_install.ModuleInstall.get_installed_numeric_version>` | ModuleInstall    | returns the version as number (not string)                                                                      |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`get_installed_version <pymyinstall.installhelper.module_install.ModuleInstall.get_installed_version>`                 | ModuleInstall    | return the version of the installed package                                                                     |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`get_pypi_numeric_version <pymyinstall.installhelper.module_install.ModuleInstall.get_pypi_numeric_version>`           | ModuleInstall    | returns the version of a package in pypi                                                                        |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`get_pypi_version <pymyinstall.installhelper.module_install.ModuleInstall.get_pypi_version>`                           | ModuleInstall    | returns the version of a package on pypi                                                                        |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`handle_data <pymyinstall.installhelper.module_install_page_wheel.HTMLParser4Links.handle_data>`                       | HTMLParser4Links | stores data if a link                                                                                           |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`handle_endtag <pymyinstall.installhelper.module_install_page_wheel.HTMLParser4Links.handle_endtag>`                   | HTMLParser4Links | ends of a tag                                                                                                   |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`handle_starttag <pymyinstall.installhelper.module_install_page_wheel.HTMLParser4Links.handle_starttag>`               | HTMLParser4Links | enters a tag                                                                                                    |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`has_update <pymyinstall.installhelper.module_install.ModuleInstall.has_update>`                                       | ModuleInstall    | tells if the package has a newer version on pipy                                                                |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`install <pymyinstall.installhelper.module_install.ModuleInstall.install>`                                             | ModuleInstall    | Installs the package.                                                                                           |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`is_installed_local <pymyinstall.installhelper.module_install.ModuleInstall.is_installed_local>`                       | ModuleInstall    | checks if a module is installed                                                                                 |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`is_installed_local_cmd <pymyinstall.installhelper.module_install.ModuleInstall.is_installed_local_cmd>`               | ModuleInstall    | Test the module by running a command line. Does some others verifications for a specific modules such as scipy. |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`is_installed_version <pymyinstall.installhelper.module_install.ModuleInstall.is_installed_version>`                   | ModuleInstall    | tells if a module is installed                                                                                  |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`module_install_preprocess <pymyinstall.installhelper.module_install.ModuleInstall.module_install_preprocess>`         | ModuleInstall    | Run some preprocessing for specific modules                                                                     |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`run <pymyinstall.installhelper.run_cmd._AsyncLineReader.run>`                                                         | _AsyncLineReader |                                                                                                                 |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`run_post_installation <pymyinstall.installhelper.module_install.ModuleInstall.run_post_installation>`                 | ModuleInstall    | Run instructions post installation                                                                              |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`unzipfiles <pymyinstall.installhelper.module_install.ModuleInstall.unzipfiles>`                                       | ModuleInstall    | unzip files from a zip archive                                                                                  |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`update <pymyinstall.installhelper.module_install.ModuleInstall.update>`                                               | ModuleInstall    | Updates the package if necessary, we use ``pip install <module_name> --upgrade --no-deps``,                     |
+------------------------------------------------------------------------------------------------------------------------------+------------------+-----------------------------------------------------------------------------------------------------------------+