setuptools.command.easy_install.easy_install

class documentation

class easy_install(Command): (source)

Known subclasses: setuptools.command.develop.develop

View In Hierarchy

Manage a download/build/install process

Method add_output Undocumented
Method build_and_install Undocumented
Method byte_compile Undocumented
Method cant_write_to_target Undocumented
Method check_editable Undocumented
Method check_pth_processing Empirically verify whether .pth files are supported in inst. dir
Method check_site_dir Verify that self.install_dir is .pth-capable dir, if needed
Method create_home_path Create directories under ~.
Method delete_blockers Undocumented
Method easy_install Undocumented
Method egg_distribution Undocumented
Method exe_to_egg Extract a bdist_wininst to the directories an egg would use
Method expand_basedirs Calls `os.path.expanduser` on install_base, install_platbase and root.
Method expand_dirs Calls `os.path.expanduser` on install dirs.
Method finalize_options Undocumented
Method initialize_options Undocumented
Method install_egg Undocumented
Method install_egg_scripts Write all the scripts for `dist`, unless scripts are excluded
Method install_eggs Undocumented
Method install_exe Undocumented
Method install_item Undocumented
Method install_script Generate a legacy script wrapper and install it
Method install_wheel Undocumented
Method install_wrapper_scripts Undocumented
Method installation_report Helpful installation message for display to package users
Method maybe_move Undocumented
Method not_editable Undocumented
Method process_distribution Undocumented
Method pseudo_tempname Return a pseudo-tempname base in the install directory. This code is intentionally naive; if a malicious party can write to the target directory you're already in deep doodoo.
Method report_editable Undocumented
Method run Undocumented
Method run_setup Undocumented
Method select_scheme Undocumented
Method should_unzip Undocumented
Method unpack_and_compile Undocumented
Method unpack_progress Undocumented
Method update_pth Undocumented
Method warn_deprecated_options Undocumented
Method write_script Write an executable file to the scripts directory
Constant DEFAULT_SCHEME Undocumented
Constant INSTALL_SCHEMES Undocumented
Class Variable boolean_options Undocumented
Class Variable command_consumes_arguments Undocumented
Class Variable description Undocumented
Class Variable negative_opt Undocumented
Class Variable user_options Undocumented
Instance Variable all_site_dirs Undocumented
Instance Variable allow_hosts Undocumented
Instance Variable always_copy Undocumented
Instance Variable always_copy_from Undocumented
Instance Variable args Undocumented
Instance Variable build_directory Undocumented
Instance Variable config_vars Undocumented
Instance Variable editable Undocumented
Instance Variable exclude_scripts Undocumented
Instance Variable find_links Undocumented
Instance Variable index_url Undocumented
Instance Variable install_base Undocumented
Instance Variable install_data Undocumented
Instance Variable install_dir Undocumented
Instance Variable install_headers Undocumented
Instance Variable install_lib Undocumented
Instance Variable install_platbase Undocumented
Instance Variable install_platlib Undocumented
Instance Variable install_purelib Undocumented
Instance Variable install_scripts Undocumented
Instance Variable install_userbase Undocumented
Instance Variable install_usersite Undocumented
Instance Variable installed_projects Undocumented
Instance Variable local_index Undocumented
Instance Variable local_snapshots_ok Undocumented
Instance Variable multi_version Undocumented
Instance Variable no_deps Undocumented
Instance Variable no_find_links Undocumented
Instance Variable no_report Undocumented
Instance Variable optimize Undocumented
Instance Variable outputs Undocumented
Instance Variable package_index Undocumented
Instance Variable prefix Undocumented
Instance Variable pth_file Undocumented
Instance Variable record Undocumented
Instance Variable root Undocumented
Instance Variable script_dir Undocumented
Instance Variable shadow_path Undocumented
Instance Variable site_dirs Undocumented
Instance Variable upgrade Undocumented
Instance Variable user Undocumented
Instance Variable verbose Undocumented
Instance Variable version Undocumented
Instance Variable zip_ok Undocumented
Static Method _load_template There are a couple of template scripts in the package. This function loads one of them and prepares it for use.
Static Method _process_site_dirs Undocumented
Static Method _render_version Render the Setuptools version and installation details, then exit.
Static Method _validate_optimize Undocumented
Method _delete_path Undocumented
Method _expand Undocumented
Method _expand_attrs Undocumented
Method _fix_install_dir_for_user_site Fix the install_dir if "--user" was used.
Method _set_fetcher_options When easy_install is about to run bdist_egg on a source dist, that source dist might have 'setup_requires' directives, requiring additional fetching. Ensure the fetcher options given to easy_install are available to that command as well.
Method _tmpdir Undocumented
Class Variable __access_msg Undocumented
Class Variable __cant_write_msg Undocumented
Class Variable __editable_msg Undocumented
Class Variable __id_warning Undocumented
Class Variable __mv_warning Undocumented
Class Variable __no_default_msg Undocumented
Class Variable __not_exists_id Undocumented
Instance Variable _dry_run Undocumented

