setuptools.command.editable_wheel.editable_wheel

class documentation

class editable_wheel(Command): (source)

View In Hierarchy

Build 'editable' wheel for development. This command is private and reserved for internal use of setuptools, users should rely on ``setuptools.build_meta`` APIs.

Method finalize_options Undocumented
Method initialize_options Undocumented
Method run Undocumented
Class Variable description Undocumented
Class Variable user_options Undocumented
Instance Variable dist_dir Undocumented
Instance Variable dist_info_dir Undocumented
Instance Variable mode Undocumented
Instance Variable package_dir Undocumented
Instance Variable project_dir Undocumented
Method _collect_build_outputs Undocumented
Method _configure_build Configure commands to behave in the following ways:
Method _create_wheel_file Undocumented
Method _ensure_dist_info Undocumented
Method _find_egg_info_dir Undocumented
Method _install_namespaces Undocumented
Method _run_build_commands Undocumented
Method _run_build_subcommands Issue #3501 indicates that some plugins/customizations might rely on:
Method _run_install Undocumented
Method _safely_run Undocumented
Method _select_strategy Decides which strategy to use to implement an editable installation.
Method _set_editable_mode Set the ``editable_mode`` flag in the build sub-commands

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
Class Variable command_consumes_arguments Undocumented
Method _ensure_stringlike Undocumented
def finalize_options(self): (source)

Undocumented

def initialize_options(self): (source)

Undocumented

def run(self): (source)

Undocumented

description: str = (source)

Undocumented

user_options = (source)

Undocumented

dist_dir = (source)

Undocumented

dist_info_dir = (source)

Undocumented

mode = (source)

Undocumented

package_dir = (source)

Undocumented

project_dir = (source)

Undocumented

def _collect_build_outputs(self) -> Tuple[List[str], Dict[str, str]]: (source)

Undocumented

def _configure_build(self, name: str, unpacked_wheel: _Path, build_lib: _Path, tmp_dir: _Path): (source)

Configure commands to behave in the following ways: - Build commands can write to ``build_lib`` if they really want to... (but this folder is expected to be ignored and modules are expected to live in the project directory...) - Binary extensions should be built in-place (editable_mode = True) - Data/header/script files are not part of the "editable" specification so they are written directly to the unpacked_wheel directory.

def _create_wheel_file(self, bdist_wheel): (source)

Undocumented

def _ensure_dist_info(self): (source)

Undocumented

def _find_egg_info_dir(self) -> Optional[str]: (source)

Undocumented

def _install_namespaces(self, installation_dir, pth_prefix): (source)

Undocumented

def _run_build_commands(self, dist_name: str, unpacked_wheel: _Path, build_lib: _Path, tmp_dir: _Path) -> Tuple[List[str], Dict[str, str]]: (source)

Undocumented

def _run_build_subcommands(self): (source)

Issue #3501 indicates that some plugins/customizations might rely on: 1. ``build_py`` not running 2. ``build_py`` always copying files to ``build_lib`` However both these assumptions may be false in editable_wheel. This method implements a temporary workaround to support the ecosystem while the implementations catch up.

def _run_install(self, category: str): (source)

Undocumented

def _safely_run(self, cmd_name: str): (source)

Undocumented

def _select_strategy(self, name: str, tag: str, build_lib: _Path) -> EditableStrategy: (source)

Decides which strategy to use to implement an editable installation.

def _set_editable_mode(self): (source)

Set the ``editable_mode`` flag in the build sub-commands