_id stringlengths 2 7 | title stringlengths 1 88 | partition stringclasses 3
values | text stringlengths 31 13.1k | language stringclasses 1
value | meta_information dict |
|---|---|---|---|---|---|
q262900 | BasePlugin.get_user | validation | def get_user(self, username):
"""
Utility function to query slack for a particular user
:param username: The username of the user to lookup
:return: SlackUser object or None
"""
if hasattr(self._bot, 'user_manager'):
user = self._bot.user_manager.get_by_username(username)
if user:
| python | {
"resource": ""
} |
q262901 | webhook | validation | def webhook(*args, **kwargs):
"""
Decorator to mark plugin functions as entry points for web calls
* route - web route to register, uses Flask syntax
* method - GET/POST, defaults to POST
"""
def wrapper(func):
func.is_webhook = True
func.route = | python | {
"resource": ""
} |
q262902 | freeze | validation | def freeze(value):
""" Cast value to its frozen counterpart. """
if isinstance(value, list): | python | {
"resource": ""
} |
q262903 | Core.help | validation | def help(self, msg, args):
"""Displays help for each command"""
output = []
if len(args) == 0:
commands = sorted(self._bot.dispatcher.commands.items(), key=itemgetter(0))
commands = filter(lambda x: x[1].is_subcmd is False, commands)
# Filter commands if auth is enabled, hide_admin_commands is enabled, and user is not admin
if self._should_filter_help_commands(msg.user):
| python | {
"resource": ""
} |
q262904 | Core.save | validation | def save(self, msg, args):
"""Causes the bot to write its current state to backend."""
| python | {
"resource": ""
} |
q262905 | Core.shutdown | validation | def shutdown(self, msg, args):
"""Causes the bot to gracefully shutdown."""
self.log.info("Received shutdown from %s", msg.user.username)
| python | {
"resource": ""
} |
q262906 | Core.whoami | validation | def whoami(self, msg, args):
"""Prints information about the user and bot version."""
output = ["Hello %s" % msg.user]
if hasattr(self._bot.dispatcher, 'auth_manager') and msg.user.is_admin is True:
output.append("You | python | {
"resource": ""
} |
q262907 | Core.sleep | validation | def sleep(self, channel):
"""Causes the bot to ignore all messages from the channel.
Usage:
!sleep [channel name] - ignore the specified channel (or current if none specified)
"""
| python | {
"resource": ""
} |
q262908 | Core.wake | validation | def wake(self, channel):
"""Causes the bot to resume operation in the channel.
Usage:
!wake [channel name] - unignore the specified channel (or | python | {
"resource": ""
} |
q262909 | _sort_by | validation | def _sort_by(key):
"""
High order function for sort methods.
"""
@staticmethod
def sort_by(p_list, reverse=False):
return sorted(
p_list,
| python | {
"resource": ""
} |
q262910 | PathFilters.select | validation | def select(self, filters=all_true, recursive=True):
"""Select path by criterion.
:param filters: a lambda function that take a `pathlib.Path` as input,
boolean as a output.
:param recursive: include files in subfolder or not. | python | {
"resource": ""
} |
q262911 | PathFilters.select_file | validation | def select_file(self, filters=all_true, recursive=True):
"""Select file path by criterion.
| python | {
"resource": ""
} |
q262912 | PathFilters.select_dir | validation | def select_dir(self, filters=all_true, recursive=True):
"""Select dir path by criterion.
| python | {
"resource": ""
} |
q262913 | PathFilters.n_file | validation | def n_file(self):
"""
Count how many files in this directory. Including file in sub folder.
"""
self.assert_is_dir_and_exists()
n = 0
| python | {
"resource": ""
} |
q262914 | PathFilters.n_dir | validation | def n_dir(self):
"""
Count how many folders in this directory. Including folder in sub folder.
"""
self.assert_is_dir_and_exists()
n = 0
| python | {
"resource": ""
} |
q262915 | PathFilters.select_by_ext | validation | def select_by_ext(self, ext, recursive=True):
"""
Select file path by extension.
:param ext:
**中文文档**
| python | {
"resource": ""
} |
q262916 | PathFilters.select_by_pattern_in_fname | validation | def select_by_pattern_in_fname(self,
pattern,
recursive=True,
case_sensitive=False):
"""
Select file path by text pattern in file name.
**中文文档**
选择文件名中包含指定子字符串的文件。
"""
if case_sensitive:
def filters(p):
return | python | {
"resource": ""
} |
q262917 | PathFilters.select_by_pattern_in_abspath | validation | def select_by_pattern_in_abspath(self,
pattern,
recursive=True,
case_sensitive=False):
"""
Select file path by text pattern in absolute path.
**中文文档**
选择绝对路径中包含指定子字符串的文件。
"""
if case_sensitive:
def filters(p):
return | python | {
"resource": ""
} |
q262918 | PathFilters.select_by_size | validation | def select_by_size(self, min_size=0, max_size=1 << 40, recursive=True):
"""
Select file path by size.
**中文文档**
选择所有文件大小在一定范围内的文件。
"""
| python | {
"resource": ""
} |
q262919 | PathFilters.select_by_mtime | validation | def select_by_mtime(self, min_time=0, max_time=ts_2100,
recursive=True):
"""
Select file path by modify time.
:param min_time: lower bound timestamp
| python | {
"resource": ""
} |
q262920 | PathFilters.select_by_atime | validation | def select_by_atime(self, min_time=0, max_time=ts_2100, recursive=True):
"""
Select file path by access time.
:param min_time: lower bound timestamp
| python | {
"resource": ""
} |
q262921 | PathFilters.select_by_ctime | validation | def select_by_ctime(self, min_time=0, max_time=ts_2100,
recursive=True):
"""
Select file path by create time.
:param min_time: lower bound timestamp
| python | {
"resource": ""
} |
q262922 | ToolBoxZip.make_zip_archive | validation | def make_zip_archive(self,
dst=None,
filters=all_true,
compress=True,
overwrite=False,
makedirs=False,
verbose=False): # pragma: no cover
"""
Make a zip archive.
:param dst: output file path. if not given, will be automatically assigned.
:param filters: custom path filter. By default it allows any file.
:param compress: compress or not.
:param overwrite: overwrite exists or not.
:param verbose: display log or not.
:return:
"""
self.assert_exists()
if dst is None:
dst = self._auto_zip_archive_dst()
else:
dst = self.change(new_abspath=dst)
if not dst.basename.lower().endswith(".zip"):
raise ValueError("zip archive name has to be endswith '.zip'!")
if dst.exists():
if not overwrite:
raise IOError("'%s' already exists!" % dst)
if compress:
compression = ZIP_DEFLATED
else:
compression = ZIP_STORED
if not dst.parent.exists():
if makedirs:
os.makedirs(dst.parent.abspath)
if verbose:
msg = "Making zip archive for '%s' ..." % self
print(msg)
current_dir = os.getcwd()
if self.is_dir():
total_size = 0
selected = list()
for p in self.glob("**/*"):
if filters(p):
selected.append(p)
| python | {
"resource": ""
} |
q262923 | ToolBoxZip.backup | validation | def backup(self,
dst=None,
ignore=None,
ignore_ext=None,
ignore_pattern=None,
ignore_size_smaller_than=None,
ignore_size_larger_than=None,
case_sensitive=False): # pragma: no cover
"""
Create a compressed zip archive backup for a directory.
:param dst: the output file path.
:param ignore: file or directory defined in this list will be ignored.
:param ignore_ext: file with extensions defined in this list will be ignored.
:param ignore_pattern: any file or directory that contains this pattern
will be ignored.
:param ignore_size_smaller_than: any file size smaller than this
will be ignored.
:param ignore_size_larger_than: any file size larger than this
will be ignored.
**中文文档**
为一个目录创建一个备份压缩包。可以通过过滤器选择你要备份的文件。
"""
def preprocess_arg(arg): # pragma: no cover
if arg is None:
return []
if isinstance(arg, (tuple, list)):
return list(arg)
else:
return [arg, ]
self.assert_is_dir_and_exists()
ignore = preprocess_arg(ignore)
for i in ignore:
if i.startswith("/") or i.startswith("\\"):
raise ValueError
ignore_ext = preprocess_arg(ignore_ext)
for ext in ignore_ext:
if not ext.startswith("."):
raise ValueError
ignore_pattern = preprocess_arg(ignore_pattern)
if case_sensitive:
pass
else:
ignore = [i.lower() for i in ignore]
ignore_ext = [i.lower() for i in ignore_ext]
ignore_pattern = [i.lower() for i in ignore_pattern]
def filters(p):
relpath = p.relative_to(self).abspath
if not case_sensitive:
relpath = relpath.lower() | python | {
"resource": ""
} |
q262924 | acquire_lock | validation | def acquire_lock(func):
"""Decorate methods when locking repository is required."""
@wraps(func)
def wrapper(self, *args, **kwargs):
with self.locker as r:
# get the result
acquired, code, _ = r
if acquired:
try:
r = func(self, *args, **kwargs)
except Exception as err:
e = str(err)
else:
| python | {
"resource": ""
} |
q262925 | sync_required | validation | def sync_required(func):
"""Decorate methods when synchronizing repository is required."""
@wraps(func)
def wrapper(self, *args, **kwargs):
if not self._keepSynchronized:
r = func(self, *args, **kwargs)
else:
state = self._load_state()
#print("-----------> ",state, self.state)
if state is None:
r = func(self, *args, **kwargs)
elif state == self.state:
| python | {
"resource": ""
} |
q262926 | get_pickling_errors | validation | def get_pickling_errors(obj, seen=None):
"""Investigate pickling errors."""
if seen == None:
seen = []
if hasattr(obj, "__getstate__"):
state = obj.__getstate__()
#elif hasattr(obj, "__dict__"):
# state = obj.__dict__
else:
return None
#try:
# state = obj.__getstate__()
#except AttributeError as e:
# #state = obj.__dict__
# return str(e)
if state == None:
return 'object state is None'
if isinstance(state,tuple):
if not isinstance(state[0], dict):
state=state[1]
| python | {
"resource": ""
} |
q262927 | Repository.walk_files_relative_path | validation | def walk_files_relative_path(self, relativePath=""):
"""
Walk the repository and yield all found files relative path joined with file name.
:parameters:
#. relativePath (str): The relative path from which start the walk.
"""
def walk_files(directory, relativePath):
directories = dict.__getitem__(directory, 'directories')
files = dict.__getitem__(directory, 'files')
for f in sorted(files):
yield os.path.join(relativePath, f)
for k in | python | {
"resource": ""
} |
q262928 | Repository.walk_directories_relative_path | validation | def walk_directories_relative_path(self, relativePath=""):
"""
Walk repository and yield all found directories relative path
:parameters:
#. relativePath (str): The relative path from which start the walk.
"""
def walk_directories(directory, relativePath):
directories = dict.__getitem__(directory, 'directories')
dirNames = dict.keys(directories)
for d in sorted(dirNames):
yield os.path.join(relativePath, d)
for k in sorted(dict.keys(directories)):
| python | {
"resource": ""
} |
q262929 | Repository.walk_directories_info | validation | def walk_directories_info(self, relativePath=""):
"""
Walk repository and yield all found directories relative path.
:parameters:
#. relativePath (str): The relative path from which start the walk.
"""
def walk_directories(directory, relativePath):
directories = dict.__getitem__(directory, 'directories')
for fname in sorted(directories):
info = dict.__getitem__(directories,fname)
yield os.path.join(relativePath, fname), info
for k in sorted(dict.keys(directories)):
| python | {
"resource": ""
} |
q262930 | Repository.walk_directory_directories_relative_path | validation | def walk_directory_directories_relative_path(self, relativePath=""):
"""
Walk a certain directory in repository and yield all found directories relative path.
:parameters:
#. relativePath (str): The relative path of the directory.
"""
# get directory info dict
errorMessage = ""
| python | {
"resource": ""
} |
q262931 | Repository.synchronize | validation | def synchronize(self, verbose=False):
"""
Synchronizes the Repository information with the directory.
All registered but missing files and directories in the directory,
will be automatically removed from the Repository.
:parameters:
#. verbose (boolean): Whether to be warn and inform about any abnormalities.
"""
if self.__path is None:
return
# walk directories
for dirPath in sorted(list(self.walk_directories_relative_path())):
realPath = os.path.join(self.__path, dirPath)
# if directory exist
if os.path.isdir(realPath):
continue
if verbose: warnings.warn("%s directory is missing"%realPath)
# loop to get dirInfoDict
keys = dirPath.split(os.sep)
dirInfoDict = self
for idx in range(len(keys)-1):
dirs = dict.get(dirInfoDict, 'directories', None)
| python | {
"resource": ""
} |
q262932 | Repository.load_repository | validation | def load_repository(self, path):
"""
Load repository from a directory path and update the current instance.
:Parameters:
#. path (string): The path of the directory from where to load the repository.
If '.' or an empty string is passed, the current working directory will be used.
:Returns:
#. repository (pyrep.Repository): returns self repository with loaded data.
"""
# try to open
if path.strip() in ('','.'):
path = os.getcwd()
repoPath = os.path.realpath( os.path.expanduser(path) )
if not self.is_repository(repoPath):
raise Exception("no repository found in '%s'"%str(repoPath))
# get pyrepinfo path
repoInfoPath = os.path.join(repoPath, ".pyrepinfo")
try:
fd = open(repoInfoPath, 'rb')
except Exception as e:
raise Exception("unable to open repository file(%s)"%e)
# before doing anything try to lock repository
# can't decorate with @acquire_lock because this will point to old repository
| python | {
"resource": ""
} |
q262933 | Repository.get_repository | validation | def get_repository(self, path, info=None, verbose=True):
"""
Create a repository at given real path or load any existing one.
This method insures the creation of the directory in the system if it is missing.\n
Unlike create_repository, this method doesn't erase any existing repository
in the path but loads it instead.
**N.B. On some systems and some paths, creating a directory may requires root permissions.**
:Parameters:
#. path (string): The real absolute path where to create the Repository.
| python | {
"resource": ""
} |
q262934 | Repository.remove_repository | validation | def remove_repository(self, path=None, relatedFiles=False, relatedFolders=False, verbose=True):
"""
Remove .pyrepinfo file from path if exists and related files and directories
when respective flags are set to True.
:Parameters:
#. path (None, string): The path of the directory where to remove an existing repository.
If None, current repository is removed if initialized.
#. relatedFiles (boolean): Whether to also remove all related files from system as well.
#. relatedFolders (boolean): Whether to also remove all related directories from system as well.
Directories will be removed only if they are left empty after removing the files.
#. verbose (boolean): Whether to be warn and informed about any abnormalities.
"""
if path is not None:
realPath = os.path.realpath( os.path.expanduser(path) )
else:
realPath = self.__path
if realPath is None:
if verbose: warnings.warn('path is None and current Repository is not initialized!')
return
if not self.is_repository(realPath):
if verbose: warnings.warn("No repository found in '%s'!"%realPath)
return
# check for security
if realPath == os.path.realpath('/..') :
if verbose: warnings.warn('You are about to wipe out your system !!! action aboarded')
return
# get repo
if path is not None:
repo = Repository()
repo.load_repository(realPath)
else:
repo = self
# delete files
if relatedFiles:
for relativePath in repo.walk_files_relative_path():
realPath = os.path.join(repo.path, relativePath)
if not os.path.isfile(realPath):
continue
if not os.path.exists(realPath):
| python | {
"resource": ""
} |
q262935 | Repository.save | validation | def save(self):
""" Save repository .pyrepinfo to disk. """
# open file
repoInfoPath = os.path.join(self.__path, ".pyrepinfo")
try:
fdinfo = open(repoInfoPath, 'wb')
except Exception as e:
raise Exception("unable to open repository info for saving (%s)"%e)
# save repository
try:
pickle.dump( self, fdinfo, protocol=2 )
except Exception as e:
fdinfo.flush()
os.fsync(fdinfo.fileno())
fdinfo.close()
raise Exception( "Unable to save repository info (%s)"%e )
finally:
fdinfo.flush()
| python | {
"resource": ""
} |
q262936 | Repository.create_package | validation | def create_package(self, path=None, name=None, mode=None):
"""
Create a tar file package of all the repository files and directories.
Only files and directories that are stored in the repository info
are stored in the package tar file.
**N.B. On some systems packaging requires root permissions.**
:Parameters:
#. path (None, string): The real absolute path where to create the package.
If None, it will be created in the same directory as the repository
If '.' or an empty string is passed, the current working directory will be used.
#. name (None, string): The name to give to the package file
If None, the package directory name will be used with the appropriate extension added.
#. mode (None, string): The writing mode of the tarfile.
If None, automatically the best compression mode will be chose.
Available modes are ('w', 'w:', 'w:gz', 'w:bz2')
"""
# check mode
assert mode in (None, 'w', 'w:', 'w:gz', 'w:bz2'), 'unkown archive mode %s'%str(mode)
if mode is None:
mode = 'w:bz2'
mode = 'w:'
# get root
if path is None:
root = os.path.split(self.__path)[0]
elif path.strip() in ('','.'):
root = os.getcwd()
else:
root = os.path.realpath( os.path.expanduser(path) )
assert os.path.isdir(root), 'absolute path %s is not a valid directory'%path
# get name
if name is None:
ext = mode.split(":")
if len(ext) == 2:
if len(ext[1]):
ext = "."+ext[1]
else:
ext = '.tar'
| python | {
"resource": ""
} |
q262937 | Repository.get_directory_info | validation | def get_directory_info(self, relativePath):
"""
get directory info from the Repository.
:Parameters:
#. relativePath (string): The relative to the repository path of the directory.
:Returns:
#. info (None, dictionary): The directory information dictionary.
If None, it means an error has occurred.
#. error (string): The error message if any error occurred.
"""
relativePath = os.path.normpath(relativePath)
| python | {
"resource": ""
} |
q262938 | Repository.get_parent_directory_info | validation | def get_parent_directory_info(self, relativePath):
"""
get parent directory info of a file or directory from the Repository.
:Parameters:
#. relativePath (string): The relative to the repository path of the file or directory of which the parent directory info is requested.
:Returns:
#. info (None, dictionary): The directory information dictionary.
If None, it means an error has occurred.
#. error (string): The error message if any error occurred.
"""
relativePath = os.path.normpath(relativePath)
| python | {
"resource": ""
} |
q262939 | Repository.get_file_info | validation | def get_file_info(self, relativePath, name=None):
"""
get file information dict from the repository given its relative path and name.
:Parameters:
#. relativePath (string): The relative to the repository path of the directory where the file is.
#. name (string): The file name.
If None is given, name will be split from relativePath.
:Returns:
#. info (None, dictionary): The file information dictionary.
If None, it means an error has occurred.
#. errorMessage (string): The error message if any error occurred.
"""
# normalize relative path and name
relativePath = os.path.normpath(relativePath)
if relativePath == '.':
relativePath = ''
assert name != '.pyrepinfo', "'.pyrepinfo' can't be a file name."
if name is None:
assert len(relativePath), "name must be given when relative path is given as empty string or as a simple dot '.'"
relativePath,name = os.path.split(relativePath)
| python | {
"resource": ""
} |
q262940 | Repository.get_file_relative_path_by_id | validation | def get_file_relative_path_by_id(self, id):
"""
Given an id, get the corresponding file info relative path joined with file name.
Parameters:
#. id (string): The file unique id string.
:Returns:
#. relativePath (string): The file relative path joined with file name.
| python | {
"resource": ""
} |
q262941 | Repository.get_file_relative_path_by_name | validation | def get_file_relative_path_by_name(self, name, skip=0):
"""
Get file relative path given the file name. If file name is redundant in different
directories in the repository, this method ensures to return all or some of the
files according to skip value.
Parameters:
#. name (string): The file name.
#. skip (None, integer): As file names can be identical, skip determines
the number of satisfying files name to skip before returning.\n
If None is given, a list of all files relative path will be returned.
:Returns:
#. relativePath (string, list): The file relative path.
If None, it means file was not found.\n
If skip is None a list of all found files relative paths will be returned.
"""
if skip is None:
paths | python | {
"resource": ""
} |
q262942 | Repository.add_directory | validation | def add_directory(self, relativePath, info=None):
"""
Adds a directory in the repository and creates its
attribute in the Repository with utc timestamp.
It insures adding all the missing directories in the path.
:Parameters:
#. relativePath (string): The relative to the repository path of the directory to add in the repository.
#. info (None, string, pickable object): Any random info about the folder.
:Returns:
#. info (dict): The directory info dict.
"""
path = os.path.normpath(relativePath)
# create directories
currentDir = self.path
currentDict = self
if path in ("","."):
return currentDict
save = False
for dir in path.split(os.sep):
dirPath = os.path.join(currentDir, dir)
# create directory
if not os.path.exists(dirPath):
os.mkdir(dirPath)
# create dictionary key
| python | {
"resource": ""
} |
q262943 | Repository.remove_directory | validation | def remove_directory(self, relativePath, removeFromSystem=False):
"""
Remove directory from repository.
:Parameters:
#. relativePath (string): The relative to the repository path of the directory to remove from the repository.
#. removeFromSystem (boolean): Whether to also remove directory and all files from the system.\n
Only files saved in the repository will be removed and empty left directories.
"""
# get parent directory info
relativePath = os.path.normpath(relativePath)
parentDirInfoDict, errorMessage = self.get_parent_directory_info(relativePath)
assert parentDirInfoDict is not None, errorMessage
# split path
path, name = os.path.split(relativePath)
if dict.__getitem__(parentDirInfoDict, 'directories').get(name, None) is None:
raise Exception("'%s' is not a registered directory in repository relative path '%s'"%(name, path))
# remove from system
if removeFromSystem:
# remove files
for rp in self.walk_files_relative_path(relativePath=relativePath):
ap = os.path.join(self.__path, relativePath, rp)
if not os.path.isfile(ap):
continue
| python | {
"resource": ""
} |
q262944 | Repository.move_directory | validation | def move_directory(self, relativePath, relativeDestination, replace=False, verbose=True):
"""
Move a directory in the repository from one place to another. It insures moving all the
files and subdirectories in the system.
:Parameters:
#. relativePath (string): The relative to the repository path of the directory to be moved.
#. relativeDestination (string): The new relative to the repository path of the directory.
#. replace (boolean): Whether to replace existing files with the same name in the new created directory.
#. verbose (boolean): Whether to be warn and informed about any abnormalities.
"""
# normalize path
relativePath = os.path.normpath(relativePath)
relativeDestination = os.path.normpath(relativeDestination)
# get files and directories
filesInfo = list( self.walk_files_info(relativePath=relativePath) )
dirsPath = list( self.walk_directories_relative_path(relativePath=relativePath) )
dirInfoDict, errorMessage = self.get_directory_info(relativePath)
assert dirInfoDict is not None, errorMessage
# remove directory info only
self.remove_directory(relativePath=relativePath, removeFromSystem=False)
# create new relative path
self.add_directory(relativeDestination)
# move files
for RP, info in filesInfo:
source = os.path.join(self.__path, relativePath, RP)
destination = os.path.join(self.__path, relativeDestination, RP)
| python | {
"resource": ""
} |
q262945 | Repository.rename_file | validation | def rename_file(self, relativePath, name, newName, replace=False, verbose=True):
"""
Rename a directory in the repository. It insures renaming the file in the system.
:Parameters:
#. relativePath (string): The relative to the repository path of the directory where the file is located.
#. name (string): The file name.
#. newName (string): The file new name.
#. replace (boolean): Whether to force renaming when new folder name exists in the system.
It fails when new folder name is registered in repository.
#. verbose (boolean): Whether to be warn and informed about any abnormalities.
"""
# normalize path
relativePath = os.path.normpath(relativePath)
if relativePath == '.':
relativePath = ''
dirInfoDict, errorMessage = self.get_directory_info(relativePath)
assert dirInfoDict is not None, errorMessage
# check directory in repository
assert name in dict.__getitem__(dirInfoDict, "files"), "file '%s' is not found in repository relative path '%s'"%(name, relativePath)
# get real path
realPath = os.path.join(self.__path, relativePath, name)
assert os.path.isfile(realPath), "file '%s' is not found in system"%realPath
# assert directory new name doesn't exist in repository
assert newName not in dict.__getitem__(dirInfoDict, "files"), "file '%s' already exists in repository relative path '%s'"%(newName, relativePath)
# check new directory in system
newRealPath = | python | {
"resource": ""
} |
q262946 | Repository.dump_copy | validation | def dump_copy(self, path, relativePath, name=None,
description=None,
replace=False, verbose=False):
"""
Copy an exisitng system file to the repository.
attribute in the Repository with utc timestamp.
:Parameters:
#. path (str): The full path of the file to copy into the repository.
#. relativePath (str): The relative to the repository path of the directory where the file should be dumped.
If relativePath does not exist, it will be created automatically.
#. name (string): The file name.
If None is given, name will be split from path.
#. description (None, string, pickable object): Any random description about the file.
#. replace (boolean): Whether to replace any existing file with the same name if existing.
#. verbose (boolean): Whether to be warn and informed about any abnormalities.
"""
relativePath = os.path.normpath(relativePath)
if relativePath == '.':
relativePath = ''
if name is None:
_,name = os.path.split(path)
# ensure directory added
self.add_directory(relativePath)
# ger real path
realPath = os.path.join(self.__path, relativePath)
# get directory info dict
dirInfoDict, errorMessage = self.get_directory_info(relativePath)
assert dirInfoDict is not None, errorMessage
if name in dict.__getitem__(dirInfoDict, "files"):
if not replace:
if verbose:
| python | {
"resource": ""
} |
q262947 | Repository.update_file | validation | def update_file(self, value, relativePath, name=None,
description=False, klass=False,
dump=False, pull=False,
ACID=None, verbose=False):
"""
Update the value and the utc timestamp of a file that is already in the Repository.\n
If file is not registered in repository, and error will be thrown.\n
If file is missing in the system, it will be regenerated as dump method is called.
:Parameters:
#. value (object): The value of the file to update. It is any python object or a file.
#. relativePath (str): The relative to the repository path of the directory where the file should be dumped.
#. name (None, string): The file name.
If None is given, name will be split from relativePath.
#. description (False, string, pickable object): Any random description about the file.
If False is given, the description info won't be updated,
otherwise it will be update to what description argument value is.
#. klass (False, class): The dumped object class. If False is given,
the class info won't be updated, otherwise it will be update to what klass argument value is.
#. dump (False, string): The new dump method. If False is given, the old one will be used.
#. pull (False, string): The new pull method. If False is given, the old one will be used.
#. ACID (boolean): Whether to ensure the ACID (Atomicity, Consistency, Isolation, Durability)
properties of the repository upon dumping a file. This is ensured by dumping the file in
a temporary path first and then moving it to the desired path.
If None is given, repository ACID property will be used.
#. verbose (boolean): Whether to be warn and informed about any abnormalities.
"""
# check ACID
if ACID is None:
ACID = self.__ACID
assert isinstance(ACID, bool), "ACID must be boolean"
# get relative path normalized
relativePath = os.path.normpath(relativePath)
if relativePath == '.':
relativePath = ''
assert name != '.pyrepinfo', "'.pyrepinfo' is not allowed as file name in main repository directory"
assert name != '.pyrepstate', "'.pyrepstate' is not allowed as file name in main repository directory"
assert name != '.pyreplock', "'.pyreplock' is not allowed as file name in main repository directory"
if name is None:
assert len(relativePath), "name must be given when relative path is given as empty string or as a simple dot '.'"
relativePath,name = os.path.split(relativePath)
# get file info dict
fileInfoDict, errorMessage = self.get_file_info(relativePath, name)
| python | {
"resource": ""
} |
q262948 | ensure_str | validation | def ensure_str(value):
"""
Ensure value is string.
"""
if isinstance(value, six.string_types):
| python | {
"resource": ""
} |
q262949 | TraceCollector.stats | validation | def stats(cls, traces):
"""Build per minute stats for each key"""
data = {}
stats = {}
# Group traces by key and minute
for trace in traces:
key = trace['key']
if key not in data:
data[key] = []
stats[key] = {}
data[key].append(trace['total_time'])
cls._traces.pop(trace['id'])
for key in data:
| python | {
"resource": ""
} |
q262950 | SynchronisedFilesDataSource.start | validation | def start(self):
"""
Monitors data kept in files in the predefined directory in a new thread.
Note: Due to the underlying library, it may take a few milliseconds after this method is started for changes to
start to being noticed.
"""
with self._status_lock:
if self._running:
| python | {
"resource": ""
} |
q262951 | SynchronisedFilesDataSource.stop | validation | def stop(self):
"""
Stops monitoring the predefined directory.
"""
with self._status_lock:
if self._running:
assert self._observer is not None
| python | {
"resource": ""
} |
q262952 | SynchronisedFilesDataSource._on_file_moved | validation | def _on_file_moved(self, event: FileSystemMovedEvent):
"""
Called when a file in the monitored directory has been moved.
Breaks move down into a delete and a create (which it is sometimes detected as!).
:param event: the file system event
"""
if not event.is_directory and self.is_data_file(event.src_path):
delete_event = FileSystemEvent(event.src_path)
| python | {
"resource": ""
} |
q262953 | TempManager.tear_down | validation | def tear_down(self):
"""
Tears down all temp files and directories.
"""
while len(self._temp_directories) > 0:
directory = self._temp_directories.pop()
shutil.rmtree(directory, ignore_errors=True)
while len(self._temp_files) > 0:
| python | {
"resource": ""
} |
q262954 | MutateMethods.is_not_exist_or_allow_overwrite | validation | def is_not_exist_or_allow_overwrite(self, overwrite=False):
"""
Test whether a file target is not exists or it exists | python | {
"resource": ""
} |
q262955 | MutateMethods.copyto | validation | def copyto(self,
new_abspath=None,
new_dirpath=None,
new_dirname=None,
new_basename=None,
new_fname=None,
new_ext=None,
overwrite=False,
makedirs=False):
"""
Copy this file to other place.
"""
self.assert_exists()
p = self.change(
new_abspath=new_abspath,
new_dirpath=new_dirpath,
new_dirname=new_dirname,
new_basename=new_basename,
new_fname=new_fname,
new_ext=new_ext,
)
| python | {
"resource": ""
} |
q262956 | create_client | validation | def create_client() -> APIClient:
"""
Clients a Docker client.
Will raise a `ConnectionError` if the Docker daemon is not accessible.
:return: the Docker client
"""
global _client
client = _client()
if client is None:
# First try looking at the environment variables for specification of the daemon's location
docker_environment = kwargs_from_env(assert_hostname=False)
if "base_url" in docker_environment:
client = _create_client(docker_environment.get("base_url"), docker_environment.get("tls"))
if client is None:
raise ConnectionError(
"Could not connect to the Docker daemon specified by the `DOCKER_X` environment variables: %s"
% docker_environment)
else:
logging.info("Connected to Docker daemon specified by the environment variables")
else:
# Let's see if the Docker daemon is accessible via the UNIX socket
client = _create_client("unix://var/run/docker.sock")
| python | {
"resource": ""
} |
q262957 | path_required | validation | def path_required(func):
"""Decorate methods when repository path is required."""
@wraps(func)
def wrapper(self, *args, **kwargs):
if self.path is None:
warnings.warn('Must load (Repository.load_repository) or | python | {
"resource": ""
} |
q262958 | Repository.__clean_before_after | validation | def __clean_before_after(self, stateBefore, stateAfter, keepNoneEmptyDirectory=True):
"""clean repository given before and after states"""
# prepare after for faster search
errors = []
afterDict = {}
[afterDict.setdefault(list(aitem)[0],[]).append(aitem) for aitem in stateAfter]
# loop before
for bitem in reversed(stateBefore):
relaPath = list(bitem)[0]
basename = os.path.basename(relaPath)
btype = bitem[relaPath]['type']
alist = afterDict.get(relaPath, [])
aitem = [a for a in alist if a[relaPath]['type']==btype]
if len(aitem)>1:
errors.append("Multiple '%s' of type '%s' where found in '%s', this should never had happened. Please report issue"%(basename,btype,relaPath))
continue
if not len(aitem):
removeDirs = []
removeFiles = []
if btype == 'dir':
if not len(relaPath):
errors.append("Removing main repository directory is not allowed")
continue
removeDirs.append(os.path.join(self.__path,relaPath))
removeFiles.append(os.path.join(self.__path,relaPath,self.__dirInfo))
removeFiles.append(os.path.join(self.__path,relaPath,self.__dirLock))
elif btype == 'file':
removeFiles.append(os.path.join(self.__path,relaPath))
removeFiles.append(os.path.join(self.__path,relaPath,self.__fileInfo%basename))
| python | {
"resource": ""
} |
q262959 | Repository.get_stats | validation | def get_stats(self):
"""
Get repository descriptive stats
:Returns:
#. numberOfDirectories (integer): Number of diretories in repository
#. numberOfFiles (integer): Number of files in repository
"""
if self.__path is None:
return 0,0
nfiles = 0
ndirs = 0
for fdict in self.get_repository_state():
fdname = list(fdict)[0]
if fdname == '':
| python | {
"resource": ""
} |
q262960 | Repository.reset | validation | def reset(self):
"""Reset repository instance.
"""
self.__path = None
self.__repo = {'repository_unique_name': str(uuid.uuid1()),
| python | {
"resource": ""
} |
q262961 | Repository.load_repository | validation | def load_repository(self, path, verbose=True, ntrials=3):
"""
Load repository from a directory path and update the current instance.
First, new repository still will be loaded. If failed, then old
style repository load will be tried.
:Parameters:
#. path (string): The path of the directory from where to load
the repository from. If '.' or an empty string is passed,
the current working directory will be used.
#. verbose (boolean): Whether to be verbose about abnormalities
#. ntrials (int): After aquiring all locks, ntrials is the maximum
number of trials allowed before failing.
In rare cases, when multiple processes
are accessing the same repository components, different processes
can alter repository components between successive lock releases
of some other process. Bigger number of trials lowers the
| python | {
"resource": ""
} |
q262962 | Repository.remove_repository | validation | def remove_repository(self, path=None, removeEmptyDirs=True):
"""
Remove all repository from path along with all repository tracked files.
:Parameters:
#. path (None, string): The path the repository to remove.
#. removeEmptyDirs (boolean): Whether to remove remaining empty
directories.
"""
assert isinstance(removeEmptyDirs, bool), "removeEmptyDirs must be boolean"
if path is not None:
if path != self.__path:
repo = Repository()
repo.load_repository(path)
else:
repo = self
else:
repo = self
assert repo.path is not None, "path is not given and repository is not initialized"
# remove repo files and directories
for fdict in reversed(repo.get_repository_state()):
relaPath = list(fdict)[0]
realPath = os.path.join(repo.path, relaPath)
path, name = os.path.split(realPath)
if fdict[relaPath]['type'] == 'file':
if os.path.isfile(realPath):
os.remove(realPath)
if os.path.isfile(os.path.join(repo.path,path,self.__fileInfo%name)):
os.remove(os.path.join(repo.path,path,self.__fileInfo%name))
if os.path.isfile(os.path.join(repo.path,path,self.__fileLock%name)):
| python | {
"resource": ""
} |
q262963 | Repository.is_name_allowed | validation | def is_name_allowed(self, path):
"""
Get whether creating a file or a directory from the basenane of the given
path is allowed
:Parameters:
#. path (str): The absolute or relative path or simply the file
or directory name.
:Returns:
#. allowed (bool): Whether name is allowed.
#. message (None, str): Reason for the name to be forbidden.
"""
assert isinstance(path, basestring), "given path must be a string"
name = os.path.basename(path)
if not len(name):
return False, "empty name is not allowed"
# exact match
for em in [self.__repoLock,self.__repoFile,self.__dirInfo,self.__dirLock]:
| python | {
"resource": ""
} |
q262964 | Repository.to_repo_relative_path | validation | def to_repo_relative_path(self, path, split=False):
"""
Given a path, return relative path to diretory
:Parameters:
#. path (str): Path as a string
#. split (boolean): Whether to split path to its components
:Returns:
#. relativePath (str, list): Relative path as a string or as a list
of components if split is True
"""
path = os.path.normpath(path) | python | {
"resource": ""
} |
q262965 | Repository.get_repository_state | validation | def get_repository_state(self, relaPath=None):
"""
Get a list representation of repository state along with useful
information. List state is ordered relativeley to directories level
:Parameters:
#. relaPath (None, str): relative directory path from where to
start. If None all repository representation is returned.
:Returns:
#. state (list): List representation of the repository.
List items are all dictionaries. Every dictionary has a single
key which is the file or the directory name and the value is a
dictionary of information including:
* 'type': the type of the tracked whether it's file, dir, or objectdir
* 'exists': whether file or directory actually exists on disk
* 'pyrepfileinfo': In case of a file or an objectdir whether .%s_pyrepfileinfo exists
* 'pyrepdirinfo': In case of a directory whether .pyrepdirinfo exists
"""
state = []
def _walk_dir(relaPath, dirList):
dirDict = {'type':'dir',
'exists':os.path.isdir(os.path.join(self.__path,relaPath)),
'pyrepdirinfo':os.path.isfile(os.path.join(self.__path,relaPath,self.__dirInfo)),
}
state.append({relaPath:dirDict})
# loop files and dirobjects
for fname in sorted([f for f in dirList if isinstance(f, basestring)]):
relaFilePath = os.path.join(relaPath,fname)
realFilePath = os.path.join(self.__path,relaFilePath)
#if os.path.isdir(realFilePath) and df.startswith('.') and df.endswith(self.__objectDir[3:]):
# fileDict = {'type':'objectdir',
# 'exists':True,
# 'pyrepfileinfo':os.path.isfile(os.path.join(self.__path,relaPath,self.__fileInfo%fname)),
# }
#else:
# fileDict = {'type':'file',
# 'exists':os.path.isfile(realFilePath),
# 'pyrepfileinfo':os.path.isfile(os.path.join(self.__path,relaPath,self.__fileInfo%fname)),
# }
| python | {
"resource": ""
} |
q262966 | Repository.get_file_info | validation | def get_file_info(self, relativePath):
"""
Get file information dict from the repository given its relative path.
:Parameters:
#. relativePath (string): The relative to the repository path of
the file.
:Returns:
#. info (None, dictionary): The file information dictionary.
If None, it means an error has occurred.
#. errorMessage (string): The error message if any error occurred.
"""
relativePath = self.to_repo_relative_path(path=relativePath, split=False)
fileName = os.path.basename(relativePath)
isRepoFile,fileOnDisk, infoOnDisk, classOnDisk = self.is_repository_file(relativePath)
if not isRepoFile:
return None, "file is not a registered repository file."
if not | python | {
"resource": ""
} |
q262967 | Repository.is_repository_file | validation | def is_repository_file(self, relativePath):
"""
Check whether a given relative path is a repository file path
:Parameters:
#. relativePath (string): File relative path
:Returns:
#. isRepoFile (boolean): Whether file is a repository file.
#. isFileOnDisk (boolean): Whether file is found on disk.
#. isFileInfoOnDisk (boolean): Whether file info is found on disk.
#. isFileClassOnDisk (boolean): Whether file class is found on disk.
"""
relativePath = self.to_repo_relative_path(path=relativePath, split=False)
if relativePath == '':
return False, False, False, False
relaDir, name = os.path.split(relativePath)
fileOnDisk = os.path.isfile(os.path.join(self.__path, relativePath))
infoOnDisk = os.path.isfile(os.path.join(self.__path,os.path.dirname(relativePath),self.__fileInfo%name))
classOnDisk = os.path.isfile(os.path.join(self.__path,os.path.dirname(relativePath),self.__fileClass%name))
cDir = self.__repo['walk_repo']
if len(relaDir):
for dirname in relaDir.split(os.sep):
dList = [d for d in cDir if isinstance(d, dict)]
if not len(dList):
cDir = | python | {
"resource": ""
} |
q262968 | Repository.create_package | validation | def create_package(self, path=None, name=None, mode=None):
"""
Create a tar file package of all the repository files and directories.
Only files and directories that are tracked in the repository
are stored in the package tar file.
**N.B. On some systems packaging requires root permissions.**
:Parameters:
#. path (None, string): The real absolute path where to create the
package. If None, it will be created in the same directory as
the repository. If '.' or an empty string is passed, the current
working directory will be used.
#. name (None, string): The name to give to the package file
If None, the package directory name will be used with the
appropriate extension added.
#. mode (None, string): The writing mode of the tarfile.
If None, automatically the best compression mode will be chose.
Available modes are ('w', 'w:', 'w:gz', 'w:bz2')
"""
# check mode
assert mode in (None, 'w', 'w:', 'w:gz', 'w:bz2'), 'unkown archive mode %s'%str(mode)
if mode is None:
#mode = 'w:bz2'
mode = 'w:'
# get root
if path is None:
root = os.path.split(self.__path)[0]
elif path.strip() in ('','.'):
root = os.getcwd()
else:
root = os.path.realpath( os.path.expanduser(path) )
assert os.path.isdir(root), 'absolute path %s is not a valid directory'%path
# get name
if name is None:
ext = mode.split(":")
if len(ext) == 2:
if len(ext[1]):
ext = "."+ext[1]
else:
ext = '.tar'
else:
ext = '.tar'
name = os.path.split(self.__path)[1]+ext
| python | {
"resource": ""
} |
q262969 | Metadata.rename | validation | def rename(self, key: Any, new_key: Any):
"""
Renames an item in this collection as a transaction.
Will override if new key name already exists.
:param key: the current name of the item
:param new_key: the new name that the item should have
"""
if new_key == key:
return
required_locks = [self._key_locks[key], self._key_locks[new_key]]
ordered_required_locks = sorted(required_locks, key=lambda x: id(x))
for lock in ordered_required_locks:
lock.acquire()
try:
if key not in | python | {
"resource": ""
} |
q262970 | get_text_fingerprint | validation | def get_text_fingerprint(text, hash_meth, encoding="utf-8"): # pragma: no cover
"""
Use default hash method to return hash value of a piece of string
default setting use 'utf-8' encoding. | python | {
"resource": ""
} |
q262971 | md5file | validation | def md5file(abspath, nbytes=0, chunk_size=DEFAULT_CHUNK_SIZE):
"""
Return md5 hash value of a piece of a file
Estimate processing time on:
:param abspath: the absolute path to the file
:param nbytes: only has first N bytes of the file. if 0 or None,
hash all file
CPU = i7-4600U 2.10GHz - 2.70GHz, RAM = 8.00 GB
| python | {
"resource": ""
} |
q262972 | sha256file | validation | def sha256file(abspath, nbytes=0, chunk_size=DEFAULT_CHUNK_SIZE):
"""
Return sha256 hash value of a piece of a file
Estimate processing time on:
| python | {
"resource": ""
} |
q262973 | sha512file | validation | def sha512file(abspath, nbytes=0, chunk_size=DEFAULT_CHUNK_SIZE):
"""
Return sha512 hash value of a piece of a file
Estimate processing time on:
| python | {
"resource": ""
} |
q262974 | ToolBox.auto_complete_choices | validation | def auto_complete_choices(self, case_sensitive=False):
"""
A command line auto complete similar behavior. Find all item with same
prefix of this one.
:param case_sensitive: toggle if it is case sensitive.
:return: list of :class:`pathlib_mate.pathlib2.Path`.
"""
self_basename = self.basename
self_basename_lower = self.basename.lower()
if case_sensitive: # pragma: no cover
def match(basename):
return basename.startswith(self_basename)
else:
def match(basename):
return basename.lower().startswith(self_basename_lower)
choices = list()
if self.is_dir():
| python | {
"resource": ""
} |
q262975 | ToolBox.print_big_dir | validation | def print_big_dir(self, top_n=5):
"""
Print ``top_n`` big dir in this dir.
"""
self.assert_is_dir_and_exists()
size_table = sorted(
[(p, p.dirsize) for p in self.select_dir(recursive=False)],
key=lambda x: x[1],
| python | {
"resource": ""
} |
q262976 | ToolBox.print_big_file | validation | def print_big_file(self, top_n=5):
"""
Print ``top_n`` big file in this dir.
"""
self.assert_is_dir_and_exists()
size_table = sorted(
[(p, p.size) for p in self.select_file(recursive=True)],
key=lambda x: x[1],
| python | {
"resource": ""
} |
q262977 | ToolBox.print_big_dir_and_big_file | validation | def print_big_dir_and_big_file(self, top_n=5):
"""Print ``top_n`` big dir and ``top_n`` big file in each dir.
"""
self.assert_is_dir_and_exists()
size_table1 = sorted(
[(p, p.dirsize) for p in self.select_dir(recursive=False)],
key=lambda x: x[1],
reverse=True,
)
for p1, size1 in size_table1[:top_n]:
print("{:<9} {:<9}".format(repr_data_size(size1), p1.abspath))
size_table2 = sorted(
[(p, p.size) | python | {
"resource": ""
} |
q262978 | ToolBox.mirror_to | validation | def mirror_to(self, dst): # pragma: no cover
"""
Create a new folder having exactly same structure with this directory.
However, all files are just empty file with same file name.
:param dst: destination directory. The directory can't exists before
you execute this.
**中文文档**
创建一个目录的镜像拷贝, 与拷贝操作不同的是, 文件的副本只是在文件名上
与原件一致, 但是是空文件, 完全没有内容, 文件大小为0。
"""
self.assert_is_dir_and_exists()
src = self.abspath
dst = os.path.abspath(dst)
if os.path.exists(dst): # pragma: no cover
raise Exception("distination already exist!")
folder_to_create = list()
| python | {
"resource": ""
} |
q262979 | ToolBox.execute_pyfile | validation | def execute_pyfile(self, py_exe=None): # pragma: no cover
"""
Execute every ``.py`` file as main script.
:param py_exe: str, python command or python executable path.
**中文文档**
将目录下的所有Python文件作为主脚本用当前解释器运行。
"""
import subprocess
self.assert_is_dir_and_exists()
if py_exe is None:
if six.PY2:
py_exe | python | {
"resource": ""
} |
q262980 | ToolBox.trail_space | validation | def trail_space(self, filters=lambda p: p.ext == ".py"): # pragma: no cover
"""
Trail white space at end of each line for every ``.py`` file.
**中文文档**
将目录下的所有被选择的文件中行末的空格删除。
"""
self.assert_is_dir_and_exists()
for p in self.select_file(filters):
try:
with open(p.abspath, "rb") as f:
lines = list()
| python | {
"resource": ""
} |
q262981 | ToolBox.autopep8 | validation | def autopep8(self, **kwargs): # pragma: no cover
"""
Auto convert your python code in a directory to pep8 styled code.
:param kwargs: arguments for ``autopep8.fix_code`` method.
**中文文档**
将目录下的所有Python文件用pep8风格格式化。增加其可读性和规范性。
| python | {
"resource": ""
} |
q262982 | AttrAccessor.size | validation | def size(self):
"""
File size in bytes.
"""
try:
return self._stat.st_size
except: # pragma: | python | {
"resource": ""
} |
q262983 | AttrAccessor.mtime | validation | def mtime(self):
"""
Get most recent modify time in timestamp.
"""
try:
return self._stat.st_mtime
| python | {
"resource": ""
} |
q262984 | AttrAccessor.atime | validation | def atime(self):
"""
Get most recent access time in timestamp.
"""
try:
return self._stat.st_atime
| python | {
"resource": ""
} |
q262985 | AttrAccessor.ctime | validation | def ctime(self):
"""
Get most recent create time in timestamp.
"""
try:
return self._stat.st_ctime
| python | {
"resource": ""
} |
q262986 | StrictConfigParser.unusedoptions | validation | def unusedoptions(self, sections):
"""Lists options that have not been used to format other values in
their sections.
Good for finding out if the user has misspelled any of the options.
"""
unused = set([])
for section in _list(sections):
if not self.has_section(section):
continue
options = self.options(section)
raw_values = [self.get(section, option, raw=True) for option in options]
for option in options:
| python | {
"resource": ""
} |
q262987 | tui.keys | validation | def keys(self):
"""List names of options and positional arguments."""
| python | {
"resource": ""
} |
q262988 | tui._add_option | validation | def _add_option(self, option):
"""Add an Option object to the user interface."""
if option.name in self.options:
raise ValueError('name already in use')
if option.abbreviation in self.abbreviations:
raise ValueError('abbreviation already in use')
if option.name in [arg.name for arg in self.positional_args]:
raise ValueError('name already in | python | {
"resource": ""
} |
q262989 | tui._add_positional_argument | validation | def _add_positional_argument(self, posarg):
"""Append a positional argument to the user interface.
Optional positional arguments must be added after the required ones.
The user interface can have at most one recurring positional argument,
and if present, that argument must be the last one.
"""
if self.positional_args:
| python | {
"resource": ""
} |
q262990 | tui.read_docs | validation | def read_docs(self, docsfiles):
"""Read program documentation from a DocParser compatible file.
docsfiles is a list of paths to potential docsfiles: parse if present.
A string is taken as a list of one item.
"""
updates = DocParser()
for docsfile in _list(docsfiles):
if os.path.isfile(docsfile):
updates.parse(docsfile)
| python | {
"resource": ""
} |
q262991 | tui.optionhelp | validation | def optionhelp(self, indent=0, maxindent=25, width=79):
"""Return user friendly help on program options."""
def makelabels(option):
labels = '%*s--%s' % (indent, ' ', option.name)
if option.abbreviation:
labels += ', -' + option.abbreviation
return labels + ': '
| python | {
"resource": ""
} |
q262992 | tui.posarghelp | validation | def posarghelp(self, indent=0, maxindent=25, width=79):
"""Return user friendly help on positional arguments in the program."""
docs = []
makelabel = lambda posarg: ' ' * indent + posarg.displayname + ': '
helpindent = _autoindent([makelabel(p) for p in self.positional_args], indent, maxindent)
for posarg in self.positional_args:
label = makelabel(posarg)
| python | {
"resource": ""
} |
q262993 | tui.strsettings | validation | def strsettings(self, indent=0, maxindent=25, width=0):
"""Return user friendly help on positional arguments.
indent is the number of spaces preceeding the text on each line.
The indent of the documentation is dependent on the length of the
longest label that is shorter than maxindent. A label longer than
maxindent will be printed on its own line.
width is maximum allowed page width, use self.width if 0.
"""
out = []
makelabel = lambda name: ' ' * indent + name + ': '
| python | {
"resource": ""
} |
q262994 | tui.settingshelp | validation | def settingshelp(self, width=0):
"""Return a summary of program options, their values and origins.
width is maximum allowed page width, use self.width if 0.
"""
out = []
out.append(self._wrap(self.docs['title'], width=width))
if self.docs['description']:
| python | {
"resource": ""
} |
q262995 | TextBlockParser.parse | validation | def parse(self, file):
"""Parse text blocks from a file."""
if isinstance(file, basestring):
file = open(file)
line_number = 0
label = None
block = self.untagged
for line in file:
line_number += 1
line = line.rstrip('\n')
if self.tabsize > 0:
line = line.replace('\t', ' ' * self.tabsize)
if self.decommenter:
line = self.decommenter.decomment(line)
if line is None:
continue
tag = line.split(':', 1)[0].strip()
# Still in the same block?
if tag not in self.names:
if block is None:
if line and not line.isspace():
raise ParseError(file.name, line, "garbage before first block: %r" % line)
continue
block.addline(line)
| python | {
"resource": ""
} |
q262996 | Format.parse | validation | def parse(self, argv):
"""Pop, parse and return the first self.nargs items from args.
if self.nargs > 1 a list of parsed values will be returned.
Raise BadNumberOfArguments or BadArgument on errors.
NOTE: argv may be modified in place by this method.
| python | {
"resource": ""
} |
q262997 | Flag.parsestr | validation | def parsestr(self, argstr):
"""Parse arguments found in settings files.
Use the values in self.true for True in settings files, or those in
self.false for False, case insensitive.
"""
argv = shlex.split(argstr, comments=True)
if len(argv) != 1:
raise BadNumberOfArguments(1, len(argv))
| python | {
"resource": ""
} |
q262998 | Tuple.get_separator | validation | def get_separator(self, i):
"""Return the separator that preceding format i, or '' for i == 0."""
return i | python | {
"resource": ""
} |
q262999 | MixcloudOauth.authorize_url | validation | def authorize_url(self):
"""
Return a URL to redirect the user to for OAuth authentication.
"""
auth_url = OAUTH_ROOT + '/authorize'
params = {
'client_id': self.client_id,
| python | {
"resource": ""
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.