repository_name
stringlengths
7
55
func_path_in_repository
stringlengths
4
223
func_name
stringlengths
1
134
whole_func_string
stringlengths
75
104k
language
stringclasses
1 value
func_code_string
stringlengths
75
104k
func_code_tokens
listlengths
19
28.4k
func_documentation_string
stringlengths
1
46.9k
func_documentation_tokens
listlengths
1
1.97k
split_name
stringclasses
1 value
func_code_url
stringlengths
87
315
elektito/finglish
finglish/f2p.py
variations
def variations(word): """Create variations of the word based on letter combinations like oo, sh, etc.""" if len(word) == 1: return [[word[0]]] elif word == 'aa': return [['A']] elif word == 'ee': return [['i']] elif word == 'ei': return [['ei']] elif word in ['oo...
python
def variations(word): """Create variations of the word based on letter combinations like oo, sh, etc.""" if len(word) == 1: return [[word[0]]] elif word == 'aa': return [['A']] elif word == 'ee': return [['i']] elif word == 'ei': return [['ei']] elif word in ['oo...
[ "def", "variations", "(", "word", ")", ":", "if", "len", "(", "word", ")", "==", "1", ":", "return", "[", "[", "word", "[", "0", "]", "]", "]", "elif", "word", "==", "'aa'", ":", "return", "[", "[", "'A'", "]", "]", "elif", "word", "==", "'ee...
Create variations of the word based on letter combinations like oo, sh, etc.
[ "Create", "variations", "of", "the", "word", "based", "on", "letter", "combinations", "like", "oo", "sh", "etc", "." ]
train
https://github.com/elektito/finglish/blob/3d6953d7ad385f860fac4b9110da4205326e4de5/finglish/f2p.py#L74-L129
elektito/finglish
finglish/f2p.py
f2p_word
def f2p_word(word, max_word_size=15, cutoff=3): """Convert a single word from Finglish to Persian. max_word_size: Maximum size of the words to consider. Words larger than this will be kept unchanged. cutoff: The cut-off point. For each word, there could be many possibilities. By default 3 of these...
python
def f2p_word(word, max_word_size=15, cutoff=3): """Convert a single word from Finglish to Persian. max_word_size: Maximum size of the words to consider. Words larger than this will be kept unchanged. cutoff: The cut-off point. For each word, there could be many possibilities. By default 3 of these...
[ "def", "f2p_word", "(", "word", ",", "max_word_size", "=", "15", ",", "cutoff", "=", "3", ")", ":", "original_word", "=", "word", "word", "=", "word", ".", "lower", "(", ")", "c", "=", "dictionary", ".", "get", "(", "word", ")", "if", "c", ":", "...
Convert a single word from Finglish to Persian. max_word_size: Maximum size of the words to consider. Words larger than this will be kept unchanged. cutoff: The cut-off point. For each word, there could be many possibilities. By default 3 of these possibilities are considered for each word. This n...
[ "Convert", "a", "single", "word", "from", "Finglish", "to", "Persian", "." ]
train
https://github.com/elektito/finglish/blob/3d6953d7ad385f860fac4b9110da4205326e4de5/finglish/f2p.py#L131-L164
elektito/finglish
finglish/f2p.py
f2p_list
def f2p_list(phrase, max_word_size=15, cutoff=3): """Convert a phrase from Finglish to Persian. phrase: The phrase to convert. max_word_size: Maximum size of the words to consider. Words larger than this will be kept unchanged. cutoff: The cut-off point. For each word, there could be many pos...
python
def f2p_list(phrase, max_word_size=15, cutoff=3): """Convert a phrase from Finglish to Persian. phrase: The phrase to convert. max_word_size: Maximum size of the words to consider. Words larger than this will be kept unchanged. cutoff: The cut-off point. For each word, there could be many pos...
[ "def", "f2p_list", "(", "phrase", ",", "max_word_size", "=", "15", ",", "cutoff", "=", "3", ")", ":", "# split the phrase into words", "results", "=", "[", "w", "for", "w", "in", "sep_regex", ".", "split", "(", "phrase", ")", "if", "w", "]", "# return an...
Convert a phrase from Finglish to Persian. phrase: The phrase to convert. max_word_size: Maximum size of the words to consider. Words larger than this will be kept unchanged. cutoff: The cut-off point. For each word, there could be many possibilities. By default 3 of these possibilities are consi...
[ "Convert", "a", "phrase", "from", "Finglish", "to", "Persian", "." ]
train
https://github.com/elektito/finglish/blob/3d6953d7ad385f860fac4b9110da4205326e4de5/finglish/f2p.py#L166-L194
elektito/finglish
finglish/f2p.py
f2p
def f2p(phrase, max_word_size=15, cutoff=3): """Convert a Finglish phrase to the most probable Persian phrase. """ results = f2p_list(phrase, max_word_size, cutoff) return ' '.join(i[0][0] for i in results)
python
def f2p(phrase, max_word_size=15, cutoff=3): """Convert a Finglish phrase to the most probable Persian phrase. """ results = f2p_list(phrase, max_word_size, cutoff) return ' '.join(i[0][0] for i in results)
[ "def", "f2p", "(", "phrase", ",", "max_word_size", "=", "15", ",", "cutoff", "=", "3", ")", ":", "results", "=", "f2p_list", "(", "phrase", ",", "max_word_size", ",", "cutoff", ")", "return", "' '", ".", "join", "(", "i", "[", "0", "]", "[", "0", ...
Convert a Finglish phrase to the most probable Persian phrase.
[ "Convert", "a", "Finglish", "phrase", "to", "the", "most", "probable", "Persian", "phrase", "." ]
train
https://github.com/elektito/finglish/blob/3d6953d7ad385f860fac4b9110da4205326e4de5/finglish/f2p.py#L196-L202
pytest-dev/apipkg
src/apipkg/__init__.py
distribution_version
def distribution_version(name): """try to get the version of the named distribution, returs None on failure""" from pkg_resources import get_distribution, DistributionNotFound try: dist = get_distribution(name) except DistributionNotFound: pass else: return dist.version
python
def distribution_version(name): """try to get the version of the named distribution, returs None on failure""" from pkg_resources import get_distribution, DistributionNotFound try: dist = get_distribution(name) except DistributionNotFound: pass else: return dist.version
[ "def", "distribution_version", "(", "name", ")", ":", "from", "pkg_resources", "import", "get_distribution", ",", "DistributionNotFound", "try", ":", "dist", "=", "get_distribution", "(", "name", ")", "except", "DistributionNotFound", ":", "pass", "else", ":", "re...
try to get the version of the named distribution, returs None on failure
[ "try", "to", "get", "the", "version", "of", "the", "named", "distribution", "returs", "None", "on", "failure" ]
train
https://github.com/pytest-dev/apipkg/blob/e409195c52bab50e14745d0adf824b2a0390a50f/src/apipkg/__init__.py#L27-L36
pytest-dev/apipkg
src/apipkg/__init__.py
initpkg
def initpkg(pkgname, exportdefs, attr=None, eager=False): """ initialize given package from the export definitions. """ attr = attr or {} oldmod = sys.modules.get(pkgname) d = {} f = getattr(oldmod, '__file__', None) if f: f = _py_abspath(f) d['__file__'] = f if hasattr(oldmod, '...
python
def initpkg(pkgname, exportdefs, attr=None, eager=False): """ initialize given package from the export definitions. """ attr = attr or {} oldmod = sys.modules.get(pkgname) d = {} f = getattr(oldmod, '__file__', None) if f: f = _py_abspath(f) d['__file__'] = f if hasattr(oldmod, '...
[ "def", "initpkg", "(", "pkgname", ",", "exportdefs", ",", "attr", "=", "None", ",", "eager", "=", "False", ")", ":", "attr", "=", "attr", "or", "{", "}", "oldmod", "=", "sys", ".", "modules", ".", "get", "(", "pkgname", ")", "d", "=", "{", "}", ...
initialize given package from the export definitions.
[ "initialize", "given", "package", "from", "the", "export", "definitions", "." ]
train
https://github.com/pytest-dev/apipkg/blob/e409195c52bab50e14745d0adf824b2a0390a50f/src/apipkg/__init__.py#L39-L67
pytest-dev/apipkg
src/apipkg/__init__.py
importobj
def importobj(modpath, attrname): """imports a module, then resolves the attrname on it""" module = __import__(modpath, None, None, ['__doc__']) if not attrname: return module retval = module names = attrname.split(".") for x in names: retval = getattr(retval, x) return retv...
python
def importobj(modpath, attrname): """imports a module, then resolves the attrname on it""" module = __import__(modpath, None, None, ['__doc__']) if not attrname: return module retval = module names = attrname.split(".") for x in names: retval = getattr(retval, x) return retv...
[ "def", "importobj", "(", "modpath", ",", "attrname", ")", ":", "module", "=", "__import__", "(", "modpath", ",", "None", ",", "None", ",", "[", "'__doc__'", "]", ")", "if", "not", "attrname", ":", "return", "module", "retval", "=", "module", "names", "...
imports a module, then resolves the attrname on it
[ "imports", "a", "module", "then", "resolves", "the", "attrname", "on", "it" ]
train
https://github.com/pytest-dev/apipkg/blob/e409195c52bab50e14745d0adf824b2a0390a50f/src/apipkg/__init__.py#L70-L80
pytest-dev/apipkg
src/apipkg/__init__.py
ApiModule.__makeattr
def __makeattr(self, name): """lazily compute value for name or raise AttributeError if unknown.""" # print "makeattr", self.__name__, name target = None if '__onfirstaccess__' in self.__map__: target = self.__map__.pop('__onfirstaccess__') importobj(*target)() ...
python
def __makeattr(self, name): """lazily compute value for name or raise AttributeError if unknown.""" # print "makeattr", self.__name__, name target = None if '__onfirstaccess__' in self.__map__: target = self.__map__.pop('__onfirstaccess__') importobj(*target)() ...
[ "def", "__makeattr", "(", "self", ",", "name", ")", ":", "# print \"makeattr\", self.__name__, name", "target", "=", "None", "if", "'__onfirstaccess__'", "in", "self", ".", "__map__", ":", "target", "=", "self", ".", "__map__", ".", "pop", "(", "'__onfirstaccess...
lazily compute value for name or raise AttributeError if unknown.
[ "lazily", "compute", "value", "for", "name", "or", "raise", "AttributeError", "if", "unknown", "." ]
train
https://github.com/pytest-dev/apipkg/blob/e409195c52bab50e14745d0adf824b2a0390a50f/src/apipkg/__init__.py#L137-L158
kimmobrunfeldt/nap
nap/url.py
Url._request
def _request(self, http_method, relative_url='', **kwargs): """Does actual HTTP request using requests library.""" # It could be possible to call api.resource.get('/index') # but it would be non-intuitive that the path would resolve # to root of domain relative_url = self._remove...
python
def _request(self, http_method, relative_url='', **kwargs): """Does actual HTTP request using requests library.""" # It could be possible to call api.resource.get('/index') # but it would be non-intuitive that the path would resolve # to root of domain relative_url = self._remove...
[ "def", "_request", "(", "self", ",", "http_method", ",", "relative_url", "=", "''", ",", "*", "*", "kwargs", ")", ":", "# It could be possible to call api.resource.get('/index')", "# but it would be non-intuitive that the path would resolve", "# to root of domain", "relative_ur...
Does actual HTTP request using requests library.
[ "Does", "actual", "HTTP", "request", "using", "requests", "library", "." ]
train
https://github.com/kimmobrunfeldt/nap/blob/3ea7b41ef6b24b7e127bc87bb010d8a8bb18a4bd/nap/url.py#L109-L132
kimmobrunfeldt/nap
nap/url.py
Url._new_url
def _new_url(self, relative_url): """Create new Url which points to new url.""" return Url( urljoin(self._base_url, relative_url), **self._default_kwargs )
python
def _new_url(self, relative_url): """Create new Url which points to new url.""" return Url( urljoin(self._base_url, relative_url), **self._default_kwargs )
[ "def", "_new_url", "(", "self", ",", "relative_url", ")", ":", "return", "Url", "(", "urljoin", "(", "self", ".", "_base_url", ",", "relative_url", ")", ",", "*", "*", "self", ".", "_default_kwargs", ")" ]
Create new Url which points to new url.
[ "Create", "new", "Url", "which", "points", "to", "new", "url", "." ]
train
https://github.com/kimmobrunfeldt/nap/blob/3ea7b41ef6b24b7e127bc87bb010d8a8bb18a4bd/nap/url.py#L142-L148
ourway/auth
auth/CAS/authorization.py
Authorization.roles
def roles(self): """gets user groups""" result = AuthGroup.objects(creator=self.client).only('role') return json.loads(result.to_json())
python
def roles(self): """gets user groups""" result = AuthGroup.objects(creator=self.client).only('role') return json.loads(result.to_json())
[ "def", "roles", "(", "self", ")", ":", "result", "=", "AuthGroup", ".", "objects", "(", "creator", "=", "self", ".", "client", ")", ".", "only", "(", "'role'", ")", "return", "json", ".", "loads", "(", "result", ".", "to_json", "(", ")", ")" ]
gets user groups
[ "gets", "user", "groups" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L25-L28
ourway/auth
auth/CAS/authorization.py
Authorization.get_permissions
def get_permissions(self, role): """gets permissions of role""" target_role = AuthGroup.objects(role=role, creator=self.client).first() if not target_role: return '[]' targets = AuthPermission.objects(groups=target_role, creator=self.client).only('name') return json.l...
python
def get_permissions(self, role): """gets permissions of role""" target_role = AuthGroup.objects(role=role, creator=self.client).first() if not target_role: return '[]' targets = AuthPermission.objects(groups=target_role, creator=self.client).only('name') return json.l...
[ "def", "get_permissions", "(", "self", ",", "role", ")", ":", "target_role", "=", "AuthGroup", ".", "objects", "(", "role", "=", "role", ",", "creator", "=", "self", ".", "client", ")", ".", "first", "(", ")", "if", "not", "target_role", ":", "return",...
gets permissions of role
[ "gets", "permissions", "of", "role" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L30-L36
ourway/auth
auth/CAS/authorization.py
Authorization.get_user_permissions
def get_user_permissions(self, user): """get permissions of a user""" memberShipRecords = AuthMembership.objects(creator=self.client, user=user).only('groups') results = [] for each in memberShipRecords: for group in each.groups: targetPermissionRecords = Auth...
python
def get_user_permissions(self, user): """get permissions of a user""" memberShipRecords = AuthMembership.objects(creator=self.client, user=user).only('groups') results = [] for each in memberShipRecords: for group in each.groups: targetPermissionRecords = Auth...
[ "def", "get_user_permissions", "(", "self", ",", "user", ")", ":", "memberShipRecords", "=", "AuthMembership", ".", "objects", "(", "creator", "=", "self", ".", "client", ",", "user", "=", "user", ")", ".", "only", "(", "'groups'", ")", "results", "=", "...
get permissions of a user
[ "get", "permissions", "of", "a", "user" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L39-L50
ourway/auth
auth/CAS/authorization.py
Authorization.get_user_roles
def get_user_roles(self, user): """get permissions of a user""" memberShipRecords = AuthMembership.objects(creator=self.client, user=user).only('groups') results = [] for each in memberShipRecords: for group in each.groups: results.append({'role':group.role}) ...
python
def get_user_roles(self, user): """get permissions of a user""" memberShipRecords = AuthMembership.objects(creator=self.client, user=user).only('groups') results = [] for each in memberShipRecords: for group in each.groups: results.append({'role':group.role}) ...
[ "def", "get_user_roles", "(", "self", ",", "user", ")", ":", "memberShipRecords", "=", "AuthMembership", ".", "objects", "(", "creator", "=", "self", ".", "client", ",", "user", "=", "user", ")", ".", "only", "(", "'groups'", ")", "results", "=", "[", ...
get permissions of a user
[ "get", "permissions", "of", "a", "user" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L52-L59
ourway/auth
auth/CAS/authorization.py
Authorization.get_role_members
def get_role_members(self, role): """get permissions of a user""" targetRoleDb = AuthGroup.objects(creator=self.client, role=role) members = AuthMembership.objects(groups__in=targetRoleDb).only('user') return json.loads(members.to_json())
python
def get_role_members(self, role): """get permissions of a user""" targetRoleDb = AuthGroup.objects(creator=self.client, role=role) members = AuthMembership.objects(groups__in=targetRoleDb).only('user') return json.loads(members.to_json())
[ "def", "get_role_members", "(", "self", ",", "role", ")", ":", "targetRoleDb", "=", "AuthGroup", ".", "objects", "(", "creator", "=", "self", ".", "client", ",", "role", "=", "role", ")", "members", "=", "AuthMembership", ".", "objects", "(", "groups__in",...
get permissions of a user
[ "get", "permissions", "of", "a", "user" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L62-L66
ourway/auth
auth/CAS/authorization.py
Authorization.which_roles_can
def which_roles_can(self, name): """Which role can SendMail? """ targetPermissionRecords = AuthPermission.objects(creator=self.client, name=name).first() return [{'role': group.role} for group in targetPermissionRecords.groups]
python
def which_roles_can(self, name): """Which role can SendMail? """ targetPermissionRecords = AuthPermission.objects(creator=self.client, name=name).first() return [{'role': group.role} for group in targetPermissionRecords.groups]
[ "def", "which_roles_can", "(", "self", ",", "name", ")", ":", "targetPermissionRecords", "=", "AuthPermission", ".", "objects", "(", "creator", "=", "self", ".", "client", ",", "name", "=", "name", ")", ".", "first", "(", ")", "return", "[", "{", "'role'...
Which role can SendMail?
[ "Which", "role", "can", "SendMail?" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L68-L71
ourway/auth
auth/CAS/authorization.py
Authorization.which_users_can
def which_users_can(self, name): """Which role can SendMail? """ _roles = self.which_roles_can(name) result = [self.get_role_members(i.get('role')) for i in _roles] return result
python
def which_users_can(self, name): """Which role can SendMail? """ _roles = self.which_roles_can(name) result = [self.get_role_members(i.get('role')) for i in _roles] return result
[ "def", "which_users_can", "(", "self", ",", "name", ")", ":", "_roles", "=", "self", ".", "which_roles_can", "(", "name", ")", "result", "=", "[", "self", ".", "get_role_members", "(", "i", ".", "get", "(", "'role'", ")", ")", "for", "i", "in", "_rol...
Which role can SendMail?
[ "Which", "role", "can", "SendMail?" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L73-L77
ourway/auth
auth/CAS/authorization.py
Authorization.get_role
def get_role(self, role): """Returns a role object """ role = AuthGroup.objects(role=role, creator=self.client).first() return role
python
def get_role(self, role): """Returns a role object """ role = AuthGroup.objects(role=role, creator=self.client).first() return role
[ "def", "get_role", "(", "self", ",", "role", ")", ":", "role", "=", "AuthGroup", ".", "objects", "(", "role", "=", "role", ",", "creator", "=", "self", ".", "client", ")", ".", "first", "(", ")", "return", "role" ]
Returns a role object
[ "Returns", "a", "role", "object" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L79-L83
ourway/auth
auth/CAS/authorization.py
Authorization.add_role
def add_role(self, role, description=None): """ Creates a new group """ new_group = AuthGroup(role=role, creator=self.client) try: new_group.save() return True except NotUniqueError: return False
python
def add_role(self, role, description=None): """ Creates a new group """ new_group = AuthGroup(role=role, creator=self.client) try: new_group.save() return True except NotUniqueError: return False
[ "def", "add_role", "(", "self", ",", "role", ",", "description", "=", "None", ")", ":", "new_group", "=", "AuthGroup", "(", "role", "=", "role", ",", "creator", "=", "self", ".", "client", ")", "try", ":", "new_group", ".", "save", "(", ")", "return"...
Creates a new group
[ "Creates", "a", "new", "group" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L85-L92
ourway/auth
auth/CAS/authorization.py
Authorization.del_role
def del_role(self, role): """ deletes a group """ target = AuthGroup.objects(role=role, creator=self.client).first() if target: target.delete() return True else: return False
python
def del_role(self, role): """ deletes a group """ target = AuthGroup.objects(role=role, creator=self.client).first() if target: target.delete() return True else: return False
[ "def", "del_role", "(", "self", ",", "role", ")", ":", "target", "=", "AuthGroup", ".", "objects", "(", "role", "=", "role", ",", "creator", "=", "self", ".", "client", ")", ".", "first", "(", ")", "if", "target", ":", "target", ".", "delete", "(",...
deletes a group
[ "deletes", "a", "group" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L94-L101
ourway/auth
auth/CAS/authorization.py
Authorization.add_membership
def add_membership(self, user, role): """ make user a member of a group """ targetGroup = AuthGroup.objects(role=role, creator=self.client).first() if not targetGroup: return False target = AuthMembership.objects(user=user, creator=self.client).first() if not target:...
python
def add_membership(self, user, role): """ make user a member of a group """ targetGroup = AuthGroup.objects(role=role, creator=self.client).first() if not targetGroup: return False target = AuthMembership.objects(user=user, creator=self.client).first() if not target:...
[ "def", "add_membership", "(", "self", ",", "user", ",", "role", ")", ":", "targetGroup", "=", "AuthGroup", ".", "objects", "(", "role", "=", "role", ",", "creator", "=", "self", ".", "client", ")", ".", "first", "(", ")", "if", "not", "targetGroup", ...
make user a member of a group
[ "make", "user", "a", "member", "of", "a", "group" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L103-L116
ourway/auth
auth/CAS/authorization.py
Authorization.del_membership
def del_membership(self, user, role): """ dismember user from a group """ if not self.has_membership(user, role): return True targetRecord = AuthMembership.objects(creator=self.client, user=user).first() if not targetRecord: return True for group in targe...
python
def del_membership(self, user, role): """ dismember user from a group """ if not self.has_membership(user, role): return True targetRecord = AuthMembership.objects(creator=self.client, user=user).first() if not targetRecord: return True for group in targe...
[ "def", "del_membership", "(", "self", ",", "user", ",", "role", ")", ":", "if", "not", "self", ".", "has_membership", "(", "user", ",", "role", ")", ":", "return", "True", "targetRecord", "=", "AuthMembership", ".", "objects", "(", "creator", "=", "self"...
dismember user from a group
[ "dismember", "user", "from", "a", "group" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L119-L130
ourway/auth
auth/CAS/authorization.py
Authorization.has_membership
def has_membership(self, user, role): """ checks if user is member of a group""" targetRecord = AuthMembership.objects(creator=self.client, user=user).first() if targetRecord: return role in [i.role for i in targetRecord.groups] return False
python
def has_membership(self, user, role): """ checks if user is member of a group""" targetRecord = AuthMembership.objects(creator=self.client, user=user).first() if targetRecord: return role in [i.role for i in targetRecord.groups] return False
[ "def", "has_membership", "(", "self", ",", "user", ",", "role", ")", ":", "targetRecord", "=", "AuthMembership", ".", "objects", "(", "creator", "=", "self", ".", "client", ",", "user", "=", "user", ")", ".", "first", "(", ")", "if", "targetRecord", ":...
checks if user is member of a group
[ "checks", "if", "user", "is", "member", "of", "a", "group" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L132-L137
ourway/auth
auth/CAS/authorization.py
Authorization.add_permission
def add_permission(self, role, name): """ authorize a group for something """ if self.has_permission(role, name): return True targetGroup = AuthGroup.objects(role=role, creator=self.client).first() if not targetGroup: return False # Create or update ...
python
def add_permission(self, role, name): """ authorize a group for something """ if self.has_permission(role, name): return True targetGroup = AuthGroup.objects(role=role, creator=self.client).first() if not targetGroup: return False # Create or update ...
[ "def", "add_permission", "(", "self", ",", "role", ",", "name", ")", ":", "if", "self", ".", "has_permission", "(", "role", ",", "name", ")", ":", "return", "True", "targetGroup", "=", "AuthGroup", ".", "objects", "(", "role", "=", "role", ",", "creato...
authorize a group for something
[ "authorize", "a", "group", "for", "something" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L140-L151
ourway/auth
auth/CAS/authorization.py
Authorization.del_permission
def del_permission(self, role, name): """ revoke authorization of a group """ if not self.has_permission(role, name): return True targetGroup = AuthGroup.objects(role=role, creator=self.client).first() target = AuthPermission.objects(groups=targetGroup, name=name, creator=sel...
python
def del_permission(self, role, name): """ revoke authorization of a group """ if not self.has_permission(role, name): return True targetGroup = AuthGroup.objects(role=role, creator=self.client).first() target = AuthPermission.objects(groups=targetGroup, name=name, creator=sel...
[ "def", "del_permission", "(", "self", ",", "role", ",", "name", ")", ":", "if", "not", "self", ".", "has_permission", "(", "role", ",", "name", ")", ":", "return", "True", "targetGroup", "=", "AuthGroup", ".", "objects", "(", "role", "=", "role", ",", ...
revoke authorization of a group
[ "revoke", "authorization", "of", "a", "group" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L153-L162
ourway/auth
auth/CAS/authorization.py
Authorization.user_has_permission
def user_has_permission(self, user, name): """ verify user has permission """ targetRecord = AuthMembership.objects(creator=self.client, user=user).first() if not targetRecord: return False for group in targetRecord.groups: if self.has_permission(group.role, name)...
python
def user_has_permission(self, user, name): """ verify user has permission """ targetRecord = AuthMembership.objects(creator=self.client, user=user).first() if not targetRecord: return False for group in targetRecord.groups: if self.has_permission(group.role, name)...
[ "def", "user_has_permission", "(", "self", ",", "user", ",", "name", ")", ":", "targetRecord", "=", "AuthMembership", ".", "objects", "(", "creator", "=", "self", ".", "client", ",", "user", "=", "user", ")", ".", "first", "(", ")", "if", "not", "targe...
verify user has permission
[ "verify", "user", "has", "permission" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/authorization.py#L174-L182
kimmobrunfeldt/nap
scripts/make-release.py
bump_version
def bump_version(version, bump='patch'): """patch: patch, minor, major""" try: parts = map(int, version.split('.')) except ValueError: fail('Current version is not numeric') if bump == 'patch': parts[2] += 1 elif bump == 'minor': parts[1] += 1 parts[2] = 0 ...
python
def bump_version(version, bump='patch'): """patch: patch, minor, major""" try: parts = map(int, version.split('.')) except ValueError: fail('Current version is not numeric') if bump == 'patch': parts[2] += 1 elif bump == 'minor': parts[1] += 1 parts[2] = 0 ...
[ "def", "bump_version", "(", "version", ",", "bump", "=", "'patch'", ")", ":", "try", ":", "parts", "=", "map", "(", "int", ",", "version", ".", "split", "(", "'.'", ")", ")", "except", "ValueError", ":", "fail", "(", "'Current version is not numeric'", "...
patch: patch, minor, major
[ "patch", ":", "patch", "minor", "major" ]
train
https://github.com/kimmobrunfeldt/nap/blob/3ea7b41ef6b24b7e127bc87bb010d8a8bb18a4bd/scripts/make-release.py#L25-L42
ourway/auth
auth/CAS/models/db.py
handler
def handler(event): """Signal decorator to allow use of callback functions as class decorators.""" def decorator(fn): def apply(cls): event.connect(fn, sender=cls) return cls fn.apply = apply return fn return decorator
python
def handler(event): """Signal decorator to allow use of callback functions as class decorators.""" def decorator(fn): def apply(cls): event.connect(fn, sender=cls) return cls fn.apply = apply return fn return decorator
[ "def", "handler", "(", "event", ")", ":", "def", "decorator", "(", "fn", ")", ":", "def", "apply", "(", "cls", ")", ":", "event", ".", "connect", "(", "fn", ",", "sender", "=", "cls", ")", "return", "cls", "fn", ".", "apply", "=", "apply", "retur...
Signal decorator to allow use of callback functions as class decorators.
[ "Signal", "decorator", "to", "allow", "use", "of", "callback", "functions", "as", "class", "decorators", "." ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/models/db.py#L47-L56
ourway/auth
auth/CAS/REST/service.py
stringify
def stringify(req, resp): """ dumps all valid jsons This is the latest after hook """ if isinstance(resp.body, dict): try: resp.body = json.dumps(resp.body) except(nameError): resp.status = falcon.HTTP_500
python
def stringify(req, resp): """ dumps all valid jsons This is the latest after hook """ if isinstance(resp.body, dict): try: resp.body = json.dumps(resp.body) except(nameError): resp.status = falcon.HTTP_500
[ "def", "stringify", "(", "req", ",", "resp", ")", ":", "if", "isinstance", "(", "resp", ".", "body", ",", "dict", ")", ":", "try", ":", "resp", ".", "body", "=", "json", ".", "dumps", "(", "resp", ".", "body", ")", "except", "(", "nameError", ")"...
dumps all valid jsons This is the latest after hook
[ "dumps", "all", "valid", "jsons", "This", "is", "the", "latest", "after", "hook" ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/REST/service.py#L71-L80
ourway/auth
auth/CAS/REST/service.py
AuthComponent.process_response
def process_response(self, req, resp, resource): """Post-processing of the response (after routing). Args: req: Request object. resp: Response object. resource: Resource object to which the request was routed. May be None if no route was found ...
python
def process_response(self, req, resp, resource): """Post-processing of the response (after routing). Args: req: Request object. resp: Response object. resource: Resource object to which the request was routed. May be None if no route was found ...
[ "def", "process_response", "(", "self", ",", "req", ",", "resp", ",", "resource", ")", ":", "if", "isinstance", "(", "resp", ".", "body", ",", "dict", ")", ":", "try", ":", "resp", ".", "body", "=", "json", ".", "dumps", "(", "resp", ".", "body", ...
Post-processing of the response (after routing). Args: req: Request object. resp: Response object. resource: Resource object to which the request was routed. May be None if no route was found for the request.
[ "Post", "-", "processing", "of", "the", "response", "(", "after", "routing", ")", "." ]
train
https://github.com/ourway/auth/blob/f0d9676854dcec494add4fa086a9b2a3e4d8cea5/auth/CAS/REST/service.py#L49-L63
jgorset/django-shortcuts
django_shortcuts.py
run
def run(command=None, *arguments): """ Run the given command. Parameters: :param command: A string describing a command. :param arguments: A list of strings describing arguments to the command. """ if command is None: sys.exit('django-shortcuts: No argument was supplied, please spe...
python
def run(command=None, *arguments): """ Run the given command. Parameters: :param command: A string describing a command. :param arguments: A list of strings describing arguments to the command. """ if command is None: sys.exit('django-shortcuts: No argument was supplied, please spe...
[ "def", "run", "(", "command", "=", "None", ",", "*", "arguments", ")", ":", "if", "command", "is", "None", ":", "sys", ".", "exit", "(", "'django-shortcuts: No argument was supplied, please specify one.'", ")", "if", "command", "in", "ALIASES", ":", "command", ...
Run the given command. Parameters: :param command: A string describing a command. :param arguments: A list of strings describing arguments to the command.
[ "Run", "the", "given", "command", "." ]
train
https://github.com/jgorset/django-shortcuts/blob/22117f797f22fd3db6b55f7db31e4cbe3fd9023d/django_shortcuts.py#L45-L76
d0c-s4vage/pfp
pfp/functions.py
ParamListDef.instantiate
def instantiate(self, scope, args, interp): """Create a ParamList instance for actual interpretation :args: TODO :returns: A ParamList object """ param_instances = [] BYREF = "byref" # TODO are default values for function parameters allowed in 010? for...
python
def instantiate(self, scope, args, interp): """Create a ParamList instance for actual interpretation :args: TODO :returns: A ParamList object """ param_instances = [] BYREF = "byref" # TODO are default values for function parameters allowed in 010? for...
[ "def", "instantiate", "(", "self", ",", "scope", ",", "args", ",", "interp", ")", ":", "param_instances", "=", "[", "]", "BYREF", "=", "\"byref\"", "# TODO are default values for function parameters allowed in 010?", "for", "param_name", ",", "param_cls", "in", "sel...
Create a ParamList instance for actual interpretation :args: TODO :returns: A ParamList object
[ "Create", "a", "ParamList", "instance", "for", "actual", "interpretation" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/functions.py#L116-L160
expfactory/expfactory
expfactory/experiment.py
get_experiments
def get_experiments(base, load=False): ''' get_experiments will return loaded json for all valid experiments from an experiment folder :param base: full path to the base folder with experiments inside :param load: if True, returns a list of loaded config.json objects. If False (default) returns the paths to...
python
def get_experiments(base, load=False): ''' get_experiments will return loaded json for all valid experiments from an experiment folder :param base: full path to the base folder with experiments inside :param load: if True, returns a list of loaded config.json objects. If False (default) returns the paths to...
[ "def", "get_experiments", "(", "base", ",", "load", "=", "False", ")", ":", "experiments", "=", "find_directories", "(", "base", ")", "valid_experiments", "=", "[", "e", "for", "e", "in", "experiments", "if", "validate", "(", "e", ",", "cleanup", "=", "F...
get_experiments will return loaded json for all valid experiments from an experiment folder :param base: full path to the base folder with experiments inside :param load: if True, returns a list of loaded config.json objects. If False (default) returns the paths to the experiments
[ "get_experiments", "will", "return", "loaded", "json", "for", "all", "valid", "experiments", "from", "an", "experiment", "folder", ":", "param", "base", ":", "full", "path", "to", "the", "base", "folder", "with", "experiments", "inside", ":", "param", "load", ...
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/experiment.py#L54-L67
expfactory/expfactory
expfactory/experiment.py
load_experiments
def load_experiments(folders): '''load_experiments a wrapper for load_experiment to read multiple experiments :param experiment_folders: a list of experiment folders to load, full paths ''' experiments = [] if isinstance(folders,str): folders = [experiment_folders] for folder in fold...
python
def load_experiments(folders): '''load_experiments a wrapper for load_experiment to read multiple experiments :param experiment_folders: a list of experiment folders to load, full paths ''' experiments = [] if isinstance(folders,str): folders = [experiment_folders] for folder in fold...
[ "def", "load_experiments", "(", "folders", ")", ":", "experiments", "=", "[", "]", "if", "isinstance", "(", "folders", ",", "str", ")", ":", "folders", "=", "[", "experiment_folders", "]", "for", "folder", "in", "folders", ":", "exp", "=", "load_experiment...
load_experiments a wrapper for load_experiment to read multiple experiments :param experiment_folders: a list of experiment folders to load, full paths
[ "load_experiments", "a", "wrapper", "for", "load_experiment", "to", "read", "multiple", "experiments", ":", "param", "experiment_folders", ":", "a", "list", "of", "experiment", "folders", "to", "load", "full", "paths" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/experiment.py#L70-L81
expfactory/expfactory
expfactory/experiment.py
load_experiment
def load_experiment(folder, return_path=False): '''load_experiment: reads in the config.json for a folder, returns None if not found. :param folder: full path to experiment folder :param return_path: if True, don't load the config.json, but return it ''' fullpath = os.path.abspath(folder) co...
python
def load_experiment(folder, return_path=False): '''load_experiment: reads in the config.json for a folder, returns None if not found. :param folder: full path to experiment folder :param return_path: if True, don't load the config.json, but return it ''' fullpath = os.path.abspath(folder) co...
[ "def", "load_experiment", "(", "folder", ",", "return_path", "=", "False", ")", ":", "fullpath", "=", "os", ".", "path", ".", "abspath", "(", "folder", ")", "config", "=", "\"%s/config.json\"", "%", "(", "fullpath", ")", "if", "not", "os", ".", "path", ...
load_experiment: reads in the config.json for a folder, returns None if not found. :param folder: full path to experiment folder :param return_path: if True, don't load the config.json, but return it
[ "load_experiment", ":", "reads", "in", "the", "config", ".", "json", "for", "a", "folder", "returns", "None", "if", "not", "found", ".", ":", "param", "folder", ":", "full", "path", "to", "experiment", "folder", ":", "param", "return_path", ":", "if", "T...
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/experiment.py#L84-L97
expfactory/expfactory
expfactory/experiment.py
get_selection
def get_selection(available, selection, base='/scif/apps'): '''we compare the basename (the exp_id) of the selection and available, regardless of parent directories''' if isinstance(selection, str): selection = selection.split(',') available = [os.path.basename(x) for x in available] s...
python
def get_selection(available, selection, base='/scif/apps'): '''we compare the basename (the exp_id) of the selection and available, regardless of parent directories''' if isinstance(selection, str): selection = selection.split(',') available = [os.path.basename(x) for x in available] s...
[ "def", "get_selection", "(", "available", ",", "selection", ",", "base", "=", "'/scif/apps'", ")", ":", "if", "isinstance", "(", "selection", ",", "str", ")", ":", "selection", "=", "selection", ".", "split", "(", "','", ")", "available", "=", "[", "os",...
we compare the basename (the exp_id) of the selection and available, regardless of parent directories
[ "we", "compare", "the", "basename", "(", "the", "exp_id", ")", "of", "the", "selection", "and", "available", "regardless", "of", "parent", "directories" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/experiment.py#L100-L113
expfactory/expfactory
expfactory/experiment.py
make_lookup
def make_lookup(experiment_list, key='exp_id'): '''make_lookup returns dict object to quickly look up query experiment on exp_id :param experiment_list: a list of query (dict objects) :param key_field: the key in the dictionary to base the lookup key (str) :returns lookup: dict (json) with key as "key_f...
python
def make_lookup(experiment_list, key='exp_id'): '''make_lookup returns dict object to quickly look up query experiment on exp_id :param experiment_list: a list of query (dict objects) :param key_field: the key in the dictionary to base the lookup key (str) :returns lookup: dict (json) with key as "key_f...
[ "def", "make_lookup", "(", "experiment_list", ",", "key", "=", "'exp_id'", ")", ":", "lookup", "=", "dict", "(", ")", "for", "single_experiment", "in", "experiment_list", ":", "if", "isinstance", "(", "single_experiment", ",", "str", ")", ":", "single_experime...
make_lookup returns dict object to quickly look up query experiment on exp_id :param experiment_list: a list of query (dict objects) :param key_field: the key in the dictionary to base the lookup key (str) :returns lookup: dict (json) with key as "key_field" from query_list
[ "make_lookup", "returns", "dict", "object", "to", "quickly", "look", "up", "query", "experiment", "on", "exp_id", ":", "param", "experiment_list", ":", "a", "list", "of", "query", "(", "dict", "objects", ")", ":", "param", "key_field", ":", "the", "key", "...
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/experiment.py#L116-L128
expfactory/expfactory
expfactory/experiment.py
validate
def validate(folder=None, cleanup=False): '''validate :param folder: full path to experiment folder with config.json. If path begins with https, we assume to be starting from a repository. ''' from expfactory.validator import ExperimentValidator cli = ExperimentValidator() ret...
python
def validate(folder=None, cleanup=False): '''validate :param folder: full path to experiment folder with config.json. If path begins with https, we assume to be starting from a repository. ''' from expfactory.validator import ExperimentValidator cli = ExperimentValidator() ret...
[ "def", "validate", "(", "folder", "=", "None", ",", "cleanup", "=", "False", ")", ":", "from", "expfactory", ".", "validator", "import", "ExperimentValidator", "cli", "=", "ExperimentValidator", "(", ")", "return", "cli", ".", "validate", "(", "folder", ",",...
validate :param folder: full path to experiment folder with config.json. If path begins with https, we assume to be starting from a repository.
[ "validate", ":", "param", "folder", ":", "full", "path", "to", "experiment", "folder", "with", "config", ".", "json", ".", "If", "path", "begins", "with", "https", "we", "assume", "to", "be", "starting", "from", "a", "repository", "." ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/experiment.py#L131-L138
expfactory/expfactory
expfactory/experiment.py
get_library
def get_library(lookup=True, key='exp_id'): ''' return the raw library, without parsing''' library = None response = requests.get(EXPFACTORY_LIBRARY) if response.status_code == 200: library = response.json() if lookup is True: return make_lookup(library,key=key) return li...
python
def get_library(lookup=True, key='exp_id'): ''' return the raw library, without parsing''' library = None response = requests.get(EXPFACTORY_LIBRARY) if response.status_code == 200: library = response.json() if lookup is True: return make_lookup(library,key=key) return li...
[ "def", "get_library", "(", "lookup", "=", "True", ",", "key", "=", "'exp_id'", ")", ":", "library", "=", "None", "response", "=", "requests", ".", "get", "(", "EXPFACTORY_LIBRARY", ")", "if", "response", ".", "status_code", "==", "200", ":", "library", "...
return the raw library, without parsing
[ "return", "the", "raw", "library", "without", "parsing" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/experiment.py#L147-L155
d0c-s4vage/pfp
pfp/native/dbg.py
int3
def int3(params, ctxt, scope, stream, coord, interp): """Define the ``Int3()`` function in the interpreter. Calling ``Int3()`` will drop the user into an interactive debugger. """ if interp._no_debug: return if interp._int3: interp.debugger = PfpDbg(interp) interp.debugger.c...
python
def int3(params, ctxt, scope, stream, coord, interp): """Define the ``Int3()`` function in the interpreter. Calling ``Int3()`` will drop the user into an interactive debugger. """ if interp._no_debug: return if interp._int3: interp.debugger = PfpDbg(interp) interp.debugger.c...
[ "def", "int3", "(", "params", ",", "ctxt", ",", "scope", ",", "stream", ",", "coord", ",", "interp", ")", ":", "if", "interp", ".", "_no_debug", ":", "return", "if", "interp", ".", "_int3", ":", "interp", ".", "debugger", "=", "PfpDbg", "(", "interp"...
Define the ``Int3()`` function in the interpreter. Calling ``Int3()`` will drop the user into an interactive debugger.
[ "Define", "the", "Int3", "()", "function", "in", "the", "interpreter", ".", "Calling", "Int3", "()", "will", "drop", "the", "user", "into", "an", "interactive", "debugger", "." ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/native/dbg.py#L9-L18
expfactory/expfactory
expfactory/server.py
EFServer.initdb
def initdb(self): '''initdb will check for writability of the data folder, meaning that it is bound to the local machine. If the folder isn't bound, expfactory runs in demo mode (not saving data) ''' self.database = EXPFACTORY_DATABASE bot.info("DATABASE: %s" %self...
python
def initdb(self): '''initdb will check for writability of the data folder, meaning that it is bound to the local machine. If the folder isn't bound, expfactory runs in demo mode (not saving data) ''' self.database = EXPFACTORY_DATABASE bot.info("DATABASE: %s" %self...
[ "def", "initdb", "(", "self", ")", ":", "self", ".", "database", "=", "EXPFACTORY_DATABASE", "bot", ".", "info", "(", "\"DATABASE: %s\"", "%", "self", ".", "database", ")", "# Supported database options", "valid", "=", "(", "'sqlite'", ",", "'postgres'", ",", ...
initdb will check for writability of the data folder, meaning that it is bound to the local machine. If the folder isn't bound, expfactory runs in demo mode (not saving data)
[ "initdb", "will", "check", "for", "writability", "of", "the", "data", "folder", "meaning", "that", "it", "is", "bound", "to", "the", "local", "machine", ".", "If", "the", "folder", "isn", "t", "bound", "expfactory", "runs", "in", "demo", "mode", "(", "no...
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/server.py#L56-L74
expfactory/expfactory
expfactory/server.py
EFServer.setup
def setup(self): ''' obtain database and filesystem preferences from defaults, and compare with selection in container. ''' self.selection = EXPFACTORY_EXPERIMENTS self.ordered = len(EXPFACTORY_EXPERIMENTS) > 0 self.data_base = EXPFACTORY_DATA self.study_id =...
python
def setup(self): ''' obtain database and filesystem preferences from defaults, and compare with selection in container. ''' self.selection = EXPFACTORY_EXPERIMENTS self.ordered = len(EXPFACTORY_EXPERIMENTS) > 0 self.data_base = EXPFACTORY_DATA self.study_id =...
[ "def", "setup", "(", "self", ")", ":", "self", ".", "selection", "=", "EXPFACTORY_EXPERIMENTS", "self", ".", "ordered", "=", "len", "(", "EXPFACTORY_EXPERIMENTS", ")", ">", "0", "self", ".", "data_base", "=", "EXPFACTORY_DATA", "self", ".", "study_id", "=", ...
obtain database and filesystem preferences from defaults, and compare with selection in container.
[ "obtain", "database", "and", "filesystem", "preferences", "from", "defaults", "and", "compare", "with", "selection", "in", "container", "." ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/server.py#L77-L103
expfactory/expfactory
expfactory/server.py
EFServer.get_next
def get_next(self, session): '''return the name of the next experiment, depending on the user's choice to randomize. We don't remove any experiments here, that is done on finish, in the case the user doesn't submit data (and thus finish). A return of None means the user has comp...
python
def get_next(self, session): '''return the name of the next experiment, depending on the user's choice to randomize. We don't remove any experiments here, that is done on finish, in the case the user doesn't submit data (and thus finish). A return of None means the user has comp...
[ "def", "get_next", "(", "self", ",", "session", ")", ":", "next", "=", "None", "experiments", "=", "session", ".", "get", "(", "'experiments'", ",", "[", "]", ")", "if", "len", "(", "experiments", ")", ">", "0", ":", "if", "app", ".", "randomize", ...
return the name of the next experiment, depending on the user's choice to randomize. We don't remove any experiments here, that is done on finish, in the case the user doesn't submit data (and thus finish). A return of None means the user has completed the battery of experime...
[ "return", "the", "name", "of", "the", "next", "experiment", "depending", "on", "the", "user", "s", "choice", "to", "randomize", ".", "We", "don", "t", "remove", "any", "experiments", "here", "that", "is", "done", "on", "finish", "in", "the", "case", "the...
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/server.py#L105-L120
expfactory/expfactory
expfactory/server.py
EFServer.finish_experiment
def finish_experiment(self, session, exp_id): '''remove an experiment from the list after completion. ''' self.logger.debug('Finishing %s' %exp_id) experiments = session.get('experiments', []) experiments = [x for x in experiments if x != exp_id] session['experiments'] = ...
python
def finish_experiment(self, session, exp_id): '''remove an experiment from the list after completion. ''' self.logger.debug('Finishing %s' %exp_id) experiments = session.get('experiments', []) experiments = [x for x in experiments if x != exp_id] session['experiments'] = ...
[ "def", "finish_experiment", "(", "self", ",", "session", ",", "exp_id", ")", ":", "self", ".", "logger", ".", "debug", "(", "'Finishing %s'", "%", "exp_id", ")", "experiments", "=", "session", ".", "get", "(", "'experiments'", ",", "[", "]", ")", "experi...
remove an experiment from the list after completion.
[ "remove", "an", "experiment", "from", "the", "list", "after", "completion", "." ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/server.py#L123-L130
expfactory/expfactory
expfactory/utils.py
find_subdirectories
def find_subdirectories(basepath): ''' Return directories (and sub) starting from a base ''' directories = [] for root, dirnames, filenames in os.walk(basepath): new_directories = [d for d in dirnames if d not in directories] directories = directories + new_directories return dir...
python
def find_subdirectories(basepath): ''' Return directories (and sub) starting from a base ''' directories = [] for root, dirnames, filenames in os.walk(basepath): new_directories = [d for d in dirnames if d not in directories] directories = directories + new_directories return dir...
[ "def", "find_subdirectories", "(", "basepath", ")", ":", "directories", "=", "[", "]", "for", "root", ",", "dirnames", ",", "filenames", "in", "os", ".", "walk", "(", "basepath", ")", ":", "new_directories", "=", "[", "d", "for", "d", "in", "dirnames", ...
Return directories (and sub) starting from a base
[ "Return", "directories", "(", "and", "sub", ")", "starting", "from", "a", "base" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/utils.py#L66-L74
expfactory/expfactory
expfactory/utils.py
find_directories
def find_directories(root,fullpath=True): ''' Return directories at one level specified by user (not recursive) ''' directories = [] for item in os.listdir(root): # Don't include hidden directories if not re.match("^[.]",item): if os.path.isdir(os.path.join(root, item...
python
def find_directories(root,fullpath=True): ''' Return directories at one level specified by user (not recursive) ''' directories = [] for item in os.listdir(root): # Don't include hidden directories if not re.match("^[.]",item): if os.path.isdir(os.path.join(root, item...
[ "def", "find_directories", "(", "root", ",", "fullpath", "=", "True", ")", ":", "directories", "=", "[", "]", "for", "item", "in", "os", ".", "listdir", "(", "root", ")", ":", "# Don't include hidden directories", "if", "not", "re", ".", "match", "(", "\...
Return directories at one level specified by user (not recursive)
[ "Return", "directories", "at", "one", "level", "specified", "by", "user", "(", "not", "recursive", ")" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/utils.py#L77-L91
expfactory/expfactory
expfactory/utils.py
copy_directory
def copy_directory(src, dest, force=False): ''' Copy an entire directory recursively ''' if os.path.exists(dest) and force is True: shutil.rmtree(dest) try: shutil.copytree(src, dest) except OSError as e: # If the error was caused because the source wasn't a directory ...
python
def copy_directory(src, dest, force=False): ''' Copy an entire directory recursively ''' if os.path.exists(dest) and force is True: shutil.rmtree(dest) try: shutil.copytree(src, dest) except OSError as e: # If the error was caused because the source wasn't a directory ...
[ "def", "copy_directory", "(", "src", ",", "dest", ",", "force", "=", "False", ")", ":", "if", "os", ".", "path", ".", "exists", "(", "dest", ")", "and", "force", "is", "True", ":", "shutil", ".", "rmtree", "(", "dest", ")", "try", ":", "shutil", ...
Copy an entire directory recursively
[ "Copy", "an", "entire", "directory", "recursively" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/utils.py#L94-L108
expfactory/expfactory
expfactory/utils.py
clone
def clone(url, tmpdir=None): '''clone a repository from Github''' if tmpdir is None: tmpdir = tempfile.mkdtemp() name = os.path.basename(url).replace('.git', '') dest = '%s/%s' %(tmpdir,name) return_code = os.system('git clone %s %s' %(url,dest)) if return_code == 0: return dest ...
python
def clone(url, tmpdir=None): '''clone a repository from Github''' if tmpdir is None: tmpdir = tempfile.mkdtemp() name = os.path.basename(url).replace('.git', '') dest = '%s/%s' %(tmpdir,name) return_code = os.system('git clone %s %s' %(url,dest)) if return_code == 0: return dest ...
[ "def", "clone", "(", "url", ",", "tmpdir", "=", "None", ")", ":", "if", "tmpdir", "is", "None", ":", "tmpdir", "=", "tempfile", ".", "mkdtemp", "(", ")", "name", "=", "os", ".", "path", ".", "basename", "(", "url", ")", ".", "replace", "(", "'.gi...
clone a repository from Github
[ "clone", "a", "repository", "from", "Github" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/utils.py#L125-L135
expfactory/expfactory
expfactory/utils.py
run_command
def run_command(cmd): '''run_command uses subprocess to send a command to the terminal. :param cmd: the command to send, should be a list for subprocess ''' output = Popen(cmd,stderr=STDOUT,stdout=PIPE) t = output.communicate()[0],output.returncode output = {'message':t[0], 'return...
python
def run_command(cmd): '''run_command uses subprocess to send a command to the terminal. :param cmd: the command to send, should be a list for subprocess ''' output = Popen(cmd,stderr=STDOUT,stdout=PIPE) t = output.communicate()[0],output.returncode output = {'message':t[0], 'return...
[ "def", "run_command", "(", "cmd", ")", ":", "output", "=", "Popen", "(", "cmd", ",", "stderr", "=", "STDOUT", ",", "stdout", "=", "PIPE", ")", "t", "=", "output", ".", "communicate", "(", ")", "[", "0", "]", ",", "output", ".", "returncode", "outpu...
run_command uses subprocess to send a command to the terminal. :param cmd: the command to send, should be a list for subprocess
[ "run_command", "uses", "subprocess", "to", "send", "a", "command", "to", "the", "terminal", ".", ":", "param", "cmd", ":", "the", "command", "to", "send", "should", "be", "a", "list", "for", "subprocess" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/utils.py#L138-L147
expfactory/expfactory
expfactory/utils.py
get_template
def get_template(name, base=None): '''read in and return a template file ''' # If the file doesn't exist, assume relative to base template_file = name if not os.path.exists(template_file): if base is None: base = get_templatedir() template_file = "%s/%s" %(base, name) ...
python
def get_template(name, base=None): '''read in and return a template file ''' # If the file doesn't exist, assume relative to base template_file = name if not os.path.exists(template_file): if base is None: base = get_templatedir() template_file = "%s/%s" %(base, name) ...
[ "def", "get_template", "(", "name", ",", "base", "=", "None", ")", ":", "# If the file doesn't exist, assume relative to base", "template_file", "=", "name", "if", "not", "os", ".", "path", ".", "exists", "(", "template_file", ")", ":", "if", "base", "is", "No...
read in and return a template file
[ "read", "in", "and", "return", "a", "template", "file" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/utils.py#L155-L170
expfactory/expfactory
expfactory/utils.py
sub_template
def sub_template(template,template_tag,substitution): '''make a substitution for a template_tag in a template ''' template = template.replace(template_tag,substitution) return template
python
def sub_template(template,template_tag,substitution): '''make a substitution for a template_tag in a template ''' template = template.replace(template_tag,substitution) return template
[ "def", "sub_template", "(", "template", ",", "template_tag", ",", "substitution", ")", ":", "template", "=", "template", ".", "replace", "(", "template_tag", ",", "substitution", ")", "return", "template" ]
make a substitution for a template_tag in a template
[ "make", "a", "substitution", "for", "a", "template_tag", "in", "a", "template" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/utils.py#L173-L177
expfactory/expfactory
expfactory/utils.py
get_post_fields
def get_post_fields(request): '''parse through a request, and return fields from post in a dictionary ''' fields = dict() for field,value in request.form.items(): fields[field] = value return fields
python
def get_post_fields(request): '''parse through a request, and return fields from post in a dictionary ''' fields = dict() for field,value in request.form.items(): fields[field] = value return fields
[ "def", "get_post_fields", "(", "request", ")", ":", "fields", "=", "dict", "(", ")", "for", "field", ",", "value", "in", "request", ".", "form", ".", "items", "(", ")", ":", "fields", "[", "field", "]", "=", "value", "return", "fields" ]
parse through a request, and return fields from post in a dictionary
[ "parse", "through", "a", "request", "and", "return", "fields", "from", "post", "in", "a", "dictionary" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/utils.py#L214-L220
expfactory/expfactory
expfactory/utils.py
getenv
def getenv(variable_key, default=None, required=False, silent=True): '''getenv will attempt to get an environment variable. If the variable is not found, None is returned. :param variable_key: the variable name :param required: exit with error if not found :param silent: Do not print debugging infor...
python
def getenv(variable_key, default=None, required=False, silent=True): '''getenv will attempt to get an environment variable. If the variable is not found, None is returned. :param variable_key: the variable name :param required: exit with error if not found :param silent: Do not print debugging infor...
[ "def", "getenv", "(", "variable_key", ",", "default", "=", "None", ",", "required", "=", "False", ",", "silent", "=", "True", ")", ":", "variable", "=", "os", ".", "environ", ".", "get", "(", "variable_key", ",", "default", ")", "if", "variable", "is",...
getenv will attempt to get an environment variable. If the variable is not found, None is returned. :param variable_key: the variable name :param required: exit with error if not found :param silent: Do not print debugging information for variable
[ "getenv", "will", "attempt", "to", "get", "an", "environment", "variable", ".", "If", "the", "variable", "is", "not", "found", "None", "is", "returned", ".", ":", "param", "variable_key", ":", "the", "variable", "name", ":", "param", "required", ":", "exit...
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/utils.py#L236-L254
d0c-s4vage/pfp
pfp/__init__.py
parse
def parse( data = None, template = None, data_file = None, template_file = None, interp = None, debug = False, predefines = True, int3 = True, keep_successful = False, printf ...
python
def parse( data = None, template = None, data_file = None, template_file = None, interp = None, debug = False, predefines = True, int3 = True, keep_successful = False, printf ...
[ "def", "parse", "(", "data", "=", "None", ",", "template", "=", "None", ",", "data_file", "=", "None", ",", "template_file", "=", "None", ",", "interp", "=", "None", ",", "debug", "=", "False", ",", "predefines", "=", "True", ",", "int3", "=", "True"...
Parse the data stream using the supplied template. The data stream WILL NOT be automatically closed. :data: Input data, can be either a string or a file-like object (StringIO, file, etc) :template: template contents (str) :data_file: PATH to the data to be used as the input stream :template_file: t...
[ "Parse", "the", "data", "stream", "using", "the", "supplied", "template", ".", "The", "data", "stream", "WILL", "NOT", "be", "automatically", "closed", "." ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/__init__.py#L19-L98
d0c-s4vage/pfp
pfp/native/compat_tools.py
Checksum
def Checksum(params, ctxt, scope, stream, coord): """ Runs a simple checksum on a file and returns the result as a int64. The algorithm can be one of the following constants: CHECKSUM_BYTE - Treats the file as a set of unsigned bytes CHECKSUM_SHORT_LE - Treats the file as a set of unsigned little-e...
python
def Checksum(params, ctxt, scope, stream, coord): """ Runs a simple checksum on a file and returns the result as a int64. The algorithm can be one of the following constants: CHECKSUM_BYTE - Treats the file as a set of unsigned bytes CHECKSUM_SHORT_LE - Treats the file as a set of unsigned little-e...
[ "def", "Checksum", "(", "params", ",", "ctxt", ",", "scope", ",", "stream", ",", "coord", ")", ":", "checksum_types", "=", "{", "0", ":", "\"CHECKSUM_BYTE\"", ",", "# Treats the file as a set of unsigned bytes", "1", ":", "\"CHECKSUM_SHORT_LE\"", ",", "# Treats th...
Runs a simple checksum on a file and returns the result as a int64. The algorithm can be one of the following constants: CHECKSUM_BYTE - Treats the file as a set of unsigned bytes CHECKSUM_SHORT_LE - Treats the file as a set of unsigned little-endian shorts CHECKSUM_SHORT_BE - Treats the file as a set ...
[ "Runs", "a", "simple", "checksum", "on", "a", "file", "and", "returns", "the", "result", "as", "a", "int64", ".", "The", "algorithm", "can", "be", "one", "of", "the", "following", "constants", ":" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/native/compat_tools.py#L47-L133
d0c-s4vage/pfp
pfp/native/compat_tools.py
FindAll
def FindAll(params, ctxt, scope, stream, coord, interp): """ This function converts the argument data into a set of hex bytes and then searches the current file for all occurrences of those bytes. data may be any of the basic types or an array of one of the types. If data is an array of signed bytes...
python
def FindAll(params, ctxt, scope, stream, coord, interp): """ This function converts the argument data into a set of hex bytes and then searches the current file for all occurrences of those bytes. data may be any of the basic types or an array of one of the types. If data is an array of signed bytes...
[ "def", "FindAll", "(", "params", ",", "ctxt", ",", "scope", ",", "stream", ",", "coord", ",", "interp", ")", ":", "matches_iter", "=", "_find_helper", "(", "params", ",", "ctxt", ",", "scope", ",", "stream", ",", "coord", ",", "interp", ")", "matches",...
This function converts the argument data into a set of hex bytes and then searches the current file for all occurrences of those bytes. data may be any of the basic types or an array of one of the types. If data is an array of signed bytes, it is assumed to be a null-terminated string. To search for an ...
[ "This", "function", "converts", "the", "argument", "data", "into", "a", "set", "of", "hex", "bytes", "and", "then", "searches", "the", "current", "file", "for", "all", "occurrences", "of", "those", "bytes", ".", "data", "may", "be", "any", "of", "the", "...
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/native/compat_tools.py#L537-L575
d0c-s4vage/pfp
pfp/native/compat_tools.py
FindFirst
def FindFirst(params, ctxt, scope, stream, coord, interp): """ This function is identical to the FindAll function except that the return value is the position of the first occurrence of the target found. A negative number is returned if the value could not be found. """ global FIND_MATCHES_ITER ...
python
def FindFirst(params, ctxt, scope, stream, coord, interp): """ This function is identical to the FindAll function except that the return value is the position of the first occurrence of the target found. A negative number is returned if the value could not be found. """ global FIND_MATCHES_ITER ...
[ "def", "FindFirst", "(", "params", ",", "ctxt", ",", "scope", ",", "stream", ",", "coord", ",", "interp", ")", ":", "global", "FIND_MATCHES_ITER", "FIND_MATCHES_ITER", "=", "_find_helper", "(", "params", ",", "ctxt", ",", "scope", ",", "stream", ",", "coor...
This function is identical to the FindAll function except that the return value is the position of the first occurrence of the target found. A negative number is returned if the value could not be found.
[ "This", "function", "is", "identical", "to", "the", "FindAll", "function", "except", "that", "the", "return", "value", "is", "the", "position", "of", "the", "first", "occurrence", "of", "the", "target", "found", ".", "A", "negative", "number", "is", "returne...
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/native/compat_tools.py#L589-L602
d0c-s4vage/pfp
pfp/native/compat_tools.py
FindNext
def FindNext(params, ctxt, scope, stream, coord): """ This function returns the position of the next occurrence of the target value specified with the FindFirst function. If dir is 1, the find direction is down. If dir is 0, the find direction is up. The return value is the address of the found data...
python
def FindNext(params, ctxt, scope, stream, coord): """ This function returns the position of the next occurrence of the target value specified with the FindFirst function. If dir is 1, the find direction is down. If dir is 0, the find direction is up. The return value is the address of the found data...
[ "def", "FindNext", "(", "params", ",", "ctxt", ",", "scope", ",", "stream", ",", "coord", ")", ":", "if", "FIND_MATCHES_ITER", "is", "None", ":", "raise", "errors", ".", "InvalidState", "(", ")", "direction", "=", "1", "if", "len", "(", "params", ")", ...
This function returns the position of the next occurrence of the target value specified with the FindFirst function. If dir is 1, the find direction is down. If dir is 0, the find direction is up. The return value is the address of the found data, or -1 if the target is not found.
[ "This", "function", "returns", "the", "position", "of", "the", "next", "occurrence", "of", "the", "target", "value", "specified", "with", "the", "FindFirst", "function", ".", "If", "dir", "is", "1", "the", "find", "direction", "is", "down", ".", "If", "dir...
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/native/compat_tools.py#L606-L633
expfactory/expfactory
expfactory/database/filesystem.py
generate_subid
def generate_subid(self, token=None): '''assumes a flat (file system) database, organized by experiment id, and subject id, with data (json) organized by subject identifier ''' # Not headless auto-increments if not token: token = str(uuid.uuid4()) # Headless doesn't use any folder_...
python
def generate_subid(self, token=None): '''assumes a flat (file system) database, organized by experiment id, and subject id, with data (json) organized by subject identifier ''' # Not headless auto-increments if not token: token = str(uuid.uuid4()) # Headless doesn't use any folder_...
[ "def", "generate_subid", "(", "self", ",", "token", "=", "None", ")", ":", "# Not headless auto-increments", "if", "not", "token", ":", "token", "=", "str", "(", "uuid", ".", "uuid4", "(", ")", ")", "# Headless doesn't use any folder_id, just generated token folder"...
assumes a flat (file system) database, organized by experiment id, and subject id, with data (json) organized by subject identifier
[ "assumes", "a", "flat", "(", "file", "system", ")", "database", "organized", "by", "experiment", "id", "and", "subject", "id", "with", "data", "(", "json", ")", "organized", "by", "subject", "identifier" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/database/filesystem.py#L56-L66
expfactory/expfactory
expfactory/database/filesystem.py
list_users
def list_users(self): '''list users, each associated with a filesystem folder ''' folders = glob('%s/*' %(self.database)) folders.sort() return [self.print_user(x) for x in folders]
python
def list_users(self): '''list users, each associated with a filesystem folder ''' folders = glob('%s/*' %(self.database)) folders.sort() return [self.print_user(x) for x in folders]
[ "def", "list_users", "(", "self", ")", ":", "folders", "=", "glob", "(", "'%s/*'", "%", "(", "self", ".", "database", ")", ")", "folders", ".", "sort", "(", ")", "return", "[", "self", ".", "print_user", "(", "x", ")", "for", "x", "in", "folders", ...
list users, each associated with a filesystem folder
[ "list", "users", "each", "associated", "with", "a", "filesystem", "folder" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/database/filesystem.py#L69-L74
expfactory/expfactory
expfactory/database/filesystem.py
print_user
def print_user(self, user): '''print a filesystem database user. A "database" folder that might end with the participant status (e.g. _finished) is extracted to print in format [folder] [identifier][studyid] /scif/data/expfactory/xxxx-xxxx xxxx-xxxx[studyid] ...
python
def print_user(self, user): '''print a filesystem database user. A "database" folder that might end with the participant status (e.g. _finished) is extracted to print in format [folder] [identifier][studyid] /scif/data/expfactory/xxxx-xxxx xxxx-xxxx[studyid] ...
[ "def", "print_user", "(", "self", ",", "user", ")", ":", "status", "=", "\"active\"", "if", "user", ".", "endswith", "(", "'_finished'", ")", ":", "status", "=", "\"finished\"", "elif", "user", ".", "endswith", "(", "'_revoked'", ")", ":", "status", "=",...
print a filesystem database user. A "database" folder that might end with the participant status (e.g. _finished) is extracted to print in format [folder] [identifier][studyid] /scif/data/expfactory/xxxx-xxxx xxxx-xxxx[studyid]
[ "print", "a", "filesystem", "database", "user", ".", "A", "database", "folder", "that", "might", "end", "with", "the", "participant", "status", "(", "e", ".", "g", ".", "_finished", ")", "is", "extracted", "to", "print", "in", "format", "[", "folder", "]...
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/database/filesystem.py#L77-L99
expfactory/expfactory
expfactory/database/filesystem.py
generate_user
def generate_user(self, subid=None): '''generate a new user on the filesystem, still session based so we create a new identifier. This function is called from the users new entrypoint, and it assumes we want a user generated with a token. since we don't have a database proper, we write the fol...
python
def generate_user(self, subid=None): '''generate a new user on the filesystem, still session based so we create a new identifier. This function is called from the users new entrypoint, and it assumes we want a user generated with a token. since we don't have a database proper, we write the fol...
[ "def", "generate_user", "(", "self", ",", "subid", "=", "None", ")", ":", "# Only generate token if subid being created", "if", "subid", "is", "None", ":", "token", "=", "str", "(", "uuid", ".", "uuid4", "(", ")", ")", "subid", "=", "self", ".", "generate_...
generate a new user on the filesystem, still session based so we create a new identifier. This function is called from the users new entrypoint, and it assumes we want a user generated with a token. since we don't have a database proper, we write the folder name to the filesystem
[ "generate", "a", "new", "user", "on", "the", "filesystem", "still", "session", "based", "so", "we", "create", "a", "new", "identifier", ".", "This", "function", "is", "called", "from", "the", "users", "new", "entrypoint", "and", "it", "assumes", "we", "wan...
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/database/filesystem.py#L105-L123
expfactory/expfactory
expfactory/database/filesystem.py
finish_user
def finish_user(self, subid, ext='finished'): '''finish user will append "finished" (or other) to the data folder when the user has completed (or been revoked from) the battery. For headless, this means that the session is ended and the token will not work again to rewrite the result. If the ...
python
def finish_user(self, subid, ext='finished'): '''finish user will append "finished" (or other) to the data folder when the user has completed (or been revoked from) the battery. For headless, this means that the session is ended and the token will not work again to rewrite the result. If the ...
[ "def", "finish_user", "(", "self", ",", "subid", ",", "ext", "=", "'finished'", ")", ":", "if", "os", ".", "path", ".", "exists", "(", "self", ".", "data_base", ")", ":", "# /scif/data", "# Only relevant to filesystem save - the studyid is the top folder", "if", ...
finish user will append "finished" (or other) to the data folder when the user has completed (or been revoked from) the battery. For headless, this means that the session is ended and the token will not work again to rewrite the result. If the user needs to update or redo an experiment, th...
[ "finish", "user", "will", "append", "finished", "(", "or", "other", ")", "to", "the", "data", "folder", "when", "the", "user", "has", "completed", "(", "or", "been", "revoked", "from", ")", "the", "battery", ".", "For", "headless", "this", "means", "that...
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/database/filesystem.py#L126-L163
expfactory/expfactory
expfactory/database/filesystem.py
restart_user
def restart_user(self, subid): '''restart user will remove any "finished" or "revoked" extensions from the user folder to restart the session. This command always comes from the client users function, so we know subid does not start with the study identifer first ''' if os.path.exists(s...
python
def restart_user(self, subid): '''restart user will remove any "finished" or "revoked" extensions from the user folder to restart the session. This command always comes from the client users function, so we know subid does not start with the study identifer first ''' if os.path.exists(s...
[ "def", "restart_user", "(", "self", ",", "subid", ")", ":", "if", "os", ".", "path", ".", "exists", "(", "self", ".", "data_base", ")", ":", "# /scif/data/<study_id>", "data_base", "=", "\"%s/%s\"", "%", "(", "self", ".", "data_base", ",", "subid", ")", ...
restart user will remove any "finished" or "revoked" extensions from the user folder to restart the session. This command always comes from the client users function, so we know subid does not start with the study identifer first
[ "restart", "user", "will", "remove", "any", "finished", "or", "revoked", "extensions", "from", "the", "user", "folder", "to", "restart", "the", "session", ".", "This", "command", "always", "comes", "from", "the", "client", "users", "function", "so", "we", "k...
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/database/filesystem.py#L166-L183
expfactory/expfactory
expfactory/database/filesystem.py
validate_token
def validate_token(self, token): '''retrieve a subject based on a token. Valid means we return a participant invalid means we return None ''' # A token that is finished or revoked is not valid subid = None if not token.endswith(('finished','revoked')): subid = self.generate_subid(toke...
python
def validate_token(self, token): '''retrieve a subject based on a token. Valid means we return a participant invalid means we return None ''' # A token that is finished or revoked is not valid subid = None if not token.endswith(('finished','revoked')): subid = self.generate_subid(toke...
[ "def", "validate_token", "(", "self", ",", "token", ")", ":", "# A token that is finished or revoked is not valid", "subid", "=", "None", "if", "not", "token", ".", "endswith", "(", "(", "'finished'", ",", "'revoked'", ")", ")", ":", "subid", "=", "self", ".",...
retrieve a subject based on a token. Valid means we return a participant invalid means we return None
[ "retrieve", "a", "subject", "based", "on", "a", "token", ".", "Valid", "means", "we", "return", "a", "participant", "invalid", "means", "we", "return", "None" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/database/filesystem.py#L188-L199
expfactory/expfactory
expfactory/database/filesystem.py
refresh_token
def refresh_token(self, subid): '''refresh or generate a new token for a user. If the user is finished, this will also make the folder available again for using.''' if os.path.exists(self.data_base): # /scif/data data_base = "%s/%s" %(self.data_base, subid) if os.path.exists(data_base)...
python
def refresh_token(self, subid): '''refresh or generate a new token for a user. If the user is finished, this will also make the folder available again for using.''' if os.path.exists(self.data_base): # /scif/data data_base = "%s/%s" %(self.data_base, subid) if os.path.exists(data_base)...
[ "def", "refresh_token", "(", "self", ",", "subid", ")", ":", "if", "os", ".", "path", ".", "exists", "(", "self", ".", "data_base", ")", ":", "# /scif/data", "data_base", "=", "\"%s/%s\"", "%", "(", "self", ".", "data_base", ",", "subid", ")", "if", ...
refresh or generate a new token for a user. If the user is finished, this will also make the folder available again for using.
[ "refresh", "or", "generate", "a", "new", "token", "for", "a", "user", ".", "If", "the", "user", "is", "finished", "this", "will", "also", "make", "the", "folder", "available", "again", "for", "using", "." ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/database/filesystem.py#L202-L213
expfactory/expfactory
expfactory/database/filesystem.py
save_data
def save_data(self, session, exp_id, content): '''save data will obtain the current subid from the session, and save it depending on the database type. Currently we just support flat files''' subid = session.get('subid') # We only attempt save if there is a subject id, set at start data_file = ...
python
def save_data(self, session, exp_id, content): '''save data will obtain the current subid from the session, and save it depending on the database type. Currently we just support flat files''' subid = session.get('subid') # We only attempt save if there is a subject id, set at start data_file = ...
[ "def", "save_data", "(", "self", ",", "session", ",", "exp_id", ",", "content", ")", ":", "subid", "=", "session", ".", "get", "(", "'subid'", ")", "# We only attempt save if there is a subject id, set at start", "data_file", "=", "None", "if", "subid", "is", "n...
save data will obtain the current subid from the session, and save it depending on the database type. Currently we just support flat files
[ "save", "data", "will", "obtain", "the", "current", "subid", "from", "the", "session", "and", "save", "it", "depending", "on", "the", "database", "type", ".", "Currently", "we", "just", "support", "flat", "files" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/database/filesystem.py#L221-L253
expfactory/expfactory
expfactory/database/filesystem.py
init_db
def init_db(self): '''init_db for the filesystem ensures that the base folder (named according to the studyid) exists. ''' self.session = None if not os.path.exists(self.data_base): mkdir_p(self.data_base) self.database = "%s/%s" %(self.data_base, self.study_id) if not os.path....
python
def init_db(self): '''init_db for the filesystem ensures that the base folder (named according to the studyid) exists. ''' self.session = None if not os.path.exists(self.data_base): mkdir_p(self.data_base) self.database = "%s/%s" %(self.data_base, self.study_id) if not os.path....
[ "def", "init_db", "(", "self", ")", ":", "self", ".", "session", "=", "None", "if", "not", "os", ".", "path", ".", "exists", "(", "self", ".", "data_base", ")", ":", "mkdir_p", "(", "self", ".", "data_base", ")", "self", ".", "database", "=", "\"%s...
init_db for the filesystem ensures that the base folder (named according to the studyid) exists.
[ "init_db", "for", "the", "filesystem", "ensures", "that", "the", "base", "folder", "(", "named", "according", "to", "the", "studyid", ")", "exists", "." ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/database/filesystem.py#L256-L267
d0c-s4vage/pfp
pfp/native/__init__.py
native
def native(name, ret, interp=None, send_interp=False): """Used as a decorator to add the decorated function to the pfp interpreter so that it can be used from within scripts. :param str name: The name of the function as it will be exposed in template scripts. :param pfp.fields.Field ret: The return typ...
python
def native(name, ret, interp=None, send_interp=False): """Used as a decorator to add the decorated function to the pfp interpreter so that it can be used from within scripts. :param str name: The name of the function as it will be exposed in template scripts. :param pfp.fields.Field ret: The return typ...
[ "def", "native", "(", "name", ",", "ret", ",", "interp", "=", "None", ",", "send_interp", "=", "False", ")", ":", "def", "native_decorator", "(", "func", ")", ":", "@", "functools", ".", "wraps", "(", "func", ")", "def", "native_wrapper", "(", "*", "...
Used as a decorator to add the decorated function to the pfp interpreter so that it can be used from within scripts. :param str name: The name of the function as it will be exposed in template scripts. :param pfp.fields.Field ret: The return type of the function (a class) :param pfp.interp.PfpInterp in...
[ "Used", "as", "a", "decorator", "to", "add", "the", "decorated", "function", "to", "the", "pfp", "interpreter", "so", "that", "it", "can", "be", "used", "from", "within", "scripts", "." ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/native/__init__.py#L5-L47
d0c-s4vage/pfp
pfp/dbg.py
PfpDbg.do_peek
def do_peek(self, args): """Peek at the next 16 bytes in the stream:: Example: The peek command will display the next 16 hex bytes in the input stream:: pfp> peek 89 50 4e 47 0d 0a 1a 0a 00 00 00 0d 49 48 44 52 .PNG........IHDR """ ...
python
def do_peek(self, args): """Peek at the next 16 bytes in the stream:: Example: The peek command will display the next 16 hex bytes in the input stream:: pfp> peek 89 50 4e 47 0d 0a 1a 0a 00 00 00 0d 49 48 44 52 .PNG........IHDR """ ...
[ "def", "do_peek", "(", "self", ",", "args", ")", ":", "s", "=", "self", ".", "_interp", ".", "_stream", "# make a copy of it", "pos", "=", "s", ".", "tell", "(", ")", "saved_bits", "=", "collections", ".", "deque", "(", "s", ".", "_bits", ")", "data"...
Peek at the next 16 bytes in the stream:: Example: The peek command will display the next 16 hex bytes in the input stream:: pfp> peek 89 50 4e 47 0d 0a 1a 0a 00 00 00 0d 49 48 44 52 .PNG........IHDR
[ "Peek", "at", "the", "next", "16", "bytes", "in", "the", "stream", "::" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/dbg.py#L59-L98
d0c-s4vage/pfp
pfp/dbg.py
PfpDbg.do_next
def do_next(self, args): """Step over the next statement """ self._do_print_from_last_cmd = True self._interp.step_over() return True
python
def do_next(self, args): """Step over the next statement """ self._do_print_from_last_cmd = True self._interp.step_over() return True
[ "def", "do_next", "(", "self", ",", "args", ")", ":", "self", ".", "_do_print_from_last_cmd", "=", "True", "self", ".", "_interp", ".", "step_over", "(", ")", "return", "True" ]
Step over the next statement
[ "Step", "over", "the", "next", "statement" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/dbg.py#L100-L105
d0c-s4vage/pfp
pfp/dbg.py
PfpDbg.do_step
def do_step(self, args): """Step INTO the next statement """ self._do_print_from_last_cmd = True self._interp.step_into() return True
python
def do_step(self, args): """Step INTO the next statement """ self._do_print_from_last_cmd = True self._interp.step_into() return True
[ "def", "do_step", "(", "self", ",", "args", ")", ":", "self", ".", "_do_print_from_last_cmd", "=", "True", "self", ".", "_interp", ".", "step_into", "(", ")", "return", "True" ]
Step INTO the next statement
[ "Step", "INTO", "the", "next", "statement" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/dbg.py#L107-L112
d0c-s4vage/pfp
pfp/dbg.py
PfpDbg.do_continue
def do_continue(self, args): """Continue the interpreter """ self._do_print_from_last_cmd = True self._interp.cont() return True
python
def do_continue(self, args): """Continue the interpreter """ self._do_print_from_last_cmd = True self._interp.cont() return True
[ "def", "do_continue", "(", "self", ",", "args", ")", ":", "self", ".", "_do_print_from_last_cmd", "=", "True", "self", ".", "_interp", ".", "cont", "(", ")", "return", "True" ]
Continue the interpreter
[ "Continue", "the", "interpreter" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/dbg.py#L119-L124
d0c-s4vage/pfp
pfp/dbg.py
PfpDbg.do_eval
def do_eval(self, args): """Eval the user-supplied statement. Note that you can do anything with this command that you can do in a template. The resulting value of your statement will be displayed. """ try: res = self._interp.eval(args) if res is not None...
python
def do_eval(self, args): """Eval the user-supplied statement. Note that you can do anything with this command that you can do in a template. The resulting value of your statement will be displayed. """ try: res = self._interp.eval(args) if res is not None...
[ "def", "do_eval", "(", "self", ",", "args", ")", ":", "try", ":", "res", "=", "self", ".", "_interp", ".", "eval", "(", "args", ")", "if", "res", "is", "not", "None", ":", "if", "hasattr", "(", "res", ",", "\"_pfp__show\"", ")", ":", "print", "("...
Eval the user-supplied statement. Note that you can do anything with this command that you can do in a template. The resulting value of your statement will be displayed.
[ "Eval", "the", "user", "-", "supplied", "statement", ".", "Note", "that", "you", "can", "do", "anything", "with", "this", "command", "that", "you", "can", "do", "in", "a", "template", "." ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/dbg.py#L126-L145
d0c-s4vage/pfp
pfp/dbg.py
PfpDbg.do_show
def do_show(self, args): """Show the current structure of __root (no args), or show the result of the expression (something that can be eval'd). """ args = args.strip() to_show = self._interp._root if args != "": try: to_show = self._interp.ev...
python
def do_show(self, args): """Show the current structure of __root (no args), or show the result of the expression (something that can be eval'd). """ args = args.strip() to_show = self._interp._root if args != "": try: to_show = self._interp.ev...
[ "def", "do_show", "(", "self", ",", "args", ")", ":", "args", "=", "args", ".", "strip", "(", ")", "to_show", "=", "self", ".", "_interp", ".", "_root", "if", "args", "!=", "\"\"", ":", "try", ":", "to_show", "=", "self", ".", "_interp", ".", "ev...
Show the current structure of __root (no args), or show the result of the expression (something that can be eval'd).
[ "Show", "the", "current", "structure", "of", "__root", "(", "no", "args", ")", "or", "show", "the", "result", "of", "the", "expression", "(", "something", "that", "can", "be", "eval", "d", ")", "." ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/dbg.py#L147-L164
d0c-s4vage/pfp
pfp/dbg.py
PfpDbg.do_quit
def do_quit(self, args): """The quit command """ self._interp.set_break(self._interp.BREAK_NONE) return True
python
def do_quit(self, args): """The quit command """ self._interp.set_break(self._interp.BREAK_NONE) return True
[ "def", "do_quit", "(", "self", ",", "args", ")", ":", "self", ".", "_interp", ".", "set_break", "(", "self", ".", "_interp", ".", "BREAK_NONE", ")", "return", "True" ]
The quit command
[ "The", "quit", "command" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/dbg.py#L175-L179
expfactory/expfactory
expfactory/validator/runtime.py
RuntimeValidator.validate
def validate(self, url): ''' takes in a Github repository for validation of preview and runtime (and possibly tests passing? ''' # Preview must provide the live URL of the repository if not url.startswith('http') or not 'github' in url: bot.error('Test of previe...
python
def validate(self, url): ''' takes in a Github repository for validation of preview and runtime (and possibly tests passing? ''' # Preview must provide the live URL of the repository if not url.startswith('http') or not 'github' in url: bot.error('Test of previe...
[ "def", "validate", "(", "self", ",", "url", ")", ":", "# Preview must provide the live URL of the repository", "if", "not", "url", ".", "startswith", "(", "'http'", ")", "or", "not", "'github'", "in", "url", ":", "bot", ".", "error", "(", "'Test of preview must ...
takes in a Github repository for validation of preview and runtime (and possibly tests passing?
[ "takes", "in", "a", "Github", "repository", "for", "validation", "of", "preview", "and", "runtime", "(", "and", "possibly", "tests", "passing?" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/validator/runtime.py#L50-L63
umago/virtualbmc
virtualbmc/utils.py
mask_dict_password
def mask_dict_password(dictionary, secret='***'): """Replace passwords with a secret in a dictionary.""" d = dictionary.copy() for k in d: if 'password' in k: d[k] = secret return d
python
def mask_dict_password(dictionary, secret='***'): """Replace passwords with a secret in a dictionary.""" d = dictionary.copy() for k in d: if 'password' in k: d[k] = secret return d
[ "def", "mask_dict_password", "(", "dictionary", ",", "secret", "=", "'***'", ")", ":", "d", "=", "dictionary", ".", "copy", "(", ")", "for", "k", "in", "d", ":", "if", "'password'", "in", "k", ":", "d", "[", "k", "]", "=", "secret", "return", "d" ]
Replace passwords with a secret in a dictionary.
[ "Replace", "passwords", "with", "a", "secret", "in", "a", "dictionary", "." ]
train
https://github.com/umago/virtualbmc/blob/47551d1427e8976da0449c5405e87a763180ad1a/virtualbmc/utils.py#L90-L96
expfactory/expfactory
expfactory/views/main.py
save
def save(): '''save is a view to save data. We might want to adjust this to allow for updating saved data, but given single file is just one post for now ''' if request.method == 'POST': exp_id = session.get('exp_id') app.logger.debug('Saving data for %s' %exp_id) fields = ge...
python
def save(): '''save is a view to save data. We might want to adjust this to allow for updating saved data, but given single file is just one post for now ''' if request.method == 'POST': exp_id = session.get('exp_id') app.logger.debug('Saving data for %s' %exp_id) fields = ge...
[ "def", "save", "(", ")", ":", "if", "request", ".", "method", "==", "'POST'", ":", "exp_id", "=", "session", ".", "get", "(", "'exp_id'", ")", "app", ".", "logger", ".", "debug", "(", "'Saving data for %s'", "%", "exp_id", ")", "fields", "=", "get_post...
save is a view to save data. We might want to adjust this to allow for updating saved data, but given single file is just one post for now
[ "save", "is", "a", "view", "to", "save", "data", ".", "We", "might", "want", "to", "adjust", "this", "to", "allow", "for", "updating", "saved", "data", "but", "given", "single", "file", "is", "just", "one", "post", "for", "now" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/views/main.py#L110-L126
expfactory/expfactory
expfactory/cli/main.py
main
def main(args,parser,subparser=None): '''this is the main entrypoint for a container based web server, with most of the variables coming from the environment. See the Dockerfile template for how this function is executed. ''' # First priority to args.base base = args.base if base is ...
python
def main(args,parser,subparser=None): '''this is the main entrypoint for a container based web server, with most of the variables coming from the environment. See the Dockerfile template for how this function is executed. ''' # First priority to args.base base = args.base if base is ...
[ "def", "main", "(", "args", ",", "parser", ",", "subparser", "=", "None", ")", ":", "# First priority to args.base", "base", "=", "args", ".", "base", "if", "base", "is", "None", ":", "base", "=", "os", ".", "environ", ".", "get", "(", "'EXPFACTORY_BASE'...
this is the main entrypoint for a container based web server, with most of the variables coming from the environment. See the Dockerfile template for how this function is executed.
[ "this", "is", "the", "main", "entrypoint", "for", "a", "container", "based", "web", "server", "with", "most", "of", "the", "variables", "coming", "from", "the", "environment", ".", "See", "the", "Dockerfile", "template", "for", "how", "this", "function", "is...
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/cli/main.py#L40-L86
expfactory/expfactory
expfactory/database/sqlite.py
save_data
def save_data(self,session, exp_id, content): '''save data will obtain the current subid from the session, and save it depending on the database type.''' from expfactory.database.models import ( Participant, Result ) subid = session.get('subid') bot.info('Saving data for subi...
python
def save_data(self,session, exp_id, content): '''save data will obtain the current subid from the session, and save it depending on the database type.''' from expfactory.database.models import ( Participant, Result ) subid = session.get('subid') bot.info('Saving data for subi...
[ "def", "save_data", "(", "self", ",", "session", ",", "exp_id", ",", "content", ")", ":", "from", "expfactory", ".", "database", ".", "models", "import", "(", "Participant", ",", "Result", ")", "subid", "=", "session", ".", "get", "(", "'subid'", ")", ...
save data will obtain the current subid from the session, and save it depending on the database type.
[ "save", "data", "will", "obtain", "the", "current", "subid", "from", "the", "session", "and", "save", "it", "depending", "on", "the", "database", "type", "." ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/database/sqlite.py#L62-L91
expfactory/expfactory
expfactory/database/sqlite.py
init_db
def init_db(self): '''initialize the database, with the default database path or custom of the format sqlite:////scif/data/expfactory.db ''' # Database Setup, use default if uri not provided if self.database == 'sqlite': db_path = os.path.join(EXPFACTORY_DATA, '%s.db' % EXPFACTORY_SUBID...
python
def init_db(self): '''initialize the database, with the default database path or custom of the format sqlite:////scif/data/expfactory.db ''' # Database Setup, use default if uri not provided if self.database == 'sqlite': db_path = os.path.join(EXPFACTORY_DATA, '%s.db' % EXPFACTORY_SUBID...
[ "def", "init_db", "(", "self", ")", ":", "# Database Setup, use default if uri not provided", "if", "self", ".", "database", "==", "'sqlite'", ":", "db_path", "=", "os", ".", "path", ".", "join", "(", "EXPFACTORY_DATA", ",", "'%s.db'", "%", "EXPFACTORY_SUBID", "...
initialize the database, with the default database path or custom of the format sqlite:////scif/data/expfactory.db
[ "initialize", "the", "database", "with", "the", "default", "database", "path", "or", "custom", "of", "the", "format", "sqlite", ":", "////", "scif", "/", "data", "/", "expfactory", ".", "db" ]
train
https://github.com/expfactory/expfactory/blob/27ce6cc93e17231df8a8024f18e631336afd3501/expfactory/database/sqlite.py#L96-L120
d0c-s4vage/pfp
pfp/fields.py
BitfieldRW.reserve_bits
def reserve_bits(self, num_bits, stream): """Used to "reserve" ``num_bits`` amount of bits in order to keep track of consecutive bitfields (or are the called bitfield groups?). E.g. :: struct { char a:8, b:8; char c:4, d:4, e:8; } ...
python
def reserve_bits(self, num_bits, stream): """Used to "reserve" ``num_bits`` amount of bits in order to keep track of consecutive bitfields (or are the called bitfield groups?). E.g. :: struct { char a:8, b:8; char c:4, d:4, e:8; } ...
[ "def", "reserve_bits", "(", "self", ",", "num_bits", ",", "stream", ")", ":", "padded", "=", "self", ".", "interp", ".", "get_bitfield_padded", "(", ")", "num_bits", "=", "PYVAL", "(", "num_bits", ")", "if", "padded", ":", "num_bits", "=", "PYVAL", "(", ...
Used to "reserve" ``num_bits`` amount of bits in order to keep track of consecutive bitfields (or are the called bitfield groups?). E.g. :: struct { char a:8, b:8; char c:4, d:4, e:8; } :param int num_bits: The number of bits to claim ...
[ "Used", "to", "reserve", "num_bits", "amount", "of", "bits", "in", "order", "to", "keep", "track", "of", "consecutive", "bitfields", "(", "or", "are", "the", "called", "bitfield", "groups?", ")", "." ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L73-L109
d0c-s4vage/pfp
pfp/fields.py
BitfieldRW.read_bits
def read_bits(self, stream, num_bits, padded, left_right, endian): """Return ``num_bits`` bits, taking into account endianness and left-right bit directions """ if self._cls_bits is None and padded: raw_bits = stream.read_bits(self.cls.width*8) self._cls_bits = s...
python
def read_bits(self, stream, num_bits, padded, left_right, endian): """Return ``num_bits`` bits, taking into account endianness and left-right bit directions """ if self._cls_bits is None and padded: raw_bits = stream.read_bits(self.cls.width*8) self._cls_bits = s...
[ "def", "read_bits", "(", "self", ",", "stream", ",", "num_bits", ",", "padded", ",", "left_right", ",", "endian", ")", ":", "if", "self", ".", "_cls_bits", "is", "None", "and", "padded", ":", "raw_bits", "=", "stream", ".", "read_bits", "(", "self", "....
Return ``num_bits`` bits, taking into account endianness and left-right bit directions
[ "Return", "num_bits", "bits", "taking", "into", "account", "endianness", "and", "left", "-", "right", "bit", "directions" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L111-L133
d0c-s4vage/pfp
pfp/fields.py
BitfieldRW.write_bits
def write_bits(self, stream, raw_bits, padded, left_right, endian): """Write the bits. Once the size of the written bits is equal to the number of the reserved bits, flush it to the stream """ if padded: if left_right: self._write_bits += raw_bits ...
python
def write_bits(self, stream, raw_bits, padded, left_right, endian): """Write the bits. Once the size of the written bits is equal to the number of the reserved bits, flush it to the stream """ if padded: if left_right: self._write_bits += raw_bits ...
[ "def", "write_bits", "(", "self", ",", "stream", ",", "raw_bits", ",", "padded", ",", "left_right", ",", "endian", ")", ":", "if", "padded", ":", "if", "left_right", ":", "self", ".", "_write_bits", "+=", "raw_bits", "else", ":", "self", ".", "_write_bit...
Write the bits. Once the size of the written bits is equal to the number of the reserved bits, flush it to the stream
[ "Write", "the", "bits", ".", "Once", "the", "size", "of", "the", "written", "bits", "is", "equal", "to", "the", "number", "of", "the", "reserved", "bits", "flush", "it", "to", "the", "stream" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L135-L170
d0c-s4vage/pfp
pfp/fields.py
Field._pfp__snapshot
def _pfp__snapshot(self, recurse=True): """Save off the current value of the field """ if hasattr(self, "_pfp__value"): self._pfp__snapshot_value = self._pfp__value
python
def _pfp__snapshot(self, recurse=True): """Save off the current value of the field """ if hasattr(self, "_pfp__value"): self._pfp__snapshot_value = self._pfp__value
[ "def", "_pfp__snapshot", "(", "self", ",", "recurse", "=", "True", ")", ":", "if", "hasattr", "(", "self", ",", "\"_pfp__value\"", ")", ":", "self", ".", "_pfp__snapshot_value", "=", "self", ".", "_pfp__value" ]
Save off the current value of the field
[ "Save", "off", "the", "current", "value", "of", "the", "field" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L236-L240
d0c-s4vage/pfp
pfp/fields.py
Field._pfp__process_metadata
def _pfp__process_metadata(self): """Process the metadata once the entire struct has been declared. """ if self._pfp__metadata_processor is None: return metadata_info = self._pfp__metadata_processor() if isinstance(metadata_info, list): for metada...
python
def _pfp__process_metadata(self): """Process the metadata once the entire struct has been declared. """ if self._pfp__metadata_processor is None: return metadata_info = self._pfp__metadata_processor() if isinstance(metadata_info, list): for metada...
[ "def", "_pfp__process_metadata", "(", "self", ")", ":", "if", "self", ".", "_pfp__metadata_processor", "is", "None", ":", "return", "metadata_info", "=", "self", ".", "_pfp__metadata_processor", "(", ")", "if", "isinstance", "(", "metadata_info", ",", "list", ")...
Process the metadata once the entire struct has been declared.
[ "Process", "the", "metadata", "once", "the", "entire", "struct", "has", "been", "declared", "." ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L247-L268
d0c-s4vage/pfp
pfp/fields.py
Field._pfp__watch
def _pfp__watch(self, watcher): """Add the watcher to the list of fields that are watching this field """ if self._pfp__parent is not None and isinstance(self._pfp__parent, Union): self._pfp__parent._pfp__watch(watcher) else: self._pfp__watchers.append(wat...
python
def _pfp__watch(self, watcher): """Add the watcher to the list of fields that are watching this field """ if self._pfp__parent is not None and isinstance(self._pfp__parent, Union): self._pfp__parent._pfp__watch(watcher) else: self._pfp__watchers.append(wat...
[ "def", "_pfp__watch", "(", "self", ",", "watcher", ")", ":", "if", "self", ".", "_pfp__parent", "is", "not", "None", "and", "isinstance", "(", "self", ".", "_pfp__parent", ",", "Union", ")", ":", "self", ".", "_pfp__parent", ".", "_pfp__watch", "(", "wat...
Add the watcher to the list of fields that are watching this field
[ "Add", "the", "watcher", "to", "the", "list", "of", "fields", "that", "are", "watching", "this", "field" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L270-L277
d0c-s4vage/pfp
pfp/fields.py
Field._pfp__set_watch
def _pfp__set_watch(self, watch_fields, update_func, *func_call_info): """Subscribe to update events on each field in ``watch_fields``, using ``update_func`` to update self's value when ``watch_field`` changes""" self._pfp__watch_fields = watch_fields for watch_field in watch_fi...
python
def _pfp__set_watch(self, watch_fields, update_func, *func_call_info): """Subscribe to update events on each field in ``watch_fields``, using ``update_func`` to update self's value when ``watch_field`` changes""" self._pfp__watch_fields = watch_fields for watch_field in watch_fi...
[ "def", "_pfp__set_watch", "(", "self", ",", "watch_fields", ",", "update_func", ",", "*", "func_call_info", ")", ":", "self", ".", "_pfp__watch_fields", "=", "watch_fields", "for", "watch_field", "in", "watch_fields", ":", "watch_field", ".", "_pfp__watch", "(", ...
Subscribe to update events on each field in ``watch_fields``, using ``update_func`` to update self's value when ``watch_field`` changes
[ "Subscribe", "to", "update", "events", "on", "each", "field", "in", "watch_fields", "using", "update_func", "to", "update", "self", "s", "value", "when", "watch_field", "changes" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L279-L288
d0c-s4vage/pfp
pfp/fields.py
Field._pfp__set_packer
def _pfp__set_packer(self, pack_type, packer=None, pack=None, unpack=None, func_call_info=None): """Set the packer/pack/unpack functions for this field, as well as the pack type. :pack_type: The data type of the packed data :packer: A function that can handle packing and unpacking. Firs...
python
def _pfp__set_packer(self, pack_type, packer=None, pack=None, unpack=None, func_call_info=None): """Set the packer/pack/unpack functions for this field, as well as the pack type. :pack_type: The data type of the packed data :packer: A function that can handle packing and unpacking. Firs...
[ "def", "_pfp__set_packer", "(", "self", ",", "pack_type", ",", "packer", "=", "None", ",", "pack", "=", "None", ",", "unpack", "=", "None", ",", "func_call_info", "=", "None", ")", ":", "self", ".", "_pfp__pack_type", "=", "pack_type", "self", ".", "_pfp...
Set the packer/pack/unpack functions for this field, as well as the pack type. :pack_type: The data type of the packed data :packer: A function that can handle packing and unpacking. First arg is true/false (to pack or unpack). Second arg is the stream. Must re...
[ "Set", "the", "packer", "/", "pack", "/", "unpack", "functions", "for", "this", "field", "as", "well", "as", "the", "pack", "type", "." ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L290-L307
d0c-s4vage/pfp
pfp/fields.py
Field._pfp__pack_data
def _pfp__pack_data(self): """Pack the nested field """ if self._pfp__pack_type is None: return tmp_stream = six.BytesIO() self._._pfp__build(bitwrap.BitwrappedStream(tmp_stream)) raw_data = tmp_stream.getvalue() unpack_func = self._pfp__packer ...
python
def _pfp__pack_data(self): """Pack the nested field """ if self._pfp__pack_type is None: return tmp_stream = six.BytesIO() self._._pfp__build(bitwrap.BitwrappedStream(tmp_stream)) raw_data = tmp_stream.getvalue() unpack_func = self._pfp__packer ...
[ "def", "_pfp__pack_data", "(", "self", ")", ":", "if", "self", ".", "_pfp__pack_type", "is", "None", ":", "return", "tmp_stream", "=", "six", ".", "BytesIO", "(", ")", "self", ".", "_", ".", "_pfp__build", "(", "bitwrap", ".", "BitwrappedStream", "(", "t...
Pack the nested field
[ "Pack", "the", "nested", "field" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L309-L342
d0c-s4vage/pfp
pfp/fields.py
Field._pfp__unpack_data
def _pfp__unpack_data(self, raw_data): """Means that the field has already been parsed normally, and that it now needs to be unpacked. :raw_data: A string of the data that the field consumed while parsing """ if self._pfp__pack_type is None: return if self._p...
python
def _pfp__unpack_data(self, raw_data): """Means that the field has already been parsed normally, and that it now needs to be unpacked. :raw_data: A string of the data that the field consumed while parsing """ if self._pfp__pack_type is None: return if self._p...
[ "def", "_pfp__unpack_data", "(", "self", ",", "raw_data", ")", ":", "if", "self", ".", "_pfp__pack_type", "is", "None", ":", "return", "if", "self", ".", "_pfp__no_unpack", ":", "return", "unpack_func", "=", "self", ".", "_pfp__packer", "unpack_args", "=", "...
Means that the field has already been parsed normally, and that it now needs to be unpacked. :raw_data: A string of the data that the field consumed while parsing
[ "Means", "that", "the", "field", "has", "already", "been", "parsed", "normally", "and", "that", "it", "now", "needs", "to", "be", "unpacked", "." ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L350-L387
d0c-s4vage/pfp
pfp/fields.py
Field._pfp__handle_updated
def _pfp__handle_updated(self, watched_field): """Handle the watched field that was updated """ self._pfp__no_notify = True # nested data has been changed, so rebuild the # nested data to update the field # TODO a global setting to determine this behavior? # coul...
python
def _pfp__handle_updated(self, watched_field): """Handle the watched field that was updated """ self._pfp__no_notify = True # nested data has been changed, so rebuild the # nested data to update the field # TODO a global setting to determine this behavior? # coul...
[ "def", "_pfp__handle_updated", "(", "self", ",", "watched_field", ")", ":", "self", ".", "_pfp__no_notify", "=", "True", "# nested data has been changed, so rebuild the", "# nested data to update the field", "# TODO a global setting to determine this behavior?", "# could slow things ...
Handle the watched field that was updated
[ "Handle", "the", "watched", "field", "that", "was", "updated" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L395-L415
d0c-s4vage/pfp
pfp/fields.py
Field._pfp__width
def _pfp__width(self): """Return the width of the field (sizeof) """ raw_output = six.BytesIO() output = bitwrap.BitwrappedStream(raw_output) self._pfp__build(output) output.flush() return len(raw_output.getvalue())
python
def _pfp__width(self): """Return the width of the field (sizeof) """ raw_output = six.BytesIO() output = bitwrap.BitwrappedStream(raw_output) self._pfp__build(output) output.flush() return len(raw_output.getvalue())
[ "def", "_pfp__width", "(", "self", ")", ":", "raw_output", "=", "six", ".", "BytesIO", "(", ")", "output", "=", "bitwrap", ".", "BitwrappedStream", "(", "raw_output", ")", "self", ".", "_pfp__build", "(", "output", ")", "output", ".", "flush", "(", ")", ...
Return the width of the field (sizeof)
[ "Return", "the", "width", "of", "the", "field", "(", "sizeof", ")" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L423-L430
d0c-s4vage/pfp
pfp/fields.py
Field._pfp__set_value
def _pfp__set_value(self, new_val): """Set the new value if type checking is passes, potentially (TODO? reevaluate this) casting the value to something else :new_val: The new value :returns: TODO """ if self._pfp__frozen: raise errors.UnmodifiableConst() ...
python
def _pfp__set_value(self, new_val): """Set the new value if type checking is passes, potentially (TODO? reevaluate this) casting the value to something else :new_val: The new value :returns: TODO """ if self._pfp__frozen: raise errors.UnmodifiableConst() ...
[ "def", "_pfp__set_value", "(", "self", ",", "new_val", ")", ":", "if", "self", ".", "_pfp__frozen", ":", "raise", "errors", ".", "UnmodifiableConst", "(", ")", "self", ".", "_pfp__value", "=", "self", ".", "_pfp__get_root_value", "(", "new_val", ")", "self",...
Set the new value if type checking is passes, potentially (TODO? reevaluate this) casting the value to something else :new_val: The new value :returns: TODO
[ "Set", "the", "new", "value", "if", "type", "checking", "is", "passes", "potentially", "(", "TODO?", "reevaluate", "this", ")", "casting", "the", "value", "to", "something", "else" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L444-L455
d0c-s4vage/pfp
pfp/fields.py
Struct._pfp__snapshot
def _pfp__snapshot(self, recurse=True): """Save off the current value of the field """ super(Struct, self)._pfp__snapshot(recurse=recurse) if recurse: for child in self._pfp__children: child._pfp__snapshot(recurse=recurse)
python
def _pfp__snapshot(self, recurse=True): """Save off the current value of the field """ super(Struct, self)._pfp__snapshot(recurse=recurse) if recurse: for child in self._pfp__children: child._pfp__snapshot(recurse=recurse)
[ "def", "_pfp__snapshot", "(", "self", ",", "recurse", "=", "True", ")", ":", "super", "(", "Struct", ",", "self", ")", ".", "_pfp__snapshot", "(", "recurse", "=", "recurse", ")", "if", "recurse", ":", "for", "child", "in", "self", ".", "_pfp__children", ...
Save off the current value of the field
[ "Save", "off", "the", "current", "value", "of", "the", "field" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L603-L610
d0c-s4vage/pfp
pfp/fields.py
Struct._pfp__restore_snapshot
def _pfp__restore_snapshot(self, recurse=True): """Restore the snapshotted value without triggering any events """ super(Struct, self)._pfp__restore_snapshot(recurse=recurse) if recurse: for child in self._pfp__children: child._pfp__restore_snapshot(recurse=r...
python
def _pfp__restore_snapshot(self, recurse=True): """Restore the snapshotted value without triggering any events """ super(Struct, self)._pfp__restore_snapshot(recurse=recurse) if recurse: for child in self._pfp__children: child._pfp__restore_snapshot(recurse=r...
[ "def", "_pfp__restore_snapshot", "(", "self", ",", "recurse", "=", "True", ")", ":", "super", "(", "Struct", ",", "self", ")", ".", "_pfp__restore_snapshot", "(", "recurse", "=", "recurse", ")", "if", "recurse", ":", "for", "child", "in", "self", ".", "_...
Restore the snapshotted value without triggering any events
[ "Restore", "the", "snapshotted", "value", "without", "triggering", "any", "events" ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L612-L619
d0c-s4vage/pfp
pfp/fields.py
Struct._pfp__set_value
def _pfp__set_value(self, value): """Initialize the struct. Value should be an array of fields, one each for each struct member. :value: An array of fields to initialize the struct with :returns: None """ if self._pfp__frozen: raise errors.UnmodifiableConst()...
python
def _pfp__set_value(self, value): """Initialize the struct. Value should be an array of fields, one each for each struct member. :value: An array of fields to initialize the struct with :returns: None """ if self._pfp__frozen: raise errors.UnmodifiableConst()...
[ "def", "_pfp__set_value", "(", "self", ",", "value", ")", ":", "if", "self", ".", "_pfp__frozen", ":", "raise", "errors", ".", "UnmodifiableConst", "(", ")", "if", "len", "(", "value", ")", "!=", "len", "(", "self", ".", "_pfp__children", ")", ":", "ra...
Initialize the struct. Value should be an array of fields, one each for each struct member. :value: An array of fields to initialize the struct with :returns: None
[ "Initialize", "the", "struct", ".", "Value", "should", "be", "an", "array", "of", "fields", "one", "each", "for", "each", "struct", "member", "." ]
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L627-L640
d0c-s4vage/pfp
pfp/fields.py
Struct._pfp__add_child
def _pfp__add_child(self, name, child, stream=None, overwrite=False): """Add a child to the Struct field. If multiple consecutive fields are added with the same name, an implicit array will be created to store all fields of that name. :param str name: The name of the child :para...
python
def _pfp__add_child(self, name, child, stream=None, overwrite=False): """Add a child to the Struct field. If multiple consecutive fields are added with the same name, an implicit array will be created to store all fields of that name. :param str name: The name of the child :para...
[ "def", "_pfp__add_child", "(", "self", ",", "name", ",", "child", ",", "stream", "=", "None", ",", "overwrite", "=", "False", ")", ":", "if", "not", "overwrite", "and", "self", ".", "_pfp__is_non_consecutive_duplicate", "(", "name", ",", "child", ")", ":",...
Add a child to the Struct field. If multiple consecutive fields are added with the same name, an implicit array will be created to store all fields of that name. :param str name: The name of the child :param pfp.fields.Field child: The field to add :param bool overwrite: Overwri...
[ "Add", "a", "child", "to", "the", "Struct", "field", ".", "If", "multiple", "consecutive", "fields", "are", "added", "with", "the", "same", "name", "an", "implicit", "array", "will", "be", "created", "to", "store", "all", "fields", "of", "that", "name", ...
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L642-L662
d0c-s4vage/pfp
pfp/fields.py
Struct._pfp__handle_non_consecutive_duplicate
def _pfp__handle_non_consecutive_duplicate(self, name, child, insert=True): """This new child, and potentially one already existing child, need to have a numeric suffix appended to their name. An entry will be made for this name in ``self._pfp__name_collisions`` to keep track of...
python
def _pfp__handle_non_consecutive_duplicate(self, name, child, insert=True): """This new child, and potentially one already existing child, need to have a numeric suffix appended to their name. An entry will be made for this name in ``self._pfp__name_collisions`` to keep track of...
[ "def", "_pfp__handle_non_consecutive_duplicate", "(", "self", ",", "name", ",", "child", ",", "insert", "=", "True", ")", ":", "if", "name", "in", "self", ".", "_pfp__children_map", ":", "previous_child", "=", "self", ".", "_pfp__children_map", "[", "name", "]...
This new child, and potentially one already existing child, need to have a numeric suffix appended to their name. An entry will be made for this name in ``self._pfp__name_collisions`` to keep track of the next available suffix number
[ "This", "new", "child", "and", "potentially", "one", "already", "existing", "child", "need", "to", "have", "a", "numeric", "suffix", "appended", "to", "their", "name", ".", "An", "entry", "will", "be", "made", "for", "this", "name", "in", "self", ".", "_...
train
https://github.com/d0c-s4vage/pfp/blob/32f2d34fdec1c70019fa83c7006d5e3be0f92fcd/pfp/fields.py#L664-L689