Code stringlengths 103 85.9k | Summary listlengths 0 94 |
|---|---|
Please provide a description of the function:def update_wrapper(wrapper,
wrapped,
assigned = functools.WRAPPER_ASSIGNMENTS,
updated = functools.WRAPPER_UPDATES):
# workaround for http://bugs.python.org/issue3445
assigned = tuple(attr for attr in assi... | [
"\n Patch two bugs in functools.update_wrapper.\n "
] |
Please provide a description of the function:def lru_cache(maxsize=100, typed=False):
# Users should only access the lru_cache through its public API:
# cache_info, cache_clear, and f.__wrapped__
# The internals of the lru_cache are encapsulated for thread safety and
# to allow the implement... | [
"Least-recently-used cache decorator.\n\n If *maxsize* is set to None, the LRU features are disabled and the cache\n can grow without bound.\n\n If *typed* is True, arguments of different types will be cached separately.\n For example, f(3.0) and f(3) will be treated as distinct calls with\n distinct... |
Please provide a description of the function:def first(iterable, default=None, key=None):
if key is None:
for el in iterable:
if el:
return el
else:
for el in iterable:
if key(el):
return el
return default | [
"\n Return first element of `iterable` that evaluates true, else return None\n (or an optional default value).\n\n >>> first([0, False, None, [], (), 42])\n 42\n\n >>> first([0, False, None, [], ()]) is None\n True\n\n >>> first([0, False, None, [], ()], default='ohai')\n 'ohai'\n\n >>> i... |
Please provide a description of the function:def get_process_mapping():
try:
output = subprocess.check_output([
'ps', '-ww', '-o', 'pid=', '-o', 'ppid=', '-o', 'args=',
])
except OSError as e: # Python 2-compatible FileNotFoundError.
if e.errno != errno.ENOENT:
... | [
"Try to look up the process tree via the output of `ps`.\n "
] |
Please provide a description of the function:def visit_Name(self, node, store_as_param=False, **kwargs):
if store_as_param or node.ctx == 'param':
self.symbols.declare_parameter(node.name)
elif node.ctx == 'store':
self.symbols.store(node.name)
elif node.ctx == '... | [
"All assignments to names go through this function."
] |
Please provide a description of the function:def visit_Assign(self, node, **kwargs):
self.visit(node.node, **kwargs)
self.visit(node.target, **kwargs) | [
"Visit assignments in the correct order."
] |
Please provide a description of the function:def make_set_closure_cell():
if PYPY: # pragma: no cover
def set_closure_cell(cell, value):
cell.__setstate__((value,))
else:
try:
ctypes = import_ctypes()
set_closure_cell = ctypes.pythonapi.PyCell_Set
... | [
"\n Moved into a function for testability.\n "
] |
Please provide a description of the function:def close(self, force=True):
'''This closes the connection with the child application. Note that
calling close() more than once is valid. This emulates standard Python
behavior with files. Set force to True if you want to make sure that
the ch... | [] |
Please provide a description of the function:def waitnoecho(self, timeout=-1):
'''This waits until the terminal ECHO flag is set False. This returns
True if the echo mode is off. This returns False if the ECHO flag was
not set False before the timeout. This can be used to detect when the
... | [] |
Please provide a description of the function:def read_nonblocking(self, size=1, timeout=-1):
'''This reads at most size characters from the child application. It
includes a timeout. If the read does not complete within the timeout
period then a TIMEOUT exception is raised. If the end of file is ... | [] |
Please provide a description of the function:def send(self, s):
'''Sends string ``s`` to the child process, returning the number of
bytes written. If a logfile is specified, a copy is written to that
log.
The default terminal input mode is canonical processing unless set
otherwi... | [] |
Please provide a description of the function:def sendline(self, s=''):
'''Wraps send(), sending string ``s`` to child process, with
``os.linesep`` automatically appended. Returns number of bytes
written. Only a limited number of bytes may be sent for each
line in the default terminal mo... | [] |
Please provide a description of the function:def _log_control(self, s):
if self.encoding is not None:
s = s.decode(self.encoding, 'replace')
self._log(s, 'send') | [
"Write control characters to the appropriate log files"
] |
Please provide a description of the function:def sendcontrol(self, char):
'''Helper method that wraps send() with mnemonic access for sending control
character to the child (such as Ctrl-C or Ctrl-D). For example, to send
Ctrl-G (ASCII 7, bell, '\a')::
child.sendcontrol('g')
... | [] |
Please provide a description of the function:def sendintr(self):
'''This sends a SIGINT to the child. It does not require
the SIGINT to be the first character on a line. '''
n, byte = self.ptyproc.sendintr()
self._log_control(byte) | [] |
Please provide a description of the function:def wait(self):
'''This waits until the child exits. This is a blocking call. This will
not read any data from the child, so this will block forever if the
child has unread output and has terminated. In other words, the child
may have printed ... | [] |
Please provide a description of the function:def isalive(self):
'''This tests if the child process is running or not. This is
non-blocking. If the child was terminated then this will read the
exitstatus or signalstatus of the child. This returns True if the child
process appears to be ru... | [] |
Please provide a description of the function:def interact(self, escape_character=chr(29),
input_filter=None, output_filter=None):
'''This gives control of the child process to the interactive user (the
human at the keyboard). Keystrokes are sent to the child process, and
the stdout ... | [] |
Please provide a description of the function:def __interact_writen(self, fd, data):
'''This is used by the interact() method.
'''
while data != b'' and self.isalive():
n = os.write(fd, data)
data = data[n:] | [] |
Please provide a description of the function:def __interact_copy(
self, escape_character=None, input_filter=None, output_filter=None
):
'''This is used by the interact() method.
'''
while self.isalive():
if self.use_poll:
r = poll_ignore_interrupts([self... | [] |
Please provide a description of the function:def extras_to_string(extras):
# type: (Iterable[S]) -> S
if isinstance(extras, six.string_types):
if extras.startswith("["):
return extras
else:
extras = [extras]
if not extras:
return ""
return "[{0}]".for... | [
"Turn a list of extras into a string"
] |
Please provide a description of the function:def parse_extras(extras_str):
# type: (AnyStr) -> List[AnyStr]
from pkg_resources import Requirement
extras = Requirement.parse("fakepkg{0}".format(extras_to_string(extras_str))).extras
return sorted(dedup([extra.lower() for extra in extras])) | [
"\n Turn a string of extras into a parsed extras list\n "
] |
Please provide a description of the function:def specs_to_string(specs):
# type: (List[Union[STRING_TYPE, Specifier]]) -> AnyStr
if specs:
if isinstance(specs, six.string_types):
return specs
try:
extras = ",".join(["".join(spec) for spec in specs])
except T... | [
"\n Turn a list of specifier tuples into a string\n "
] |
Please provide a description of the function:def convert_direct_url_to_url(direct_url):
# type: (AnyStr) -> AnyStr
direct_match = DIRECT_URL_RE.match(direct_url) # type: Optional[Match]
if direct_match is None:
url_match = URL_RE.match(direct_url)
if url_match or is_valid_url(direct_ur... | [
"\n Given a direct url as defined by *PEP 508*, convert to a :class:`~pip_shims.shims.Link`\n compatible URL by moving the name and extras into an **egg_fragment**.\n\n :param str direct_url: A pep-508 compliant direct url.\n :return: A reformatted URL for use with Link objects and :class:`~pip_shims.sh... |
Please provide a description of the function:def convert_url_to_direct_url(url, name=None):
# type: (AnyStr, Optional[AnyStr]) -> AnyStr
if not isinstance(url, six.string_types):
raise TypeError(
"Expected a string to convert to a direct url, got {0!r}".format(url)
)
direct_... | [
"\n Given a :class:`~pip_shims.shims.Link` compatible URL, convert to a direct url as\n defined by *PEP 508* by extracting the name and extras from the **egg_fragment**.\n\n :param AnyStr url: A :class:`~pip_shims.shims.InstallRequirement` compliant URL.\n :param Optiona[AnyStr] name: A name to use in c... |
Please provide a description of the function:def strip_extras_markers_from_requirement(req):
# type: (TRequirement) -> TRequirement
if req is None:
raise TypeError("Must pass in a valid requirement, received {0!r}".format(req))
if getattr(req, "marker", None) is not None:
marker = req.m... | [
"\n Given a :class:`~packaging.requirements.Requirement` instance with markers defining\n *extra == 'name'*, strip out the extras from the markers and return the cleaned\n requirement\n\n :param PackagingRequirement req: A packaging requirement to clean\n :return: A cleaned requirement\n :rtype: P... |
Please provide a description of the function:def get_pyproject(path):
# type: (Union[STRING_TYPE, Path]) -> Optional[Tuple[List[STRING_TYPE], STRING_TYPE]]
if not path:
return
from vistir.compat import Path
if not isinstance(path, Path):
path = Path(path)
if not path.is_dir():... | [
"\n Given a base path, look for the corresponding ``pyproject.toml`` file and return its\n build_requires and build_backend.\n\n :param AnyStr path: The root path of the project, should be a directory (will be truncated)\n :return: A 2 tuple of build requirements and the build backend\n :rtype: Optio... |
Please provide a description of the function:def split_markers_from_line(line):
# type: (AnyStr) -> Tuple[AnyStr, Optional[AnyStr]]
if not any(line.startswith(uri_prefix) for uri_prefix in SCHEME_LIST):
marker_sep = ";"
else:
marker_sep = "; "
markers = None
if marker_sep in lin... | [
"Split markers from a dependency"
] |
Please provide a description of the function:def split_vcs_method_from_uri(uri):
# type: (AnyStr) -> Tuple[Optional[STRING_TYPE], STRING_TYPE]
vcs_start = "{0}+"
vcs = None # type: Optional[STRING_TYPE]
vcs = first([vcs for vcs in VCS_LIST if uri.startswith(vcs_start.format(vcs))])
if vcs:
... | [
"Split a vcs+uri formatted uri into (vcs, uri)"
] |
Please provide a description of the function:def split_ref_from_uri(uri):
# type: (AnyStr) -> Tuple[AnyStr, Optional[AnyStr]]
if not isinstance(uri, six.string_types):
raise TypeError("Expected a string, received {0!r}".format(uri))
parsed = urllib_parse.urlparse(uri)
path = parsed.path
... | [
"\n Given a path or URI, check for a ref and split it from the path if it is present,\n returning a tuple of the original input and the ref or None.\n\n :param AnyStr uri: The path or URI to split\n :returns: A 2-tuple of the path or URI and the ref\n :rtype: Tuple[AnyStr, Optional[AnyStr]]\n "
] |
Please provide a description of the function:def key_from_ireq(ireq):
if ireq.req is None and ireq.link is not None:
return str(ireq.link)
else:
return key_from_req(ireq.req) | [
"Get a standardized key for an InstallRequirement."
] |
Please provide a description of the function:def key_from_req(req):
if hasattr(req, "key"):
# from pkg_resources, such as installed dists for pip-sync
key = req.key
else:
# from packaging, such as install requirements from requirements.txt
key = req.name
key = key.repla... | [
"Get an all-lowercase version of the requirement's name."
] |
Please provide a description of the function:def _requirement_to_str_lowercase_name(requirement):
parts = [requirement.name.lower()]
if requirement.extras:
parts.append("[{0}]".format(",".join(sorted(requirement.extras))))
if requirement.specifier:
parts.append(str(requirement.specif... | [
"\n Formats a packaging.requirements.Requirement with a lowercase name.\n\n This is simply a copy of\n https://github.com/pypa/packaging/blob/16.8/packaging/requirements.py#L109-L124\n modified to lowercase the dependency name.\n\n Previously, we were invoking the original Requirement.__str__ method ... |
Please provide a description of the function:def format_requirement(ireq):
if ireq.editable:
line = "-e {}".format(ireq.link)
else:
line = _requirement_to_str_lowercase_name(ireq.req)
if str(ireq.req.marker) != str(ireq.markers):
if not ireq.req.marker:
line = "{};... | [
"\n Generic formatter for pretty printing InstallRequirements to the terminal\n in a less verbose way than using its `__str__` method.\n "
] |
Please provide a description of the function:def format_specifier(ireq):
# TODO: Ideally, this is carried over to the pip library itself
specs = ireq.specifier._specs if ireq.req is not None else []
specs = sorted(specs, key=lambda x: x._spec[1])
return ",".join(str(s) for s in specs) or "<any>" | [
"\n Generic formatter for pretty printing the specifier part of\n InstallRequirements to the terminal.\n "
] |
Please provide a description of the function:def as_tuple(ireq):
if not is_pinned_requirement(ireq):
raise TypeError("Expected a pinned InstallRequirement, got {}".format(ireq))
name = key_from_req(ireq.req)
version = first(ireq.specifier._specs)._spec[1]
extras = tuple(sorted(ireq.extras... | [
"\n Pulls out the (name: str, version:str, extras:(str)) tuple from the pinned InstallRequirement.\n "
] |
Please provide a description of the function:def full_groupby(iterable, key=None):
return groupby(sorted(iterable, key=key), key=key) | [
"\n Like groupby(), but sorts the input on the group key first.\n "
] |
Please provide a description of the function:def lookup_table(values, key=None, keyval=None, unique=False, use_lists=False):
if keyval is None:
if key is None:
keyval = lambda v: v
else:
keyval = lambda v: (key(v), v)
if unique:
return dict(keyval(v) for v ... | [
"\n Builds a dict-based lookup table (index) elegantly.\n\n Supports building normal and unique lookup tables. For example:\n\n >>> assert lookup_table(\n ... ['foo', 'bar', 'baz', 'qux', 'quux'], lambda s: s[0]) == {\n ... 'b': {'bar', 'baz'},\n ... 'f': {'foo'},\n ... 'q': {'... |
Please provide a description of the function:def make_install_requirement(name, version, extras, markers, constraint=False):
# If no extras are specified, the extras string is blank
from pip_shims.shims import install_req_from_line
extras_string = ""
if extras:
# Sort extras for stability... | [
"\n Generates an :class:`~pip._internal.req.req_install.InstallRequirement`.\n\n Create an InstallRequirement from the supplied metadata.\n\n :param name: The requirement's name.\n :type name: str\n :param version: The requirement version (must be pinned).\n :type version: str.\n :param extras:... |
Please provide a description of the function:def clean_requires_python(candidates):
all_candidates = []
sys_version = ".".join(map(str, sys.version_info[:3]))
from packaging.version import parse as parse_version
py_version = parse_version(os.environ.get("PIP_PYTHON_VERSION", sys_version))
for ... | [
"Get a cleaned list of all the candidates with valid specifiers in the `requires_python` attributes."
] |
Please provide a description of the function:def get_name_variants(pkg):
# type: (STRING_TYPE) -> Set[STRING_TYPE]
if not isinstance(pkg, six.string_types):
raise TypeError("must provide a string to derive package names")
from pkg_resources import safe_name
from packaging.utils import cano... | [
"\n Given a packager name, get the variants of its name for both the canonicalized\n and \"safe\" forms.\n\n :param AnyStr pkg: The package to lookup\n :returns: A list of names.\n :rtype: Set\n "
] |
Please provide a description of the function:def _best_version(fields):
def _has_marker(keys, markers):
for marker in markers:
if marker in keys:
return True
return False
keys = []
for key, value in fields.items():
if value in ([], 'UNKNOWN', None):
... | [
"Detect the best version depending on the fields used."
] |
Please provide a description of the function:def _get_name_and_version(name, version, for_filename=False):
if for_filename:
# For both name and version any runs of non-alphanumeric or '.'
# characters are replaced with a single '-'. Additionally any
# spaces in the version string becom... | [
"Return the distribution name with version.\n\n If for_filename is true, return a filename-escaped form."
] |
Please provide a description of the function:def read(self, filepath):
fp = codecs.open(filepath, 'r', encoding='utf-8')
try:
self.read_file(fp)
finally:
fp.close() | [
"Read the metadata values from a file path."
] |
Please provide a description of the function:def write(self, filepath, skip_unknown=False):
fp = codecs.open(filepath, 'w', encoding='utf-8')
try:
self.write_file(fp, skip_unknown)
finally:
fp.close() | [
"Write the metadata fields to filepath."
] |
Please provide a description of the function:def write_file(self, fileobject, skip_unknown=False):
self.set_metadata_version()
for field in _version2fieldlist(self['Metadata-Version']):
values = self.get(field)
if skip_unknown and values in ('UNKNOWN', [], ['UNKNOWN']):... | [
"Write the PKG-INFO format data to a file object."
] |
Please provide a description of the function:def update(self, other=None, **kwargs):
def _set(key, value):
if key in _ATTR2FIELD and value:
self.set(self._convert_name(key), value)
if not other:
# other is None or empty container
pass
... | [
"Set metadata values from the given iterable `other` and kwargs.\n\n Behavior is like `dict.update`: If `other` has a ``keys`` method,\n they are looped over and ``self[key]`` is assigned ``other[key]``.\n Else, ``other`` is an iterable of ``(key, value)`` iterables.\n\n Keys that don't ... |
Please provide a description of the function:def set(self, name, value):
name = self._convert_name(name)
if ((name in _ELEMENTSFIELD or name == 'Platform') and
not isinstance(value, (list, tuple))):
if isinstance(value, string_types):
value = [v.strip() ... | [
"Control then set a metadata field."
] |
Please provide a description of the function:def get(self, name, default=_MISSING):
name = self._convert_name(name)
if name not in self._fields:
if default is _MISSING:
default = self._default_value(name)
return default
if name in _UNICODEFIELDS:
... | [
"Get a metadata field."
] |
Please provide a description of the function:def todict(self, skip_missing=False):
self.set_metadata_version()
mapping_1_0 = (
('metadata_version', 'Metadata-Version'),
('name', 'Name'),
('version', 'Version'),
('summary', 'Summary'),
... | [
"Return fields as a dict.\n\n Field names will be converted to use the underscore-lowercase style\n instead of hyphen-mixed case (i.e. home_page instead of Home-page).\n "
] |
Please provide a description of the function:def get_requirements(self, reqts, extras=None, env=None):
if self._legacy:
result = reqts
else:
result = []
extras = get_extras(extras or [], self.extras)
for d in reqts:
if 'extra' not ... | [
"\n Base method to get dependencies, given a set of extras\n to satisfy and an optional environment context.\n :param reqts: A list of sometimes-wanted dependencies,\n perhaps dependent on extras and environment.\n :param extras: A list of optional components being r... |
Please provide a description of the function:def remove_move(name):
try:
delattr(_MovedItems, name)
except AttributeError:
try:
del moves.__dict__[name]
except KeyError:
raise AttributeError("no such move, %r" % (name,)) | [
"Remove item from six.moves."
] |
Please provide a description of the function:def ensure_binary(s, encoding='utf-8', errors='strict'):
if isinstance(s, text_type):
return s.encode(encoding, errors)
elif isinstance(s, binary_type):
return s
else:
raise TypeError("not expecting type '%s'" % type(s)) | [
"Coerce **s** to six.binary_type.\n\n For Python 2:\n - `unicode` -> encoded to `str`\n - `str` -> `str`\n\n For Python 3:\n - `str` -> encoded to `bytes`\n - `bytes` -> `bytes`\n "
] |
Please provide a description of the function:def ensure_str(s, encoding='utf-8', errors='strict'):
if not isinstance(s, (text_type, binary_type)):
raise TypeError("not expecting type '%s'" % type(s))
if PY2 and isinstance(s, text_type):
s = s.encode(encoding, errors)
elif PY3 and isinst... | [
"Coerce *s* to `str`.\n\n For Python 2:\n - `unicode` -> encoded to `str`\n - `str` -> `str`\n\n For Python 3:\n - `str` -> `str`\n - `bytes` -> decoded to `str`\n "
] |
Please provide a description of the function:def ensure_text(s, encoding='utf-8', errors='strict'):
if isinstance(s, binary_type):
return s.decode(encoding, errors)
elif isinstance(s, text_type):
return s
else:
raise TypeError("not expecting type '%s'" % type(s)) | [
"Coerce *s* to six.text_type.\n\n For Python 2:\n - `unicode` -> `unicode`\n - `str` -> `unicode`\n\n For Python 3:\n - `str` -> `str`\n - `bytes` -> decoded to `str`\n "
] |
Please provide a description of the function:def python_2_unicode_compatible(klass):
if PY2:
if '__str__' not in klass.__dict__:
raise ValueError("@python_2_unicode_compatible cannot be applied "
"to %s because it doesn't define __str__()." %
... | [
"\n A decorator that defines __unicode__ and __str__ methods under Python 2.\n Under Python 3 it does nothing.\n\n To support Python 2 and 3 with a single code base, define a __str__ method\n returning text and apply this decorator to the class.\n "
] |
Please provide a description of the function:def parse_requirements(
filename, # type: str
finder=None, # type: Optional[PackageFinder]
comes_from=None, # type: Optional[str]
options=None, # type: Optional[optparse.Values]
session=None, # type: Optional[PipSession]
constraint=False, # type... | [
"Parse a requirements file and yield InstallRequirement instances.\n\n :param filename: Path or url of requirements file.\n :param finder: Instance of pip.index.PackageFinder.\n :param comes_from: Origin description of requirements.\n :param options: cli options.\n :param session: In... |
Please provide a description of the function:def preprocess(content, options):
# type: (Text, Optional[optparse.Values]) -> ReqFileLines
lines_enum = enumerate(content.splitlines(), start=1) # type: ReqFileLines
lines_enum = join_lines(lines_enum)
lines_enum = ignore_comments(lines_enum)
lines... | [
"Split, filter, and join lines, and return a line iterator\n\n :param content: the content of the requirements file\n :param options: cli options\n "
] |
Please provide a description of the function:def process_line(
line, # type: Text
filename, # type: str
line_number, # type: int
finder=None, # type: Optional[PackageFinder]
comes_from=None, # type: Optional[str]
options=None, # type: Optional[optparse.Values]
session=None, # type: Op... | [
"Process a single requirements line; This can result in creating/yielding\n requirements, or updating the finder.\n\n For lines that contain requirements, the only options that have an effect\n are from SUPPORTED_OPTIONS_REQ, and they are scoped to the\n requirement. Other options from SUPPORTED_OPTIONS... |
Please provide a description of the function:def break_args_options(line):
# type: (Text) -> Tuple[str, Text]
tokens = line.split(' ')
args = []
options = tokens[:]
for token in tokens:
if token.startswith('-') or token.startswith('--'):
break
else:
args.... | [
"Break up the line into an args and options string. We only want to shlex\n (and then optparse) the options, not the args. args can contain markers\n which are corrupted by shlex.\n "
] |
Please provide a description of the function:def build_parser(line):
# type: (Text) -> optparse.OptionParser
parser = optparse.OptionParser(add_help_option=False)
option_factories = SUPPORTED_OPTIONS + SUPPORTED_OPTIONS_REQ
for option_factory in option_factories:
option = option_factory()
... | [
"\n Return a parser for parsing requirement lines\n "
] |
Please provide a description of the function:def join_lines(lines_enum):
# type: (ReqFileLines) -> ReqFileLines
primary_line_number = None
new_line = [] # type: List[Text]
for line_number, line in lines_enum:
if not line.endswith('\\') or COMMENT_RE.match(line):
if COMMENT_RE.m... | [
"Joins a line ending in '\\' with the previous line (except when following\n comments). The joined line takes on the index of the first line.\n "
] |
Please provide a description of the function:def ignore_comments(lines_enum):
# type: (ReqFileLines) -> ReqFileLines
for line_number, line in lines_enum:
line = COMMENT_RE.sub('', line)
line = line.strip()
if line:
yield line_number, line | [
"\n Strips comments and filter empty lines.\n "
] |
Please provide a description of the function:def skip_regex(lines_enum, options):
# type: (ReqFileLines, Optional[optparse.Values]) -> ReqFileLines
skip_regex = options.skip_requirements_regex if options else None
if skip_regex:
pattern = re.compile(skip_regex)
lines_enum = filterfalse(... | [
"\n Skip lines that match '--skip-requirements-regex' pattern\n\n Note: the regex pattern is only built once\n "
] |
Please provide a description of the function:def expand_env_variables(lines_enum):
# type: (ReqFileLines) -> ReqFileLines
for line_number, line in lines_enum:
for env_var, var_name in ENV_VAR_RE.findall(line):
value = os.getenv(var_name)
if not value:
continu... | [
"Replace all environment variables that can be retrieved via `os.getenv`.\n\n The only allowed format for environment variables defined in the\n requirement file is `${MY_VARIABLE_1}` to ensure two things:\n\n 1. Strings that contain a `$` aren't accidentally (partially) expanded.\n 2. Ensure consistenc... |
Please provide a description of the function:def finish(self):
super(InterruptibleMixin, self).finish()
signal(SIGINT, self.original_handler) | [
"\n Restore the original SIGINT handler after finishing.\n\n This should happen regardless of whether the progress display finishes\n normally, or gets interrupted.\n "
] |
Please provide a description of the function:def handle_sigint(self, signum, frame):
self.finish()
self.original_handler(signum, frame) | [
"\n Call self.finish() before delegating to the original SIGINT handler.\n\n This handler should only be in place while the progress display is\n active.\n "
] |
Please provide a description of the function:def iter_fields(self, exclude=None, only=None):
for name in self.fields:
if (exclude is only is None) or \
(exclude is not None and name not in exclude) or \
(only is not None and name in only):
try:
... | [
"This method iterates over all fields that are defined and yields\n ``(key, value)`` tuples. Per default all fields are returned, but\n it's possible to limit that to some fields by providing the `only`\n parameter or to exclude some using the `exclude` parameter. Both\n should be sets... |
Please provide a description of the function:def iter_child_nodes(self, exclude=None, only=None):
for field, item in self.iter_fields(exclude, only):
if isinstance(item, list):
for n in item:
if isinstance(n, Node):
yield n
... | [
"Iterates over all direct child nodes of the node. This iterates\n over all fields and yields the values of they are nodes. If the value\n of a field is a list all the nodes in that list are returned.\n "
] |
Please provide a description of the function:def find_all(self, node_type):
for child in self.iter_child_nodes():
if isinstance(child, node_type):
yield child
for result in child.find_all(node_type):
yield result | [
"Find all the nodes of a given type. If the type is a tuple,\n the check is performed for any of the tuple items.\n "
] |
Please provide a description of the function:def set_ctx(self, ctx):
todo = deque([self])
while todo:
node = todo.popleft()
if 'ctx' in node.fields:
node.ctx = ctx
todo.extend(node.iter_child_nodes())
return self | [
"Reset the context of a node and all child nodes. Per default the\n parser will all generate nodes that have a 'load' context as it's the\n most common one. This method is used in the parser to set assignment\n targets and other nodes to a store context.\n "
] |
Please provide a description of the function:def set_lineno(self, lineno, override=False):
todo = deque([self])
while todo:
node = todo.popleft()
if 'lineno' in node.attributes:
if node.lineno is None or override:
node.lineno = lineno
... | [
"Set the line numbers of the node and children."
] |
Please provide a description of the function:def set_environment(self, environment):
todo = deque([self])
while todo:
node = todo.popleft()
node.environment = environment
todo.extend(node.iter_child_nodes())
return self | [
"Set the environment for all nodes."
] |
Please provide a description of the function:def from_untrusted(cls, value, lineno=None, environment=None):
from .compiler import has_safe_repr
if not has_safe_repr(value):
raise Impossible()
return cls(value, lineno=lineno, environment=environment) | [
"Return a const object if the value is representable as\n constant value in the generated code, otherwise it will raise\n an `Impossible` exception.\n "
] |
Please provide a description of the function:def build_wheel(source_dir, wheel_dir, config_settings=None):
if config_settings is None:
config_settings = {}
requires, backend = _load_pyproject(source_dir)
hooks = Pep517HookCaller(source_dir, backend)
with BuildEnvironment() as env:
... | [
"Build a wheel from a source directory using PEP 517 hooks.\n\n :param str source_dir: Source directory containing pyproject.toml\n :param str wheel_dir: Target directory to create wheel in\n :param dict config_settings: Options to pass to build backend\n\n This is a blocking function which will run pip... |
Please provide a description of the function:def build_sdist(source_dir, sdist_dir, config_settings=None):
if config_settings is None:
config_settings = {}
requires, backend = _load_pyproject(source_dir)
hooks = Pep517HookCaller(source_dir, backend)
with BuildEnvironment() as env:
... | [
"Build an sdist from a source directory using PEP 517 hooks.\n\n :param str source_dir: Source directory containing pyproject.toml\n :param str sdist_dir: Target directory to place sdist in\n :param dict config_settings: Options to pass to build backend\n\n This is a blocking function which will run pip... |
Please provide a description of the function:def pip_install(self, reqs):
if not reqs:
return
log.info('Calling pip to install %s', reqs)
check_call([
sys.executable, '-m', 'pip', 'install', '--ignore-installed',
'--prefix', self.path] + list(reqs)) | [
"Install dependencies into this env by calling pip in a subprocess"
] |
Please provide a description of the function:def reparentChildren(self, newParent):
# XXX - should this method be made more general?
for child in self.childNodes:
newParent.appendChild(child)
self.childNodes = [] | [
"Move all the children of the current node to newParent.\n This is needed so that trees that don't store text as nodes move the\n text in the correct way\n\n :arg newParent: the node to move all this node's children to\n\n "
] |
Please provide a description of the function:def elementInActiveFormattingElements(self, name):
for item in self.activeFormattingElements[::-1]:
# Check for Marker first because if it's a Marker it doesn't have a
# name attribute.
if item == Marker:
... | [
"Check if an element exists between the end of the active\n formatting elements and the last marker. If it does, return it, else\n return false"
] |
Please provide a description of the function:def createElement(self, token):
name = token["name"]
namespace = token.get("namespace", self.defaultNamespace)
element = self.elementClass(name, namespace)
element.attributes = token["data"]
return element | [
"Create an element but don't insert it anywhere"
] |
Please provide a description of the function:def _setInsertFromTable(self, value):
self._insertFromTable = value
if value:
self.insertElement = self.insertElementTable
else:
self.insertElement = self.insertElementNormal | [
"Switch the function used to insert an element from the\n normal one to the misnested table one and back again"
] |
Please provide a description of the function:def insertElementTable(self, token):
element = self.createElement(token)
if self.openElements[-1].name not in tableInsertModeElements:
return self.insertElementNormal(token)
else:
# We should be in the InTable mode. Th... | [
"Create an element and insert it into the tree"
] |
Please provide a description of the function:def insertText(self, data, parent=None):
if parent is None:
parent = self.openElements[-1]
if (not self.insertFromTable or (self.insertFromTable and
self.openElements[-1].name
... | [
"Insert text data."
] |
Please provide a description of the function:def getTableMisnestedNodePosition(self):
# The foster parent element is the one which comes before the most
# recently opened table element
# XXX - this is really inelegant
lastTable = None
fosterParent = None
insertBe... | [
"Get the foster parent element, and sibling to insert before\n (or None) when inserting a misnested table node"
] |
Please provide a description of the function:def getFragment(self):
# assert self.innerHTML
fragment = self.fragmentClass()
self.openElements[0].reparentChildren(fragment)
return fragment | [
"Return the final fragment"
] |
Please provide a description of the function:def evaluate(self, environment=None):
current_environment = default_environment()
if environment is not None:
current_environment.update(environment)
return _evaluate_markers(self._markers, current_environment) | [
"Evaluate a marker.\n\n Return the boolean from evaluating the given marker against the\n environment. environment is an optional argument to override all or\n part of the determined environment.\n\n The environment is determined from the current Python process.\n "
] |
Please provide a description of the function:def _allow_all_wheels():
original_wheel_supported = Wheel.supported
original_support_index_min = Wheel.support_index_min
Wheel.supported = _wheel_supported
Wheel.support_index_min = _wheel_support_index_min
yield
Wheel.supported = original_wheel... | [
"Monkey patch pip.Wheel to allow all wheels\n\n The usual checks against platforms and Python versions are ignored to allow\n fetching all available entries in PyPI. This also saves the candidate cache\n and set a new one, or else the results from the previous non-patched calls\n will interfere.\n "
... |
Please provide a description of the function:def create(self):
if self.path is not None:
logger.debug(
"Skipped creation of temporary directory: {}".format(self.path)
)
return
# We realpath here because some systems have their default tmpdir
... | [
"Create a temporary directory and store its path in self.path\n "
] |
Please provide a description of the function:def cleanup(self):
if getattr(self._finalizer, "detach", None) and self._finalizer.detach():
if os.path.exists(self.path):
try:
rmtree(self.path)
except OSError:
pass
... | [
"Remove the temporary directory created and reset state\n "
] |
Please provide a description of the function:def _generate_names(cls, name):
for i in range(1, len(name)):
for candidate in itertools.combinations_with_replacement(
cls.LEADING_CHARS, i - 1):
new_name = '~' + ''.join(candidate) + name[i:]
... | [
"Generates a series of temporary names.\n\n The algorithm replaces the leading characters in the name\n with ones that are valid filesystem characters, but are not\n valid package names (for both Python and pip definitions of\n package).\n "
] |
Please provide a description of the function:def detect(byte_str):
if not isinstance(byte_str, bytearray):
if not isinstance(byte_str, bytes):
raise TypeError('Expected object of type bytes or bytearray, got: '
'{0}'.format(type(byte_str)))
else:
... | [
"\n Detect the encoding of the given byte string.\n\n :param byte_str: The byte sequence to examine.\n :type byte_str: ``bytes`` or ``bytearray``\n "
] |
Please provide a description of the function:def unescape(self):
from ._constants import HTML_ENTITIES
def handle_match(m):
name = m.group(1)
if name in HTML_ENTITIES:
return unichr(HTML_ENTITIES[name])
try:
if name[:2] in ("#... | [
"Convert escaped markup back into a text string. This replaces\n HTML entities with the characters they represent.\n\n >>> Markup('Main » <em>About</em>').unescape()\n 'Main » <em>About</em>'\n "
] |
Please provide a description of the function:def escape(cls, s):
rv = escape(s)
if rv.__class__ is not cls:
return cls(rv)
return rv | [
"Escape a string. Calls :func:`escape` and ensures that for\n subclasses the correct type is returned.\n "
] |
Please provide a description of the function:def populate_link(self, finder, upgrade, require_hashes):
# type: (PackageFinder, bool, bool) -> None
if self.link is None:
self.link = finder.find_requirement(self, upgrade)
if self._wheel_cache is not None and not require_hashes... | [
"Ensure that if a link can be found for this, that it is found.\n\n Note that self.link may still be None - if Upgrade is False and the\n requirement is already installed.\n\n If require_hashes is True, don't use the wheel cache, because cached\n wheels, always built locally, have differ... |
Please provide a description of the function:def is_pinned(self):
# type: () -> bool
specifiers = self.specifier
return (len(specifiers) == 1 and
next(iter(specifiers)).operator in {'==', '==='}) | [
"Return whether I am pinned to an exact version.\n\n For example, some-package==1.2 is pinned; some-package>1.2 is not.\n "
] |
Please provide a description of the function:def hashes(self, trust_internet=True):
# type: (bool) -> Hashes
good_hashes = self.options.get('hashes', {}).copy()
link = self.link if trust_internet else self.original_link
if link and link.hash:
good_hashes.setdefault(l... | [
"Return a hash-comparer that considers my option- and URL-based\n hashes to be known-good.\n\n Hashes in URLs--ones embedded in the requirements file, not ones\n downloaded from an index server--are almost peers with ones from\n flags. They satisfy --require-hashes (whether it was implic... |
Please provide a description of the function:def _correct_build_location(self):
# type: () -> None
if self.source_dir is not None:
return
assert self.req is not None
assert self._temp_build_dir.path
assert (self._ideal_build_dir is not None and
... | [
"Move self._temp_build_dir to self._ideal_build_dir/self.req.name\n\n For some requirements (e.g. a path to a directory), the name of the\n package is not available until we run egg_info, so the build_location\n will return a temporary directory and store the _ideal_build_dir.\n\n This i... |
Please provide a description of the function:def remove_temporary_source(self):
# type: () -> None
if self.source_dir and os.path.exists(
os.path.join(self.source_dir, PIP_DELETE_MARKER_FILENAME)):
logger.debug('Removing source in %s', self.source_dir)
rm... | [
"Remove the source files from this requirement, if they are marked\n for deletion"
] |
Please provide a description of the function:def load_pyproject_toml(self):
# type: () -> None
pep517_data = load_pyproject_toml(
self.use_pep517,
self.pyproject_toml,
self.setup_py,
str(self)
)
if pep517_data is None:
... | [
"Load the pyproject.toml file.\n\n After calling this routine, all of the attributes related to PEP 517\n processing for this requirement have been set. In particular, the\n use_pep517 attribute can be used to determine whether we should\n follow the PEP 517 or legacy (setup.py) code pat... |
Please provide a description of the function:def prepare_metadata(self):
# type: () -> None
assert self.source_dir
with indent_log():
if self.use_pep517:
self.prepare_pep517_metadata()
else:
self.run_egg_info()
if not sel... | [
"Ensure that project metadata is available.\n\n Under PEP 517, call the backend hook to prepare the metadata.\n Under legacy processing, call setup.py egg-info.\n "
] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.