Inherited from Command:

Method __init__ Construct the command for dist, updating vars(self) with any keyword parameters.
Method ensure_string_list Ensure that 'option' is a list of strings. If 'option' is currently a string, we split it either on /,\s*/ or /\s+/, so "foo bar baz", "foo,bar,baz", and "foo, bar baz" all become ["foo", "bar", "baz"].
Method reinitialize_command Undocumented
Method _ensure_stringlike Undocumented
def add_output(self, path): (source)

Undocumented

def build_and_install(self, setup_script, setup_base): (source)

Undocumented

def byte_compile(self, to_compile): (source)

Undocumented

def cant_write_to_target(self): (source)

Undocumented

def check_editable(self, spec): (source)

Undocumented

def check_pth_processing(self): (source)

Empirically verify whether .pth files are supported in inst. dir

def check_site_dir(self): (source)

Verify that self.install_dir is .pth-capable dir, if needed

def create_home_path(self): (source)

Create directories under ~.

def delete_blockers(self, blockers): (source)

Undocumented

def easy_install(self, spec, deps=False): (source)

Undocumented

def egg_distribution(self, egg_path): (source)

Undocumented

def exe_to_egg(self, dist_filename, egg_tmp): (source)

Extract a bdist_wininst to the directories an egg would use

def expand_basedirs(self): (source)

Calls `os.path.expanduser` on install_base, install_platbase and root.

def expand_dirs(self): (source)

Calls `os.path.expanduser` on install dirs.

def finalize_options(self): (source)
overridden in setuptools.command.develop.develop

Undocumented

def initialize_options(self): (source)
overridden in setuptools.command.develop.develop

Undocumented

def install_egg(self, egg_path, tmpdir): (source)

Undocumented

def install_egg_scripts(self, dist): (source)
overridden in setuptools.command.develop.develop

Write all the scripts for `dist`, unless scripts are excluded

def install_eggs(self, spec, dist_filename, tmpdir): (source)

Undocumented

def install_exe(self, dist_filename, tmpdir): (source)

Undocumented

def install_item(self, spec, download, tmpdir, deps, install_needed=False): (source)

Undocumented

def install_script(self, dist, script_name, script_text, dev_path=None): (source)

Generate a legacy script wrapper and install it

def install_wheel(self, wheel_path, tmpdir): (source)

Undocumented

def install_wrapper_scripts(self, dist): (source)
overridden in setuptools.command.develop.develop

Undocumented

def installation_report(self, req, dist, what='Installed'): (source)

Helpful installation message for display to package users

def maybe_move(self, spec, dist_filename, setup_base): (source)

Undocumented

def not_editable(self, spec): (source)

Undocumented

def process_distribution(self, requirement, dist, deps=True, *info): (source)

Undocumented

def pseudo_tempname(self): (source)

Return a pseudo-tempname base in the install directory. This code is intentionally naive; if a malicious party can write to the target directory you're already in deep doodoo.

def report_editable(self, spec, setup_script): (source)

Undocumented

def run(self, show_deprecation=True): (source)
overridden in setuptools.command.develop.develop

Undocumented

def run_setup(self, setup_script, setup_base, args): (source)

Undocumented

def select_scheme(self, name): (source)

Undocumented

def should_unzip(self, dist): (source)

Undocumented

def unpack_and_compile(self, egg_path, destination): (source)

Undocumented

