.. _l-classes:

Classes
=======

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


Summary
+++++++

+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| class                                                                                                                            | class parent | truncated documentation                                           |
+==================================================================================================================================+==============+===================================================================+
| :class:`AnnoyingPackageException <pymyinstall.installhelper.module_install_exceptions.AnnoyingPackageException>`                 |              | raised when a package is not on pypi                              |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`ConfigurationError <pymyinstall.installhelper.module_install_exceptions.ConfigurationError>`                             |              | raised when something is wrong the current configuration          |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`Distribution <pymyinstall.installhelper.pip_helper.Distribution>`                                                        |              | Common interface for old and recent pip packages.                 |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`DownloadError <pymyinstall.installhelper.module_install_exceptions.DownloadError>`                                       |              | raised when a package cannot be downloaded                        |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`DownloadException <pymyinstall.installcustom.install_custom.DownloadException>`                                          |              | Cannot download.                                                  |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`FileShouldNotBeFound <pymyinstall.packaged.automate_install.FileShouldNotBeFound>`                                       |              | Raised by function :func:`check_sys_path`.                        |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`HTMLParser4Links <pymyinstall.installhelper.module_install_page_wheel.HTMLParser4Links>`                                 |              | extreact all links ni HTML page                                   |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`InnoSetupException <pymyinstall.win_installer.win_innosetup_helper.InnoSetupException>`                                  |              | Exception happening with InnoSetup                                |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`InstallError <pymyinstall.installhelper.module_install_exceptions.InstallError>`                                         |              | raised when a package cannot be installed                         |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`InternalJsException <pymyinstall.installhelper.module_install_page_wheel.InternalJsException>`                           |              | Raises when a javascript url cannot be decrypted.                 |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`JuliaBatchException <pymyinstall.win_installer.win_setup_julia.JuliaBatchException>`                                     |              | raised when running R in batch mode                               |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`ManualDownloadException <pymyinstall.installcustom.install_custom_exceptions.ManualDownloadException>`                   |              | raised when a manual download is required                         |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`MissingInstalledPackageException <pymyinstall.installhelper.module_install_exceptions.MissingInstalledPackageException>` |              | raised when a package is not installed                            |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`MissingPackageOnPyPiException <pymyinstall.installhelper.module_install_exceptions.MissingPackageOnPyPiException>`       |              | raised when a package is not found on pipy                        |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`MissingReferenceException <pymyinstall.installhelper.module_install_exceptions.MissingReferenceException>`               |              | raised when a module is not referenced by this package            |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`MissingVersionOnPyPiException <pymyinstall.installhelper.module_install_exceptions.MissingVersionOnPyPiException>`       |              | raised when a version is missing on pipy                          |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`MissingVersionWheelException <pymyinstall.installhelper.module_install_exceptions.MissingVersionWheelException>`         |              | raised when a version is missing as a wheel                       |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`MissingWheelException <pymyinstall.installhelper.module_install_exceptions.MissingWheelException>`                       |              | raised when a wheel is missing                                    |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`ModuleInstall <pymyinstall.installhelper.module_install.ModuleInstall>`                                                  |              | defines the necessary information for a module                    |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`ModuleNotFoundError <pymyinstall.packaged.packaged_exception.ModuleNotFoundError>`                                       |              | raised when a module was not found                                |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`RBatchException <pymyinstall.win_installer.win_setup_r.RBatchException>`                                                 |              | raised when running R in batch mode                               |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`RunCmdError <pymyinstall.installhelper.module_install_exceptions.RunCmdError>`                                           |              | raised when a command line cannot be run                          |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`RunCmdException <pymyinstall.installhelper.run_cmd.RunCmdException>`                                                     |              | raised by function :func:`run_cmd`                                |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`ShebangException <pymyinstall.win_installer.win_patch.ShebangException>`                                                 |              | exception raised when the shebang is not correct                  |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`UnavailableCustomBuildError <pymyinstall.installhelper.module_install_exceptions.UnavailableCustomBuildError>`           |              | raise when a module does not have a custom build                  |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`UpdatePipError <pymyinstall.installhelper.module_install_exceptions.UpdatePipError>`                                     |              | raised when pip cannot be update or reinstalled                   |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`VirtualEnvError <pymyinstall.installhelper.install_venv_helper.VirtualEnvError>`                                         |              | exception raised by the function implemented in this file         |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`WinInstallDistributionError <pymyinstall.win_installer.win_exception.WinInstallDistributionError>`                       |              | raised when an issue is detected in the distribution              |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`WinInstallException <pymyinstall.win_installer.win_exception.WinInstallException>`                                       |              | exception raised by this package                                  |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`WinInstallMissingDependency <pymyinstall.win_installer.win_exception.WinInstallMissingDependency>`                       |              | raised when a dependency is missing                               |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`WinInstallPackageException <pymyinstall.win_installer.win_exception.WinInstallPackageException>`                         |              | exception raised by this package when installing a Python package |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`WrongVersionError <pymyinstall.installhelper.module_install_exceptions.WrongVersionError>`                               |              | cannot interpret a version                                        |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`WrongWheelException <pymyinstall.installhelper.module_install_exceptions.WrongWheelException>`                           |              | raised when the downloaded wheel seems wrong                      |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+
| :class:`_AsyncLineReader <pymyinstall.installhelper.run_cmd._AsyncLineReader>`                                                   |              |                                                                   |
+----------------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------+