Code stringlengths 103 85.9k | Summary listlengths 0 94 |
|---|---|
Please provide a description of the function:def _normalize_name(name):
# type: (str) -> str
name = name.lower().replace('_', '-')
if name.startswith('--'):
name = name[2:] # only prefer long opts
return name | [
"Make a name consistent regardless of source (environment or file)\n "
] |
Please provide a description of the function:def get_value(self, key):
# type: (str) -> Any
try:
return self._dictionary[key]
except KeyError:
raise ConfigurationError("No such key - {}".format(key)) | [
"Get a value from the configuration.\n "
] |
Please provide a description of the function:def set_value(self, key, value):
# type: (str, Any) -> None
self._ensure_have_load_only()
fname, parser = self._get_parser_to_modify()
if parser is not None:
section, name = _disassemble_key(key)
# Modify th... | [
"Modify a value in the configuration.\n "
] |
Please provide a description of the function:def unset_value(self, key):
# type: (str) -> None
self._ensure_have_load_only()
if key not in self._config[self.load_only]:
raise ConfigurationError("No such key - {}".format(key))
fname, parser = self._get_parser_to_mod... | [
"Unset a value in the configuration.\n "
] |
Please provide a description of the function:def save(self):
# type: () -> None
self._ensure_have_load_only()
for fname, parser in self._modified_parsers:
logger.info("Writing to %s", fname)
# Ensure directory exists.
ensure_dir(os.path.dirname(fnam... | [
"Save the currentin-memory state.\n "
] |
Please provide a description of the function:def _dictionary(self):
# type: () -> Dict[str, Any]
# NOTE: Dictionaries are not populated if not loaded. So, conditionals
# are not needed here.
retval = {}
for variant in self._override_order:
retval.updat... | [
"A dictionary representing the loaded configuration.\n "
] |
Please provide a description of the function:def _load_config_files(self):
# type: () -> None
config_files = dict(self._iter_config_files())
if config_files[kinds.ENV][0:1] == [os.devnull]:
logger.debug(
"Skipping loading configuration files due to "
... | [
"Loads configuration from configuration files\n "
] |
Please provide a description of the function:def _load_environment_vars(self):
# type: () -> None
self._config[kinds.ENV_VAR].update(
self._normalized_keys(":env:", self._get_environ_vars())
) | [
"Loads configuration from environment variables\n "
] |
Please provide a description of the function:def _normalized_keys(self, section, items):
# type: (str, Iterable[Tuple[str, Any]]) -> Dict[str, Any]
normalized = {}
for name, val in items:
key = section + "." + _normalize_name(name)
normalized[key] = val
r... | [
"Normalizes items to construct a dictionary with normalized keys.\n\n This routine is where the names become keys and are made the same\n regardless of source - configuration files or environment.\n "
] |
Please provide a description of the function:def _get_environ_vars(self):
# type: () -> Iterable[Tuple[str, str]]
for key, val in os.environ.items():
should_be_yielded = (
key.startswith("PIP_") and
key[4:].lower() not in self._ignore_env_names
... | [
"Returns a generator with all environmental vars with prefix PIP_"
] |
Please provide a description of the function:def _iter_config_files(self):
# type: () -> Iterable[Tuple[Kind, List[str]]]
# SMELL: Move the conditions out of this function
# environment variables have the lowest priority
config_file = os.environ.get('PIP_CONFIG_FILE', None)
... | [
"Yields variant and configuration files associated with it.\n\n This should be treated like items of a dictionary.\n "
] |
Please provide a description of the function:def _get_n_args(self, args, example, n):
if len(args) != n:
msg = (
'Got unexpected number of arguments, expected {}. '
'(example: "{} config {}")'
).format(n, get_prog(), example)
raise Pip... | [
"Helper to make sure the command got the right number of arguments\n "
] |
Please provide a description of the function:def cmdify(self):
return " ".join(itertools.chain(
[_quote_if_contains(self.command, r'[\s^()]')],
(_quote_if_contains(arg, r'[\s^]') for arg in self.args),
)) | [
"Encode into a cmd-executable string.\n\n This re-implements CreateProcess's quoting logic to turn a list of\n arguments into one single string for the shell to interpret.\n\n * All double quotes are escaped with a backslash.\n * Existing backslashes before a quote are doubled, so they a... |
Please provide a description of the function:def normalize_path(path):
# type: (AnyStr) -> AnyStr
return os.path.normpath(
os.path.normcase(
os.path.abspath(os.path.expandvars(os.path.expanduser(str(path))))
)
) | [
"\n Return a case-normalized absolute variable-expanded path.\n\n :param str path: The non-normalized path\n :return: A normalized, expanded, case-normalized path\n :rtype: str\n "
] |
Please provide a description of the function:def path_to_url(path):
# type: (str) -> Text
from .misc import to_text, to_bytes
if not path:
return path
path = to_bytes(path, encoding="utf-8")
normalized_path = to_text(normalize_drive(os.path.abspath(path)), encoding="utf-8")
return ... | [
"Convert the supplied local path to a file uri.\n\n :param str path: A string pointing to or representing a local path\n :return: A `file://` uri for the same location\n :rtype: str\n\n >>> path_to_url(\"/home/user/code/myrepo/myfile.zip\")\n 'file:///home/user/code/myrepo/myfile.zip'\n "
] |
Please provide a description of the function:def url_to_path(url):
# type: (str) -> ByteString
from .misc import to_bytes
assert is_file_url(url), "Only file: urls can be converted to local paths"
_, netloc, path, _, _ = urllib_parse.urlsplit(url)
# Netlocs are UNC paths
if netloc:
... | [
"\n Convert a valid file url to a local filesystem path\n\n Follows logic taken from pip's equivalent function\n "
] |
Please provide a description of the function:def is_valid_url(url):
from .misc import to_text
if not url:
return url
pieces = urllib_parse.urlparse(to_text(url))
return all([pieces.scheme, pieces.netloc]) | [
"Checks if a given string is an url"
] |
Please provide a description of the function:def is_file_url(url):
from .misc import to_text
if not url:
return False
if not isinstance(url, six.string_types):
try:
url = getattr(url, "url")
except AttributeError:
raise ValueError("Cannot parse url from ... | [
"Returns true if the given url is a file url"
] |
Please provide a description of the function:def is_readonly_path(fn):
fn = fs_encode(fn)
if os.path.exists(fn):
file_stat = os.stat(fn).st_mode
return not bool(file_stat & stat.S_IWRITE) or not os.access(fn, os.W_OK)
return False | [
"Check if a provided path exists and is readonly.\n\n Permissions check is `bool(path.stat & stat.S_IREAD)` or `not os.access(path, os.W_OK)`\n "
] |
Please provide a description of the function:def mkdir_p(newdir, mode=0o777):
# http://code.activestate.com/recipes/82465-a-friendly-mkdir/
newdir = fs_encode(newdir)
if os.path.exists(newdir):
if not os.path.isdir(newdir):
raise OSError(
"a file with the same name ... | [
"Recursively creates the target directory and all of its parents if they do not\n already exist. Fails silently if they do.\n\n :param str newdir: The directory path to ensure\n :raises: OSError if a file is encountered along the way\n "
] |
Please provide a description of the function:def ensure_mkdir_p(mode=0o777):
def decorator(f):
@functools.wraps(f)
def decorated(*args, **kwargs):
path = f(*args, **kwargs)
mkdir_p(path, mode=mode)
return path
return decorated
return decorator | [
"Decorator to ensure `mkdir_p` is called to the function's return value.\n "
] |
Please provide a description of the function:def create_tracked_tempdir(*args, **kwargs):
tempdir = TemporaryDirectory(*args, **kwargs)
TRACKED_TEMPORARY_DIRECTORIES.append(tempdir)
atexit.register(tempdir.cleanup)
warnings.simplefilter("ignore", ResourceWarning)
return tempdir.name | [
"Create a tracked temporary directory.\n\n This uses `TemporaryDirectory`, but does not remove the directory when\n the return value goes out of scope, instead registers a handler to cleanup\n on program exit.\n\n The return value is the path to the created directory.\n "
] |
Please provide a description of the function:def set_write_bit(fn):
# type: (str) -> None
fn = fs_encode(fn)
if not os.path.exists(fn):
return
file_stat = os.stat(fn).st_mode
os.chmod(fn, file_stat | stat.S_IRWXU | stat.S_IRWXG | stat.S_IRWXO)
if not os.path.isdir(fn):
for ... | [
"\n Set read-write permissions for the current user on the target path. Fail silently\n if the path doesn't exist.\n\n :param str fn: The target filename or path\n :return: None\n "
] |
Please provide a description of the function:def rmtree(directory, ignore_errors=False, onerror=None):
# type: (str, bool, Optional[Callable]) -> None
directory = fs_encode(directory)
if onerror is None:
onerror = handle_remove_readonly
try:
shutil.rmtree(directory, ignore_errors=i... | [
"\n Stand-in for :func:`~shutil.rmtree` with additional error-handling.\n\n This version of `rmtree` handles read-only paths, especially in the case of index\n files written by certain source control systems.\n\n :param str directory: The target directory to remove\n :param bool ignore_errors: Whethe... |
Please provide a description of the function:def _wait_for_files(path):
timeout = 0.001
remaining = []
while timeout < 1.0:
remaining = []
if os.path.isdir(path):
L = os.listdir(path)
for target in L:
_remaining = _wait_for_files(target)
... | [
"\n Retry with backoff up to 1 second to delete files from a directory.\n\n :param str path: The path to crawl to delete files from\n :return: A list of remaining paths or None\n :rtype: Optional[List[str]]\n "
] |
Please provide a description of the function:def handle_remove_readonly(func, path, exc):
# Check for read-only attribute
from .compat import ResourceWarning, FileNotFoundError, PermissionError
PERM_ERRORS = (errno.EACCES, errno.EPERM, errno.ENOENT)
default_warning_message = "Unable to remove file... | [
"Error handler for shutil.rmtree.\n\n Windows source repo folders are read-only by default, so this error handler\n attempts to set them as writeable and then proceed with deletion.\n\n :param function func: The caller function\n :param str path: The target path for removal\n :param Exception exc: Th... |
Please provide a description of the function:def check_for_unc_path(path):
if (
os.name == "nt"
and len(path.drive) > 2
and not path.drive[0].isalpha()
and path.drive[1] != ":"
):
return True
else:
return False | [
" Checks to see if a pathlib `Path` object is a unc path or not"
] |
Please provide a description of the function:def get_converted_relative_path(path, relative_to=None):
from .misc import to_text, to_bytes # noqa
if not relative_to:
relative_to = os.getcwdu() if six.PY2 else os.getcwd()
if six.PY2:
path = to_bytes(path, encoding="utf-8")
else:
... | [
"Convert `path` to be relative.\n\n Given a vague relative path, return the path relative to the given\n location.\n\n :param str path: The location of a target path\n :param str relative_to: The starting path to build against, optional\n :returns: A relative posix-style path with a leading `./`\n\n ... |
Please provide a description of the function:def is_fp_closed(obj):
try:
# Check `isclosed()` first, in case Python3 doesn't set `closed`.
# GH Issue #928
return obj.isclosed()
except AttributeError:
pass
try:
# Check via the official file-like-object way.
... | [
"\n Checks whether a given file-like object is closed.\n\n :param obj:\n The file-like object to check.\n "
] |
Please provide a description of the function:def assert_header_parsing(headers):
# This will fail silently if we pass in the wrong kind of parameter.
# To make debugging easier add an explicit check.
if not isinstance(headers, httplib.HTTPMessage):
raise TypeError('expected httplib.Message, go... | [
"\n Asserts whether all headers have been successfully parsed.\n Extracts encountered errors from the result of parsing headers.\n\n Only works on Python 3.\n\n :param headers: Headers to verify.\n :type headers: `httplib.HTTPMessage`.\n\n :raises urllib3.exceptions.HeaderParsingError:\n If... |
Please provide a description of the function:def is_response_to_head(response):
# FIXME: Can we do this somehow without accessing private httplib _method?
method = response._method
if isinstance(method, int): # Platform-specific: Appengine
return method == 3
return method.upper() == 'HEAD' | [
"\n Checks whether the request of a response has been a HEAD-request.\n Handles the quirks of AppEngine.\n\n :param conn:\n :type conn: :class:`httplib.HTTPResponse`\n "
] |
Please provide a description of the function:def levenshtein_distance(self, a, b):
'''This calculates the Levenshtein distance between a and b.
'''
n, m = len(a), len(b)
if n > m:
a,b = b,a
n,m = m,n
current = range(n+1)
for i in range(1,m+1):
... | [] |
Please provide a description of the function:def try_read_prompt(self, timeout_multiplier):
'''This facilitates using communication timeouts to perform
synchronization as quickly as possible, while supporting high latency
connections with a tunable worst case performance. Fast connections
... | [] |
Please provide a description of the function:def sync_original_prompt (self, sync_multiplier=1.0):
'''This attempts to find the prompt. Basically, press enter and record
the response; press enter again and record the response; if the two
responses are similar then assume we are at the original p... | [] |
Please provide a description of the function:def login (self, server, username, password='', terminal_type='ansi',
original_prompt=r"[#$]", login_timeout=10, port=None,
auto_prompt_reset=True, ssh_key=None, quiet=True,
sync_multiplier=1, check_local_ip=True,
... | [] |
Please provide a description of the function:def logout (self):
'''Sends exit to the remote shell.
If there are stopped jobs then this automatically sends exit twice.
'''
self.sendline("exit")
index = self.expect([EOF, "(?i)there are stopped jobs"])
if index==1:
... | [] |
Please provide a description of the function:def prompt(self, timeout=-1):
'''Match the next shell prompt.
This is little more than a short-cut to the :meth:`~pexpect.spawn.expect`
method. Note that if you called :meth:`login` with
``auto_prompt_reset=False``, then before calling :meth:... | [] |
Please provide a description of the function:def set_unique_prompt(self):
'''This sets the remote prompt to something more unique than ``#`` or ``$``.
This makes it easier for the :meth:`prompt` method to match the shell prompt
unambiguously. This method is called automatically by the :meth:`log... | [] |
Please provide a description of the function:def user_agent():
data = {
"installer": {"name": "pip", "version": pipenv.patched.notpip.__version__},
"python": platform.python_version(),
"implementation": {
"name": platform.python_implementation(),
},
}
if dat... | [
"\n Return a string representing the user agent.\n "
] |
Please provide a description of the function:def url_to_path(url):
# type: (str) -> str
assert url.startswith('file:'), (
"You can only turn file: urls into filenames (not %r)" % url)
_, netloc, path, _, _ = urllib_parse.urlsplit(url)
# if we have a UNC path, prepend UNC share notation
... | [
"\n Convert a file: URL to a path.\n "
] |
Please provide a description of the function:def path_to_url(path):
# type: (Union[str, Text]) -> str
path = os.path.normpath(os.path.abspath(path))
url = urllib_parse.urljoin('file:', urllib_request.pathname2url(path))
return url | [
"\n Convert a path to a file: URL. The path will be made absolute and have\n quoted path parts.\n "
] |
Please provide a description of the function:def is_archive_file(name):
# type: (str) -> bool
ext = splitext(name)[1].lower()
if ext in ARCHIVE_EXTENSIONS:
return True
return False | [
"Return True if `name` is a considered as an archive file."
] |
Please provide a description of the function:def is_dir_url(link):
# type: (Link) -> bool
link_path = url_to_path(link.url_without_fragment)
return os.path.isdir(link_path) | [
"Return whether a file:// Link points to a directory.\n\n ``link`` must not have any other scheme but file://. Call is_file_url()\n first.\n\n "
] |
Please provide a description of the function:def unpack_file_url(
link, # type: Link
location, # type: str
download_dir=None, # type: Optional[str]
hashes=None # type: Optional[Hashes]
):
# type: (...) -> None
link_path = url_to_path(link.url_without_fragment)
# If it's a url to a ... | [
"Unpack link into location.\n\n If download_dir is provided and link points to a file, make a copy\n of the link file inside download_dir.\n "
] |
Please provide a description of the function:def _copy_dist_from_dir(link_path, location):
# Note: This is currently VERY SLOW if you have a lot of data in the
# directory, because it copies everything with `shutil.copytree`.
# What it should really do is build an sdist and install that.
# See htt... | [
"Copy distribution files in `link_path` to `location`.\n\n Invoked when user requests to install a local directory. E.g.:\n\n pip install .\n pip install ~/dev/git-repos/python-prompt-toolkit\n\n "
] |
Please provide a description of the function:def unpack_url(
link, # type: Optional[Link]
location, # type: Optional[str]
download_dir=None, # type: Optional[str]
only_download=False, # type: bool
session=None, # type: Optional[PipSession]
hashes=None, # type: Optional[Hashes]
progress... | [
"Unpack link.\n If link is a VCS link:\n if only_download, export into download_dir and ignore location\n else unpack into location\n for other types of link:\n - unpack into location\n - if download_dir, copy the file into download_dir\n - if only_download, mark... |
Please provide a description of the function:def _check_download_dir(link, download_dir, hashes):
# type: (Link, str, Hashes) -> Optional[str]
download_path = os.path.join(download_dir, link.filename)
if os.path.exists(download_path):
# If already downloaded, does its hash match?
logger... | [
" Check download_dir for previously downloaded file with correct hash\n If a correct file is found return its path else None\n "
] |
Please provide a description of the function:def _default_key_normalizer(key_class, request_context):
# Since we mutate the dictionary, make a copy first
context = request_context.copy()
context['scheme'] = context['scheme'].lower()
context['host'] = context['host'].lower()
# These are both di... | [
"\n Create a pool key out of a request context dictionary.\n\n According to RFC 3986, both the scheme and host are case-insensitive.\n Therefore, this function normalizes both before constructing the pool\n key for an HTTPS request. If you wish to change this behaviour, provide\n alternate callables ... |
Please provide a description of the function:def _new_pool(self, scheme, host, port, request_context=None):
pool_cls = self.pool_classes_by_scheme[scheme]
if request_context is None:
request_context = self.connection_pool_kw.copy()
# Although the context has everything nece... | [
"\n Create a new :class:`ConnectionPool` based on host, port, scheme, and\n any additional pool keyword arguments.\n\n If ``request_context`` is provided, it is provided as keyword arguments\n to the pool class used. This method is used to actually create the\n connection pools ha... |
Please provide a description of the function:def connection_from_host(self, host, port=None, scheme='http', pool_kwargs=None):
if not host:
raise LocationValueError("No host specified.")
request_context = self._merge_pool_kwargs(pool_kwargs)
request_context['scheme'] = sch... | [
"\n Get a :class:`ConnectionPool` based on the host, port, and scheme.\n\n If ``port`` isn't given, it will be derived from the ``scheme`` using\n ``urllib3.connectionpool.port_by_scheme``. If ``pool_kwargs`` is\n provided, it is merged with the instance's ``connection_pool_kw``\n ... |
Please provide a description of the function:def connection_from_context(self, request_context):
scheme = request_context['scheme'].lower()
pool_key_constructor = self.key_fn_by_scheme[scheme]
pool_key = pool_key_constructor(request_context)
return self.connection_from_pool_key... | [
"\n Get a :class:`ConnectionPool` based on the request context.\n\n ``request_context`` must at least contain the ``scheme`` key and its\n value must be a key in ``key_fn_by_scheme`` instance variable.\n "
] |
Please provide a description of the function:def connection_from_pool_key(self, pool_key, request_context=None):
with self.pools.lock:
# If the scheme, host, or port doesn't match existing open
# connections, open a new ConnectionPool.
pool = self.pools.get(pool_key)... | [
"\n Get a :class:`ConnectionPool` based on the provided pool key.\n\n ``pool_key`` should be a namedtuple that only contains immutable\n objects. At a minimum it must have the ``scheme``, ``host``, and\n ``port`` fields.\n "
] |
Please provide a description of the function:def connection_from_url(self, url, pool_kwargs=None):
u = parse_url(url)
return self.connection_from_host(u.host, port=u.port, scheme=u.scheme,
pool_kwargs=pool_kwargs) | [
"\n Similar to :func:`urllib3.connectionpool.connection_from_url`.\n\n If ``pool_kwargs`` is not provided and a new pool needs to be\n constructed, ``self.connection_pool_kw`` is used to initialize\n the :class:`urllib3.connectionpool.ConnectionPool`. If ``pool_kwargs``\n is provi... |
Please provide a description of the function:def _merge_pool_kwargs(self, override):
base_pool_kwargs = self.connection_pool_kw.copy()
if override:
for key, value in override.items():
if value is None:
try:
del base_pool_kw... | [
"\n Merge a dictionary of override values for self.connection_pool_kw.\n\n This does not modify self.connection_pool_kw and returns a new dict.\n Any keys in the override dictionary with a value of ``None`` are\n removed from the merged dictionary.\n "
] |
Please provide a description of the function:def urlopen(self, method, url, redirect=True, **kw):
u = parse_url(url)
conn = self.connection_from_host(u.host, port=u.port, scheme=u.scheme)
kw['assert_same_host'] = False
kw['redirect'] = False
if 'headers' not in kw:
... | [
"\n Same as :meth:`urllib3.connectionpool.HTTPConnectionPool.urlopen`\n with custom cross-host redirect logic and only sends the request-uri\n portion of the ``url``.\n\n The given ``url`` parameter must be absolute, such that an appropriate\n :class:`urllib3.connectionpool.Connec... |
Please provide a description of the function:def _set_proxy_headers(self, url, headers=None):
headers_ = {'Accept': '*/*'}
netloc = parse_url(url).netloc
if netloc:
headers_['Host'] = netloc
if headers:
headers_.update(headers)
return headers_ | [
"\n Sets headers needed by proxies: specifically, the Accept and Host\n headers. Only sets headers not provided by the user.\n "
] |
Please provide a description of the function:def urlopen(self, method, url, redirect=True, **kw):
"Same as HTTP(S)ConnectionPool.urlopen, ``url`` must be absolute."
u = parse_url(url)
if u.scheme == "http":
# For proxied HTTPS requests, httplib sets the necessary headers
... | [] |
Please provide a description of the function:def find_undeclared_variables(ast):
codegen = TrackingCodeGenerator(ast.environment)
codegen.visit(ast)
return codegen.undeclared_identifiers | [
"Returns a set of all variables in the AST that will be looked up from\n the context at runtime. Because at compile time it's not known which\n variables will be used depending on the path the execution takes at\n runtime, all variables are returned.\n\n >>> from jinja2 import Environment, meta\n >>... |
Please provide a description of the function:def find_referenced_templates(ast):
for node in ast.find_all((nodes.Extends, nodes.FromImport, nodes.Import,
nodes.Include)):
if not isinstance(node.template, nodes.Const):
# a tuple with some non consts in there
... | [
"Finds all the referenced templates from the AST. This will return an\n iterator over all the hardcoded template extensions, inclusions and\n imports. If dynamic inheritance or inclusion is used, `None` will be\n yielded.\n\n >>> from jinja2 import Environment, meta\n >>> env = Environment()\n >... |
Please provide a description of the function:def enter_frame(self, frame):
CodeGenerator.enter_frame(self, frame)
for _, (action, param) in iteritems(frame.symbols.loads):
if action == 'resolve':
self.undeclared_identifiers.add(param) | [
"Remember all undeclared identifiers."
] |
Please provide a description of the function:def parse_marker(marker_string):
def marker_var(remaining):
# either identifier, or literal string
m = IDENTIFIER.match(remaining)
if m:
result = m.groups()[0]
remaining = remaining[m.end():]
elif not remaining... | [
"\n Parse a marker string and return a dictionary containing a marker expression.\n\n The dictionary will contain keys \"op\", \"lhs\" and \"rhs\" for non-terminals in\n the expression grammar, or strings. A string contained in quotes is to be\n interpreted as a literal string, and a string not containe... |
Please provide a description of the function:def parse_requirement(req):
remaining = req.strip()
if not remaining or remaining.startswith('#'):
return None
m = IDENTIFIER.match(remaining)
if not m:
raise SyntaxError('name expected: %s' % remaining)
distname = m.groups()[0]
r... | [
"\n Parse a requirement passed in as a string. Return a Container\n whose attributes contain the various parts of the requirement.\n ",
"\n Return a list of operator, version tuples if any are\n specified, else None.\n "
] |
Please provide a description of the function:def convert_path(pathname):
if os.sep == '/':
return pathname
if not pathname:
return pathname
if pathname[0] == '/':
raise ValueError("path '%s' cannot be absolute" % pathname)
if pathname[-1] == '/':
raise ValueError("pa... | [
"Return 'pathname' as a name that will work on the native filesystem.\n\n The path is split on '/' and put back together again using the current\n directory separator. Needed because filenames in the setup script are\n always supplied in Unix style, and have to be converted to the local\n convention be... |
Please provide a description of the function:def get_cache_base(suffix=None):
if suffix is None:
suffix = '.distlib'
if os.name == 'nt' and 'LOCALAPPDATA' in os.environ:
result = os.path.expandvars('$localappdata')
else:
# Assume posix, or old Windows
result = os.path.ex... | [
"\n Return the default base location for distlib caches. If the directory does\n not exist, it is created. Use the suffix provided for the base directory,\n and default to '.distlib' if it isn't provided.\n\n On Windows, if LOCALAPPDATA is defined in the environment, then it is\n assumed to be a dire... |
Please provide a description of the function:def path_to_cache_dir(path):
d, p = os.path.splitdrive(os.path.abspath(path))
if d:
d = d.replace(':', '---')
p = p.replace(os.sep, '--')
return d + p + '.cache' | [
"\n Convert an absolute path to a directory name for use in a cache.\n\n The algorithm used is:\n\n #. On Windows, any ``':'`` in the drive is replaced with ``'---'``.\n #. Any occurrence of ``os.sep`` is replaced with ``'--'``.\n #. ``'.cache'`` is appended.\n "
] |
Please provide a description of the function:def split_filename(filename, project_name=None):
result = None
pyver = None
filename = unquote(filename).replace(' ', '-')
m = PYTHON_VERSION.search(filename)
if m:
pyver = m.group(1)
filename = filename[:m.start()]
if project_nam... | [
"\n Extract name, version, python version from a filename (no extension)\n\n Return name, version, pyver or None\n "
] |
Please provide a description of the function:def parse_name_and_version(p):
m = NAME_VERSION_RE.match(p)
if not m:
raise DistlibException('Ill-formed name/version string: \'%s\'' % p)
d = m.groupdict()
return d['name'].strip().lower(), d['ver'] | [
"\n A utility method used to get name and version from a string.\n\n From e.g. a Provides-Dist value.\n\n :param p: A value in a form 'foo (1.0)'\n :return: The name and version as a tuple.\n "
] |
Please provide a description of the function:def zip_dir(directory):
result = io.BytesIO()
dlen = len(directory)
with ZipFile(result, "w") as zf:
for root, dirs, files in os.walk(directory):
for name in files:
full = os.path.join(root, name)
rel = roo... | [
"zip a directory tree into a BytesIO object"
] |
Please provide a description of the function:def iglob(path_glob):
if _CHECK_RECURSIVE_GLOB.search(path_glob):
msg =
raise ValueError(msg % path_glob)
if _CHECK_MISMATCH_SET.search(path_glob):
msg =
raise ValueError(msg % path_glob)
return _iglob(path_glob) | [
"Extended globbing function that supports ** and {opt1,opt2,opt3}.",
"invalid glob %r: recursive glob \"**\" must be used alone",
"invalid glob %r: mismatching set marker '{' or '}'"
] |
Please provide a description of the function:def newer(self, source, target):
if not os.path.exists(source):
raise DistlibException("file '%r' does not exist" %
os.path.abspath(source))
if not os.path.exists(target):
return True
... | [
"Tell if the target is newer than the source.\n\n Returns true if 'source' exists and is more recently modified than\n 'target', or if 'source' exists and 'target' doesn't.\n\n Returns false if both exist and 'target' is the same age or younger\n than 'source'. Raise PackagingFileError i... |
Please provide a description of the function:def copy_file(self, infile, outfile, check=True):
self.ensure_dir(os.path.dirname(outfile))
logger.info('Copying %s to %s', infile, outfile)
if not self.dry_run:
msg = None
if check:
if os.path.islink(o... | [
"Copy a file respecting dry-run and force flags.\n "
] |
Please provide a description of the function:def commit(self):
assert self.record
result = self.files_written, self.dirs_created
self._init_record()
return result | [
"\n Commit recorded changes, turn off recording, return\n changes.\n "
] |
Please provide a description of the function:def clear(self):
not_removed = []
for fn in os.listdir(self.base):
fn = os.path.join(self.base, fn)
try:
if os.path.islink(fn) or os.path.isfile(fn):
os.remove(fn)
elif os.pa... | [
"\n Clear the cache.\n "
] |
Please provide a description of the function:def add(self, event, subscriber, append=True):
subs = self._subscribers
if event not in subs:
subs[event] = deque([subscriber])
else:
sq = subs[event]
if append:
sq.append(subscriber)
... | [
"\n Add a subscriber for an event.\n\n :param event: The name of an event.\n :param subscriber: The subscriber to be added (and called when the\n event is published).\n :param append: Whether to append or prepend the subscriber to an\n exis... |
Please provide a description of the function:def remove(self, event, subscriber):
subs = self._subscribers
if event not in subs:
raise ValueError('No subscribers: %r' % event)
subs[event].remove(subscriber) | [
"\n Remove a subscriber for an event.\n\n :param event: The name of an event.\n :param subscriber: The subscriber to be removed.\n "
] |
Please provide a description of the function:def publish(self, event, *args, **kwargs):
result = []
for subscriber in self.get_subscribers(event):
try:
value = subscriber(event, *args, **kwargs)
except Exception:
logger.exception('Exceptio... | [
"\n Publish a event and return a list of values returned by its\n subscribers.\n\n :param event: The event to publish.\n :param args: The positional arguments to pass to the event's\n subscribers.\n :param kwargs: The keyword arguments to pass to the event's\n ... |
Please provide a description of the function:def inc_convert(self, value):
if not os.path.isabs(value):
value = os.path.join(self.base, value)
with codecs.open(value, 'r', encoding='utf-8') as f:
result = json.load(f)
return result | [
"Default converter for the inc:// protocol."
] |
Please provide a description of the function:def reader(self, stream, context):
progress = self.progress
verbose = self.verbose
while True:
s = stream.readline()
if not s:
break
if progress is not None:
progress(s, cont... | [
"\n Read lines from a subprocess' output stream and either pass to a progress\n callable (if specified) or write progress information to sys.stderr.\n "
] |
Please provide a description of the function:def _get(pypi_server):
response = requests.get(pypi_server)
if response.status_code >= 300:
raise HTTPError(status_code=response.status_code,
reason=response.reason)
if hasattr(response.content, 'decode'):
tree = xml.e... | [
"\n Query the PyPI RSS feed and return a list\n of XML items.\n "
] |
Please provide a description of the function:def newest_packages(
pypi_server="https://pypi.python.org/pypi?%3Aaction=packages_rss"):
items = _get(pypi_server)
i = []
for item in items:
i_dict = {'name': item[0].text.split()[0],
'url': item[1].text,
'... | [
"\n Constructs a request to the PyPI server and returns a list of\n :class:`yarg.parse.Package`.\n\n :param pypi_server: (option) URL to the PyPI server.\n\n >>> import yarg\n >>> yarg.newest_packages()\n [<Package yarg>, <Package gray>, <Package ragy>]\n "
] |
Please provide a description of the function:def _get_requirements(model, section_name):
if not model:
return {}
return {identify_requirment(r): r for r in (
requirementslib.Requirement.from_pipfile(name, package._data)
for name, package in model.get(section_name, {}).items()
)} | [
"Produce a mapping of identifier: requirement from the section.\n "
] |
Please provide a description of the function:def _collect_derived_entries(state, traces, identifiers):
identifiers = set(identifiers)
if not identifiers:
return {}
entries = {}
extras = {}
for identifier, requirement in state.mapping.items():
routes = {trace[1] for trace in tra... | [
"Produce a mapping containing all candidates derived from `identifiers`.\n\n `identifiers` should provide a collection of requirement identifications\n from a section (i.e. `packages` or `dev-packages`). This function uses\n `trace` to filter out candidates in the state that are present because of\n an ... |
Please provide a description of the function:def lock(self):
provider = self.get_provider()
reporter = self.get_reporter()
resolver = resolvelib.Resolver(provider, reporter)
with vistir.cd(self.project.root):
state = resolver.resolve(self.requirements)
trac... | [
"Lock specified (abstract) requirements into (concrete) candidates.\n\n The locking procedure consists of four stages:\n\n * Resolve versions and dependency graph (powered by ResolveLib).\n * Walk the graph to determine \"why\" each candidate came to be, i.e.\n what top-level requireme... |
Please provide a description of the function:def setup_logging(verbosity, no_color, user_log_file):
# Determine the level to be logging at.
if verbosity >= 1:
level = "DEBUG"
elif verbosity == -1:
level = "WARNING"
elif verbosity == -2:
level = "ERROR"
elif verbosity <=... | [
"Configures and sets up all of the logging\n\n Returns the requested logging level, as its integer value.\n "
] |
Please provide a description of the function:def format(self, record):
formatted = super(IndentingFormatter, self).format(record)
prefix = ''
if self.add_timestamp:
prefix = self.formatTime(record, "%Y-%m-%dT%H:%M:%S ")
prefix += " " * get_indentation()
forma... | [
"\n Calls the standard formatter, but will indent all of the log messages\n by our current indentation level.\n "
] |
Please provide a description of the function:def _using_stdout(self):
if WINDOWS and colorama:
# Then self.stream is an AnsiToWin32 object.
return self.stream.wrapped is sys.stdout
return self.stream is sys.stdout | [
"\n Return whether the handler is using sys.stdout.\n "
] |
Please provide a description of the function:def _cast_boolean(value):
_BOOLEANS = {'1': True, 'yes': True, 'true': True, 'on': True,
'0': False, 'no': False, 'false': False, 'off': False, '': False}
value = str(value)
if value.lower() not in _BOOLEANS:
raise ValueError('Not a ... | [
"\n Helper to convert config values to boolean as ConfigParser do.\n "
] |
Please provide a description of the function:def getenv(option, default=undefined, cast=undefined):
# We can't avoid __contains__ because value may be empty.
if option in os.environ:
value = os.environ[option]
else:
if isinstance(default, Undefined):
raise UndefinedValueErr... | [
"\n Return the value for option or default if defined.\n "
] |
Please provide a description of the function:def join_options(options):
rv = []
any_prefix_is_slash = False
for opt in options:
prefix = split_opt(opt)[0]
if prefix == '/':
any_prefix_is_slash = True
rv.append((len(prefix), opt))
rv.sort(key=lambda x: x[0])
... | [
"Given a list of option strings this joins them in the most appropriate\n way and returns them in the form ``(formatted_string,\n any_prefix_is_slash)`` where the second item in the tuple is a flag that\n indicates if any of the option prefixes was a slash.\n "
] |
Please provide a description of the function:def write_usage(self, prog, args='', prefix='Usage: '):
usage_prefix = '%*s%s ' % (self.current_indent, prefix, prog)
text_width = self.width - self.current_indent
if text_width >= (term_len(usage_prefix) + 20):
# The arguments w... | [
"Writes a usage line into the buffer.\n\n :param prog: the program name.\n :param args: whitespace separated list of arguments.\n :param prefix: the prefix for the first line.\n "
] |
Please provide a description of the function:def write_text(self, text):
text_width = max(self.width - self.current_indent, 11)
indent = ' ' * self.current_indent
self.write(wrap_text(text, text_width,
initial_indent=indent,
subs... | [
"Writes re-indented text into the buffer. This rewraps and\n preserves paragraphs.\n "
] |
Please provide a description of the function:def write_dl(self, rows, col_max=30, col_spacing=2):
rows = list(rows)
widths = measure_table(rows)
if len(widths) != 2:
raise TypeError('Expected two columns for definition list')
first_col = min(widths[0], col_max) + co... | [
"Writes a definition list into the buffer. This is how options\n and commands are usually formatted.\n\n :param rows: a list of two item tuples for the terms and values.\n :param col_max: the maximum width of the first column.\n :param col_spacing: the number of spaces between the first... |
Please provide a description of the function:def section(self, name):
self.write_paragraph()
self.write_heading(name)
self.indent()
try:
yield
finally:
self.dedent() | [
"Helpful context manager that writes a paragraph, a heading,\n and the indents.\n\n :param name: the section name that is written as heading.\n "
] |
Please provide a description of the function:def invalid_config_error_message(action, key, val):
if action in ('store_true', 'store_false'):
return ("{0} is not a valid value for {1} option, "
"please specify a boolean value like yes/no, "
"true/false or 1/0 instead.").f... | [
"Returns a better error message when invalid configuration option\n is provided."
] |
Please provide a description of the function:def _format_option_strings(self, option, mvarfmt=' <%s>', optsep=', '):
opts = []
if option._short_opts:
opts.append(option._short_opts[0])
if option._long_opts:
opts.append(option._long_opts[0])
if len(opts) ... | [
"\n Return a comma-separated list of option strings and metavars.\n\n :param option: tuple of (short opt, long opt), e.g: ('-f', '--format')\n :param mvarfmt: metavar format string - evaluated as mvarfmt % metavar\n :param optsep: separator\n "
] |
Please provide a description of the function:def format_usage(self, usage):
msg = '\nUsage: %s\n' % self.indent_lines(textwrap.dedent(usage), " ")
return msg | [
"\n Ensure there is only one newline between usage and the first heading\n if there is no description.\n "
] |
Please provide a description of the function:def insert_option_group(self, idx, *args, **kwargs):
group = self.add_option_group(*args, **kwargs)
self.option_groups.pop()
self.option_groups.insert(idx, group)
return group | [
"Insert an OptionGroup at a given position."
] |
Please provide a description of the function:def option_list_all(self):
res = self.option_list[:]
for i in self.option_groups:
res.extend(i.option_list)
return res | [
"Get a list of all options, including those in option groups."
] |
Please provide a description of the function:def _update_defaults(self, defaults):
# Accumulate complex default state.
self.values = optparse.Values(self.defaults)
late_eval = set()
# Then set the options with those values
for key, val in self._get_ordered_configuration... | [
"Updates the given defaults with values from the config files and\n the environ. Does a little special handling for certain types of\n options (lists)."
] |
Please provide a description of the function:def get_default_values(self):
if not self.process_default_values:
# Old, pre-Optik 1.5 behaviour.
return optparse.Values(self.defaults)
# Load the configuration, or error out in case of an error
try:
self.... | [
"Overriding to make updating the defaults after instantiation of\n the option parser possible, _update_defaults() does the dirty work."
] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.