repo stringlengths 7 55 | path stringlengths 4 127 | func_name stringlengths 1 88 | original_string stringlengths 75 19.8k | language stringclasses 1
value | code stringlengths 75 19.8k | code_tokens list | docstring stringlengths 3 17.3k | docstring_tokens list | sha stringlengths 40 40 | url stringlengths 87 242 | partition stringclasses 1
value |
|---|---|---|---|---|---|---|---|---|---|---|---|
pyviz/param | param/__init__.py | ObjectSelector._validate | def _validate(self, val):
"""
val must be None or one of the objects in self.objects.
"""
if not self.check_on_set:
self._ensure_value_is_in_objects(val)
return
if not (val in self.objects or (self.allow_None and val is None)):
# CEBALERT: can... | python | def _validate(self, val):
"""
val must be None or one of the objects in self.objects.
"""
if not self.check_on_set:
self._ensure_value_is_in_objects(val)
return
if not (val in self.objects or (self.allow_None and val is None)):
# CEBALERT: can... | [
"def",
"_validate",
"(",
"self",
",",
"val",
")",
":",
"if",
"not",
"self",
".",
"check_on_set",
":",
"self",
".",
"_ensure_value_is_in_objects",
"(",
"val",
")",
"return",
"if",
"not",
"(",
"val",
"in",
"self",
".",
"objects",
"or",
"(",
"self",
".",
... | val must be None or one of the objects in self.objects. | [
"val",
"must",
"be",
"None",
"or",
"one",
"of",
"the",
"objects",
"in",
"self",
".",
"objects",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/__init__.py#L1206-L1235 | train |
pyviz/param | param/__init__.py | ObjectSelector._ensure_value_is_in_objects | def _ensure_value_is_in_objects(self,val):
"""
Make sure that the provided value is present on the objects list.
Subclasses can override if they support multiple items on a list,
to check each item instead.
"""
if not (val in self.objects):
self.objects.append(... | python | def _ensure_value_is_in_objects(self,val):
"""
Make sure that the provided value is present on the objects list.
Subclasses can override if they support multiple items on a list,
to check each item instead.
"""
if not (val in self.objects):
self.objects.append(... | [
"def",
"_ensure_value_is_in_objects",
"(",
"self",
",",
"val",
")",
":",
"if",
"not",
"(",
"val",
"in",
"self",
".",
"objects",
")",
":",
"self",
".",
"objects",
".",
"append",
"(",
"val",
")"
] | Make sure that the provided value is present on the objects list.
Subclasses can override if they support multiple items on a list,
to check each item instead. | [
"Make",
"sure",
"that",
"the",
"provided",
"value",
"is",
"present",
"on",
"the",
"objects",
"list",
".",
"Subclasses",
"can",
"override",
"if",
"they",
"support",
"multiple",
"items",
"on",
"a",
"list",
"to",
"check",
"each",
"item",
"instead",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/__init__.py#L1237-L1244 | train |
pyviz/param | param/__init__.py | ClassSelector._validate | def _validate(self,val):
"""val must be None, an instance of self.class_ if self.is_instance=True or a subclass of self_class if self.is_instance=False"""
if isinstance(self.class_, tuple):
class_name = ('(%s)' % ', '.join(cl.__name__ for cl in self.class_))
else:
class_n... | python | def _validate(self,val):
"""val must be None, an instance of self.class_ if self.is_instance=True or a subclass of self_class if self.is_instance=False"""
if isinstance(self.class_, tuple):
class_name = ('(%s)' % ', '.join(cl.__name__ for cl in self.class_))
else:
class_n... | [
"def",
"_validate",
"(",
"self",
",",
"val",
")",
":",
"if",
"isinstance",
"(",
"self",
".",
"class_",
",",
"tuple",
")",
":",
"class_name",
"=",
"(",
"'(%s)'",
"%",
"', '",
".",
"join",
"(",
"cl",
".",
"__name__",
"for",
"cl",
"in",
"self",
".",
... | val must be None, an instance of self.class_ if self.is_instance=True or a subclass of self_class if self.is_instance=False | [
"val",
"must",
"be",
"None",
"an",
"instance",
"of",
"self",
".",
"class_",
"if",
"self",
".",
"is_instance",
"=",
"True",
"or",
"a",
"subclass",
"of",
"self_class",
"if",
"self",
".",
"is_instance",
"=",
"False"
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/__init__.py#L1303-L1318 | train |
pyviz/param | param/__init__.py | ClassSelector.get_range | def get_range(self):
"""
Return the possible types for this parameter's value.
(I.e. return {name: <class>} for all classes that are
concrete_descendents() of self.class_.)
Only classes from modules that have been imported are added
(see concrete_descendents()).
... | python | def get_range(self):
"""
Return the possible types for this parameter's value.
(I.e. return {name: <class>} for all classes that are
concrete_descendents() of self.class_.)
Only classes from modules that have been imported are added
(see concrete_descendents()).
... | [
"def",
"get_range",
"(",
"self",
")",
":",
"classes",
"=",
"concrete_descendents",
"(",
"self",
".",
"class_",
")",
"d",
"=",
"OrderedDict",
"(",
"(",
"name",
",",
"class_",
")",
"for",
"name",
",",
"class_",
"in",
"classes",
".",
"items",
"(",
")",
... | Return the possible types for this parameter's value.
(I.e. return {name: <class>} for all classes that are
concrete_descendents() of self.class_.)
Only classes from modules that have been imported are added
(see concrete_descendents()). | [
"Return",
"the",
"possible",
"types",
"for",
"this",
"parameter",
"s",
"value",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/__init__.py#L1321-L1335 | train |
pyviz/param | param/__init__.py | List._validate | def _validate(self, val):
"""
Checks that the list is of the right length and has the right contents.
Otherwise, an exception is raised.
"""
if self.allow_None and val is None:
return
if not isinstance(val, list):
raise ValueError("List '%s' must ... | python | def _validate(self, val):
"""
Checks that the list is of the right length and has the right contents.
Otherwise, an exception is raised.
"""
if self.allow_None and val is None:
return
if not isinstance(val, list):
raise ValueError("List '%s' must ... | [
"def",
"_validate",
"(",
"self",
",",
"val",
")",
":",
"if",
"self",
".",
"allow_None",
"and",
"val",
"is",
"None",
":",
"return",
"if",
"not",
"isinstance",
"(",
"val",
",",
"list",
")",
":",
"raise",
"ValueError",
"(",
"\"List '%s' must be a list.\"",
... | Checks that the list is of the right length and has the right contents.
Otherwise, an exception is raised. | [
"Checks",
"that",
"the",
"list",
"is",
"of",
"the",
"right",
"length",
"and",
"has",
"the",
"right",
"contents",
".",
"Otherwise",
"an",
"exception",
"is",
"raised",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/__init__.py#L1357-L1381 | train |
pyviz/param | param/parameterized.py | logging_level | def logging_level(level):
"""
Temporarily modify param's logging level.
"""
level = level.upper()
levels = [DEBUG, INFO, WARNING, ERROR, CRITICAL, VERBOSE]
level_names = ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL', 'VERBOSE']
if level not in level_names:
raise Exception("Level ... | python | def logging_level(level):
"""
Temporarily modify param's logging level.
"""
level = level.upper()
levels = [DEBUG, INFO, WARNING, ERROR, CRITICAL, VERBOSE]
level_names = ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL', 'VERBOSE']
if level not in level_names:
raise Exception("Level ... | [
"def",
"logging_level",
"(",
"level",
")",
":",
"level",
"=",
"level",
".",
"upper",
"(",
")",
"levels",
"=",
"[",
"DEBUG",
",",
"INFO",
",",
"WARNING",
",",
"ERROR",
",",
"CRITICAL",
",",
"VERBOSE",
"]",
"level_names",
"=",
"[",
"'DEBUG'",
",",
"'IN... | Temporarily modify param's logging level. | [
"Temporarily",
"modify",
"param",
"s",
"logging",
"level",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L69-L86 | train |
pyviz/param | param/parameterized.py | batch_watch | def batch_watch(parameterized, run=True):
"""
Context manager to batch watcher events on a parameterized object.
The context manager will queue any events triggered by setting a
parameter on the supplied parameterized object and dispatch them
all at once when the context manager exits. If run=False ... | python | def batch_watch(parameterized, run=True):
"""
Context manager to batch watcher events on a parameterized object.
The context manager will queue any events triggered by setting a
parameter on the supplied parameterized object and dispatch them
all at once when the context manager exits. If run=False ... | [
"def",
"batch_watch",
"(",
"parameterized",
",",
"run",
"=",
"True",
")",
":",
"BATCH_WATCH",
"=",
"parameterized",
".",
"param",
".",
"_BATCH_WATCH",
"parameterized",
".",
"param",
".",
"_BATCH_WATCH",
"=",
"True",
"try",
":",
"yield",
"finally",
":",
"para... | Context manager to batch watcher events on a parameterized object.
The context manager will queue any events triggered by setting a
parameter on the supplied parameterized object and dispatch them
all at once when the context manager exits. If run=False the
queued events are not dispatched and should be... | [
"Context",
"manager",
"to",
"batch",
"watcher",
"events",
"on",
"a",
"parameterized",
"object",
".",
"The",
"context",
"manager",
"will",
"queue",
"any",
"events",
"triggered",
"by",
"setting",
"a",
"parameter",
"on",
"the",
"supplied",
"parameterized",
"object"... | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L90-L105 | train |
pyviz/param | param/parameterized.py | get_all_slots | def get_all_slots(class_):
"""
Return a list of slot names for slots defined in class_ and its
superclasses.
"""
# A subclass's __slots__ attribute does not contain slots defined
# in its superclass (the superclass' __slots__ end up as
# attributes of the subclass).
all_slots = []
pa... | python | def get_all_slots(class_):
"""
Return a list of slot names for slots defined in class_ and its
superclasses.
"""
# A subclass's __slots__ attribute does not contain slots defined
# in its superclass (the superclass' __slots__ end up as
# attributes of the subclass).
all_slots = []
pa... | [
"def",
"get_all_slots",
"(",
"class_",
")",
":",
"# A subclass's __slots__ attribute does not contain slots defined",
"# in its superclass (the superclass' __slots__ end up as",
"# attributes of the subclass).",
"all_slots",
"=",
"[",
"]",
"parent_param_classes",
"=",
"[",
"c",
"fo... | Return a list of slot names for slots defined in class_ and its
superclasses. | [
"Return",
"a",
"list",
"of",
"slot",
"names",
"for",
"slots",
"defined",
"in",
"class_",
"and",
"its",
"superclasses",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L136-L149 | train |
pyviz/param | param/parameterized.py | get_occupied_slots | def get_occupied_slots(instance):
"""
Return a list of slots for which values have been set.
(While a slot might be defined, if a value for that slot hasn't
been set, then it's an AttributeError to request the slot's
value.)
"""
return [slot for slot in get_all_slots(type(instance))
... | python | def get_occupied_slots(instance):
"""
Return a list of slots for which values have been set.
(While a slot might be defined, if a value for that slot hasn't
been set, then it's an AttributeError to request the slot's
value.)
"""
return [slot for slot in get_all_slots(type(instance))
... | [
"def",
"get_occupied_slots",
"(",
"instance",
")",
":",
"return",
"[",
"slot",
"for",
"slot",
"in",
"get_all_slots",
"(",
"type",
"(",
"instance",
")",
")",
"if",
"hasattr",
"(",
"instance",
",",
"slot",
")",
"]"
] | Return a list of slots for which values have been set.
(While a slot might be defined, if a value for that slot hasn't
been set, then it's an AttributeError to request the slot's
value.) | [
"Return",
"a",
"list",
"of",
"slots",
"for",
"which",
"values",
"have",
"been",
"set",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L152-L161 | train |
pyviz/param | param/parameterized.py | all_equal | def all_equal(arg1,arg2):
"""
Return a single boolean for arg1==arg2, even for numpy arrays
using element-wise comparison.
Uses all(arg1==arg2) for sequences, and arg1==arg2 otherwise.
If both objects have an '_infinitely_iterable' attribute, they are
not be zipped together and are compared di... | python | def all_equal(arg1,arg2):
"""
Return a single boolean for arg1==arg2, even for numpy arrays
using element-wise comparison.
Uses all(arg1==arg2) for sequences, and arg1==arg2 otherwise.
If both objects have an '_infinitely_iterable' attribute, they are
not be zipped together and are compared di... | [
"def",
"all_equal",
"(",
"arg1",
",",
"arg2",
")",
":",
"if",
"all",
"(",
"hasattr",
"(",
"el",
",",
"'_infinitely_iterable'",
")",
"for",
"el",
"in",
"[",
"arg1",
",",
"arg2",
"]",
")",
":",
"return",
"arg1",
"==",
"arg2",
"try",
":",
"return",
"a... | Return a single boolean for arg1==arg2, even for numpy arrays
using element-wise comparison.
Uses all(arg1==arg2) for sequences, and arg1==arg2 otherwise.
If both objects have an '_infinitely_iterable' attribute, they are
not be zipped together and are compared directly instead. | [
"Return",
"a",
"single",
"boolean",
"for",
"arg1",
"==",
"arg2",
"even",
"for",
"numpy",
"arrays",
"using",
"element",
"-",
"wise",
"comparison",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L164-L179 | train |
pyviz/param | param/parameterized.py | output | def output(func, *output, **kw):
"""
output allows annotating a method on a Parameterized class to
declare that it returns an output of a specific type. The outputs
of a Parameterized class can be queried using the
Parameterized.param.outputs method. By default the output will
inherit the method... | python | def output(func, *output, **kw):
"""
output allows annotating a method on a Parameterized class to
declare that it returns an output of a specific type. The outputs
of a Parameterized class can be queried using the
Parameterized.param.outputs method. By default the output will
inherit the method... | [
"def",
"output",
"(",
"func",
",",
"*",
"output",
",",
"*",
"*",
"kw",
")",
":",
"if",
"output",
":",
"outputs",
"=",
"[",
"]",
"for",
"i",
",",
"out",
"in",
"enumerate",
"(",
"output",
")",
":",
"i",
"=",
"i",
"if",
"len",
"(",
"output",
")"... | output allows annotating a method on a Parameterized class to
declare that it returns an output of a specific type. The outputs
of a Parameterized class can be queried using the
Parameterized.param.outputs method. By default the output will
inherit the method name but a custom name can be declared by
... | [
"output",
"allows",
"annotating",
"a",
"method",
"on",
"a",
"Parameterized",
"class",
"to",
"declare",
"that",
"it",
"returns",
"an",
"output",
"of",
"a",
"specific",
"type",
".",
"The",
"outputs",
"of",
"a",
"Parameterized",
"class",
"can",
"be",
"queried",... | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L293-L384 | train |
pyviz/param | param/parameterized.py | Parameters._setup_params | def _setup_params(self_,**params):
"""
Initialize default and keyword parameter values.
First, ensures that all Parameters with 'instantiate=True'
(typically used for mutable Parameters) are copied directly
into each object, to ensure that there is an independent copy
(t... | python | def _setup_params(self_,**params):
"""
Initialize default and keyword parameter values.
First, ensures that all Parameters with 'instantiate=True'
(typically used for mutable Parameters) are copied directly
into each object, to ensure that there is an independent copy
(t... | [
"def",
"_setup_params",
"(",
"self_",
",",
"*",
"*",
"params",
")",
":",
"self",
"=",
"self_",
".",
"param",
".",
"self",
"## Deepcopy all 'instantiate=True' parameters",
"# (build a set of names first to avoid redundantly instantiating",
"# a later-overridden parent class's p... | Initialize default and keyword parameter values.
First, ensures that all Parameters with 'instantiate=True'
(typically used for mutable Parameters) are copied directly
into each object, to ensure that there is an independent copy
(to avoid suprising aliasing errors). Then sets each of ... | [
"Initialize",
"default",
"and",
"keyword",
"parameter",
"values",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1094-L1129 | train |
pyviz/param | param/parameterized.py | Parameters.deprecate | def deprecate(cls, fn):
"""
Decorator to issue warnings for API moving onto the param
namespace and to add a docstring directing people to the
appropriate method.
"""
def inner(*args, **kwargs):
if cls._disable_stubs:
raise AssertionError('Stub... | python | def deprecate(cls, fn):
"""
Decorator to issue warnings for API moving onto the param
namespace and to add a docstring directing people to the
appropriate method.
"""
def inner(*args, **kwargs):
if cls._disable_stubs:
raise AssertionError('Stub... | [
"def",
"deprecate",
"(",
"cls",
",",
"fn",
")",
":",
"def",
"inner",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"cls",
".",
"_disable_stubs",
":",
"raise",
"AssertionError",
"(",
"'Stubs supporting old API disabled'",
")",
"elif",
"cls",
... | Decorator to issue warnings for API moving onto the param
namespace and to add a docstring directing people to the
appropriate method. | [
"Decorator",
"to",
"issue",
"warnings",
"for",
"API",
"moving",
"onto",
"the",
"param",
"namespace",
"and",
"to",
"add",
"a",
"docstring",
"directing",
"people",
"to",
"the",
"appropriate",
"method",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1132-L1149 | train |
pyviz/param | param/parameterized.py | Parameters.print_param_defaults | def print_param_defaults(self_):
"""Print the default values of all cls's Parameters."""
cls = self_.cls
for key,val in cls.__dict__.items():
if isinstance(val,Parameter):
print(cls.__name__+'.'+key+ '='+ repr(val.default)) | python | def print_param_defaults(self_):
"""Print the default values of all cls's Parameters."""
cls = self_.cls
for key,val in cls.__dict__.items():
if isinstance(val,Parameter):
print(cls.__name__+'.'+key+ '='+ repr(val.default)) | [
"def",
"print_param_defaults",
"(",
"self_",
")",
":",
"cls",
"=",
"self_",
".",
"cls",
"for",
"key",
",",
"val",
"in",
"cls",
".",
"__dict__",
".",
"items",
"(",
")",
":",
"if",
"isinstance",
"(",
"val",
",",
"Parameter",
")",
":",
"print",
"(",
"... | Print the default values of all cls's Parameters. | [
"Print",
"the",
"default",
"values",
"of",
"all",
"cls",
"s",
"Parameters",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1188-L1193 | train |
pyviz/param | param/parameterized.py | Parameters.set_default | def set_default(self_,param_name,value):
"""
Set the default value of param_name.
Equivalent to setting param_name on the class.
"""
cls = self_.cls
setattr(cls,param_name,value) | python | def set_default(self_,param_name,value):
"""
Set the default value of param_name.
Equivalent to setting param_name on the class.
"""
cls = self_.cls
setattr(cls,param_name,value) | [
"def",
"set_default",
"(",
"self_",
",",
"param_name",
",",
"value",
")",
":",
"cls",
"=",
"self_",
".",
"cls",
"setattr",
"(",
"cls",
",",
"param_name",
",",
"value",
")"
] | Set the default value of param_name.
Equivalent to setting param_name on the class. | [
"Set",
"the",
"default",
"value",
"of",
"param_name",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1196-L1203 | train |
pyviz/param | param/parameterized.py | Parameters._add_parameter | def _add_parameter(self_, param_name,param_obj):
"""
Add a new Parameter object into this object's class.
Supposed to result in a Parameter equivalent to one declared
in the class's source code.
"""
# CEBALERT: can't we just do
# setattr(cls,param_name,param_obj)... | python | def _add_parameter(self_, param_name,param_obj):
"""
Add a new Parameter object into this object's class.
Supposed to result in a Parameter equivalent to one declared
in the class's source code.
"""
# CEBALERT: can't we just do
# setattr(cls,param_name,param_obj)... | [
"def",
"_add_parameter",
"(",
"self_",
",",
"param_name",
",",
"param_obj",
")",
":",
"# CEBALERT: can't we just do",
"# setattr(cls,param_name,param_obj)? The metaclass's",
"# __setattr__ is actually written to handle that. (Would also",
"# need to do something about the params() cache.... | Add a new Parameter object into this object's class.
Supposed to result in a Parameter equivalent to one declared
in the class's source code. | [
"Add",
"a",
"new",
"Parameter",
"object",
"into",
"this",
"object",
"s",
"class",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1206-L1228 | train |
pyviz/param | param/parameterized.py | Parameters.set_param | def set_param(self_, *args,**kwargs):
"""
For each param=value keyword argument, sets the corresponding
parameter of this object or class to the given value.
For backwards compatibility, also accepts
set_param("param",value) for a single parameter value using
positional ... | python | def set_param(self_, *args,**kwargs):
"""
For each param=value keyword argument, sets the corresponding
parameter of this object or class to the given value.
For backwards compatibility, also accepts
set_param("param",value) for a single parameter value using
positional ... | [
"def",
"set_param",
"(",
"self_",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"BATCH_WATCH",
"=",
"self_",
".",
"self_or_cls",
".",
"param",
".",
"_BATCH_WATCH",
"self_",
".",
"self_or_cls",
".",
"param",
".",
"_BATCH_WATCH",
"=",
"True",
"self_... | For each param=value keyword argument, sets the corresponding
parameter of this object or class to the given value.
For backwards compatibility, also accepts
set_param("param",value) for a single parameter value using
positional arguments, but the keyword interface is preferred
... | [
"For",
"each",
"param",
"=",
"value",
"keyword",
"argument",
"sets",
"the",
"corresponding",
"parameter",
"of",
"this",
"object",
"or",
"class",
"to",
"the",
"given",
"value",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1259-L1292 | train |
pyviz/param | param/parameterized.py | Parameters.objects | def objects(self_, instance=True):
"""
Returns the Parameters of this instance or class
If instance=True and called on a Parameterized instance it
will create instance parameters for all Parameters defined on
the class. To force class parameters to be returned use
instan... | python | def objects(self_, instance=True):
"""
Returns the Parameters of this instance or class
If instance=True and called on a Parameterized instance it
will create instance parameters for all Parameters defined on
the class. To force class parameters to be returned use
instan... | [
"def",
"objects",
"(",
"self_",
",",
"instance",
"=",
"True",
")",
":",
"cls",
"=",
"self_",
".",
"cls",
"# CB: we cache the parameters because this method is called often,",
"# and parameters are rarely added (and cannot be deleted)",
"try",
":",
"pdict",
"=",
"getattr",
... | Returns the Parameters of this instance or class
If instance=True and called on a Parameterized instance it
will create instance parameters for all Parameters defined on
the class. To force class parameters to be returned use
instance=False. Since classes avoid creating instance
... | [
"Returns",
"the",
"Parameters",
"of",
"this",
"instance",
"or",
"class"
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1295-L1333 | train |
pyviz/param | param/parameterized.py | Parameters.trigger | def trigger(self_, *param_names):
"""
Trigger watchers for the given set of parameter names. Watchers
will be triggered whether or not the parameter values have
actually changed.
"""
events = self_.self_or_cls.param._events
watchers = self_.self_or_cls.param._watc... | python | def trigger(self_, *param_names):
"""
Trigger watchers for the given set of parameter names. Watchers
will be triggered whether or not the parameter values have
actually changed.
"""
events = self_.self_or_cls.param._events
watchers = self_.self_or_cls.param._watc... | [
"def",
"trigger",
"(",
"self_",
",",
"*",
"param_names",
")",
":",
"events",
"=",
"self_",
".",
"self_or_cls",
".",
"param",
".",
"_events",
"watchers",
"=",
"self_",
".",
"self_or_cls",
".",
"param",
".",
"_watchers",
"self_",
".",
"self_or_cls",
".",
"... | Trigger watchers for the given set of parameter names. Watchers
will be triggered whether or not the parameter values have
actually changed. | [
"Trigger",
"watchers",
"for",
"the",
"given",
"set",
"of",
"parameter",
"names",
".",
"Watchers",
"will",
"be",
"triggered",
"whether",
"or",
"not",
"the",
"parameter",
"values",
"have",
"actually",
"changed",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1336-L1352 | train |
pyviz/param | param/parameterized.py | Parameters._update_event_type | def _update_event_type(self_, watcher, event, triggered):
"""
Returns an updated Event object with the type field set appropriately.
"""
if triggered:
event_type = 'triggered'
else:
event_type = 'changed' if watcher.onlychanged else 'set'
return Ev... | python | def _update_event_type(self_, watcher, event, triggered):
"""
Returns an updated Event object with the type field set appropriately.
"""
if triggered:
event_type = 'triggered'
else:
event_type = 'changed' if watcher.onlychanged else 'set'
return Ev... | [
"def",
"_update_event_type",
"(",
"self_",
",",
"watcher",
",",
"event",
",",
"triggered",
")",
":",
"if",
"triggered",
":",
"event_type",
"=",
"'triggered'",
"else",
":",
"event_type",
"=",
"'changed'",
"if",
"watcher",
".",
"onlychanged",
"else",
"'set'",
... | Returns an updated Event object with the type field set appropriately. | [
"Returns",
"an",
"updated",
"Event",
"object",
"with",
"the",
"type",
"field",
"set",
"appropriately",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1355-L1364 | train |
pyviz/param | param/parameterized.py | Parameters._call_watcher | def _call_watcher(self_, watcher, event):
"""
Invoke the given the watcher appropriately given a Event object.
"""
if self_.self_or_cls.param._TRIGGER:
pass
elif watcher.onlychanged and (not self_._changed(event)):
return
if self_.self_or_cls.para... | python | def _call_watcher(self_, watcher, event):
"""
Invoke the given the watcher appropriately given a Event object.
"""
if self_.self_or_cls.param._TRIGGER:
pass
elif watcher.onlychanged and (not self_._changed(event)):
return
if self_.self_or_cls.para... | [
"def",
"_call_watcher",
"(",
"self_",
",",
"watcher",
",",
"event",
")",
":",
"if",
"self_",
".",
"self_or_cls",
".",
"param",
".",
"_TRIGGER",
":",
"pass",
"elif",
"watcher",
".",
"onlychanged",
"and",
"(",
"not",
"self_",
".",
"_changed",
"(",
"event",... | Invoke the given the watcher appropriately given a Event object. | [
"Invoke",
"the",
"given",
"the",
"watcher",
"appropriately",
"given",
"a",
"Event",
"object",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1366-L1385 | train |
pyviz/param | param/parameterized.py | Parameters._batch_call_watchers | def _batch_call_watchers(self_):
"""
Batch call a set of watchers based on the parameter value
settings in kwargs using the queued Event and watcher objects.
"""
while self_.self_or_cls.param._events:
event_dict = OrderedDict([((event.name, event.what), event)
... | python | def _batch_call_watchers(self_):
"""
Batch call a set of watchers based on the parameter value
settings in kwargs using the queued Event and watcher objects.
"""
while self_.self_or_cls.param._events:
event_dict = OrderedDict([((event.name, event.what), event)
... | [
"def",
"_batch_call_watchers",
"(",
"self_",
")",
":",
"while",
"self_",
".",
"self_or_cls",
".",
"param",
".",
"_events",
":",
"event_dict",
"=",
"OrderedDict",
"(",
"[",
"(",
"(",
"event",
".",
"name",
",",
"event",
".",
"what",
")",
",",
"event",
")... | Batch call a set of watchers based on the parameter value
settings in kwargs using the queued Event and watcher objects. | [
"Batch",
"call",
"a",
"set",
"of",
"watchers",
"based",
"on",
"the",
"parameter",
"value",
"settings",
"in",
"kwargs",
"using",
"the",
"queued",
"Event",
"and",
"watcher",
"objects",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1388-L1409 | train |
pyviz/param | param/parameterized.py | Parameters.set_dynamic_time_fn | def set_dynamic_time_fn(self_,time_fn,sublistattr=None):
"""
Set time_fn for all Dynamic Parameters of this class or
instance object that are currently being dynamically
generated.
Additionally, sets _Dynamic_time_fn=time_fn on this class or
instance object, so that any ... | python | def set_dynamic_time_fn(self_,time_fn,sublistattr=None):
"""
Set time_fn for all Dynamic Parameters of this class or
instance object that are currently being dynamically
generated.
Additionally, sets _Dynamic_time_fn=time_fn on this class or
instance object, so that any ... | [
"def",
"set_dynamic_time_fn",
"(",
"self_",
",",
"time_fn",
",",
"sublistattr",
"=",
"None",
")",
":",
"self_or_cls",
"=",
"self_",
".",
"self_or_cls",
"self_or_cls",
".",
"_Dynamic_time_fn",
"=",
"time_fn",
"if",
"isinstance",
"(",
"self_or_cls",
",",
"type",
... | Set time_fn for all Dynamic Parameters of this class or
instance object that are currently being dynamically
generated.
Additionally, sets _Dynamic_time_fn=time_fn on this class or
instance object, so that any future changes to Dynamic
Parmeters can inherit time_fn (e.g. if a Nu... | [
"Set",
"time_fn",
"for",
"all",
"Dynamic",
"Parameters",
"of",
"this",
"class",
"or",
"instance",
"object",
"that",
"are",
"currently",
"being",
"dynamically",
"generated",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1412-L1451 | train |
pyviz/param | param/parameterized.py | Parameters.get_param_values | def get_param_values(self_,onlychanged=False):
"""
Return a list of name,value pairs for all Parameters of this
object.
When called on an instance with onlychanged set to True, will
only return values that are not equal to the default value
(onlychanged has no effect whe... | python | def get_param_values(self_,onlychanged=False):
"""
Return a list of name,value pairs for all Parameters of this
object.
When called on an instance with onlychanged set to True, will
only return values that are not equal to the default value
(onlychanged has no effect whe... | [
"def",
"get_param_values",
"(",
"self_",
",",
"onlychanged",
"=",
"False",
")",
":",
"self_or_cls",
"=",
"self_",
".",
"self_or_cls",
"# CEB: we'd actually like to know whether a value has been",
"# explicitly set on the instance, but I'm not sure that's easy",
"# (would need to di... | Return a list of name,value pairs for all Parameters of this
object.
When called on an instance with onlychanged set to True, will
only return values that are not equal to the default value
(onlychanged has no effect when called on a class). | [
"Return",
"a",
"list",
"of",
"name",
"value",
"pairs",
"for",
"all",
"Parameters",
"of",
"this",
"object",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1453-L1475 | train |
pyviz/param | param/parameterized.py | Parameters.force_new_dynamic_value | def force_new_dynamic_value(self_, name): # pylint: disable-msg=E0213
"""
Force a new value to be generated for the dynamic attribute
name, and return it.
If name is not dynamic, its current value is returned
(i.e. equivalent to getattr(name).
"""
cls_or_slf = se... | python | def force_new_dynamic_value(self_, name): # pylint: disable-msg=E0213
"""
Force a new value to be generated for the dynamic attribute
name, and return it.
If name is not dynamic, its current value is returned
(i.e. equivalent to getattr(name).
"""
cls_or_slf = se... | [
"def",
"force_new_dynamic_value",
"(",
"self_",
",",
"name",
")",
":",
"# pylint: disable-msg=E0213",
"cls_or_slf",
"=",
"self_",
".",
"self_or_cls",
"param_obj",
"=",
"cls_or_slf",
".",
"param",
".",
"objects",
"(",
"'existing'",
")",
".",
"get",
"(",
"name",
... | Force a new value to be generated for the dynamic attribute
name, and return it.
If name is not dynamic, its current value is returned
(i.e. equivalent to getattr(name). | [
"Force",
"a",
"new",
"value",
"to",
"be",
"generated",
"for",
"the",
"dynamic",
"attribute",
"name",
"and",
"return",
"it",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1478-L1501 | train |
pyviz/param | param/parameterized.py | Parameters.get_value_generator | def get_value_generator(self_,name): # pylint: disable-msg=E0213
"""
Return the value or value-generating object of the named
attribute.
For most parameters, this is simply the parameter's value
(i.e. the same as getattr()), but Dynamic parameters have
their value-genera... | python | def get_value_generator(self_,name): # pylint: disable-msg=E0213
"""
Return the value or value-generating object of the named
attribute.
For most parameters, this is simply the parameter's value
(i.e. the same as getattr()), but Dynamic parameters have
their value-genera... | [
"def",
"get_value_generator",
"(",
"self_",
",",
"name",
")",
":",
"# pylint: disable-msg=E0213",
"cls_or_slf",
"=",
"self_",
".",
"self_or_cls",
"param_obj",
"=",
"cls_or_slf",
".",
"param",
".",
"objects",
"(",
"'existing'",
")",
".",
"get",
"(",
"name",
")"... | Return the value or value-generating object of the named
attribute.
For most parameters, this is simply the parameter's value
(i.e. the same as getattr()), but Dynamic parameters have
their value-generating object returned. | [
"Return",
"the",
"value",
"or",
"value",
"-",
"generating",
"object",
"of",
"the",
"named",
"attribute",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1504-L1537 | train |
pyviz/param | param/parameterized.py | Parameters.inspect_value | def inspect_value(self_,name): # pylint: disable-msg=E0213
"""
Return the current value of the named attribute without modifying it.
Same as getattr() except for Dynamic parameters, which have their
last generated value returned.
"""
cls_or_slf = self_.self_or_cls
... | python | def inspect_value(self_,name): # pylint: disable-msg=E0213
"""
Return the current value of the named attribute without modifying it.
Same as getattr() except for Dynamic parameters, which have their
last generated value returned.
"""
cls_or_slf = self_.self_or_cls
... | [
"def",
"inspect_value",
"(",
"self_",
",",
"name",
")",
":",
"# pylint: disable-msg=E0213",
"cls_or_slf",
"=",
"self_",
".",
"self_or_cls",
"param_obj",
"=",
"cls_or_slf",
".",
"param",
".",
"objects",
"(",
"'existing'",
")",
".",
"get",
"(",
"name",
")",
"i... | Return the current value of the named attribute without modifying it.
Same as getattr() except for Dynamic parameters, which have their
last generated value returned. | [
"Return",
"the",
"current",
"value",
"of",
"the",
"named",
"attribute",
"without",
"modifying",
"it",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1539-L1561 | train |
pyviz/param | param/parameterized.py | Parameters.outputs | def outputs(self_):
"""
Returns a mapping between any declared outputs and a tuple
of the declared Parameter type, the output method, and the
index into the output if multiple outputs are returned.
"""
outputs = {}
for cls in classlist(self_.cls):
for ... | python | def outputs(self_):
"""
Returns a mapping between any declared outputs and a tuple
of the declared Parameter type, the output method, and the
index into the output if multiple outputs are returned.
"""
outputs = {}
for cls in classlist(self_.cls):
for ... | [
"def",
"outputs",
"(",
"self_",
")",
":",
"outputs",
"=",
"{",
"}",
"for",
"cls",
"in",
"classlist",
"(",
"self_",
".",
"cls",
")",
":",
"for",
"name",
"in",
"dir",
"(",
"cls",
")",
":",
"method",
"=",
"getattr",
"(",
"self_",
".",
"self_or_cls",
... | Returns a mapping between any declared outputs and a tuple
of the declared Parameter type, the output method, and the
index into the output if multiple outputs are returned. | [
"Returns",
"a",
"mapping",
"between",
"any",
"declared",
"outputs",
"and",
"a",
"tuple",
"of",
"the",
"declared",
"Parameter",
"type",
"the",
"output",
"method",
"and",
"the",
"index",
"into",
"the",
"output",
"if",
"multiple",
"outputs",
"are",
"returned",
... | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1568-L1585 | train |
pyviz/param | param/parameterized.py | Parameters.unwatch | def unwatch(self_,watcher):
"""
Unwatch watchers set either with watch or watch_values.
"""
try:
self_._watch('remove',watcher)
except:
self_.warning('No such watcher {watcher} to remove.'.format(watcher=watcher)) | python | def unwatch(self_,watcher):
"""
Unwatch watchers set either with watch or watch_values.
"""
try:
self_._watch('remove',watcher)
except:
self_.warning('No such watcher {watcher} to remove.'.format(watcher=watcher)) | [
"def",
"unwatch",
"(",
"self_",
",",
"watcher",
")",
":",
"try",
":",
"self_",
".",
"_watch",
"(",
"'remove'",
",",
"watcher",
")",
"except",
":",
"self_",
".",
"warning",
"(",
"'No such watcher {watcher} to remove.'",
".",
"format",
"(",
"watcher",
"=",
"... | Unwatch watchers set either with watch or watch_values. | [
"Unwatch",
"watchers",
"set",
"either",
"with",
"watch",
"or",
"watch_values",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1645-L1652 | train |
pyviz/param | param/parameterized.py | Parameters.print_param_values | def print_param_values(self_):
"""Print the values of all this object's Parameters."""
self = self_.self
for name,val in self.param.get_param_values():
print('%s.%s = %s' % (self.name,name,val)) | python | def print_param_values(self_):
"""Print the values of all this object's Parameters."""
self = self_.self
for name,val in self.param.get_param_values():
print('%s.%s = %s' % (self.name,name,val)) | [
"def",
"print_param_values",
"(",
"self_",
")",
":",
"self",
"=",
"self_",
".",
"self",
"for",
"name",
",",
"val",
"in",
"self",
".",
"param",
".",
"get_param_values",
"(",
")",
":",
"print",
"(",
"'%s.%s = %s'",
"%",
"(",
"self",
".",
"name",
",",
"... | Print the values of all this object's Parameters. | [
"Print",
"the",
"values",
"of",
"all",
"this",
"object",
"s",
"Parameters",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1706-L1710 | train |
pyviz/param | param/parameterized.py | Parameters.warning | def warning(self_, msg,*args,**kw):
"""
Print msg merged with args as a warning, unless module variable
warnings_as_exceptions is True, then raise an Exception
containing the arguments.
See Python's logging module for details of message formatting.
"""
if not war... | python | def warning(self_, msg,*args,**kw):
"""
Print msg merged with args as a warning, unless module variable
warnings_as_exceptions is True, then raise an Exception
containing the arguments.
See Python's logging module for details of message formatting.
"""
if not war... | [
"def",
"warning",
"(",
"self_",
",",
"msg",
",",
"*",
"args",
",",
"*",
"*",
"kw",
")",
":",
"if",
"not",
"warnings_as_exceptions",
":",
"global",
"warning_count",
"warning_count",
"+=",
"1",
"self_",
".",
"__db_print",
"(",
"WARNING",
",",
"msg",
",",
... | Print msg merged with args as a warning, unless module variable
warnings_as_exceptions is True, then raise an Exception
containing the arguments.
See Python's logging module for details of message formatting. | [
"Print",
"msg",
"merged",
"with",
"args",
"as",
"a",
"warning",
"unless",
"module",
"variable",
"warnings_as_exceptions",
"is",
"True",
"then",
"raise",
"an",
"Exception",
"containing",
"the",
"arguments",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1712-L1725 | train |
pyviz/param | param/parameterized.py | Parameters.message | def message(self_,msg,*args,**kw):
"""
Print msg merged with args as a message.
See Python's logging module for details of message formatting.
"""
self_.__db_print(INFO,msg,*args,**kw) | python | def message(self_,msg,*args,**kw):
"""
Print msg merged with args as a message.
See Python's logging module for details of message formatting.
"""
self_.__db_print(INFO,msg,*args,**kw) | [
"def",
"message",
"(",
"self_",
",",
"msg",
",",
"*",
"args",
",",
"*",
"*",
"kw",
")",
":",
"self_",
".",
"__db_print",
"(",
"INFO",
",",
"msg",
",",
"*",
"args",
",",
"*",
"*",
"kw",
")"
] | Print msg merged with args as a message.
See Python's logging module for details of message formatting. | [
"Print",
"msg",
"merged",
"with",
"args",
"as",
"a",
"message",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1727-L1733 | train |
pyviz/param | param/parameterized.py | Parameters.verbose | def verbose(self_,msg,*args,**kw):
"""
Print msg merged with args as a verbose message.
See Python's logging module for details of message formatting.
"""
self_.__db_print(VERBOSE,msg,*args,**kw) | python | def verbose(self_,msg,*args,**kw):
"""
Print msg merged with args as a verbose message.
See Python's logging module for details of message formatting.
"""
self_.__db_print(VERBOSE,msg,*args,**kw) | [
"def",
"verbose",
"(",
"self_",
",",
"msg",
",",
"*",
"args",
",",
"*",
"*",
"kw",
")",
":",
"self_",
".",
"__db_print",
"(",
"VERBOSE",
",",
"msg",
",",
"*",
"args",
",",
"*",
"*",
"kw",
")"
] | Print msg merged with args as a verbose message.
See Python's logging module for details of message formatting. | [
"Print",
"msg",
"merged",
"with",
"args",
"as",
"a",
"verbose",
"message",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1735-L1741 | train |
pyviz/param | param/parameterized.py | Parameters.debug | def debug(self_,msg,*args,**kw):
"""
Print msg merged with args as a debugging statement.
See Python's logging module for details of message formatting.
"""
self_.__db_print(DEBUG,msg,*args,**kw) | python | def debug(self_,msg,*args,**kw):
"""
Print msg merged with args as a debugging statement.
See Python's logging module for details of message formatting.
"""
self_.__db_print(DEBUG,msg,*args,**kw) | [
"def",
"debug",
"(",
"self_",
",",
"msg",
",",
"*",
"args",
",",
"*",
"*",
"kw",
")",
":",
"self_",
".",
"__db_print",
"(",
"DEBUG",
",",
"msg",
",",
"*",
"args",
",",
"*",
"*",
"kw",
")"
] | Print msg merged with args as a debugging statement.
See Python's logging module for details of message formatting. | [
"Print",
"msg",
"merged",
"with",
"args",
"as",
"a",
"debugging",
"statement",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1743-L1749 | train |
pyviz/param | param/parameterized.py | ParameterizedMetaclass.__class_docstring_signature | def __class_docstring_signature(mcs, max_repr_len=15):
"""
Autogenerate a keyword signature in the class docstring for
all available parameters. This is particularly useful in the
IPython Notebook as IPython will parse this signature to allow
tab-completion of keywords.
... | python | def __class_docstring_signature(mcs, max_repr_len=15):
"""
Autogenerate a keyword signature in the class docstring for
all available parameters. This is particularly useful in the
IPython Notebook as IPython will parse this signature to allow
tab-completion of keywords.
... | [
"def",
"__class_docstring_signature",
"(",
"mcs",
",",
"max_repr_len",
"=",
"15",
")",
":",
"processed_kws",
",",
"keyword_groups",
"=",
"set",
"(",
")",
",",
"[",
"]",
"for",
"cls",
"in",
"reversed",
"(",
"mcs",
".",
"mro",
"(",
")",
")",
":",
"keywor... | Autogenerate a keyword signature in the class docstring for
all available parameters. This is particularly useful in the
IPython Notebook as IPython will parse this signature to allow
tab-completion of keywords.
max_repr_len: Maximum length (in characters) of value reprs. | [
"Autogenerate",
"a",
"keyword",
"signature",
"in",
"the",
"class",
"docstring",
"for",
"all",
"available",
"parameters",
".",
"This",
"is",
"particularly",
"useful",
"in",
"the",
"IPython",
"Notebook",
"as",
"IPython",
"will",
"parse",
"this",
"signature",
"to",... | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1830-L1853 | train |
pyviz/param | param/parameterized.py | ParameterizedMetaclass.__param_inheritance | def __param_inheritance(mcs,param_name,param):
"""
Look for Parameter values in superclasses of this
Parameterized class.
Ordinarily, when a Python object is instantiated, attributes
not given values in the constructor will inherit the value
given in the object's class, ... | python | def __param_inheritance(mcs,param_name,param):
"""
Look for Parameter values in superclasses of this
Parameterized class.
Ordinarily, when a Python object is instantiated, attributes
not given values in the constructor will inherit the value
given in the object's class, ... | [
"def",
"__param_inheritance",
"(",
"mcs",
",",
"param_name",
",",
"param",
")",
":",
"# get all relevant slots (i.e. slots defined in all",
"# superclasses of this parameter)",
"slots",
"=",
"{",
"}",
"for",
"p_class",
"in",
"classlist",
"(",
"type",
"(",
"param",
")"... | Look for Parameter values in superclasses of this
Parameterized class.
Ordinarily, when a Python object is instantiated, attributes
not given values in the constructor will inherit the value
given in the object's class, or in its superclasses. For
Parameters owned by Parameteri... | [
"Look",
"for",
"Parameter",
"values",
"in",
"superclasses",
"of",
"this",
"Parameterized",
"class",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L1940-L2011 | train |
pyviz/param | param/parameterized.py | ParamOverrides._check_params | def _check_params(self,params):
"""
Print a warning if params contains something that is not a
Parameter of the overridden object.
"""
overridden_object_params = list(self._overridden.param)
for item in params:
if item not in overridden_object_params:
... | python | def _check_params(self,params):
"""
Print a warning if params contains something that is not a
Parameter of the overridden object.
"""
overridden_object_params = list(self._overridden.param)
for item in params:
if item not in overridden_object_params:
... | [
"def",
"_check_params",
"(",
"self",
",",
"params",
")",
":",
"overridden_object_params",
"=",
"list",
"(",
"self",
".",
"_overridden",
".",
"param",
")",
"for",
"item",
"in",
"params",
":",
"if",
"item",
"not",
"in",
"overridden_object_params",
":",
"self",... | Print a warning if params contains something that is not a
Parameter of the overridden object. | [
"Print",
"a",
"warning",
"if",
"params",
"contains",
"something",
"that",
"is",
"not",
"a",
"Parameter",
"of",
"the",
"overridden",
"object",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L2653-L2661 | train |
pyviz/param | param/parameterized.py | ParamOverrides._extract_extra_keywords | def _extract_extra_keywords(self,params):
"""
Return any items in params that are not also
parameters of the overridden object.
"""
extra_keywords = {}
overridden_object_params = list(self._overridden.param)
for name, val in params.items():
if name not... | python | def _extract_extra_keywords(self,params):
"""
Return any items in params that are not also
parameters of the overridden object.
"""
extra_keywords = {}
overridden_object_params = list(self._overridden.param)
for name, val in params.items():
if name not... | [
"def",
"_extract_extra_keywords",
"(",
"self",
",",
"params",
")",
":",
"extra_keywords",
"=",
"{",
"}",
"overridden_object_params",
"=",
"list",
"(",
"self",
".",
"_overridden",
".",
"param",
")",
"for",
"name",
",",
"val",
"in",
"params",
".",
"items",
"... | Return any items in params that are not also
parameters of the overridden object. | [
"Return",
"any",
"items",
"in",
"params",
"that",
"are",
"not",
"also",
"parameters",
"of",
"the",
"overridden",
"object",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L2663-L2676 | train |
pyviz/param | param/parameterized.py | ParameterizedFunction.instance | def instance(self_or_cls,**params):
"""
Return an instance of this class, copying parameters from any
existing instance provided.
"""
if isinstance (self_or_cls,ParameterizedMetaclass):
cls = self_or_cls
else:
p = params
params = dict(... | python | def instance(self_or_cls,**params):
"""
Return an instance of this class, copying parameters from any
existing instance provided.
"""
if isinstance (self_or_cls,ParameterizedMetaclass):
cls = self_or_cls
else:
p = params
params = dict(... | [
"def",
"instance",
"(",
"self_or_cls",
",",
"*",
"*",
"params",
")",
":",
"if",
"isinstance",
"(",
"self_or_cls",
",",
"ParameterizedMetaclass",
")",
":",
"cls",
"=",
"self_or_cls",
"else",
":",
"p",
"=",
"params",
"params",
"=",
"dict",
"(",
"self_or_cls"... | Return an instance of this class, copying parameters from any
existing instance provided. | [
"Return",
"an",
"instance",
"of",
"this",
"class",
"copying",
"parameters",
"from",
"any",
"existing",
"instance",
"provided",
"."
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L2702-L2721 | train |
pyviz/param | param/parameterized.py | ParameterizedFunction.script_repr | def script_repr(self,imports=[],prefix=" "):
"""
Same as Parameterized.script_repr, except that X.classname(Y
is replaced with X.classname.instance(Y
"""
return self.pprint(imports,prefix,unknown_value='',qualify=True,
separator="\n") | python | def script_repr(self,imports=[],prefix=" "):
"""
Same as Parameterized.script_repr, except that X.classname(Y
is replaced with X.classname.instance(Y
"""
return self.pprint(imports,prefix,unknown_value='',qualify=True,
separator="\n") | [
"def",
"script_repr",
"(",
"self",
",",
"imports",
"=",
"[",
"]",
",",
"prefix",
"=",
"\" \"",
")",
":",
"return",
"self",
".",
"pprint",
"(",
"imports",
",",
"prefix",
",",
"unknown_value",
"=",
"''",
",",
"qualify",
"=",
"True",
",",
"separator",
... | Same as Parameterized.script_repr, except that X.classname(Y
is replaced with X.classname.instance(Y | [
"Same",
"as",
"Parameterized",
".",
"script_repr",
"except",
"that",
"X",
".",
"classname",
"(",
"Y",
"is",
"replaced",
"with",
"X",
".",
"classname",
".",
"instance",
"(",
"Y"
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L2742-L2748 | train |
pyviz/param | param/parameterized.py | ParameterizedFunction.pprint | def pprint(self, imports=None, prefix="\n ",unknown_value='<?>',
qualify=False, separator=""):
"""
Same as Parameterized.pprint, except that X.classname(Y
is replaced with X.classname.instance(Y
"""
r = Parameterized.pprint(self,imports,prefix,
... | python | def pprint(self, imports=None, prefix="\n ",unknown_value='<?>',
qualify=False, separator=""):
"""
Same as Parameterized.pprint, except that X.classname(Y
is replaced with X.classname.instance(Y
"""
r = Parameterized.pprint(self,imports,prefix,
... | [
"def",
"pprint",
"(",
"self",
",",
"imports",
"=",
"None",
",",
"prefix",
"=",
"\"\\n \"",
",",
"unknown_value",
"=",
"'<?>'",
",",
"qualify",
"=",
"False",
",",
"separator",
"=",
"\"\"",
")",
":",
"r",
"=",
"Parameterized",
".",
"pprint",
"(",
"sel... | Same as Parameterized.pprint, except that X.classname(Y
is replaced with X.classname.instance(Y | [
"Same",
"as",
"Parameterized",
".",
"pprint",
"except",
"that",
"X",
".",
"classname",
"(",
"Y",
"is",
"replaced",
"with",
"X",
".",
"classname",
".",
"instance",
"(",
"Y"
] | 8f0dafa78defa883247b40635f96cc6d5c1b3481 | https://github.com/pyviz/param/blob/8f0dafa78defa883247b40635f96cc6d5c1b3481/param/parameterized.py#L2751-L2761 | train |
sass/libsass-python | sassutils/builder.py | Manifest.resolve_filename | def resolve_filename(self, package_dir, filename):
"""Gets a proper full relative path of Sass source and
CSS source that will be generated, according to ``package_dir``
and ``filename``.
:param package_dir: the path of package directory
:type package_dir: :class:`str`, :class:`... | python | def resolve_filename(self, package_dir, filename):
"""Gets a proper full relative path of Sass source and
CSS source that will be generated, according to ``package_dir``
and ``filename``.
:param package_dir: the path of package directory
:type package_dir: :class:`str`, :class:`... | [
"def",
"resolve_filename",
"(",
"self",
",",
"package_dir",
",",
"filename",
")",
":",
"sass_path",
"=",
"os",
".",
"path",
".",
"join",
"(",
"package_dir",
",",
"self",
".",
"sass_path",
",",
"filename",
")",
"if",
"self",
".",
"strip_extension",
":",
"... | Gets a proper full relative path of Sass source and
CSS source that will be generated, according to ``package_dir``
and ``filename``.
:param package_dir: the path of package directory
:type package_dir: :class:`str`, :class:`basestring`
:param filename: the filename of Sass/SCSS... | [
"Gets",
"a",
"proper",
"full",
"relative",
"path",
"of",
"Sass",
"source",
"and",
"CSS",
"source",
"that",
"will",
"be",
"generated",
"according",
"to",
"package_dir",
"and",
"filename",
"."
] | fde5b18bc761f0253e71685ee5489e4beb8a403e | https://github.com/sass/libsass-python/blob/fde5b18bc761f0253e71685ee5489e4beb8a403e/sassutils/builder.py#L181-L199 | train |
sass/libsass-python | sassutils/builder.py | Manifest.unresolve_filename | def unresolve_filename(self, package_dir, filename):
"""Retrieves the probable source path from the output filename. Pass
in a .css path to get out a .scss path.
:param package_dir: the path of the package directory
:type package_dir: :class:`str`
:param filename: the css filen... | python | def unresolve_filename(self, package_dir, filename):
"""Retrieves the probable source path from the output filename. Pass
in a .css path to get out a .scss path.
:param package_dir: the path of the package directory
:type package_dir: :class:`str`
:param filename: the css filen... | [
"def",
"unresolve_filename",
"(",
"self",
",",
"package_dir",
",",
"filename",
")",
":",
"filename",
",",
"_",
"=",
"os",
".",
"path",
".",
"splitext",
"(",
"filename",
")",
"if",
"self",
".",
"strip_extension",
":",
"for",
"ext",
"in",
"(",
"'.scss'",
... | Retrieves the probable source path from the output filename. Pass
in a .css path to get out a .scss path.
:param package_dir: the path of the package directory
:type package_dir: :class:`str`
:param filename: the css filename
:type filename: :class:`str`
:returns: the s... | [
"Retrieves",
"the",
"probable",
"source",
"path",
"from",
"the",
"output",
"filename",
".",
"Pass",
"in",
"a",
".",
"css",
"path",
"to",
"get",
"out",
"a",
".",
"scss",
"path",
"."
] | fde5b18bc761f0253e71685ee5489e4beb8a403e | https://github.com/sass/libsass-python/blob/fde5b18bc761f0253e71685ee5489e4beb8a403e/sassutils/builder.py#L201-L223 | train |
sass/libsass-python | sass.py | _validate_importers | def _validate_importers(importers):
"""Validates the importers and decorates the callables with our output
formatter.
"""
# They could have no importers, that's chill
if importers is None:
return None
def _to_importer(priority, func):
assert isinstance(priority, int), priority
... | python | def _validate_importers(importers):
"""Validates the importers and decorates the callables with our output
formatter.
"""
# They could have no importers, that's chill
if importers is None:
return None
def _to_importer(priority, func):
assert isinstance(priority, int), priority
... | [
"def",
"_validate_importers",
"(",
"importers",
")",
":",
"# They could have no importers, that's chill",
"if",
"importers",
"is",
"None",
":",
"return",
"None",
"def",
"_to_importer",
"(",
"priority",
",",
"func",
")",
":",
"assert",
"isinstance",
"(",
"priority",
... | Validates the importers and decorates the callables with our output
formatter. | [
"Validates",
"the",
"importers",
"and",
"decorates",
"the",
"callables",
"with",
"our",
"output",
"formatter",
"."
] | fde5b18bc761f0253e71685ee5489e4beb8a403e | https://github.com/sass/libsass-python/blob/fde5b18bc761f0253e71685ee5489e4beb8a403e/sass.py#L218-L232 | train |
sass/libsass-python | sass.py | and_join | def and_join(strings):
"""Join the given ``strings`` by commas with last `' and '` conjuction.
>>> and_join(['Korea', 'Japan', 'China', 'Taiwan'])
'Korea, Japan, China, and Taiwan'
:param strings: a list of words to join
:type string: :class:`collections.abc.Sequence`
:returns: a joined string... | python | def and_join(strings):
"""Join the given ``strings`` by commas with last `' and '` conjuction.
>>> and_join(['Korea', 'Japan', 'China', 'Taiwan'])
'Korea, Japan, China, and Taiwan'
:param strings: a list of words to join
:type string: :class:`collections.abc.Sequence`
:returns: a joined string... | [
"def",
"and_join",
"(",
"strings",
")",
":",
"last",
"=",
"len",
"(",
"strings",
")",
"-",
"1",
"if",
"last",
"==",
"0",
":",
"return",
"strings",
"[",
"0",
"]",
"elif",
"last",
"<",
"0",
":",
"return",
"''",
"iterator",
"=",
"enumerate",
"(",
"s... | Join the given ``strings`` by commas with last `' and '` conjuction.
>>> and_join(['Korea', 'Japan', 'China', 'Taiwan'])
'Korea, Japan, China, and Taiwan'
:param strings: a list of words to join
:type string: :class:`collections.abc.Sequence`
:returns: a joined string
:rtype: :class:`str`, :cl... | [
"Join",
"the",
"given",
"strings",
"by",
"commas",
"with",
"last",
"and",
"conjuction",
"."
] | fde5b18bc761f0253e71685ee5489e4beb8a403e | https://github.com/sass/libsass-python/blob/fde5b18bc761f0253e71685ee5489e4beb8a403e/sass.py#L741-L759 | train |
dbkaplan/dry-rest-permissions | dry_rest_permissions/generics.py | allow_staff_or_superuser | def allow_staff_or_superuser(func):
"""
This decorator is used to abstract common is_staff and is_superuser functionality
out of permission checks. It determines which parameter is the request based on name.
"""
is_object_permission = "has_object" in func.__name__
@wraps(func)
def func_wrap... | python | def allow_staff_or_superuser(func):
"""
This decorator is used to abstract common is_staff and is_superuser functionality
out of permission checks. It determines which parameter is the request based on name.
"""
is_object_permission = "has_object" in func.__name__
@wraps(func)
def func_wrap... | [
"def",
"allow_staff_or_superuser",
"(",
"func",
")",
":",
"is_object_permission",
"=",
"\"has_object\"",
"in",
"func",
".",
"__name__",
"@",
"wraps",
"(",
"func",
")",
"def",
"func_wrapper",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"request",
"... | This decorator is used to abstract common is_staff and is_superuser functionality
out of permission checks. It determines which parameter is the request based on name. | [
"This",
"decorator",
"is",
"used",
"to",
"abstract",
"common",
"is_staff",
"and",
"is_superuser",
"functionality",
"out",
"of",
"permission",
"checks",
".",
"It",
"determines",
"which",
"parameter",
"is",
"the",
"request",
"based",
"on",
"name",
"."
] | b2d4d3c76041f6c405e2537bea9639657b75b90e | https://github.com/dbkaplan/dry-rest-permissions/blob/b2d4d3c76041f6c405e2537bea9639657b75b90e/dry_rest_permissions/generics.py#L269-L288 | train |
dbkaplan/dry-rest-permissions | dry_rest_permissions/generics.py | authenticated_users | def authenticated_users(func):
"""
This decorator is used to abstract common authentication checking functionality
out of permission checks. It determines which parameter is the request based on name.
"""
is_object_permission = "has_object" in func.__name__
@wraps(func)
def func_wrapper(*ar... | python | def authenticated_users(func):
"""
This decorator is used to abstract common authentication checking functionality
out of permission checks. It determines which parameter is the request based on name.
"""
is_object_permission = "has_object" in func.__name__
@wraps(func)
def func_wrapper(*ar... | [
"def",
"authenticated_users",
"(",
"func",
")",
":",
"is_object_permission",
"=",
"\"has_object\"",
"in",
"func",
".",
"__name__",
"@",
"wraps",
"(",
"func",
")",
"def",
"func_wrapper",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"request",
"=",
... | This decorator is used to abstract common authentication checking functionality
out of permission checks. It determines which parameter is the request based on name. | [
"This",
"decorator",
"is",
"used",
"to",
"abstract",
"common",
"authentication",
"checking",
"functionality",
"out",
"of",
"permission",
"checks",
".",
"It",
"determines",
"which",
"parameter",
"is",
"the",
"request",
"based",
"on",
"name",
"."
] | b2d4d3c76041f6c405e2537bea9639657b75b90e | https://github.com/dbkaplan/dry-rest-permissions/blob/b2d4d3c76041f6c405e2537bea9639657b75b90e/dry_rest_permissions/generics.py#L291-L310 | train |
dbkaplan/dry-rest-permissions | dry_rest_permissions/generics.py | DRYPermissionFiltersBase.filter_queryset | def filter_queryset(self, request, queryset, view):
"""
This method overrides the standard filter_queryset method.
This method will check to see if the view calling this is from
a list type action. This function will also route the filter
by action type if action_routing is set t... | python | def filter_queryset(self, request, queryset, view):
"""
This method overrides the standard filter_queryset method.
This method will check to see if the view calling this is from
a list type action. This function will also route the filter
by action type if action_routing is set t... | [
"def",
"filter_queryset",
"(",
"self",
",",
"request",
",",
"queryset",
",",
"view",
")",
":",
"# Check if this is a list type request",
"if",
"view",
".",
"lookup_field",
"not",
"in",
"view",
".",
"kwargs",
":",
"if",
"not",
"self",
".",
"action_routing",
":"... | This method overrides the standard filter_queryset method.
This method will check to see if the view calling this is from
a list type action. This function will also route the filter
by action type if action_routing is set to True. | [
"This",
"method",
"overrides",
"the",
"standard",
"filter_queryset",
"method",
".",
"This",
"method",
"will",
"check",
"to",
"see",
"if",
"the",
"view",
"calling",
"this",
"is",
"from",
"a",
"list",
"type",
"action",
".",
"This",
"function",
"will",
"also",
... | b2d4d3c76041f6c405e2537bea9639657b75b90e | https://github.com/dbkaplan/dry-rest-permissions/blob/b2d4d3c76041f6c405e2537bea9639657b75b90e/dry_rest_permissions/generics.py#L35-L49 | train |
dbkaplan/dry-rest-permissions | dry_rest_permissions/generics.py | DRYPermissions.has_permission | def has_permission(self, request, view):
"""
Overrides the standard function and figures out methods to call for global permissions.
"""
if not self.global_permissions:
return True
serializer_class = view.get_serializer_class()
assert serializer_class.Meta.m... | python | def has_permission(self, request, view):
"""
Overrides the standard function and figures out methods to call for global permissions.
"""
if not self.global_permissions:
return True
serializer_class = view.get_serializer_class()
assert serializer_class.Meta.m... | [
"def",
"has_permission",
"(",
"self",
",",
"request",
",",
"view",
")",
":",
"if",
"not",
"self",
".",
"global_permissions",
":",
"return",
"True",
"serializer_class",
"=",
"view",
".",
"get_serializer_class",
"(",
")",
"assert",
"serializer_class",
".",
"Meta... | Overrides the standard function and figures out methods to call for global permissions. | [
"Overrides",
"the",
"standard",
"function",
"and",
"figures",
"out",
"methods",
"to",
"call",
"for",
"global",
"permissions",
"."
] | b2d4d3c76041f6c405e2537bea9639657b75b90e | https://github.com/dbkaplan/dry-rest-permissions/blob/b2d4d3c76041f6c405e2537bea9639657b75b90e/dry_rest_permissions/generics.py#L97-L128 | train |
dbkaplan/dry-rest-permissions | dry_rest_permissions/generics.py | DRYPermissions.has_object_permission | def has_object_permission(self, request, view, obj):
"""
Overrides the standard function and figures out methods to call for object permissions.
"""
if not self.object_permissions:
return True
serializer_class = view.get_serializer_class()
model_class = seria... | python | def has_object_permission(self, request, view, obj):
"""
Overrides the standard function and figures out methods to call for object permissions.
"""
if not self.object_permissions:
return True
serializer_class = view.get_serializer_class()
model_class = seria... | [
"def",
"has_object_permission",
"(",
"self",
",",
"request",
",",
"view",
",",
"obj",
")",
":",
"if",
"not",
"self",
".",
"object_permissions",
":",
"return",
"True",
"serializer_class",
"=",
"view",
".",
"get_serializer_class",
"(",
")",
"model_class",
"=",
... | Overrides the standard function and figures out methods to call for object permissions. | [
"Overrides",
"the",
"standard",
"function",
"and",
"figures",
"out",
"methods",
"to",
"call",
"for",
"object",
"permissions",
"."
] | b2d4d3c76041f6c405e2537bea9639657b75b90e | https://github.com/dbkaplan/dry-rest-permissions/blob/b2d4d3c76041f6c405e2537bea9639657b75b90e/dry_rest_permissions/generics.py#L130-L154 | train |
dbkaplan/dry-rest-permissions | dry_rest_permissions/generics.py | DRYPermissions._get_action | def _get_action(self, action):
"""
Utility function that consolidates actions if necessary.
"""
return_action = action
if self.partial_update_is_update and action == 'partial_update':
return_action = 'update'
return return_action | python | def _get_action(self, action):
"""
Utility function that consolidates actions if necessary.
"""
return_action = action
if self.partial_update_is_update and action == 'partial_update':
return_action = 'update'
return return_action | [
"def",
"_get_action",
"(",
"self",
",",
"action",
")",
":",
"return_action",
"=",
"action",
"if",
"self",
".",
"partial_update_is_update",
"and",
"action",
"==",
"'partial_update'",
":",
"return_action",
"=",
"'update'",
"return",
"return_action"
] | Utility function that consolidates actions if necessary. | [
"Utility",
"function",
"that",
"consolidates",
"actions",
"if",
"necessary",
"."
] | b2d4d3c76041f6c405e2537bea9639657b75b90e | https://github.com/dbkaplan/dry-rest-permissions/blob/b2d4d3c76041f6c405e2537bea9639657b75b90e/dry_rest_permissions/generics.py#L156-L163 | train |
dbkaplan/dry-rest-permissions | dry_rest_permissions/generics.py | DRYPermissions._get_error_message | def _get_error_message(self, model_class, method_name, action_method_name):
"""
Get assertion error message depending if there are actions permissions methods defined.
"""
if action_method_name:
return "'{}' does not have '{}' or '{}' defined.".format(model_class, method_name... | python | def _get_error_message(self, model_class, method_name, action_method_name):
"""
Get assertion error message depending if there are actions permissions methods defined.
"""
if action_method_name:
return "'{}' does not have '{}' or '{}' defined.".format(model_class, method_name... | [
"def",
"_get_error_message",
"(",
"self",
",",
"model_class",
",",
"method_name",
",",
"action_method_name",
")",
":",
"if",
"action_method_name",
":",
"return",
"\"'{}' does not have '{}' or '{}' defined.\"",
".",
"format",
"(",
"model_class",
",",
"method_name",
",",
... | Get assertion error message depending if there are actions permissions methods defined. | [
"Get",
"assertion",
"error",
"message",
"depending",
"if",
"there",
"are",
"actions",
"permissions",
"methods",
"defined",
"."
] | b2d4d3c76041f6c405e2537bea9639657b75b90e | https://github.com/dbkaplan/dry-rest-permissions/blob/b2d4d3c76041f6c405e2537bea9639657b75b90e/dry_rest_permissions/generics.py#L165-L172 | train |
dbkaplan/dry-rest-permissions | dry_rest_permissions/generics.py | DRYPermissionsField.bind | def bind(self, field_name, parent):
"""
Check the model attached to the serializer to see what methods are defined and save them.
"""
assert parent.Meta.model is not None, \
"DRYPermissions is used on '{}' without a model".format(parent.__class__.__name__)
for action... | python | def bind(self, field_name, parent):
"""
Check the model attached to the serializer to see what methods are defined and save them.
"""
assert parent.Meta.model is not None, \
"DRYPermissions is used on '{}' without a model".format(parent.__class__.__name__)
for action... | [
"def",
"bind",
"(",
"self",
",",
"field_name",
",",
"parent",
")",
":",
"assert",
"parent",
".",
"Meta",
".",
"model",
"is",
"not",
"None",
",",
"\"DRYPermissions is used on '{}' without a model\"",
".",
"format",
"(",
"parent",
".",
"__class__",
".",
"__name_... | Check the model attached to the serializer to see what methods are defined and save them. | [
"Check",
"the",
"model",
"attached",
"to",
"the",
"serializer",
"to",
"see",
"what",
"methods",
"are",
"defined",
"and",
"save",
"them",
"."
] | b2d4d3c76041f6c405e2537bea9639657b75b90e | https://github.com/dbkaplan/dry-rest-permissions/blob/b2d4d3c76041f6c405e2537bea9639657b75b90e/dry_rest_permissions/generics.py#L229-L250 | train |
toastdriven/restless | restless/resources.py | skip_prepare | def skip_prepare(func):
"""
A convenience decorator for indicating the raw data should not be prepared.
"""
@wraps(func)
def _wrapper(self, *args, **kwargs):
value = func(self, *args, **kwargs)
return Data(value, should_prepare=False)
return _wrapper | python | def skip_prepare(func):
"""
A convenience decorator for indicating the raw data should not be prepared.
"""
@wraps(func)
def _wrapper(self, *args, **kwargs):
value = func(self, *args, **kwargs)
return Data(value, should_prepare=False)
return _wrapper | [
"def",
"skip_prepare",
"(",
"func",
")",
":",
"@",
"wraps",
"(",
"func",
")",
"def",
"_wrapper",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"value",
"=",
"func",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")"... | A convenience decorator for indicating the raw data should not be prepared. | [
"A",
"convenience",
"decorator",
"for",
"indicating",
"the",
"raw",
"data",
"should",
"not",
"be",
"prepared",
"."
] | 661593b7b43c42d1bc508dec795356297991255e | https://github.com/toastdriven/restless/blob/661593b7b43c42d1bc508dec795356297991255e/restless/resources.py#L12-L20 | train |
toastdriven/restless | restless/resources.py | Resource.build_error | def build_error(self, err):
"""
When an exception is encountered, this generates a JSON error message
for display to the user.
:param err: The exception seen. The message is exposed to the user, so
beware of sensitive data leaking.
:type err: Exception
:retu... | python | def build_error(self, err):
"""
When an exception is encountered, this generates a JSON error message
for display to the user.
:param err: The exception seen. The message is exposed to the user, so
beware of sensitive data leaking.
:type err: Exception
:retu... | [
"def",
"build_error",
"(",
"self",
",",
"err",
")",
":",
"data",
"=",
"{",
"'error'",
":",
"err",
".",
"args",
"[",
"0",
"]",
",",
"}",
"if",
"self",
".",
"is_debug",
"(",
")",
":",
"# Add the traceback.",
"data",
"[",
"'traceback'",
"]",
"=",
"for... | When an exception is encountered, this generates a JSON error message
for display to the user.
:param err: The exception seen. The message is exposed to the user, so
beware of sensitive data leaking.
:type err: Exception
:returns: A response object | [
"When",
"an",
"exception",
"is",
"encountered",
"this",
"generates",
"a",
"JSON",
"error",
"message",
"for",
"display",
"to",
"the",
"user",
"."
] | 661593b7b43c42d1bc508dec795356297991255e | https://github.com/toastdriven/restless/blob/661593b7b43c42d1bc508dec795356297991255e/restless/resources.py#L192-L213 | train |
toastdriven/restless | restless/resources.py | Resource.deserialize | def deserialize(self, method, endpoint, body):
"""
A convenience method for deserializing the body of a request.
If called on a list-style endpoint, this calls ``deserialize_list``.
Otherwise, it will call ``deserialize_detail``.
:param method: The HTTP method of the current re... | python | def deserialize(self, method, endpoint, body):
"""
A convenience method for deserializing the body of a request.
If called on a list-style endpoint, this calls ``deserialize_list``.
Otherwise, it will call ``deserialize_detail``.
:param method: The HTTP method of the current re... | [
"def",
"deserialize",
"(",
"self",
",",
"method",
",",
"endpoint",
",",
"body",
")",
":",
"if",
"endpoint",
"==",
"'list'",
":",
"return",
"self",
".",
"deserialize_list",
"(",
"body",
")",
"return",
"self",
".",
"deserialize_detail",
"(",
"body",
")"
] | A convenience method for deserializing the body of a request.
If called on a list-style endpoint, this calls ``deserialize_list``.
Otherwise, it will call ``deserialize_detail``.
:param method: The HTTP method of the current request
:type method: string
:param endpoint: The en... | [
"A",
"convenience",
"method",
"for",
"deserializing",
"the",
"body",
"of",
"a",
"request",
"."
] | 661593b7b43c42d1bc508dec795356297991255e | https://github.com/toastdriven/restless/blob/661593b7b43c42d1bc508dec795356297991255e/restless/resources.py#L310-L332 | train |
toastdriven/restless | restless/resources.py | Resource.serialize | def serialize(self, method, endpoint, data):
"""
A convenience method for serializing data for a response.
If called on a list-style endpoint, this calls ``serialize_list``.
Otherwise, it will call ``serialize_detail``.
:param method: The HTTP method of the current request
... | python | def serialize(self, method, endpoint, data):
"""
A convenience method for serializing data for a response.
If called on a list-style endpoint, this calls ``serialize_list``.
Otherwise, it will call ``serialize_detail``.
:param method: The HTTP method of the current request
... | [
"def",
"serialize",
"(",
"self",
",",
"method",
",",
"endpoint",
",",
"data",
")",
":",
"if",
"endpoint",
"==",
"'list'",
":",
"# Create is a special-case, because you POST it to the collection,",
"# not to a detail.",
"if",
"method",
"==",
"'POST'",
":",
"return",
... | A convenience method for serializing data for a response.
If called on a list-style endpoint, this calls ``serialize_list``.
Otherwise, it will call ``serialize_detail``.
:param method: The HTTP method of the current request
:type method: string
:param endpoint: The endpoint s... | [
"A",
"convenience",
"method",
"for",
"serializing",
"data",
"for",
"a",
"response",
"."
] | 661593b7b43c42d1bc508dec795356297991255e | https://github.com/toastdriven/restless/blob/661593b7b43c42d1bc508dec795356297991255e/restless/resources.py#L362-L388 | train |
toastdriven/restless | restless/tnd.py | _method | def _method(self, *args, **kwargs):
"""
the body of those http-methods used in tornado.web.RequestHandler
"""
yield self.resource_handler.handle(self.__resource_view_type__, *args, **kwargs) | python | def _method(self, *args, **kwargs):
"""
the body of those http-methods used in tornado.web.RequestHandler
"""
yield self.resource_handler.handle(self.__resource_view_type__, *args, **kwargs) | [
"def",
"_method",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"yield",
"self",
".",
"resource_handler",
".",
"handle",
"(",
"self",
".",
"__resource_view_type__",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")"
] | the body of those http-methods used in tornado.web.RequestHandler | [
"the",
"body",
"of",
"those",
"http",
"-",
"methods",
"used",
"in",
"tornado",
".",
"web",
".",
"RequestHandler"
] | 661593b7b43c42d1bc508dec795356297991255e | https://github.com/toastdriven/restless/blob/661593b7b43c42d1bc508dec795356297991255e/restless/tnd.py#L36-L40 | train |
toastdriven/restless | restless/tnd.py | TornadoResource.as_view | def as_view(cls, view_type, *init_args, **init_kwargs):
"""
Return a subclass of tornado.web.RequestHandler and
apply required setting.
"""
global _method
new_cls = type(
cls.__name__ + '_' + _BridgeMixin.__name__ + '_restless',
(_BridgeMixin, cls... | python | def as_view(cls, view_type, *init_args, **init_kwargs):
"""
Return a subclass of tornado.web.RequestHandler and
apply required setting.
"""
global _method
new_cls = type(
cls.__name__ + '_' + _BridgeMixin.__name__ + '_restless',
(_BridgeMixin, cls... | [
"def",
"as_view",
"(",
"cls",
",",
"view_type",
",",
"*",
"init_args",
",",
"*",
"*",
"init_kwargs",
")",
":",
"global",
"_method",
"new_cls",
"=",
"type",
"(",
"cls",
".",
"__name__",
"+",
"'_'",
"+",
"_BridgeMixin",
".",
"__name__",
"+",
"'_restless'",... | Return a subclass of tornado.web.RequestHandler and
apply required setting. | [
"Return",
"a",
"subclass",
"of",
"tornado",
".",
"web",
".",
"RequestHandler",
"and",
"apply",
"required",
"setting",
"."
] | 661593b7b43c42d1bc508dec795356297991255e | https://github.com/toastdriven/restless/blob/661593b7b43c42d1bc508dec795356297991255e/restless/tnd.py#L95-L123 | train |
toastdriven/restless | restless/tnd.py | TornadoResource.handle | def handle(self, endpoint, *args, **kwargs):
"""
almost identical to Resource.handle, except
the way we handle the return value of view_method.
"""
method = self.request_method()
try:
if not method in self.http_methods.get(endpoint, {}):
raise... | python | def handle(self, endpoint, *args, **kwargs):
"""
almost identical to Resource.handle, except
the way we handle the return value of view_method.
"""
method = self.request_method()
try:
if not method in self.http_methods.get(endpoint, {}):
raise... | [
"def",
"handle",
"(",
"self",
",",
"endpoint",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"method",
"=",
"self",
".",
"request_method",
"(",
")",
"try",
":",
"if",
"not",
"method",
"in",
"self",
".",
"http_methods",
".",
"get",
"(",
"endp... | almost identical to Resource.handle, except
the way we handle the return value of view_method. | [
"almost",
"identical",
"to",
"Resource",
".",
"handle",
"except",
"the",
"way",
"we",
"handle",
"the",
"return",
"value",
"of",
"view_method",
"."
] | 661593b7b43c42d1bc508dec795356297991255e | https://github.com/toastdriven/restless/blob/661593b7b43c42d1bc508dec795356297991255e/restless/tnd.py#L147-L177 | train |
toastdriven/restless | restless/preparers.py | FieldsPreparer.prepare | def prepare(self, data):
"""
Handles transforming the provided data into the fielded data that should
be exposed to the end user.
Uses the ``lookup_data`` method to traverse dotted paths.
Returns a dictionary of data as the response.
"""
result = {}
if ... | python | def prepare(self, data):
"""
Handles transforming the provided data into the fielded data that should
be exposed to the end user.
Uses the ``lookup_data`` method to traverse dotted paths.
Returns a dictionary of data as the response.
"""
result = {}
if ... | [
"def",
"prepare",
"(",
"self",
",",
"data",
")",
":",
"result",
"=",
"{",
"}",
"if",
"not",
"self",
".",
"fields",
":",
"# No fields specified. Serialize everything.",
"return",
"data",
"for",
"fieldname",
",",
"lookup",
"in",
"self",
".",
"fields",
".",
"... | Handles transforming the provided data into the fielded data that should
be exposed to the end user.
Uses the ``lookup_data`` method to traverse dotted paths.
Returns a dictionary of data as the response. | [
"Handles",
"transforming",
"the",
"provided",
"data",
"into",
"the",
"fielded",
"data",
"that",
"should",
"be",
"exposed",
"to",
"the",
"end",
"user",
"."
] | 661593b7b43c42d1bc508dec795356297991255e | https://github.com/toastdriven/restless/blob/661593b7b43c42d1bc508dec795356297991255e/restless/preparers.py#L42-L63 | train |
toastdriven/restless | restless/preparers.py | FieldsPreparer.lookup_data | def lookup_data(self, lookup, data):
"""
Given a lookup string, attempts to descend through nested data looking for
the value.
Can work with either dictionary-alikes or objects (or any combination of
those).
Lookups should be a string. If it is a dotted path, it will be... | python | def lookup_data(self, lookup, data):
"""
Given a lookup string, attempts to descend through nested data looking for
the value.
Can work with either dictionary-alikes or objects (or any combination of
those).
Lookups should be a string. If it is a dotted path, it will be... | [
"def",
"lookup_data",
"(",
"self",
",",
"lookup",
",",
"data",
")",
":",
"value",
"=",
"data",
"parts",
"=",
"lookup",
".",
"split",
"(",
"'.'",
")",
"if",
"not",
"parts",
"or",
"not",
"parts",
"[",
"0",
"]",
":",
"return",
"value",
"part",
"=",
... | Given a lookup string, attempts to descend through nested data looking for
the value.
Can work with either dictionary-alikes or objects (or any combination of
those).
Lookups should be a string. If it is a dotted path, it will be split on
``.`` & it will traverse through to fin... | [
"Given",
"a",
"lookup",
"string",
"attempts",
"to",
"descend",
"through",
"nested",
"data",
"looking",
"for",
"the",
"value",
"."
] | 661593b7b43c42d1bc508dec795356297991255e | https://github.com/toastdriven/restless/blob/661593b7b43c42d1bc508dec795356297991255e/restless/preparers.py#L65-L123 | train |
toastdriven/restless | restless/preparers.py | CollectionSubPreparer.prepare | def prepare(self, data):
"""
Handles passing each item in the collection data to the configured
subpreparer.
Uses a loop and the ``get_inner_data`` method to provide the correct
item of the data.
Returns a list of data as the response.
"""
result = []
... | python | def prepare(self, data):
"""
Handles passing each item in the collection data to the configured
subpreparer.
Uses a loop and the ``get_inner_data`` method to provide the correct
item of the data.
Returns a list of data as the response.
"""
result = []
... | [
"def",
"prepare",
"(",
"self",
",",
"data",
")",
":",
"result",
"=",
"[",
"]",
"for",
"item",
"in",
"self",
".",
"get_inner_data",
"(",
"data",
")",
":",
"result",
".",
"append",
"(",
"self",
".",
"preparer",
".",
"prepare",
"(",
"item",
")",
")",
... | Handles passing each item in the collection data to the configured
subpreparer.
Uses a loop and the ``get_inner_data`` method to provide the correct
item of the data.
Returns a list of data as the response. | [
"Handles",
"passing",
"each",
"item",
"in",
"the",
"collection",
"data",
"to",
"the",
"configured",
"subpreparer",
"."
] | 661593b7b43c42d1bc508dec795356297991255e | https://github.com/toastdriven/restless/blob/661593b7b43c42d1bc508dec795356297991255e/restless/preparers.py#L201-L216 | train |
toastdriven/restless | restless/dj.py | DjangoResource.build_url_name | def build_url_name(cls, name, name_prefix=None):
"""
Given a ``name`` & an optional ``name_prefix``, this generates a name
for a URL.
:param name: The name for the URL (ex. 'detail')
:type name: string
:param name_prefix: (Optional) A prefix for the URL's name (for
... | python | def build_url_name(cls, name, name_prefix=None):
"""
Given a ``name`` & an optional ``name_prefix``, this generates a name
for a URL.
:param name: The name for the URL (ex. 'detail')
:type name: string
:param name_prefix: (Optional) A prefix for the URL's name (for
... | [
"def",
"build_url_name",
"(",
"cls",
",",
"name",
",",
"name_prefix",
"=",
"None",
")",
":",
"if",
"name_prefix",
"is",
"None",
":",
"name_prefix",
"=",
"'api_{}'",
".",
"format",
"(",
"cls",
".",
"__name__",
".",
"replace",
"(",
"'Resource'",
",",
"''",... | Given a ``name`` & an optional ``name_prefix``, this generates a name
for a URL.
:param name: The name for the URL (ex. 'detail')
:type name: string
:param name_prefix: (Optional) A prefix for the URL's name (for
resolving). The default is ``None``, which will autocreate a ... | [
"Given",
"a",
"name",
"&",
"an",
"optional",
"name_prefix",
"this",
"generates",
"a",
"name",
"for",
"a",
"URL",
"."
] | 661593b7b43c42d1bc508dec795356297991255e | https://github.com/toastdriven/restless/blob/661593b7b43c42d1bc508dec795356297991255e/restless/dj.py#L90-L113 | train |
toastdriven/restless | restless/fl.py | FlaskResource.build_endpoint_name | def build_endpoint_name(cls, name, endpoint_prefix=None):
"""
Given a ``name`` & an optional ``endpoint_prefix``, this generates a name
for a URL.
:param name: The name for the URL (ex. 'detail')
:type name: string
:param endpoint_prefix: (Optional) A prefix for the URL... | python | def build_endpoint_name(cls, name, endpoint_prefix=None):
"""
Given a ``name`` & an optional ``endpoint_prefix``, this generates a name
for a URL.
:param name: The name for the URL (ex. 'detail')
:type name: string
:param endpoint_prefix: (Optional) A prefix for the URL... | [
"def",
"build_endpoint_name",
"(",
"cls",
",",
"name",
",",
"endpoint_prefix",
"=",
"None",
")",
":",
"if",
"endpoint_prefix",
"is",
"None",
":",
"endpoint_prefix",
"=",
"'api_{}'",
".",
"format",
"(",
"cls",
".",
"__name__",
".",
"replace",
"(",
"'Resource'... | Given a ``name`` & an optional ``endpoint_prefix``, this generates a name
for a URL.
:param name: The name for the URL (ex. 'detail')
:type name: string
:param endpoint_prefix: (Optional) A prefix for the URL's name (for
resolving). The default is ``None``, which will autoc... | [
"Given",
"a",
"name",
"&",
"an",
"optional",
"endpoint_prefix",
"this",
"generates",
"a",
"name",
"for",
"a",
"URL",
"."
] | 661593b7b43c42d1bc508dec795356297991255e | https://github.com/toastdriven/restless/blob/661593b7b43c42d1bc508dec795356297991255e/restless/fl.py#L59-L82 | train |
toastdriven/restless | restless/pyr.py | PyramidResource.build_routename | def build_routename(cls, name, routename_prefix=None):
"""
Given a ``name`` & an optional ``routename_prefix``, this generates a
name for a URL.
:param name: The name for the URL (ex. 'detail')
:type name: string
:param routename_prefix: (Optional) A prefix for the URL'... | python | def build_routename(cls, name, routename_prefix=None):
"""
Given a ``name`` & an optional ``routename_prefix``, this generates a
name for a URL.
:param name: The name for the URL (ex. 'detail')
:type name: string
:param routename_prefix: (Optional) A prefix for the URL'... | [
"def",
"build_routename",
"(",
"cls",
",",
"name",
",",
"routename_prefix",
"=",
"None",
")",
":",
"if",
"routename_prefix",
"is",
"None",
":",
"routename_prefix",
"=",
"'api_{}'",
".",
"format",
"(",
"cls",
".",
"__name__",
".",
"replace",
"(",
"'Resource'"... | Given a ``name`` & an optional ``routename_prefix``, this generates a
name for a URL.
:param name: The name for the URL (ex. 'detail')
:type name: string
:param routename_prefix: (Optional) A prefix for the URL's name (for
resolving). The default is ``None``, which will aut... | [
"Given",
"a",
"name",
"&",
"an",
"optional",
"routename_prefix",
"this",
"generates",
"a",
"name",
"for",
"a",
"URL",
"."
] | 661593b7b43c42d1bc508dec795356297991255e | https://github.com/toastdriven/restless/blob/661593b7b43c42d1bc508dec795356297991255e/restless/pyr.py#L41-L64 | train |
toastdriven/restless | restless/pyr.py | PyramidResource.add_views | def add_views(cls, config, rule_prefix, routename_prefix=None):
"""
A convenience method for registering the routes and views in pyramid.
This automatically adds a list and detail endpoint to your routes.
:param config: The pyramid ``Configurator`` object for your app.
:type co... | python | def add_views(cls, config, rule_prefix, routename_prefix=None):
"""
A convenience method for registering the routes and views in pyramid.
This automatically adds a list and detail endpoint to your routes.
:param config: The pyramid ``Configurator`` object for your app.
:type co... | [
"def",
"add_views",
"(",
"cls",
",",
"config",
",",
"rule_prefix",
",",
"routename_prefix",
"=",
"None",
")",
":",
"methods",
"=",
"(",
"'GET'",
",",
"'POST'",
",",
"'PUT'",
",",
"'DELETE'",
")",
"config",
".",
"add_route",
"(",
"cls",
".",
"build_routen... | A convenience method for registering the routes and views in pyramid.
This automatically adds a list and detail endpoint to your routes.
:param config: The pyramid ``Configurator`` object for your app.
:type config: ``pyramid.config.Configurator``
:param rule_prefix: The start of the ... | [
"A",
"convenience",
"method",
"for",
"registering",
"the",
"routes",
"and",
"views",
"in",
"pyramid",
"."
] | 661593b7b43c42d1bc508dec795356297991255e | https://github.com/toastdriven/restless/blob/661593b7b43c42d1bc508dec795356297991255e/restless/pyr.py#L67-L107 | train |
toastdriven/restless | restless/serializers.py | JSONSerializer.deserialize | def deserialize(self, body):
"""
The low-level deserialization.
Underpins ``deserialize``, ``deserialize_list`` &
``deserialize_detail``.
Has no built-in smarts, simply loads the JSON.
:param body: The body of the current request
:type body: string
:re... | python | def deserialize(self, body):
"""
The low-level deserialization.
Underpins ``deserialize``, ``deserialize_list`` &
``deserialize_detail``.
Has no built-in smarts, simply loads the JSON.
:param body: The body of the current request
:type body: string
:re... | [
"def",
"deserialize",
"(",
"self",
",",
"body",
")",
":",
"try",
":",
"if",
"isinstance",
"(",
"body",
",",
"bytes",
")",
":",
"return",
"json",
".",
"loads",
"(",
"body",
".",
"decode",
"(",
"'utf-8'",
")",
")",
"return",
"json",
".",
"loads",
"("... | The low-level deserialization.
Underpins ``deserialize``, ``deserialize_list`` &
``deserialize_detail``.
Has no built-in smarts, simply loads the JSON.
:param body: The body of the current request
:type body: string
:returns: The deserialized data
:rtype: ``li... | [
"The",
"low",
"-",
"level",
"deserialization",
"."
] | 661593b7b43c42d1bc508dec795356297991255e | https://github.com/toastdriven/restless/blob/661593b7b43c42d1bc508dec795356297991255e/restless/serializers.py#L47-L67 | train |
mila-iqia/fuel | fuel/converters/mnist.py | convert_mnist | def convert_mnist(directory, output_directory, output_filename=None,
dtype=None):
"""Converts the MNIST dataset to HDF5.
Converts the MNIST dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.MNIST`. The converted dataset is
saved as 'mnist.hdf5'.
This method assumes... | python | def convert_mnist(directory, output_directory, output_filename=None,
dtype=None):
"""Converts the MNIST dataset to HDF5.
Converts the MNIST dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.MNIST`. The converted dataset is
saved as 'mnist.hdf5'.
This method assumes... | [
"def",
"convert_mnist",
"(",
"directory",
",",
"output_directory",
",",
"output_filename",
"=",
"None",
",",
"dtype",
"=",
"None",
")",
":",
"if",
"not",
"output_filename",
":",
"if",
"dtype",
":",
"output_filename",
"=",
"'mnist_{}.hdf5'",
".",
"format",
"(",... | Converts the MNIST dataset to HDF5.
Converts the MNIST dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.MNIST`. The converted dataset is
saved as 'mnist.hdf5'.
This method assumes the existence of the following files:
`train-images-idx3-ubyte.gz`, `train-labels-idx1-ubyte.gz`
`... | [
"Converts",
"the",
"MNIST",
"dataset",
"to",
"HDF5",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/mnist.py#L22-L92 | train |
mila-iqia/fuel | fuel/converters/mnist.py | fill_subparser | def fill_subparser(subparser):
"""Sets up a subparser to convert the MNIST dataset files.
Parameters
----------
subparser : :class:`argparse.ArgumentParser`
Subparser handling the `mnist` command.
"""
subparser.add_argument(
"--dtype", help="dtype to save to; by default, images... | python | def fill_subparser(subparser):
"""Sets up a subparser to convert the MNIST dataset files.
Parameters
----------
subparser : :class:`argparse.ArgumentParser`
Subparser handling the `mnist` command.
"""
subparser.add_argument(
"--dtype", help="dtype to save to; by default, images... | [
"def",
"fill_subparser",
"(",
"subparser",
")",
":",
"subparser",
".",
"add_argument",
"(",
"\"--dtype\"",
",",
"help",
"=",
"\"dtype to save to; by default, images will be \"",
"+",
"\"returned in their original unsigned byte format\"",
",",
"choices",
"=",
"(",
"'float32'... | Sets up a subparser to convert the MNIST dataset files.
Parameters
----------
subparser : :class:`argparse.ArgumentParser`
Subparser handling the `mnist` command. | [
"Sets",
"up",
"a",
"subparser",
"to",
"convert",
"the",
"MNIST",
"dataset",
"files",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/mnist.py#L95-L108 | train |
mila-iqia/fuel | fuel/converters/mnist.py | read_mnist_images | def read_mnist_images(filename, dtype=None):
"""Read MNIST images from the original ubyte file format.
Parameters
----------
filename : str
Filename/path from which to read images.
dtype : 'float32', 'float64', or 'bool'
If unspecified, images will be returned in their original
... | python | def read_mnist_images(filename, dtype=None):
"""Read MNIST images from the original ubyte file format.
Parameters
----------
filename : str
Filename/path from which to read images.
dtype : 'float32', 'float64', or 'bool'
If unspecified, images will be returned in their original
... | [
"def",
"read_mnist_images",
"(",
"filename",
",",
"dtype",
"=",
"None",
")",
":",
"with",
"gzip",
".",
"open",
"(",
"filename",
",",
"'rb'",
")",
"as",
"f",
":",
"magic",
",",
"number",
",",
"rows",
",",
"cols",
"=",
"struct",
".",
"unpack",
"(",
"... | Read MNIST images from the original ubyte file format.
Parameters
----------
filename : str
Filename/path from which to read images.
dtype : 'float32', 'float64', or 'bool'
If unspecified, images will be returned in their original
unsigned byte format.
Returns
-------
... | [
"Read",
"MNIST",
"images",
"from",
"the",
"original",
"ubyte",
"file",
"format",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/mnist.py#L111-L159 | train |
mila-iqia/fuel | fuel/converters/mnist.py | read_mnist_labels | def read_mnist_labels(filename):
"""Read MNIST labels from the original ubyte file format.
Parameters
----------
filename : str
Filename/path from which to read labels.
Returns
-------
labels : :class:`~numpy.ndarray`, shape (nlabels, 1)
A one-dimensional unsigned byte arra... | python | def read_mnist_labels(filename):
"""Read MNIST labels from the original ubyte file format.
Parameters
----------
filename : str
Filename/path from which to read labels.
Returns
-------
labels : :class:`~numpy.ndarray`, shape (nlabels, 1)
A one-dimensional unsigned byte arra... | [
"def",
"read_mnist_labels",
"(",
"filename",
")",
":",
"with",
"gzip",
".",
"open",
"(",
"filename",
",",
"'rb'",
")",
"as",
"f",
":",
"magic",
",",
"_",
"=",
"struct",
".",
"unpack",
"(",
"'>ii'",
",",
"f",
".",
"read",
"(",
"8",
")",
")",
"if",... | Read MNIST labels from the original ubyte file format.
Parameters
----------
filename : str
Filename/path from which to read labels.
Returns
-------
labels : :class:`~numpy.ndarray`, shape (nlabels, 1)
A one-dimensional unsigned byte array containing the
labels as integ... | [
"Read",
"MNIST",
"labels",
"from",
"the",
"original",
"ubyte",
"file",
"format",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/mnist.py#L162-L183 | train |
mila-iqia/fuel | fuel/converters/ilsvrc2010.py | prepare_hdf5_file | def prepare_hdf5_file(hdf5_file, n_train, n_valid, n_test):
"""Create datasets within a given HDF5 file.
Parameters
----------
hdf5_file : :class:`h5py.File` instance
HDF5 file handle to which to write.
n_train : int
The number of training set examples.
n_valid : int
The... | python | def prepare_hdf5_file(hdf5_file, n_train, n_valid, n_test):
"""Create datasets within a given HDF5 file.
Parameters
----------
hdf5_file : :class:`h5py.File` instance
HDF5 file handle to which to write.
n_train : int
The number of training set examples.
n_valid : int
The... | [
"def",
"prepare_hdf5_file",
"(",
"hdf5_file",
",",
"n_train",
",",
"n_valid",
",",
"n_test",
")",
":",
"n_total",
"=",
"n_train",
"+",
"n_valid",
"+",
"n_test",
"splits",
"=",
"create_splits",
"(",
"n_train",
",",
"n_valid",
",",
"n_test",
")",
"hdf5_file",
... | Create datasets within a given HDF5 file.
Parameters
----------
hdf5_file : :class:`h5py.File` instance
HDF5 file handle to which to write.
n_train : int
The number of training set examples.
n_valid : int
The number of validation set examples.
n_test : int
The nu... | [
"Create",
"datasets",
"within",
"a",
"given",
"HDF5",
"file",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/ilsvrc2010.py#L179-L201 | train |
mila-iqia/fuel | fuel/converters/ilsvrc2010.py | process_train_set | def process_train_set(hdf5_file, train_archive, patch_archive, n_train,
wnid_map, shuffle_seed=None):
"""Process the ILSVRC2010 training set.
Parameters
----------
hdf5_file : :class:`h5py.File` instance
HDF5 file handle to which to write. Assumes `features`, `targets`
... | python | def process_train_set(hdf5_file, train_archive, patch_archive, n_train,
wnid_map, shuffle_seed=None):
"""Process the ILSVRC2010 training set.
Parameters
----------
hdf5_file : :class:`h5py.File` instance
HDF5 file handle to which to write. Assumes `features`, `targets`
... | [
"def",
"process_train_set",
"(",
"hdf5_file",
",",
"train_archive",
",",
"patch_archive",
",",
"n_train",
",",
"wnid_map",
",",
"shuffle_seed",
"=",
"None",
")",
":",
"producer",
"=",
"partial",
"(",
"train_set_producer",
",",
"train_archive",
"=",
"train_archive"... | Process the ILSVRC2010 training set.
Parameters
----------
hdf5_file : :class:`h5py.File` instance
HDF5 file handle to which to write. Assumes `features`, `targets`
and `filenames` already exist and have first dimension larger than
`n_train`.
train_archive : str or file-like ob... | [
"Process",
"the",
"ILSVRC2010",
"training",
"set",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/ilsvrc2010.py#L204-L232 | train |
mila-iqia/fuel | fuel/converters/ilsvrc2010.py | image_consumer | def image_consumer(socket, hdf5_file, num_expected, shuffle_seed=None,
offset=0):
"""Fill an HDF5 file with incoming images from a socket.
Parameters
----------
socket : :class:`zmq.Socket`
PULL socket on which to receive images.
hdf5_file : :class:`h5py.File` instance
... | python | def image_consumer(socket, hdf5_file, num_expected, shuffle_seed=None,
offset=0):
"""Fill an HDF5 file with incoming images from a socket.
Parameters
----------
socket : :class:`zmq.Socket`
PULL socket on which to receive images.
hdf5_file : :class:`h5py.File` instance
... | [
"def",
"image_consumer",
"(",
"socket",
",",
"hdf5_file",
",",
"num_expected",
",",
"shuffle_seed",
"=",
"None",
",",
"offset",
"=",
"0",
")",
":",
"with",
"progress_bar",
"(",
"'images'",
",",
"maxval",
"=",
"num_expected",
")",
"as",
"pb",
":",
"if",
"... | Fill an HDF5 file with incoming images from a socket.
Parameters
----------
socket : :class:`zmq.Socket`
PULL socket on which to receive images.
hdf5_file : :class:`h5py.File` instance
HDF5 file handle to which to write. Assumes `features`, `targets`
and `filenames` already exis... | [
"Fill",
"an",
"HDF5",
"file",
"with",
"incoming",
"images",
"from",
"a",
"socket",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/ilsvrc2010.py#L283-L316 | train |
mila-iqia/fuel | fuel/converters/ilsvrc2010.py | process_other_set | def process_other_set(hdf5_file, which_set, image_archive, patch_archive,
groundtruth, offset):
"""Process the validation or test set.
Parameters
----------
hdf5_file : :class:`h5py.File` instance
HDF5 file handle to which to write. Assumes `features`, `targets`
an... | python | def process_other_set(hdf5_file, which_set, image_archive, patch_archive,
groundtruth, offset):
"""Process the validation or test set.
Parameters
----------
hdf5_file : :class:`h5py.File` instance
HDF5 file handle to which to write. Assumes `features`, `targets`
an... | [
"def",
"process_other_set",
"(",
"hdf5_file",
",",
"which_set",
",",
"image_archive",
",",
"patch_archive",
",",
"groundtruth",
",",
"offset",
")",
":",
"producer",
"=",
"partial",
"(",
"other_set_producer",
",",
"image_archive",
"=",
"image_archive",
",",
"patch_... | Process the validation or test set.
Parameters
----------
hdf5_file : :class:`h5py.File` instance
HDF5 file handle to which to write. Assumes `features`, `targets`
and `filenames` already exist and have first dimension larger than
`sum(images_per_class)`.
which_set : str
... | [
"Process",
"the",
"validation",
"or",
"test",
"set",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/ilsvrc2010.py#L319-L349 | train |
mila-iqia/fuel | fuel/converters/ilsvrc2010.py | load_from_tar_or_patch | def load_from_tar_or_patch(tar, image_filename, patch_images):
"""Do everything necessary to process an image inside a TAR.
Parameters
----------
tar : `TarFile` instance
The tar from which to read `image_filename`.
image_filename : str
Fully-qualified path inside of `tar` from whic... | python | def load_from_tar_or_patch(tar, image_filename, patch_images):
"""Do everything necessary to process an image inside a TAR.
Parameters
----------
tar : `TarFile` instance
The tar from which to read `image_filename`.
image_filename : str
Fully-qualified path inside of `tar` from whic... | [
"def",
"load_from_tar_or_patch",
"(",
"tar",
",",
"image_filename",
",",
"patch_images",
")",
":",
"patched",
"=",
"True",
"image_bytes",
"=",
"patch_images",
".",
"get",
"(",
"os",
".",
"path",
".",
"basename",
"(",
"image_filename",
")",
",",
"None",
")",
... | Do everything necessary to process an image inside a TAR.
Parameters
----------
tar : `TarFile` instance
The tar from which to read `image_filename`.
image_filename : str
Fully-qualified path inside of `tar` from which to read an
image file.
patch_images : dict
A dic... | [
"Do",
"everything",
"necessary",
"to",
"process",
"an",
"image",
"inside",
"a",
"TAR",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/ilsvrc2010.py#L390-L426 | train |
mila-iqia/fuel | fuel/converters/ilsvrc2010.py | read_devkit | def read_devkit(f):
"""Read relevant information from the development kit archive.
Parameters
----------
f : str or file-like object
The filename or file-handle for the gzipped TAR archive
containing the ILSVRC2010 development kit.
Returns
-------
synsets : ndarray, 1-dimen... | python | def read_devkit(f):
"""Read relevant information from the development kit archive.
Parameters
----------
f : str or file-like object
The filename or file-handle for the gzipped TAR archive
containing the ILSVRC2010 development kit.
Returns
-------
synsets : ndarray, 1-dimen... | [
"def",
"read_devkit",
"(",
"f",
")",
":",
"with",
"tar_open",
"(",
"f",
")",
"as",
"tar",
":",
"# Metadata table containing class hierarchy, textual descriptions, etc.",
"meta_mat",
"=",
"tar",
".",
"extractfile",
"(",
"DEVKIT_META_PATH",
")",
"synsets",
",",
"cost_... | Read relevant information from the development kit archive.
Parameters
----------
f : str or file-like object
The filename or file-handle for the gzipped TAR archive
containing the ILSVRC2010 development kit.
Returns
-------
synsets : ndarray, 1-dimensional, compound dtype
... | [
"Read",
"relevant",
"information",
"from",
"the",
"development",
"kit",
"archive",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/ilsvrc2010.py#L429-L458 | train |
mila-iqia/fuel | fuel/converters/ilsvrc2010.py | extract_patch_images | def extract_patch_images(f, which_set):
"""Extracts a dict of the "patch images" for ILSVRC2010.
Parameters
----------
f : str or file-like object
The filename or file-handle to the patch images TAR file.
which_set : str
Which set of images to extract. One of 'train', 'valid', 'test... | python | def extract_patch_images(f, which_set):
"""Extracts a dict of the "patch images" for ILSVRC2010.
Parameters
----------
f : str or file-like object
The filename or file-handle to the patch images TAR file.
which_set : str
Which set of images to extract. One of 'train', 'valid', 'test... | [
"def",
"extract_patch_images",
"(",
"f",
",",
"which_set",
")",
":",
"if",
"which_set",
"not",
"in",
"(",
"'train'",
",",
"'valid'",
",",
"'test'",
")",
":",
"raise",
"ValueError",
"(",
"'which_set must be one of train, valid, or test'",
")",
"which_set",
"=",
"... | Extracts a dict of the "patch images" for ILSVRC2010.
Parameters
----------
f : str or file-like object
The filename or file-handle to the patch images TAR file.
which_set : str
Which set of images to extract. One of 'train', 'valid', 'test'.
Returns
-------
dict
A ... | [
"Extracts",
"a",
"dict",
"of",
"the",
"patch",
"images",
"for",
"ILSVRC2010",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/ilsvrc2010.py#L533-L573 | train |
mila-iqia/fuel | fuel/converters/cifar10.py | convert_cifar10 | def convert_cifar10(directory, output_directory,
output_filename='cifar10.hdf5'):
"""Converts the CIFAR-10 dataset to HDF5.
Converts the CIFAR-10 dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.CIFAR10`. The converted dataset is saved as
'cifar10.hdf5'.
It assu... | python | def convert_cifar10(directory, output_directory,
output_filename='cifar10.hdf5'):
"""Converts the CIFAR-10 dataset to HDF5.
Converts the CIFAR-10 dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.CIFAR10`. The converted dataset is saved as
'cifar10.hdf5'.
It assu... | [
"def",
"convert_cifar10",
"(",
"directory",
",",
"output_directory",
",",
"output_filename",
"=",
"'cifar10.hdf5'",
")",
":",
"output_path",
"=",
"os",
".",
"path",
".",
"join",
"(",
"output_directory",
",",
"output_filename",
")",
"h5file",
"=",
"h5py",
".",
... | Converts the CIFAR-10 dataset to HDF5.
Converts the CIFAR-10 dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.CIFAR10`. The converted dataset is saved as
'cifar10.hdf5'.
It assumes the existence of the following file:
* `cifar-10-python.tar.gz`
Parameters
----------
d... | [
"Converts",
"the",
"CIFAR",
"-",
"10",
"dataset",
"to",
"HDF5",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/cifar10.py#L15-L97 | train |
mila-iqia/fuel | fuel/converters/base.py | check_exists | def check_exists(required_files):
"""Decorator that checks if required files exist before running.
Parameters
----------
required_files : list of str
A list of strings indicating the filenames of regular files
(not directories) that should be found in the input directory
(which ... | python | def check_exists(required_files):
"""Decorator that checks if required files exist before running.
Parameters
----------
required_files : list of str
A list of strings indicating the filenames of regular files
(not directories) that should be found in the input directory
(which ... | [
"def",
"check_exists",
"(",
"required_files",
")",
":",
"def",
"function_wrapper",
"(",
"f",
")",
":",
"@",
"wraps",
"(",
"f",
")",
"def",
"wrapped",
"(",
"directory",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"missing",
"=",
"[",
"]",
"... | Decorator that checks if required files exist before running.
Parameters
----------
required_files : list of str
A list of strings indicating the filenames of regular files
(not directories) that should be found in the input directory
(which is the first argument to the wrapped func... | [
"Decorator",
"that",
"checks",
"if",
"required",
"files",
"exist",
"before",
"running",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/base.py#L13-L47 | train |
mila-iqia/fuel | fuel/converters/base.py | fill_hdf5_file | def fill_hdf5_file(h5file, data):
"""Fills an HDF5 file in a H5PYDataset-compatible manner.
Parameters
----------
h5file : :class:`h5py.File`
File handle for an HDF5 file.
data : tuple of tuple
One element per split/source pair. Each element consists of a
tuple of (split_nam... | python | def fill_hdf5_file(h5file, data):
"""Fills an HDF5 file in a H5PYDataset-compatible manner.
Parameters
----------
h5file : :class:`h5py.File`
File handle for an HDF5 file.
data : tuple of tuple
One element per split/source pair. Each element consists of a
tuple of (split_nam... | [
"def",
"fill_hdf5_file",
"(",
"h5file",
",",
"data",
")",
":",
"# Check that all sources for a split have the same length",
"split_names",
"=",
"set",
"(",
"split_tuple",
"[",
"0",
"]",
"for",
"split_tuple",
"in",
"data",
")",
"for",
"name",
"in",
"split_names",
"... | Fills an HDF5 file in a H5PYDataset-compatible manner.
Parameters
----------
h5file : :class:`h5py.File`
File handle for an HDF5 file.
data : tuple of tuple
One element per split/source pair. Each element consists of a
tuple of (split_name, source_name, data_array, comment), whe... | [
"Fills",
"an",
"HDF5",
"file",
"in",
"a",
"H5PYDataset",
"-",
"compatible",
"manner",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/base.py#L50-L103 | train |
mila-iqia/fuel | fuel/converters/base.py | progress_bar | def progress_bar(name, maxval, prefix='Converting'):
"""Manages a progress bar for a conversion.
Parameters
----------
name : str
Name of the file being converted.
maxval : int
Total number of steps for the conversion.
"""
widgets = ['{} {}: '.format(prefix, name), Percenta... | python | def progress_bar(name, maxval, prefix='Converting'):
"""Manages a progress bar for a conversion.
Parameters
----------
name : str
Name of the file being converted.
maxval : int
Total number of steps for the conversion.
"""
widgets = ['{} {}: '.format(prefix, name), Percenta... | [
"def",
"progress_bar",
"(",
"name",
",",
"maxval",
",",
"prefix",
"=",
"'Converting'",
")",
":",
"widgets",
"=",
"[",
"'{} {}: '",
".",
"format",
"(",
"prefix",
",",
"name",
")",
",",
"Percentage",
"(",
")",
",",
"' '",
",",
"Bar",
"(",
"marker",
"="... | Manages a progress bar for a conversion.
Parameters
----------
name : str
Name of the file being converted.
maxval : int
Total number of steps for the conversion. | [
"Manages",
"a",
"progress",
"bar",
"for",
"a",
"conversion",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/base.py#L107-L125 | train |
mila-iqia/fuel | fuel/converters/iris.py | convert_iris | def convert_iris(directory, output_directory, output_filename='iris.hdf5'):
"""Convert the Iris dataset to HDF5.
Converts the Iris dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.Iris`. The converted dataset is
saved as 'iris.hdf5'.
This method assumes the existence of the file `ir... | python | def convert_iris(directory, output_directory, output_filename='iris.hdf5'):
"""Convert the Iris dataset to HDF5.
Converts the Iris dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.Iris`. The converted dataset is
saved as 'iris.hdf5'.
This method assumes the existence of the file `ir... | [
"def",
"convert_iris",
"(",
"directory",
",",
"output_directory",
",",
"output_filename",
"=",
"'iris.hdf5'",
")",
":",
"classes",
"=",
"{",
"b'Iris-setosa'",
":",
"0",
",",
"b'Iris-versicolor'",
":",
"1",
",",
"b'Iris-virginica'",
":",
"2",
"}",
"data",
"=",
... | Convert the Iris dataset to HDF5.
Converts the Iris dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.Iris`. The converted dataset is
saved as 'iris.hdf5'.
This method assumes the existence of the file `iris.data`.
Parameters
----------
directory : str
Directory in w... | [
"Convert",
"the",
"Iris",
"dataset",
"to",
"HDF5",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/iris.py#L9-L54 | train |
mila-iqia/fuel | fuel/downloaders/ilsvrc2012.py | fill_subparser | def fill_subparser(subparser):
"""Sets up a subparser to download the ILSVRC2012 dataset files.
Note that you will need to use `--url-prefix` to download the
non-public files (namely, the TARs of images). This is a single
prefix that is common to all distributed files, which you can
obtain by regis... | python | def fill_subparser(subparser):
"""Sets up a subparser to download the ILSVRC2012 dataset files.
Note that you will need to use `--url-prefix` to download the
non-public files (namely, the TARs of images). This is a single
prefix that is common to all distributed files, which you can
obtain by regis... | [
"def",
"fill_subparser",
"(",
"subparser",
")",
":",
"urls",
"=",
"(",
"[",
"None",
"]",
"*",
"len",
"(",
"ALL_FILES",
")",
")",
"filenames",
"=",
"list",
"(",
"ALL_FILES",
")",
"subparser",
".",
"set_defaults",
"(",
"urls",
"=",
"urls",
",",
"filename... | Sets up a subparser to download the ILSVRC2012 dataset files.
Note that you will need to use `--url-prefix` to download the
non-public files (namely, the TARs of images). This is a single
prefix that is common to all distributed files, which you can
obtain by registering at the ImageNet website [DOWNLO... | [
"Sets",
"up",
"a",
"subparser",
"to",
"download",
"the",
"ILSVRC2012",
"dataset",
"files",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/downloaders/ilsvrc2012.py#L5-L32 | train |
mila-iqia/fuel | fuel/transformers/sequences.py | Window._get_target_index | def _get_target_index(self):
"""Return the index where the target window starts."""
return (self.index + self.source_window * (not self.overlapping) +
self.offset) | python | def _get_target_index(self):
"""Return the index where the target window starts."""
return (self.index + self.source_window * (not self.overlapping) +
self.offset) | [
"def",
"_get_target_index",
"(",
"self",
")",
":",
"return",
"(",
"self",
".",
"index",
"+",
"self",
".",
"source_window",
"*",
"(",
"not",
"self",
".",
"overlapping",
")",
"+",
"self",
".",
"offset",
")"
] | Return the index where the target window starts. | [
"Return",
"the",
"index",
"where",
"the",
"target",
"window",
"starts",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/transformers/sequences.py#L66-L69 | train |
mila-iqia/fuel | fuel/transformers/sequences.py | Window._get_end_index | def _get_end_index(self):
"""Return the end of both windows."""
return max(self.index + self.source_window,
self._get_target_index() + self.target_window) | python | def _get_end_index(self):
"""Return the end of both windows."""
return max(self.index + self.source_window,
self._get_target_index() + self.target_window) | [
"def",
"_get_end_index",
"(",
"self",
")",
":",
"return",
"max",
"(",
"self",
".",
"index",
"+",
"self",
".",
"source_window",
",",
"self",
".",
"_get_target_index",
"(",
")",
"+",
"self",
".",
"target_window",
")"
] | Return the end of both windows. | [
"Return",
"the",
"end",
"of",
"both",
"windows",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/transformers/sequences.py#L71-L74 | train |
mila-iqia/fuel | fuel/converters/svhn.py | convert_svhn | def convert_svhn(which_format, directory, output_directory,
output_filename=None):
"""Converts the SVHN dataset to HDF5.
Converts the SVHN dataset [SVHN] to an HDF5 dataset compatible
with :class:`fuel.datasets.SVHN`. The converted dataset is
saved as 'svhn_format_1.hdf5' or 'svhn_form... | python | def convert_svhn(which_format, directory, output_directory,
output_filename=None):
"""Converts the SVHN dataset to HDF5.
Converts the SVHN dataset [SVHN] to an HDF5 dataset compatible
with :class:`fuel.datasets.SVHN`. The converted dataset is
saved as 'svhn_format_1.hdf5' or 'svhn_form... | [
"def",
"convert_svhn",
"(",
"which_format",
",",
"directory",
",",
"output_directory",
",",
"output_filename",
"=",
"None",
")",
":",
"if",
"which_format",
"not",
"in",
"(",
"1",
",",
"2",
")",
":",
"raise",
"ValueError",
"(",
"\"SVHN format needs to be either 1... | Converts the SVHN dataset to HDF5.
Converts the SVHN dataset [SVHN] to an HDF5 dataset compatible
with :class:`fuel.datasets.SVHN`. The converted dataset is
saved as 'svhn_format_1.hdf5' or 'svhn_format_2.hdf5', depending
on the `which_format` argument.
.. [SVHN] Yuval Netzer, Tao Wang, Adam Coate... | [
"Converts",
"the",
"SVHN",
"dataset",
"to",
"HDF5",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/svhn.py#L327-L369 | train |
mila-iqia/fuel | fuel/utils/formats.py | open_ | def open_(filename, mode='r', encoding=None):
"""Open a text file with encoding and optional gzip compression.
Note that on legacy Python any encoding other than ``None`` or opening
GZipped files will return an unpicklable file-like object.
Parameters
----------
filename : str
The file... | python | def open_(filename, mode='r', encoding=None):
"""Open a text file with encoding and optional gzip compression.
Note that on legacy Python any encoding other than ``None`` or opening
GZipped files will return an unpicklable file-like object.
Parameters
----------
filename : str
The file... | [
"def",
"open_",
"(",
"filename",
",",
"mode",
"=",
"'r'",
",",
"encoding",
"=",
"None",
")",
":",
"if",
"filename",
".",
"endswith",
"(",
"'.gz'",
")",
":",
"if",
"six",
".",
"PY2",
":",
"zf",
"=",
"io",
".",
"BufferedReader",
"(",
"gzip",
".",
"... | Open a text file with encoding and optional gzip compression.
Note that on legacy Python any encoding other than ``None`` or opening
GZipped files will return an unpicklable file-like object.
Parameters
----------
filename : str
The filename to read.
mode : str, optional
The mo... | [
"Open",
"a",
"text",
"file",
"with",
"encoding",
"and",
"optional",
"gzip",
"compression",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/utils/formats.py#L9-L45 | train |
mila-iqia/fuel | fuel/utils/formats.py | tar_open | def tar_open(f):
"""Open either a filename or a file-like object as a TarFile.
Parameters
----------
f : str or file-like object
The filename or file-like object from which to read.
Returns
-------
TarFile
A `TarFile` instance.
"""
if isinstance(f, six.string_types... | python | def tar_open(f):
"""Open either a filename or a file-like object as a TarFile.
Parameters
----------
f : str or file-like object
The filename or file-like object from which to read.
Returns
-------
TarFile
A `TarFile` instance.
"""
if isinstance(f, six.string_types... | [
"def",
"tar_open",
"(",
"f",
")",
":",
"if",
"isinstance",
"(",
"f",
",",
"six",
".",
"string_types",
")",
":",
"return",
"tarfile",
".",
"open",
"(",
"name",
"=",
"f",
")",
"else",
":",
"return",
"tarfile",
".",
"open",
"(",
"fileobj",
"=",
"f",
... | Open either a filename or a file-like object as a TarFile.
Parameters
----------
f : str or file-like object
The filename or file-like object from which to read.
Returns
-------
TarFile
A `TarFile` instance. | [
"Open",
"either",
"a",
"filename",
"or",
"a",
"file",
"-",
"like",
"object",
"as",
"a",
"TarFile",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/utils/formats.py#L48-L65 | train |
mila-iqia/fuel | fuel/utils/cache.py | copy_from_server_to_local | def copy_from_server_to_local(dataset_remote_dir, dataset_local_dir,
remote_fname, local_fname):
"""Copies a remote file locally.
Parameters
----------
remote_fname : str
Remote file to copy
local_fname : str
Path and name of the local copy to be made o... | python | def copy_from_server_to_local(dataset_remote_dir, dataset_local_dir,
remote_fname, local_fname):
"""Copies a remote file locally.
Parameters
----------
remote_fname : str
Remote file to copy
local_fname : str
Path and name of the local copy to be made o... | [
"def",
"copy_from_server_to_local",
"(",
"dataset_remote_dir",
",",
"dataset_local_dir",
",",
"remote_fname",
",",
"local_fname",
")",
":",
"log",
".",
"debug",
"(",
"\"Copying file `{}` to a local directory `{}`.\"",
".",
"format",
"(",
"remote_fname",
",",
"dataset_loca... | Copies a remote file locally.
Parameters
----------
remote_fname : str
Remote file to copy
local_fname : str
Path and name of the local copy to be made of the remote file. | [
"Copies",
"a",
"remote",
"file",
"locally",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/utils/cache.py#L217-L269 | train |
mila-iqia/fuel | fuel/converters/adult.py | convert_to_one_hot | def convert_to_one_hot(y):
"""
converts y into one hot reprsentation.
Parameters
----------
y : list
A list containing continous integer values.
Returns
-------
one_hot : numpy.ndarray
A numpy.ndarray object, which is one-hot representation of y.
"""
max_value ... | python | def convert_to_one_hot(y):
"""
converts y into one hot reprsentation.
Parameters
----------
y : list
A list containing continous integer values.
Returns
-------
one_hot : numpy.ndarray
A numpy.ndarray object, which is one-hot representation of y.
"""
max_value ... | [
"def",
"convert_to_one_hot",
"(",
"y",
")",
":",
"max_value",
"=",
"max",
"(",
"y",
")",
"min_value",
"=",
"min",
"(",
"y",
")",
"length",
"=",
"len",
"(",
"y",
")",
"one_hot",
"=",
"numpy",
".",
"zeros",
"(",
"(",
"length",
",",
"(",
"max_value",
... | converts y into one hot reprsentation.
Parameters
----------
y : list
A list containing continous integer values.
Returns
-------
one_hot : numpy.ndarray
A numpy.ndarray object, which is one-hot representation of y. | [
"converts",
"y",
"into",
"one",
"hot",
"reprsentation",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/adult.py#L9-L29 | train |
mila-iqia/fuel | fuel/converters/binarized_mnist.py | convert_binarized_mnist | def convert_binarized_mnist(directory, output_directory,
output_filename='binarized_mnist.hdf5'):
"""Converts the binarized MNIST dataset to HDF5.
Converts the binarized MNIST dataset used in R. Salakhutdinov's DBN
paper [DBN] to an HDF5 dataset compatible with
:class:`fuel.... | python | def convert_binarized_mnist(directory, output_directory,
output_filename='binarized_mnist.hdf5'):
"""Converts the binarized MNIST dataset to HDF5.
Converts the binarized MNIST dataset used in R. Salakhutdinov's DBN
paper [DBN] to an HDF5 dataset compatible with
:class:`fuel.... | [
"def",
"convert_binarized_mnist",
"(",
"directory",
",",
"output_directory",
",",
"output_filename",
"=",
"'binarized_mnist.hdf5'",
")",
":",
"output_path",
"=",
"os",
".",
"path",
".",
"join",
"(",
"output_directory",
",",
"output_filename",
")",
"h5file",
"=",
"... | Converts the binarized MNIST dataset to HDF5.
Converts the binarized MNIST dataset used in R. Salakhutdinov's DBN
paper [DBN] to an HDF5 dataset compatible with
:class:`fuel.datasets.BinarizedMNIST`. The converted dataset is
saved as 'binarized_mnist.hdf5'.
This method assumes the existence of the... | [
"Converts",
"the",
"binarized",
"MNIST",
"dataset",
"to",
"HDF5",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/binarized_mnist.py#L17-L71 | train |
mila-iqia/fuel | fuel/downloaders/cifar10.py | fill_subparser | def fill_subparser(subparser):
"""Sets up a subparser to download the CIFAR-10 dataset file.
The CIFAR-10 dataset file is downloaded from Alex Krizhevsky's
website [ALEX].
Parameters
----------
subparser : :class:`argparse.ArgumentParser`
Subparser handling the `cifar10` command.
... | python | def fill_subparser(subparser):
"""Sets up a subparser to download the CIFAR-10 dataset file.
The CIFAR-10 dataset file is downloaded from Alex Krizhevsky's
website [ALEX].
Parameters
----------
subparser : :class:`argparse.ArgumentParser`
Subparser handling the `cifar10` command.
... | [
"def",
"fill_subparser",
"(",
"subparser",
")",
":",
"url",
"=",
"'http://www.cs.toronto.edu/~kriz/cifar-10-python.tar.gz'",
"filename",
"=",
"'cifar-10-python.tar.gz'",
"subparser",
".",
"set_defaults",
"(",
"urls",
"=",
"[",
"url",
"]",
",",
"filenames",
"=",
"[",
... | Sets up a subparser to download the CIFAR-10 dataset file.
The CIFAR-10 dataset file is downloaded from Alex Krizhevsky's
website [ALEX].
Parameters
----------
subparser : :class:`argparse.ArgumentParser`
Subparser handling the `cifar10` command. | [
"Sets",
"up",
"a",
"subparser",
"to",
"download",
"the",
"CIFAR",
"-",
"10",
"dataset",
"file",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/downloaders/cifar10.py#L4-L19 | train |
mila-iqia/fuel | fuel/converters/celeba.py | convert_celeba_aligned_cropped | def convert_celeba_aligned_cropped(directory, output_directory,
output_filename=OUTPUT_FILENAME):
"""Converts the aligned and cropped CelebA dataset to HDF5.
Converts the CelebA dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.CelebA`. The converted datase... | python | def convert_celeba_aligned_cropped(directory, output_directory,
output_filename=OUTPUT_FILENAME):
"""Converts the aligned and cropped CelebA dataset to HDF5.
Converts the CelebA dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.CelebA`. The converted datase... | [
"def",
"convert_celeba_aligned_cropped",
"(",
"directory",
",",
"output_directory",
",",
"output_filename",
"=",
"OUTPUT_FILENAME",
")",
":",
"output_path",
"=",
"os",
".",
"path",
".",
"join",
"(",
"output_directory",
",",
"output_filename",
")",
"h5file",
"=",
"... | Converts the aligned and cropped CelebA dataset to HDF5.
Converts the CelebA dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.CelebA`. The converted dataset is saved as
'celeba_aligned_cropped.hdf5'.
It assumes the existence of the following files:
* `img_align_celeba.zip`
* `... | [
"Converts",
"the",
"aligned",
"and",
"cropped",
"CelebA",
"dataset",
"to",
"HDF5",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/celeba.py#L55-L102 | train |
mila-iqia/fuel | fuel/converters/celeba.py | convert_celeba | def convert_celeba(which_format, directory, output_directory,
output_filename=None):
"""Converts the CelebA dataset to HDF5.
Converts the CelebA dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.CelebA`. The converted dataset is
saved as 'celeba_aligned_cropped.hdf5' o... | python | def convert_celeba(which_format, directory, output_directory,
output_filename=None):
"""Converts the CelebA dataset to HDF5.
Converts the CelebA dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.CelebA`. The converted dataset is
saved as 'celeba_aligned_cropped.hdf5' o... | [
"def",
"convert_celeba",
"(",
"which_format",
",",
"directory",
",",
"output_directory",
",",
"output_filename",
"=",
"None",
")",
":",
"if",
"which_format",
"not",
"in",
"(",
"'aligned_cropped'",
",",
"'64'",
")",
":",
"raise",
"ValueError",
"(",
"\"CelebA form... | Converts the CelebA dataset to HDF5.
Converts the CelebA dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.CelebA`. The converted dataset is
saved as 'celeba_aligned_cropped.hdf5' or 'celeba_64.hdf5',
depending on the `which_format` argument.
Parameters
----------
which_form... | [
"Converts",
"the",
"CelebA",
"dataset",
"to",
"HDF5",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/celeba.py#L159-L198 | train |
mila-iqia/fuel | fuel/utils/disk.py | disk_usage | def disk_usage(path):
"""Return free usage about the given path, in bytes.
Parameters
----------
path : str
Folder for which to return disk usage
Returns
-------
output : tuple
Tuple containing total space in the folder and currently
used space in the folder
""... | python | def disk_usage(path):
"""Return free usage about the given path, in bytes.
Parameters
----------
path : str
Folder for which to return disk usage
Returns
-------
output : tuple
Tuple containing total space in the folder and currently
used space in the folder
""... | [
"def",
"disk_usage",
"(",
"path",
")",
":",
"st",
"=",
"os",
".",
"statvfs",
"(",
"path",
")",
"total",
"=",
"st",
".",
"f_blocks",
"*",
"st",
".",
"f_frsize",
"used",
"=",
"(",
"st",
".",
"f_blocks",
"-",
"st",
".",
"f_bfree",
")",
"*",
"st",
... | Return free usage about the given path, in bytes.
Parameters
----------
path : str
Folder for which to return disk usage
Returns
-------
output : tuple
Tuple containing total space in the folder and currently
used space in the folder | [
"Return",
"free",
"usage",
"about",
"the",
"given",
"path",
"in",
"bytes",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/utils/disk.py#L39-L57 | train |
mila-iqia/fuel | fuel/utils/disk.py | safe_mkdir | def safe_mkdir(folder_name, force_perm=None):
"""Create the specified folder.
If the parent folders do not exist, they are also created.
If the folder already exists, nothing is done.
Parameters
----------
folder_name : str
Name of the folder to create.
force_perm : str
Mod... | python | def safe_mkdir(folder_name, force_perm=None):
"""Create the specified folder.
If the parent folders do not exist, they are also created.
If the folder already exists, nothing is done.
Parameters
----------
folder_name : str
Name of the folder to create.
force_perm : str
Mod... | [
"def",
"safe_mkdir",
"(",
"folder_name",
",",
"force_perm",
"=",
"None",
")",
":",
"if",
"os",
".",
"path",
".",
"exists",
"(",
"folder_name",
")",
":",
"return",
"intermediary_folders",
"=",
"folder_name",
".",
"split",
"(",
"os",
".",
"path",
".",
"sep... | Create the specified folder.
If the parent folders do not exist, they are also created.
If the folder already exists, nothing is done.
Parameters
----------
folder_name : str
Name of the folder to create.
force_perm : str
Mode to use for folder creation. | [
"Create",
"the",
"specified",
"folder",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/utils/disk.py#L60-L93 | train |
mila-iqia/fuel | fuel/utils/disk.py | check_enough_space | def check_enough_space(dataset_local_dir, remote_fname, local_fname,
max_disk_usage=0.9):
"""Check if the given local folder has enough space.
Check if the given local folder has enough space to store
the specified remote file.
Parameters
----------
remote_fname : str
... | python | def check_enough_space(dataset_local_dir, remote_fname, local_fname,
max_disk_usage=0.9):
"""Check if the given local folder has enough space.
Check if the given local folder has enough space to store
the specified remote file.
Parameters
----------
remote_fname : str
... | [
"def",
"check_enough_space",
"(",
"dataset_local_dir",
",",
"remote_fname",
",",
"local_fname",
",",
"max_disk_usage",
"=",
"0.9",
")",
":",
"storage_need",
"=",
"os",
".",
"path",
".",
"getsize",
"(",
"remote_fname",
")",
"storage_total",
",",
"storage_used",
"... | Check if the given local folder has enough space.
Check if the given local folder has enough space to store
the specified remote file.
Parameters
----------
remote_fname : str
Path to the remote file
remote_fname : str
Path to the local folder
max_disk_usage : float
... | [
"Check",
"if",
"the",
"given",
"local",
"folder",
"has",
"enough",
"space",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/utils/disk.py#L96-L126 | train |
mila-iqia/fuel | fuel/converters/cifar100.py | convert_cifar100 | def convert_cifar100(directory, output_directory,
output_filename='cifar100.hdf5'):
"""Converts the CIFAR-100 dataset to HDF5.
Converts the CIFAR-100 dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.CIFAR100`. The converted dataset is saved as
'cifar100.hdf5'.
... | python | def convert_cifar100(directory, output_directory,
output_filename='cifar100.hdf5'):
"""Converts the CIFAR-100 dataset to HDF5.
Converts the CIFAR-100 dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.CIFAR100`. The converted dataset is saved as
'cifar100.hdf5'.
... | [
"def",
"convert_cifar100",
"(",
"directory",
",",
"output_directory",
",",
"output_filename",
"=",
"'cifar100.hdf5'",
")",
":",
"output_path",
"=",
"os",
".",
"path",
".",
"join",
"(",
"output_directory",
",",
"output_filename",
")",
"h5file",
"=",
"h5py",
".",
... | Converts the CIFAR-100 dataset to HDF5.
Converts the CIFAR-100 dataset to an HDF5 dataset compatible with
:class:`fuel.datasets.CIFAR100`. The converted dataset is saved as
'cifar100.hdf5'.
This method assumes the existence of the following file:
`cifar-100-python.tar.gz`
Parameters
-----... | [
"Converts",
"the",
"CIFAR",
"-",
"100",
"dataset",
"to",
"HDF5",
"."
] | 1d6292dc25e3a115544237e392e61bff6631d23c | https://github.com/mila-iqia/fuel/blob/1d6292dc25e3a115544237e392e61bff6631d23c/fuel/converters/cifar100.py#L15-L95 | train |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.