def unpack_progress(self, src, dst): (source)

Undocumented

def update_pth(self, dist): (source)

Undocumented

def warn_deprecated_options(self): (source)

Undocumented

def write_script(self, script_name, contents, mode='t', blockers=()): (source)

Write an executable file to the scripts directory

DEFAULT_SCHEME = (source)

Undocumented

Value
dict(install_dir='$base/Lib/site-packages', script_dir='$base/Scripts')
INSTALL_SCHEMES = (source)

Undocumented

Value
dict(posix=dict(install_dir='$base/lib/python$py_version_short/site-packages',
                script_dir='$base/bin'))
boolean_options: list[str] = (source)
overridden in setuptools.command.develop.develop

Undocumented

command_consumes_arguments: bool = (source)
overrides setuptools.Command.command_consumes_arguments
overridden in setuptools.command.develop.develop

Undocumented

description: str = (source)
overridden in setuptools.command.develop.develop

Undocumented

negative_opt: dict[str, str] = (source)

Undocumented

user_options = (source)
overridden in setuptools.command.develop.develop

Undocumented

all_site_dirs = (source)

Undocumented

allow_hosts = (source)

Undocumented

always_copy = (source)

Undocumented

always_copy_from = (source)
overridden in setuptools.command.develop.develop

Undocumented

args = (source)
overridden in setuptools.command.develop.develop

Undocumented

build_directory = (source)

Undocumented

config_vars = (source)

Undocumented

editable = (source)

Undocumented

exclude_scripts = (source)

Undocumented

find_links = (source)

Undocumented

index_url = (source)

Undocumented

install_base = (source)

Undocumented

install_data = (source)

Undocumented

install_dir = (source)

Undocumented

install_headers = (source)

Undocumented

install_lib = (source)

Undocumented

install_platbase = (source)

Undocumented

install_platlib = (source)

Undocumented

install_purelib = (source)

Undocumented

install_scripts = (source)

Undocumented

install_userbase = (source)

Undocumented

install_usersite = (source)

Undocumented

installed_projects: dict = (source)

Undocumented

local_index = (source)

Undocumented

local_snapshots_ok = (source)

Undocumented

multi_version = (source)
overridden in setuptools.command.develop.develop

Undocumented

no_deps = (source)

Undocumented

no_find_links: bool = (source)

Undocumented

no_report = (source)

Undocumented

optimize = (source)

Undocumented

outputs: list = (source)

Undocumented

package_index = (source)

Undocumented

prefix = (source)

Undocumented

pth_file = (source)

Undocumented

record = (source)

Undocumented

root = (source)

Undocumented

script_dir = (source)

Undocumented

shadow_path = (source)

Undocumented

site_dirs = (source)

Undocumented

upgrade = (source)

Undocumented

user: int = (source)

Undocumented

verbose = (source)

Undocumented

version = (source)

Undocumented

zip_ok = (source)

Undocumented

@staticmethod
def _load_template(dev_path): (source)

There are a couple of template scripts in the package. This function loads one of them and prepares it for use.

@staticmethod
def _process_site_dirs(site_dirs): (source)

Undocumented

@staticmethod
def _render_version(): (source)

Render the Setuptools version and installation details, then exit.

@staticmethod
def _validate_optimize(value): (source)

Undocumented

def _delete_path(self, path): (source)

Undocumented

def _expand(self, *attrs): (source)

Undocumented

def _expand_attrs(self, attrs): (source)

Undocumented

def _fix_install_dir_for_user_site(self): (source)

Fix the install_dir if "--user" was used.

def _set_fetcher_options(self, base): (source)

When easy_install is about to run bdist_egg on a source dist, that source dist might have 'setup_requires' directives, requiring additional fetching. Ensure the fetcher options given to easy_install are available to that command as well.

@contextlib.contextmanager
def _tmpdir(self): (source)

Undocumented

__access_msg = (source)

Undocumented

__cant_write_msg = (source)

Undocumented

__editable_msg = (source)

Undocumented

__id_warning = (source)

Undocumented

__mv_warning = (source)

Undocumented

__no_default_msg = (source)

Undocumented

__not_exists_id = (source)

Undocumented

_dry_run = (source)

Undocumented