id int32 0 252k | 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 51 19.8k | code_tokens list | docstring stringlengths 3 17.3k | docstring_tokens list | sha stringlengths 40 40 | url stringlengths 87 242 |
|---|---|---|---|---|---|---|---|---|---|---|---|
200 | has2k1/plydata | plydata/dataframe/one_table.py | _nth | def _nth(arr, n):
"""
Return the nth value of array
If it is missing return NaN
"""
try:
return arr.iloc[n]
except (KeyError, IndexError):
return np.nan | python | def _nth(arr, n):
try:
return arr.iloc[n]
except (KeyError, IndexError):
return np.nan | [
"def",
"_nth",
"(",
"arr",
",",
"n",
")",
":",
"try",
":",
"return",
"arr",
".",
"iloc",
"[",
"n",
"]",
"except",
"(",
"KeyError",
",",
"IndexError",
")",
":",
"return",
"np",
".",
"nan"
] | Return the nth value of array
If it is missing return NaN | [
"Return",
"the",
"nth",
"value",
"of",
"array"
] | d8ca85ff70eee621e96f7c74034e90fec16e8b61 | https://github.com/has2k1/plydata/blob/d8ca85ff70eee621e96f7c74034e90fec16e8b61/plydata/dataframe/one_table.py#L217-L226 |
201 | tkarabela/pysubs2 | pysubs2/time.py | make_time | def make_time(h=0, m=0, s=0, ms=0, frames=None, fps=None):
"""
Convert time to milliseconds.
See :func:`pysubs2.time.times_to_ms()`. When both frames and fps are specified,
:func:`pysubs2.time.frames_to_ms()` is called instead.
Raises:
ValueError: Invalid fps, or one of frames/fps is missi... | python | def make_time(h=0, m=0, s=0, ms=0, frames=None, fps=None):
if frames is None and fps is None:
return times_to_ms(h, m, s, ms)
elif frames is not None and fps is not None:
return frames_to_ms(frames, fps)
else:
raise ValueError("Both fps and frames must be specified") | [
"def",
"make_time",
"(",
"h",
"=",
"0",
",",
"m",
"=",
"0",
",",
"s",
"=",
"0",
",",
"ms",
"=",
"0",
",",
"frames",
"=",
"None",
",",
"fps",
"=",
"None",
")",
":",
"if",
"frames",
"is",
"None",
"and",
"fps",
"is",
"None",
":",
"return",
"ti... | Convert time to milliseconds.
See :func:`pysubs2.time.times_to_ms()`. When both frames and fps are specified,
:func:`pysubs2.time.frames_to_ms()` is called instead.
Raises:
ValueError: Invalid fps, or one of frames/fps is missing.
Example:
>>> make_time(s=1.5)
1500
>>>... | [
"Convert",
"time",
"to",
"milliseconds",
"."
] | 6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f | https://github.com/tkarabela/pysubs2/blob/6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f/pysubs2/time.py#L12-L34 |
202 | tkarabela/pysubs2 | pysubs2/ssaevent.py | SSAEvent.shift | def shift(self, h=0, m=0, s=0, ms=0, frames=None, fps=None):
"""
Shift start and end times.
See :meth:`SSAFile.shift()` for full description.
"""
delta = make_time(h=h, m=m, s=s, ms=ms, frames=frames, fps=fps)
self.start += delta
self.end += delta | python | def shift(self, h=0, m=0, s=0, ms=0, frames=None, fps=None):
delta = make_time(h=h, m=m, s=s, ms=ms, frames=frames, fps=fps)
self.start += delta
self.end += delta | [
"def",
"shift",
"(",
"self",
",",
"h",
"=",
"0",
",",
"m",
"=",
"0",
",",
"s",
"=",
"0",
",",
"ms",
"=",
"0",
",",
"frames",
"=",
"None",
",",
"fps",
"=",
"None",
")",
":",
"delta",
"=",
"make_time",
"(",
"h",
"=",
"h",
",",
"m",
"=",
"... | Shift start and end times.
See :meth:`SSAFile.shift()` for full description. | [
"Shift",
"start",
"and",
"end",
"times",
"."
] | 6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f | https://github.com/tkarabela/pysubs2/blob/6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f/pysubs2/ssaevent.py#L105-L114 |
203 | tkarabela/pysubs2 | pysubs2/ssaevent.py | SSAEvent.equals | def equals(self, other):
"""Field-based equality for SSAEvents."""
if isinstance(other, SSAEvent):
return self.as_dict() == other.as_dict()
else:
raise TypeError("Cannot compare to non-SSAEvent object") | python | def equals(self, other):
if isinstance(other, SSAEvent):
return self.as_dict() == other.as_dict()
else:
raise TypeError("Cannot compare to non-SSAEvent object") | [
"def",
"equals",
"(",
"self",
",",
"other",
")",
":",
"if",
"isinstance",
"(",
"other",
",",
"SSAEvent",
")",
":",
"return",
"self",
".",
"as_dict",
"(",
")",
"==",
"other",
".",
"as_dict",
"(",
")",
"else",
":",
"raise",
"TypeError",
"(",
"\"Cannot ... | Field-based equality for SSAEvents. | [
"Field",
"-",
"based",
"equality",
"for",
"SSAEvents",
"."
] | 6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f | https://github.com/tkarabela/pysubs2/blob/6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f/pysubs2/ssaevent.py#L123-L128 |
204 | tkarabela/pysubs2 | pysubs2/ssafile.py | SSAFile.load | def load(cls, path, encoding="utf-8", format_=None, fps=None, **kwargs):
"""
Load subtitle file from given path.
Arguments:
path (str): Path to subtitle file.
encoding (str): Character encoding of input file.
Defaults to UTF-8, you may need to change this... | python | def load(cls, path, encoding="utf-8", format_=None, fps=None, **kwargs):
with open(path, encoding=encoding) as fp:
return cls.from_file(fp, format_, fps=fps, **kwargs) | [
"def",
"load",
"(",
"cls",
",",
"path",
",",
"encoding",
"=",
"\"utf-8\"",
",",
"format_",
"=",
"None",
",",
"fps",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"with",
"open",
"(",
"path",
",",
"encoding",
"=",
"encoding",
")",
"as",
"fp",
":... | Load subtitle file from given path.
Arguments:
path (str): Path to subtitle file.
encoding (str): Character encoding of input file.
Defaults to UTF-8, you may need to change this.
format_ (str): Optional, forces use of specific parser
(eg. `"s... | [
"Load",
"subtitle",
"file",
"from",
"given",
"path",
"."
] | 6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f | https://github.com/tkarabela/pysubs2/blob/6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f/pysubs2/ssafile.py#L52-L92 |
205 | tkarabela/pysubs2 | pysubs2/ssafile.py | SSAFile.from_string | def from_string(cls, string, format_=None, fps=None, **kwargs):
"""
Load subtitle file from string.
See :meth:`SSAFile.load()` for full description.
Arguments:
string (str): Subtitle file in a string. Note that the string
must be Unicode (in Python 2).
... | python | def from_string(cls, string, format_=None, fps=None, **kwargs):
fp = io.StringIO(string)
return cls.from_file(fp, format_, fps=fps, **kwargs) | [
"def",
"from_string",
"(",
"cls",
",",
"string",
",",
"format_",
"=",
"None",
",",
"fps",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"fp",
"=",
"io",
".",
"StringIO",
"(",
"string",
")",
"return",
"cls",
".",
"from_file",
"(",
"fp",
",",
"fo... | Load subtitle file from string.
See :meth:`SSAFile.load()` for full description.
Arguments:
string (str): Subtitle file in a string. Note that the string
must be Unicode (in Python 2).
Returns:
SSAFile
Example:
>>> text = '''
... | [
"Load",
"subtitle",
"file",
"from",
"string",
"."
] | 6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f | https://github.com/tkarabela/pysubs2/blob/6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f/pysubs2/ssafile.py#L95-L118 |
206 | tkarabela/pysubs2 | pysubs2/ssafile.py | SSAFile.from_file | def from_file(cls, fp, format_=None, fps=None, **kwargs):
"""
Read subtitle file from file object.
See :meth:`SSAFile.load()` for full description.
Note:
This is a low-level method. Usually, one of :meth:`SSAFile.load()`
or :meth:`SSAFile.from_string()` is prefe... | python | def from_file(cls, fp, format_=None, fps=None, **kwargs):
if format_ is None:
# Autodetect subtitle format, then read again using correct parser.
# The file might be a pipe and we need to read it twice,
# so just buffer everything.
text = fp.read()
fra... | [
"def",
"from_file",
"(",
"cls",
",",
"fp",
",",
"format_",
"=",
"None",
",",
"fps",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"format_",
"is",
"None",
":",
"# Autodetect subtitle format, then read again using correct parser.",
"# The file might be a pi... | Read subtitle file from file object.
See :meth:`SSAFile.load()` for full description.
Note:
This is a low-level method. Usually, one of :meth:`SSAFile.load()`
or :meth:`SSAFile.from_string()` is preferable.
Arguments:
fp (file object): A file object, ie. :c... | [
"Read",
"subtitle",
"file",
"from",
"file",
"object",
"."
] | 6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f | https://github.com/tkarabela/pysubs2/blob/6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f/pysubs2/ssafile.py#L121-L153 |
207 | tkarabela/pysubs2 | pysubs2/ssafile.py | SSAFile.save | def save(self, path, encoding="utf-8", format_=None, fps=None, **kwargs):
"""
Save subtitle file to given path.
Arguments:
path (str): Path to subtitle file.
encoding (str): Character encoding of output file.
Defaults to UTF-8, which should be fine for mo... | python | def save(self, path, encoding="utf-8", format_=None, fps=None, **kwargs):
if format_ is None:
ext = os.path.splitext(path)[1].lower()
format_ = get_format_identifier(ext)
with open(path, "w", encoding=encoding) as fp:
self.to_file(fp, format_, fps=fps, **kwargs) | [
"def",
"save",
"(",
"self",
",",
"path",
",",
"encoding",
"=",
"\"utf-8\"",
",",
"format_",
"=",
"None",
",",
"fps",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"format_",
"is",
"None",
":",
"ext",
"=",
"os",
".",
"path",
".",
"splitext... | Save subtitle file to given path.
Arguments:
path (str): Path to subtitle file.
encoding (str): Character encoding of output file.
Defaults to UTF-8, which should be fine for most purposes.
format_ (str): Optional, specifies desired subtitle format
... | [
"Save",
"subtitle",
"file",
"to",
"given",
"path",
"."
] | 6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f | https://github.com/tkarabela/pysubs2/blob/6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f/pysubs2/ssafile.py#L155-L190 |
208 | tkarabela/pysubs2 | pysubs2/ssafile.py | SSAFile.to_string | def to_string(self, format_, fps=None, **kwargs):
"""
Get subtitle file as a string.
See :meth:`SSAFile.save()` for full description.
Returns:
str
"""
fp = io.StringIO()
self.to_file(fp, format_, fps=fps, **kwargs)
return fp.getvalue() | python | def to_string(self, format_, fps=None, **kwargs):
fp = io.StringIO()
self.to_file(fp, format_, fps=fps, **kwargs)
return fp.getvalue() | [
"def",
"to_string",
"(",
"self",
",",
"format_",
",",
"fps",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"fp",
"=",
"io",
".",
"StringIO",
"(",
")",
"self",
".",
"to_file",
"(",
"fp",
",",
"format_",
",",
"fps",
"=",
"fps",
",",
"*",
"*",
... | Get subtitle file as a string.
See :meth:`SSAFile.save()` for full description.
Returns:
str | [
"Get",
"subtitle",
"file",
"as",
"a",
"string",
"."
] | 6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f | https://github.com/tkarabela/pysubs2/blob/6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f/pysubs2/ssafile.py#L192-L204 |
209 | tkarabela/pysubs2 | pysubs2/ssafile.py | SSAFile.to_file | def to_file(self, fp, format_, fps=None, **kwargs):
"""
Write subtitle file to file object.
See :meth:`SSAFile.save()` for full description.
Note:
This is a low-level method. Usually, one of :meth:`SSAFile.save()`
or :meth:`SSAFile.to_string()` is preferable.
... | python | def to_file(self, fp, format_, fps=None, **kwargs):
impl = get_format_class(format_)
impl.to_file(self, fp, format_, fps=fps, **kwargs) | [
"def",
"to_file",
"(",
"self",
",",
"fp",
",",
"format_",
",",
"fps",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"impl",
"=",
"get_format_class",
"(",
"format_",
")",
"impl",
".",
"to_file",
"(",
"self",
",",
"fp",
",",
"format_",
",",
"fps",
... | Write subtitle file to file object.
See :meth:`SSAFile.save()` for full description.
Note:
This is a low-level method. Usually, one of :meth:`SSAFile.save()`
or :meth:`SSAFile.to_string()` is preferable.
Arguments:
fp (file object): A file object, ie. :clas... | [
"Write",
"subtitle",
"file",
"to",
"file",
"object",
"."
] | 6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f | https://github.com/tkarabela/pysubs2/blob/6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f/pysubs2/ssafile.py#L206-L222 |
210 | tkarabela/pysubs2 | pysubs2/ssafile.py | SSAFile.rename_style | def rename_style(self, old_name, new_name):
"""
Rename a style, including references to it.
Arguments:
old_name (str): Style to be renamed.
new_name (str): New name for the style (must be unused).
Raises:
KeyError: No style named old_name.
... | python | def rename_style(self, old_name, new_name):
if old_name not in self.styles:
raise KeyError("Style %r not found" % old_name)
if new_name in self.styles:
raise ValueError("There is already a style called %r" % new_name)
if not is_valid_field_content(new_name):
r... | [
"def",
"rename_style",
"(",
"self",
",",
"old_name",
",",
"new_name",
")",
":",
"if",
"old_name",
"not",
"in",
"self",
".",
"styles",
":",
"raise",
"KeyError",
"(",
"\"Style %r not found\"",
"%",
"old_name",
")",
"if",
"new_name",
"in",
"self",
".",
"style... | Rename a style, including references to it.
Arguments:
old_name (str): Style to be renamed.
new_name (str): New name for the style (must be unused).
Raises:
KeyError: No style named old_name.
ValueError: new_name is not a legal name (cannot use commas)
... | [
"Rename",
"a",
"style",
"including",
"references",
"to",
"it",
"."
] | 6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f | https://github.com/tkarabela/pysubs2/blob/6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f/pysubs2/ssafile.py#L277-L304 |
211 | tkarabela/pysubs2 | pysubs2/ssafile.py | SSAFile.import_styles | def import_styles(self, subs, overwrite=True):
"""
Merge in styles from other SSAFile.
Arguments:
subs (SSAFile): Subtitle file imported from.
overwrite (bool): On name conflict, use style from the other file
(default: True).
"""
if not i... | python | def import_styles(self, subs, overwrite=True):
if not isinstance(subs, SSAFile):
raise TypeError("Must supply an SSAFile.")
for name, style in subs.styles.items():
if name not in self.styles or overwrite:
self.styles[name] = style | [
"def",
"import_styles",
"(",
"self",
",",
"subs",
",",
"overwrite",
"=",
"True",
")",
":",
"if",
"not",
"isinstance",
"(",
"subs",
",",
"SSAFile",
")",
":",
"raise",
"TypeError",
"(",
"\"Must supply an SSAFile.\"",
")",
"for",
"name",
",",
"style",
"in",
... | Merge in styles from other SSAFile.
Arguments:
subs (SSAFile): Subtitle file imported from.
overwrite (bool): On name conflict, use style from the other file
(default: True). | [
"Merge",
"in",
"styles",
"from",
"other",
"SSAFile",
"."
] | 6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f | https://github.com/tkarabela/pysubs2/blob/6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f/pysubs2/ssafile.py#L306-L321 |
212 | tkarabela/pysubs2 | pysubs2/ssafile.py | SSAFile.equals | def equals(self, other):
"""
Equality of two SSAFiles.
Compares :attr:`SSAFile.info`, :attr:`SSAFile.styles` and :attr:`SSAFile.events`.
Order of entries in OrderedDicts does not matter. "ScriptType" key in info is
considered an implementation detail and thus ignored.
U... | python | def equals(self, other):
if isinstance(other, SSAFile):
for key in set(chain(self.info.keys(), other.info.keys())) - {"ScriptType"}:
sv, ov = self.info.get(key), other.info.get(key)
if sv is None:
logging.debug("%r missing in self.info", key)
... | [
"def",
"equals",
"(",
"self",
",",
"other",
")",
":",
"if",
"isinstance",
"(",
"other",
",",
"SSAFile",
")",
":",
"for",
"key",
"in",
"set",
"(",
"chain",
"(",
"self",
".",
"info",
".",
"keys",
"(",
")",
",",
"other",
".",
"info",
".",
"keys",
... | Equality of two SSAFiles.
Compares :attr:`SSAFile.info`, :attr:`SSAFile.styles` and :attr:`SSAFile.events`.
Order of entries in OrderedDicts does not matter. "ScriptType" key in info is
considered an implementation detail and thus ignored.
Useful mostly in unit tests. Differences are l... | [
"Equality",
"of",
"two",
"SSAFiles",
"."
] | 6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f | https://github.com/tkarabela/pysubs2/blob/6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f/pysubs2/ssafile.py#L327-L379 |
213 | tkarabela/pysubs2 | pysubs2/formats.py | get_file_extension | def get_file_extension(format_):
"""Format identifier -> file extension"""
if format_ not in FORMAT_IDENTIFIER_TO_FORMAT_CLASS:
raise UnknownFormatIdentifierError(format_)
for ext, f in FILE_EXTENSION_TO_FORMAT_IDENTIFIER.items():
if f == format_:
return ext
raise RuntimeEr... | python | def get_file_extension(format_):
if format_ not in FORMAT_IDENTIFIER_TO_FORMAT_CLASS:
raise UnknownFormatIdentifierError(format_)
for ext, f in FILE_EXTENSION_TO_FORMAT_IDENTIFIER.items():
if f == format_:
return ext
raise RuntimeError("No file extension for format %r" % format... | [
"def",
"get_file_extension",
"(",
"format_",
")",
":",
"if",
"format_",
"not",
"in",
"FORMAT_IDENTIFIER_TO_FORMAT_CLASS",
":",
"raise",
"UnknownFormatIdentifierError",
"(",
"format_",
")",
"for",
"ext",
",",
"f",
"in",
"FILE_EXTENSION_TO_FORMAT_IDENTIFIER",
".",
"item... | Format identifier -> file extension | [
"Format",
"identifier",
"-",
">",
"file",
"extension"
] | 6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f | https://github.com/tkarabela/pysubs2/blob/6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f/pysubs2/formats.py#L42-L51 |
214 | tkarabela/pysubs2 | pysubs2/formats.py | autodetect_format | def autodetect_format(content):
"""Return format identifier for given fragment or raise FormatAutodetectionError."""
formats = set()
for impl in FORMAT_IDENTIFIER_TO_FORMAT_CLASS.values():
guess = impl.guess_format(content)
if guess is not None:
formats.add(guess)
if len(for... | python | def autodetect_format(content):
formats = set()
for impl in FORMAT_IDENTIFIER_TO_FORMAT_CLASS.values():
guess = impl.guess_format(content)
if guess is not None:
formats.add(guess)
if len(formats) == 1:
return formats.pop()
elif not formats:
raise FormatAutode... | [
"def",
"autodetect_format",
"(",
"content",
")",
":",
"formats",
"=",
"set",
"(",
")",
"for",
"impl",
"in",
"FORMAT_IDENTIFIER_TO_FORMAT_CLASS",
".",
"values",
"(",
")",
":",
"guess",
"=",
"impl",
".",
"guess_format",
"(",
"content",
")",
"if",
"guess",
"i... | Return format identifier for given fragment or raise FormatAutodetectionError. | [
"Return",
"format",
"identifier",
"for",
"given",
"fragment",
"or",
"raise",
"FormatAutodetectionError",
"."
] | 6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f | https://github.com/tkarabela/pysubs2/blob/6439eb5159e6aa6b47e0f8e1d950e8bdd7c5341f/pysubs2/formats.py#L53-L66 |
215 | aio-libs/aiohttp-devtools | aiohttp_devtools/runserver/serve.py | src_reload | async def src_reload(app, path: str = None):
"""
prompt each connected browser to reload by sending websocket message.
:param path: if supplied this must be a path relative to app['static_path'],
eg. reload of a single file is only supported for static resources.
:return: number of sources relo... | python | async def src_reload(app, path: str = None):
cli_count = len(app[WS])
if cli_count == 0:
return 0
is_html = None
if path:
path = str(Path(app['static_url']) / Path(path).relative_to(app['static_path']))
is_html = mimetypes.guess_type(path)[0] == 'text/html'
reloads = 0
... | [
"async",
"def",
"src_reload",
"(",
"app",
",",
"path",
":",
"str",
"=",
"None",
")",
":",
"cli_count",
"=",
"len",
"(",
"app",
"[",
"WS",
"]",
")",
"if",
"cli_count",
"==",
"0",
":",
"return",
"0",
"is_html",
"=",
"None",
"if",
"path",
":",
"path... | prompt each connected browser to reload by sending websocket message.
:param path: if supplied this must be a path relative to app['static_path'],
eg. reload of a single file is only supported for static resources.
:return: number of sources reloaded | [
"prompt",
"each",
"connected",
"browser",
"to",
"reload",
"by",
"sending",
"websocket",
"message",
"."
] | e9ea6feb43558e6e64595ea0ea5613f226cba81f | https://github.com/aio-libs/aiohttp-devtools/blob/e9ea6feb43558e6e64595ea0ea5613f226cba81f/aiohttp_devtools/runserver/serve.py#L145-L186 |
216 | aio-libs/aiohttp-devtools | aiohttp_devtools/start/template/app/settings.py | Settings.substitute_environ | def substitute_environ(self):
"""
Substitute environment variables into settings.
"""
for attr_name in dir(self):
if attr_name.startswith('_') or attr_name.upper() != attr_name:
continue
orig_value = getattr(self, attr_name)
is_require... | python | def substitute_environ(self):
for attr_name in dir(self):
if attr_name.startswith('_') or attr_name.upper() != attr_name:
continue
orig_value = getattr(self, attr_name)
is_required = isinstance(orig_value, Required)
orig_type = orig_value.v_type i... | [
"def",
"substitute_environ",
"(",
"self",
")",
":",
"for",
"attr_name",
"in",
"dir",
"(",
"self",
")",
":",
"if",
"attr_name",
".",
"startswith",
"(",
"'_'",
")",
"or",
"attr_name",
".",
"upper",
"(",
")",
"!=",
"attr_name",
":",
"continue",
"orig_value"... | Substitute environment variables into settings. | [
"Substitute",
"environment",
"variables",
"into",
"settings",
"."
] | e9ea6feb43558e6e64595ea0ea5613f226cba81f | https://github.com/aio-libs/aiohttp-devtools/blob/e9ea6feb43558e6e64595ea0ea5613f226cba81f/aiohttp_devtools/start/template/app/settings.py#L48-L76 |
217 | aio-libs/aiohttp-devtools | aiohttp_devtools/cli.py | serve | def serve(path, livereload, port, verbose):
"""
Serve static files from a directory.
"""
setup_logging(verbose)
run_app(*serve_static(static_path=path, livereload=livereload, port=port)) | python | def serve(path, livereload, port, verbose):
setup_logging(verbose)
run_app(*serve_static(static_path=path, livereload=livereload, port=port)) | [
"def",
"serve",
"(",
"path",
",",
"livereload",
",",
"port",
",",
"verbose",
")",
":",
"setup_logging",
"(",
"verbose",
")",
"run_app",
"(",
"*",
"serve_static",
"(",
"static_path",
"=",
"path",
",",
"livereload",
"=",
"livereload",
",",
"port",
"=",
"po... | Serve static files from a directory. | [
"Serve",
"static",
"files",
"from",
"a",
"directory",
"."
] | e9ea6feb43558e6e64595ea0ea5613f226cba81f | https://github.com/aio-libs/aiohttp-devtools/blob/e9ea6feb43558e6e64595ea0ea5613f226cba81f/aiohttp_devtools/cli.py#L38-L43 |
218 | aio-libs/aiohttp-devtools | aiohttp_devtools/cli.py | runserver | def runserver(**config):
"""
Run a development server for an aiohttp apps.
Takes one argument "app-path" which should be a path to either a directory containing a recognized default file
("app.py" or "main.py") or to a specific file. Defaults to the environment variable "AIO_APP_PATH" or ".".
The ... | python | def runserver(**config):
active_config = {k: v for k, v in config.items() if v is not None}
setup_logging(config['verbose'])
try:
run_app(*_runserver(**active_config))
except AiohttpDevException as e:
if config['verbose']:
tb = click.style(traceback.format_exc().strip('\n'), ... | [
"def",
"runserver",
"(",
"*",
"*",
"config",
")",
":",
"active_config",
"=",
"{",
"k",
":",
"v",
"for",
"k",
",",
"v",
"in",
"config",
".",
"items",
"(",
")",
"if",
"v",
"is",
"not",
"None",
"}",
"setup_logging",
"(",
"config",
"[",
"'verbose'",
... | Run a development server for an aiohttp apps.
Takes one argument "app-path" which should be a path to either a directory containing a recognized default file
("app.py" or "main.py") or to a specific file. Defaults to the environment variable "AIO_APP_PATH" or ".".
The app path is run directly, see the "--... | [
"Run",
"a",
"development",
"server",
"for",
"an",
"aiohttp",
"apps",
"."
] | e9ea6feb43558e6e64595ea0ea5613f226cba81f | https://github.com/aio-libs/aiohttp-devtools/blob/e9ea6feb43558e6e64595ea0ea5613f226cba81f/aiohttp_devtools/cli.py#L73-L92 |
219 | loads/molotov | molotov/api.py | scenario | def scenario(weight=1, delay=0.0, name=None):
"""Decorator to register a function as a Molotov test.
Options:
- **weight** used by Molotov when the scenarii are randomly picked.
The functions with the highest values are more likely to be picked.
Integer, defaults to 1. This value is ignored wh... | python | def scenario(weight=1, delay=0.0, name=None):
def _scenario(func, *args, **kw):
_check_coroutine(func)
if weight > 0:
sname = name or func.__name__
data = {'name': sname,
'weight': weight, 'delay': delay,
'func': func, 'args': args, 'kw... | [
"def",
"scenario",
"(",
"weight",
"=",
"1",
",",
"delay",
"=",
"0.0",
",",
"name",
"=",
"None",
")",
":",
"def",
"_scenario",
"(",
"func",
",",
"*",
"args",
",",
"*",
"*",
"kw",
")",
":",
"_check_coroutine",
"(",
"func",
")",
"if",
"weight",
">",... | Decorator to register a function as a Molotov test.
Options:
- **weight** used by Molotov when the scenarii are randomly picked.
The functions with the highest values are more likely to be picked.
Integer, defaults to 1. This value is ignored when the
*scenario_picker* decorator is used.
... | [
"Decorator",
"to",
"register",
"a",
"function",
"as",
"a",
"Molotov",
"test",
"."
] | bd2c94e7f250e1fbb21940f02c68b4437655bc11 | https://github.com/loads/molotov/blob/bd2c94e7f250e1fbb21940f02c68b4437655bc11/molotov/api.py#L24-L56 |
220 | loads/molotov | molotov/util.py | request | def request(endpoint, verb='GET', session_options=None, **options):
"""Performs a synchronous request.
Uses a dedicated event loop and aiohttp.ClientSession object.
Options:
- endpoint: the endpoint to call
- verb: the HTTP verb to use (defaults: GET)
- session_options: a dict containing opti... | python | def request(endpoint, verb='GET', session_options=None, **options):
req = functools.partial(_request, endpoint, verb, session_options,
**options)
return _run_in_fresh_loop(req) | [
"def",
"request",
"(",
"endpoint",
",",
"verb",
"=",
"'GET'",
",",
"session_options",
"=",
"None",
",",
"*",
"*",
"options",
")",
":",
"req",
"=",
"functools",
".",
"partial",
"(",
"_request",
",",
"endpoint",
",",
"verb",
",",
"session_options",
",",
... | Performs a synchronous request.
Uses a dedicated event loop and aiohttp.ClientSession object.
Options:
- endpoint: the endpoint to call
- verb: the HTTP verb to use (defaults: GET)
- session_options: a dict containing options to initialize the session
(defaults: None)
- options: extra o... | [
"Performs",
"a",
"synchronous",
"request",
"."
] | bd2c94e7f250e1fbb21940f02c68b4437655bc11 | https://github.com/loads/molotov/blob/bd2c94e7f250e1fbb21940f02c68b4437655bc11/molotov/util.py#L179-L200 |
221 | loads/molotov | molotov/util.py | get_var | def get_var(name, factory=None):
"""Gets a global variable given its name.
If factory is not None and the variable is not set, factory
is a callable that will set the variable.
If not set, returns None.
"""
if name not in _VARS and factory is not None:
_VARS[name] = factory()
retur... | python | def get_var(name, factory=None):
if name not in _VARS and factory is not None:
_VARS[name] = factory()
return _VARS.get(name) | [
"def",
"get_var",
"(",
"name",
",",
"factory",
"=",
"None",
")",
":",
"if",
"name",
"not",
"in",
"_VARS",
"and",
"factory",
"is",
"not",
"None",
":",
"_VARS",
"[",
"name",
"]",
"=",
"factory",
"(",
")",
"return",
"_VARS",
".",
"get",
"(",
"name",
... | Gets a global variable given its name.
If factory is not None and the variable is not set, factory
is a callable that will set the variable.
If not set, returns None. | [
"Gets",
"a",
"global",
"variable",
"given",
"its",
"name",
"."
] | bd2c94e7f250e1fbb21940f02c68b4437655bc11 | https://github.com/loads/molotov/blob/bd2c94e7f250e1fbb21940f02c68b4437655bc11/molotov/util.py#L225-L235 |
222 | loads/molotov | molotov/worker.py | Worker.step | async def step(self, step_id, session, scenario=None):
""" single scenario call.
When it returns 1, it works. -1 the script failed,
0 the test is stopping or needs to stop.
"""
if scenario is None:
scenario = pick_scenario(self.wid, step_id)
try:
... | python | async def step(self, step_id, session, scenario=None):
if scenario is None:
scenario = pick_scenario(self.wid, step_id)
try:
await self.send_event('scenario_start', scenario=scenario)
await scenario['func'](session, *scenario['args'],
... | [
"async",
"def",
"step",
"(",
"self",
",",
"step_id",
",",
"session",
",",
"scenario",
"=",
"None",
")",
":",
"if",
"scenario",
"is",
"None",
":",
"scenario",
"=",
"pick_scenario",
"(",
"self",
".",
"wid",
",",
"step_id",
")",
"try",
":",
"await",
"se... | single scenario call.
When it returns 1, it works. -1 the script failed,
0 the test is stopping or needs to stop. | [
"single",
"scenario",
"call",
"."
] | bd2c94e7f250e1fbb21940f02c68b4437655bc11 | https://github.com/loads/molotov/blob/bd2c94e7f250e1fbb21940f02c68b4437655bc11/molotov/worker.py#L194-L221 |
223 | loads/molotov | molotov/slave.py | main | def main():
"""Moloslave clones a git repo and runs a molotov test
"""
parser = argparse.ArgumentParser(description='Github-based load test')
parser.add_argument('--version', action='store_true', default=False,
help='Displays version and exits.')
parser.add_argument('--virt... | python | def main():
parser = argparse.ArgumentParser(description='Github-based load test')
parser.add_argument('--version', action='store_true', default=False,
help='Displays version and exits.')
parser.add_argument('--virtualenv', type=str, default='virtualenv',
he... | [
"def",
"main",
"(",
")",
":",
"parser",
"=",
"argparse",
".",
"ArgumentParser",
"(",
"description",
"=",
"'Github-based load test'",
")",
"parser",
".",
"add_argument",
"(",
"'--version'",
",",
"action",
"=",
"'store_true'",
",",
"default",
"=",
"False",
",",
... | Moloslave clones a git repo and runs a molotov test | [
"Moloslave",
"clones",
"a",
"git",
"repo",
"and",
"runs",
"a",
"molotov",
"test"
] | bd2c94e7f250e1fbb21940f02c68b4437655bc11 | https://github.com/loads/molotov/blob/bd2c94e7f250e1fbb21940f02c68b4437655bc11/molotov/slave.py#L62-L122 |
224 | joeyespo/gitpress | gitpress/helpers.py | copy_files | def copy_files(source_files, target_directory, source_directory=None):
"""Copies a list of files to the specified directory.
If source_directory is provided, it will be prepended to each source file."""
try:
os.makedirs(target_directory)
except: # TODO: specific exception?
pass
f... | python | def copy_files(source_files, target_directory, source_directory=None):
try:
os.makedirs(target_directory)
except: # TODO: specific exception?
pass
for f in source_files:
source = os.path.join(source_directory, f) if source_directory else f
target = os.path.join(target_dir... | [
"def",
"copy_files",
"(",
"source_files",
",",
"target_directory",
",",
"source_directory",
"=",
"None",
")",
":",
"try",
":",
"os",
".",
"makedirs",
"(",
"target_directory",
")",
"except",
":",
"# TODO: specific exception?",
"pass",
"for",
"f",
"in",
"source_fi... | Copies a list of files to the specified directory.
If source_directory is provided, it will be prepended to each source file. | [
"Copies",
"a",
"list",
"of",
"files",
"to",
"the",
"specified",
"directory",
".",
"If",
"source_directory",
"is",
"provided",
"it",
"will",
"be",
"prepended",
"to",
"each",
"source",
"file",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/helpers.py#L31-L41 |
225 | joeyespo/gitpress | gitpress/helpers.py | yes_or_no | def yes_or_no(message):
"""Gets user input and returns True for yes and False for no."""
while True:
print message, '(yes/no)',
line = raw_input()
if line is None:
return None
line = line.lower()
if line == 'y' or line == 'ye' or line == 'yes':
ret... | python | def yes_or_no(message):
while True:
print message, '(yes/no)',
line = raw_input()
if line is None:
return None
line = line.lower()
if line == 'y' or line == 'ye' or line == 'yes':
return True
if line == 'n' or line == 'no':
return F... | [
"def",
"yes_or_no",
"(",
"message",
")",
":",
"while",
"True",
":",
"print",
"message",
",",
"'(yes/no)'",
",",
"line",
"=",
"raw_input",
"(",
")",
"if",
"line",
"is",
"None",
":",
"return",
"None",
"line",
"=",
"line",
".",
"lower",
"(",
")",
"if",
... | Gets user input and returns True for yes and False for no. | [
"Gets",
"user",
"input",
"and",
"returns",
"True",
"for",
"yes",
"and",
"False",
"for",
"no",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/helpers.py#L44-L55 |
226 | joeyespo/gitpress | gitpress/plugins.py | add_plugin | def add_plugin(plugin, directory=None):
"""Adds the specified plugin. This returns False if it was already added."""
repo = require_repo(directory)
plugins = get_value(repo, 'plugins', expect_type=dict)
if plugin in plugins:
return False
plugins[plugin] = {}
set_value(repo, 'plugins', p... | python | def add_plugin(plugin, directory=None):
repo = require_repo(directory)
plugins = get_value(repo, 'plugins', expect_type=dict)
if plugin in plugins:
return False
plugins[plugin] = {}
set_value(repo, 'plugins', plugins)
return True | [
"def",
"add_plugin",
"(",
"plugin",
",",
"directory",
"=",
"None",
")",
":",
"repo",
"=",
"require_repo",
"(",
"directory",
")",
"plugins",
"=",
"get_value",
"(",
"repo",
",",
"'plugins'",
",",
"expect_type",
"=",
"dict",
")",
"if",
"plugin",
"in",
"plug... | Adds the specified plugin. This returns False if it was already added. | [
"Adds",
"the",
"specified",
"plugin",
".",
"This",
"returns",
"False",
"if",
"it",
"was",
"already",
"added",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/plugins.py#L14-L23 |
227 | joeyespo/gitpress | gitpress/plugins.py | get_plugin_settings | def get_plugin_settings(plugin, directory=None):
"""Gets the settings for the specified plugin."""
repo = require_repo(directory)
plugins = get_value(repo, 'plugins')
return plugins.get(plugin) if isinstance(plugins, dict) else None | python | def get_plugin_settings(plugin, directory=None):
repo = require_repo(directory)
plugins = get_value(repo, 'plugins')
return plugins.get(plugin) if isinstance(plugins, dict) else None | [
"def",
"get_plugin_settings",
"(",
"plugin",
",",
"directory",
"=",
"None",
")",
":",
"repo",
"=",
"require_repo",
"(",
"directory",
")",
"plugins",
"=",
"get_value",
"(",
"repo",
",",
"'plugins'",
")",
"return",
"plugins",
".",
"get",
"(",
"plugin",
")",
... | Gets the settings for the specified plugin. | [
"Gets",
"the",
"settings",
"for",
"the",
"specified",
"plugin",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/plugins.py#L38-L42 |
228 | joeyespo/gitpress | gitpress/previewing.py | preview | def preview(directory=None, host=None, port=None, watch=True):
"""Runs a local server to preview the working directory of a repository."""
directory = directory or '.'
host = host or '127.0.0.1'
port = port or 5000
# TODO: admin interface
# TODO: use cache_only to keep from modifying output di... | python | def preview(directory=None, host=None, port=None, watch=True):
directory = directory or '.'
host = host or '127.0.0.1'
port = port or 5000
# TODO: admin interface
# TODO: use cache_only to keep from modifying output directly
out_directory = build(directory)
# Serve generated site
os.c... | [
"def",
"preview",
"(",
"directory",
"=",
"None",
",",
"host",
"=",
"None",
",",
"port",
"=",
"None",
",",
"watch",
"=",
"True",
")",
":",
"directory",
"=",
"directory",
"or",
"'.'",
"host",
"=",
"host",
"or",
"'127.0.0.1'",
"port",
"=",
"port",
"or",... | Runs a local server to preview the working directory of a repository. | [
"Runs",
"a",
"local",
"server",
"to",
"preview",
"the",
"working",
"directory",
"of",
"a",
"repository",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/previewing.py#L7-L23 |
229 | joeyespo/gitpress | gitpress/repository.py | require_repo | def require_repo(directory=None):
"""Checks for a presentation repository and raises an exception if not found."""
if directory and not os.path.isdir(directory):
raise ValueError('Directory not found: ' + repr(directory))
repo = repo_path(directory)
if not os.path.isdir(repo):
raise Repo... | python | def require_repo(directory=None):
if directory and not os.path.isdir(directory):
raise ValueError('Directory not found: ' + repr(directory))
repo = repo_path(directory)
if not os.path.isdir(repo):
raise RepositoryNotFoundError(directory)
return repo | [
"def",
"require_repo",
"(",
"directory",
"=",
"None",
")",
":",
"if",
"directory",
"and",
"not",
"os",
".",
"path",
".",
"isdir",
"(",
"directory",
")",
":",
"raise",
"ValueError",
"(",
"'Directory not found: '",
"+",
"repr",
"(",
"directory",
")",
")",
... | Checks for a presentation repository and raises an exception if not found. | [
"Checks",
"for",
"a",
"presentation",
"repository",
"and",
"raises",
"an",
"exception",
"if",
"not",
"found",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/repository.py#L30-L37 |
230 | joeyespo/gitpress | gitpress/repository.py | init | def init(directory=None):
"""Initializes a Gitpress presentation repository at the specified directory."""
repo = repo_path(directory)
if os.path.isdir(repo):
raise RepositoryAlreadyExistsError(directory, repo)
# Initialize repository with default template
shutil.copytree(default_template_p... | python | def init(directory=None):
repo = repo_path(directory)
if os.path.isdir(repo):
raise RepositoryAlreadyExistsError(directory, repo)
# Initialize repository with default template
shutil.copytree(default_template_path, repo)
message = '"Default presentation content."'
subprocess.call(['git... | [
"def",
"init",
"(",
"directory",
"=",
"None",
")",
":",
"repo",
"=",
"repo_path",
"(",
"directory",
")",
"if",
"os",
".",
"path",
".",
"isdir",
"(",
"repo",
")",
":",
"raise",
"RepositoryAlreadyExistsError",
"(",
"directory",
",",
"repo",
")",
"# Initial... | Initializes a Gitpress presentation repository at the specified directory. | [
"Initializes",
"a",
"Gitpress",
"presentation",
"repository",
"at",
"the",
"specified",
"directory",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/repository.py#L45-L59 |
231 | joeyespo/gitpress | gitpress/repository.py | iterate_presentation_files | def iterate_presentation_files(path=None, excludes=None, includes=None):
"""Iterates the repository presentation files relative to 'path',
not including themes. Note that 'includes' take priority."""
# Defaults
if includes is None:
includes = []
if excludes is None:
excludes = []
... | python | def iterate_presentation_files(path=None, excludes=None, includes=None):
# Defaults
if includes is None:
includes = []
if excludes is None:
excludes = []
# Transform glob patterns to regular expressions
includes_pattern = r'|'.join([fnmatch.translate(x) for x in includes]) or r'$.'
... | [
"def",
"iterate_presentation_files",
"(",
"path",
"=",
"None",
",",
"excludes",
"=",
"None",
",",
"includes",
"=",
"None",
")",
":",
"# Defaults",
"if",
"includes",
"is",
"None",
":",
"includes",
"=",
"[",
"]",
"if",
"excludes",
"is",
"None",
":",
"exclu... | Iterates the repository presentation files relative to 'path',
not including themes. Note that 'includes' take priority. | [
"Iterates",
"the",
"repository",
"presentation",
"files",
"relative",
"to",
"path",
"not",
"including",
"themes",
".",
"Note",
"that",
"includes",
"take",
"priority",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/repository.py#L68-L99 |
232 | joeyespo/gitpress | gitpress/config.py | read_config_file | def read_config_file(path):
"""Returns the configuration from the specified file."""
try:
with open(path, 'r') as f:
return json.load(f, object_pairs_hook=OrderedDict)
except IOError as ex:
if ex != errno.ENOENT:
raise
return {} | python | def read_config_file(path):
try:
with open(path, 'r') as f:
return json.load(f, object_pairs_hook=OrderedDict)
except IOError as ex:
if ex != errno.ENOENT:
raise
return {} | [
"def",
"read_config_file",
"(",
"path",
")",
":",
"try",
":",
"with",
"open",
"(",
"path",
",",
"'r'",
")",
"as",
"f",
":",
"return",
"json",
".",
"load",
"(",
"f",
",",
"object_pairs_hook",
"=",
"OrderedDict",
")",
"except",
"IOError",
"as",
"ex",
"... | Returns the configuration from the specified file. | [
"Returns",
"the",
"configuration",
"from",
"the",
"specified",
"file",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/config.py#L23-L31 |
233 | joeyespo/gitpress | gitpress/config.py | write_config | def write_config(repo_directory, config):
"""Writes the specified configuration to the presentation repository."""
return write_config_file(os.path.join(repo_directory, config_file), config) | python | def write_config(repo_directory, config):
return write_config_file(os.path.join(repo_directory, config_file), config) | [
"def",
"write_config",
"(",
"repo_directory",
",",
"config",
")",
":",
"return",
"write_config_file",
"(",
"os",
".",
"path",
".",
"join",
"(",
"repo_directory",
",",
"config_file",
")",
",",
"config",
")"
] | Writes the specified configuration to the presentation repository. | [
"Writes",
"the",
"specified",
"configuration",
"to",
"the",
"presentation",
"repository",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/config.py#L34-L36 |
234 | joeyespo/gitpress | gitpress/config.py | write_config_file | def write_config_file(path, config):
"""Writes the specified configuration to the specified file."""
contents = json.dumps(config, indent=4, separators=(',', ': ')) + '\n'
try:
with open(path, 'w') as f:
f.write(contents)
return True
except IOError as ex:
if ex != err... | python | def write_config_file(path, config):
contents = json.dumps(config, indent=4, separators=(',', ': ')) + '\n'
try:
with open(path, 'w') as f:
f.write(contents)
return True
except IOError as ex:
if ex != errno.ENOENT:
raise
return False | [
"def",
"write_config_file",
"(",
"path",
",",
"config",
")",
":",
"contents",
"=",
"json",
".",
"dumps",
"(",
"config",
",",
"indent",
"=",
"4",
",",
"separators",
"=",
"(",
"','",
",",
"': '",
")",
")",
"+",
"'\\n'",
"try",
":",
"with",
"open",
"(... | Writes the specified configuration to the specified file. | [
"Writes",
"the",
"specified",
"configuration",
"to",
"the",
"specified",
"file",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/config.py#L39-L49 |
235 | joeyespo/gitpress | gitpress/config.py | get_value | def get_value(repo_directory, key, expect_type=None):
"""Gets the value of the specified key in the config file."""
config = read_config(repo_directory)
value = config.get(key)
if expect_type and value is not None and not isinstance(value, expect_type):
raise ConfigSchemaError('Expected config v... | python | def get_value(repo_directory, key, expect_type=None):
config = read_config(repo_directory)
value = config.get(key)
if expect_type and value is not None and not isinstance(value, expect_type):
raise ConfigSchemaError('Expected config variable %s to be type %s, got %s'
% (repr(key), repr(e... | [
"def",
"get_value",
"(",
"repo_directory",
",",
"key",
",",
"expect_type",
"=",
"None",
")",
":",
"config",
"=",
"read_config",
"(",
"repo_directory",
")",
"value",
"=",
"config",
".",
"get",
"(",
"key",
")",
"if",
"expect_type",
"and",
"value",
"is",
"n... | Gets the value of the specified key in the config file. | [
"Gets",
"the",
"value",
"of",
"the",
"specified",
"key",
"in",
"the",
"config",
"file",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/config.py#L52-L59 |
236 | joeyespo/gitpress | gitpress/config.py | set_value | def set_value(repo_directory, key, value, strict=True):
"""Sets the value of a particular key in the config file. This has no effect when setting to the same value."""
if value is None:
raise ValueError('Argument "value" must not be None.')
# Read values and do nothing if not making any changes
... | python | def set_value(repo_directory, key, value, strict=True):
if value is None:
raise ValueError('Argument "value" must not be None.')
# Read values and do nothing if not making any changes
config = read_config(repo_directory)
old = config.get(key)
if old == value:
return old
# Check... | [
"def",
"set_value",
"(",
"repo_directory",
",",
"key",
",",
"value",
",",
"strict",
"=",
"True",
")",
":",
"if",
"value",
"is",
"None",
":",
"raise",
"ValueError",
"(",
"'Argument \"value\" must not be None.'",
")",
"# Read values and do nothing if not making any chan... | Sets the value of a particular key in the config file. This has no effect when setting to the same value. | [
"Sets",
"the",
"value",
"of",
"a",
"particular",
"key",
"in",
"the",
"config",
"file",
".",
"This",
"has",
"no",
"effect",
"when",
"setting",
"to",
"the",
"same",
"value",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/config.py#L62-L81 |
237 | joeyespo/gitpress | gitpress/building.py | build | def build(content_directory=None, out_directory=None):
"""Builds the site from its content and presentation repository."""
content_directory = content_directory or '.'
out_directory = os.path.abspath(out_directory or default_out_directory)
repo = require_repo(content_directory)
# Prevent user mista... | python | def build(content_directory=None, out_directory=None):
content_directory = content_directory or '.'
out_directory = os.path.abspath(out_directory or default_out_directory)
repo = require_repo(content_directory)
# Prevent user mistakes
if out_directory == '.':
raise ValueError('Output direct... | [
"def",
"build",
"(",
"content_directory",
"=",
"None",
",",
"out_directory",
"=",
"None",
")",
":",
"content_directory",
"=",
"content_directory",
"or",
"'.'",
"out_directory",
"=",
"os",
".",
"path",
".",
"abspath",
"(",
"out_directory",
"or",
"default_out_dire... | Builds the site from its content and presentation repository. | [
"Builds",
"the",
"site",
"from",
"its",
"content",
"and",
"presentation",
"repository",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/building.py#L9-L31 |
238 | joeyespo/gitpress | gitpress/command.py | gpp | def gpp(argv=None):
"""Shortcut function for running the previewing command."""
if argv is None:
argv = sys.argv[1:]
argv.insert(0, 'preview')
return main(argv) | python | def gpp(argv=None):
if argv is None:
argv = sys.argv[1:]
argv.insert(0, 'preview')
return main(argv) | [
"def",
"gpp",
"(",
"argv",
"=",
"None",
")",
":",
"if",
"argv",
"is",
"None",
":",
"argv",
"=",
"sys",
".",
"argv",
"[",
"1",
":",
"]",
"argv",
".",
"insert",
"(",
"0",
",",
"'preview'",
")",
"return",
"main",
"(",
"argv",
")"
] | Shortcut function for running the previewing command. | [
"Shortcut",
"function",
"for",
"running",
"the",
"previewing",
"command",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/command.py#L152-L157 |
239 | joeyespo/gitpress | gitpress/themes.py | use_theme | def use_theme(theme, directory=None):
"""Switches to the specified theme. This returns False if switching to the already active theme."""
repo = require_repo(directory)
if theme not in list_themes(directory):
raise ThemeNotFoundError(theme)
old_theme = set_value(repo, 'theme', theme)
return... | python | def use_theme(theme, directory=None):
repo = require_repo(directory)
if theme not in list_themes(directory):
raise ThemeNotFoundError(theme)
old_theme = set_value(repo, 'theme', theme)
return old_theme != theme | [
"def",
"use_theme",
"(",
"theme",
",",
"directory",
"=",
"None",
")",
":",
"repo",
"=",
"require_repo",
"(",
"directory",
")",
"if",
"theme",
"not",
"in",
"list_themes",
"(",
"directory",
")",
":",
"raise",
"ThemeNotFoundError",
"(",
"theme",
")",
"old_the... | Switches to the specified theme. This returns False if switching to the already active theme. | [
"Switches",
"to",
"the",
"specified",
"theme",
".",
"This",
"returns",
"False",
"if",
"switching",
"to",
"the",
"already",
"active",
"theme",
"."
] | a23edb80b6e4a113d167217475344a01c92b5c6d | https://github.com/joeyespo/gitpress/blob/a23edb80b6e4a113d167217475344a01c92b5c6d/gitpress/themes.py#L24-L31 |
240 | wrobstory/vincent | vincent/charts.py | data_type | def data_type(data, grouped=False, columns=None, key_on='idx', iter_idx=None):
'''Data type check for automatic import'''
if iter_idx:
return Data.from_mult_iters(idx=iter_idx, **data)
if pd:
if isinstance(data, (pd.Series, pd.DataFrame)):
return Data.from_pandas(data, grouped=gr... | python | def data_type(data, grouped=False, columns=None, key_on='idx', iter_idx=None):
'''Data type check for automatic import'''
if iter_idx:
return Data.from_mult_iters(idx=iter_idx, **data)
if pd:
if isinstance(data, (pd.Series, pd.DataFrame)):
return Data.from_pandas(data, grouped=gr... | [
"def",
"data_type",
"(",
"data",
",",
"grouped",
"=",
"False",
",",
"columns",
"=",
"None",
",",
"key_on",
"=",
"'idx'",
",",
"iter_idx",
"=",
"None",
")",
":",
"if",
"iter_idx",
":",
"return",
"Data",
".",
"from_mult_iters",
"(",
"idx",
"=",
"iter_idx... | Data type check for automatic import | [
"Data",
"type",
"check",
"for",
"automatic",
"import"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/charts.py#L28-L39 |
241 | wrobstory/vincent | vincent/charts.py | Map.rebind | def rebind(self, column=None, brew='GnBu'):
"""Bind a new column to the data map
Parameters
----------
column: str, default None
Pandas DataFrame column name
brew: str, default None
Color brewer abbreviation. See colors.py
"""
self.data['... | python | def rebind(self, column=None, brew='GnBu'):
self.data['table'] = Data.keypairs(
self.raw_data, columns=[self.data_key, column])
domain = [Data.serialize(self.raw_data[column].min()),
Data.serialize(self.raw_data[column].quantile(0.95))]
scale = Scale(name='color', t... | [
"def",
"rebind",
"(",
"self",
",",
"column",
"=",
"None",
",",
"brew",
"=",
"'GnBu'",
")",
":",
"self",
".",
"data",
"[",
"'table'",
"]",
"=",
"Data",
".",
"keypairs",
"(",
"self",
".",
"raw_data",
",",
"columns",
"=",
"[",
"self",
".",
"data_key",... | Bind a new column to the data map
Parameters
----------
column: str, default None
Pandas DataFrame column name
brew: str, default None
Color brewer abbreviation. See colors.py | [
"Bind",
"a",
"new",
"column",
"to",
"the",
"data",
"map"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/charts.py#L510-L527 |
242 | wrobstory/vincent | vincent/visualization.py | Visualization.axis_titles | def axis_titles(self, x=None, y=None):
"""Apply axis titles to the figure.
This is a convenience method for manually modifying the "Axes" mark.
Parameters
----------
x: string, default 'null'
X-axis title
y: string, default 'null'
Y-axis title
... | python | def axis_titles(self, x=None, y=None):
keys = self.axes.get_keys()
if keys:
for key in keys:
if key == 'x':
self.axes[key].title = x
elif key == 'y':
self.axes[key].title = y
else:
self.axes.extend([... | [
"def",
"axis_titles",
"(",
"self",
",",
"x",
"=",
"None",
",",
"y",
"=",
"None",
")",
":",
"keys",
"=",
"self",
".",
"axes",
".",
"get_keys",
"(",
")",
"if",
"keys",
":",
"for",
"key",
"in",
"keys",
":",
"if",
"key",
"==",
"'x'",
":",
"self",
... | Apply axis titles to the figure.
This is a convenience method for manually modifying the "Axes" mark.
Parameters
----------
x: string, default 'null'
X-axis title
y: string, default 'null'
Y-axis title
Example
-------
>>>vis.axis... | [
"Apply",
"axis",
"titles",
"to",
"the",
"figure",
"."
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/visualization.py#L173-L201 |
243 | wrobstory/vincent | vincent/visualization.py | Visualization._set_axis_properties | def _set_axis_properties(self, axis):
"""Set AxisProperties and PropertySets"""
if not getattr(axis, 'properties'):
axis.properties = AxisProperties()
for prop in ['ticks', 'axis', 'major_ticks', 'minor_ticks',
'title', 'labels']:
setattr(... | python | def _set_axis_properties(self, axis):
if not getattr(axis, 'properties'):
axis.properties = AxisProperties()
for prop in ['ticks', 'axis', 'major_ticks', 'minor_ticks',
'title', 'labels']:
setattr(axis.properties, prop, PropertySet()) | [
"def",
"_set_axis_properties",
"(",
"self",
",",
"axis",
")",
":",
"if",
"not",
"getattr",
"(",
"axis",
",",
"'properties'",
")",
":",
"axis",
".",
"properties",
"=",
"AxisProperties",
"(",
")",
"for",
"prop",
"in",
"[",
"'ticks'",
",",
"'axis'",
",",
... | Set AxisProperties and PropertySets | [
"Set",
"AxisProperties",
"and",
"PropertySets"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/visualization.py#L203-L209 |
244 | wrobstory/vincent | vincent/visualization.py | Visualization._set_all_axis_color | def _set_all_axis_color(self, axis, color):
"""Set axis ticks, title, labels to given color"""
for prop in ['ticks', 'axis', 'major_ticks', 'minor_ticks', 'title',
'labels']:
prop_set = getattr(axis.properties, prop)
if color and prop in ['title', 'labels']:
... | python | def _set_all_axis_color(self, axis, color):
for prop in ['ticks', 'axis', 'major_ticks', 'minor_ticks', 'title',
'labels']:
prop_set = getattr(axis.properties, prop)
if color and prop in ['title', 'labels']:
prop_set.fill = ValueRef(value=color)
... | [
"def",
"_set_all_axis_color",
"(",
"self",
",",
"axis",
",",
"color",
")",
":",
"for",
"prop",
"in",
"[",
"'ticks'",
",",
"'axis'",
",",
"'major_ticks'",
",",
"'minor_ticks'",
",",
"'title'",
",",
"'labels'",
"]",
":",
"prop_set",
"=",
"getattr",
"(",
"a... | Set axis ticks, title, labels to given color | [
"Set",
"axis",
"ticks",
"title",
"labels",
"to",
"given",
"color"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/visualization.py#L211-L220 |
245 | wrobstory/vincent | vincent/visualization.py | Visualization._axis_properties | def _axis_properties(self, axis, title_size, title_offset, label_angle,
label_align, color):
"""Assign axis properties"""
if self.axes:
axis = [a for a in self.axes if a.scale == axis][0]
self._set_axis_properties(axis)
self._set_all_axis_colo... | python | def _axis_properties(self, axis, title_size, title_offset, label_angle,
label_align, color):
if self.axes:
axis = [a for a in self.axes if a.scale == axis][0]
self._set_axis_properties(axis)
self._set_all_axis_color(axis, color)
if title_... | [
"def",
"_axis_properties",
"(",
"self",
",",
"axis",
",",
"title_size",
",",
"title_offset",
",",
"label_angle",
",",
"label_align",
",",
"color",
")",
":",
"if",
"self",
".",
"axes",
":",
"axis",
"=",
"[",
"a",
"for",
"a",
"in",
"self",
".",
"axes",
... | Assign axis properties | [
"Assign",
"axis",
"properties"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/visualization.py#L222-L239 |
246 | wrobstory/vincent | vincent/visualization.py | Visualization.common_axis_properties | def common_axis_properties(self, color=None, title_size=None):
"""Set common axis properties such as color
Parameters
----------
color: str, default None
Hex color str, etc
"""
if self.axes:
for axis in self.axes:
self._set_axis_pr... | python | def common_axis_properties(self, color=None, title_size=None):
if self.axes:
for axis in self.axes:
self._set_axis_properties(axis)
self._set_all_axis_color(axis, color)
if title_size:
ref = ValueRef(value=title_size)
... | [
"def",
"common_axis_properties",
"(",
"self",
",",
"color",
"=",
"None",
",",
"title_size",
"=",
"None",
")",
":",
"if",
"self",
".",
"axes",
":",
"for",
"axis",
"in",
"self",
".",
"axes",
":",
"self",
".",
"_set_axis_properties",
"(",
"axis",
")",
"se... | Set common axis properties such as color
Parameters
----------
color: str, default None
Hex color str, etc | [
"Set",
"common",
"axis",
"properties",
"such",
"as",
"color"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/visualization.py#L241-L258 |
247 | wrobstory/vincent | vincent/visualization.py | Visualization.x_axis_properties | def x_axis_properties(self, title_size=None, title_offset=None,
label_angle=None, label_align=None, color=None):
"""Change x-axis title font size and label angle
Parameters
----------
title_size: int, default None
Title size, in px
title_off... | python | def x_axis_properties(self, title_size=None, title_offset=None,
label_angle=None, label_align=None, color=None):
self._axis_properties('x', title_size, title_offset, label_angle,
label_align, color)
return self | [
"def",
"x_axis_properties",
"(",
"self",
",",
"title_size",
"=",
"None",
",",
"title_offset",
"=",
"None",
",",
"label_angle",
"=",
"None",
",",
"label_align",
"=",
"None",
",",
"color",
"=",
"None",
")",
":",
"self",
".",
"_axis_properties",
"(",
"'x'",
... | Change x-axis title font size and label angle
Parameters
----------
title_size: int, default None
Title size, in px
title_offset: int, default None
Pixel offset from given axis
label_angle: int, default None
label angle in degrees
labe... | [
"Change",
"x",
"-",
"axis",
"title",
"font",
"size",
"and",
"label",
"angle"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/visualization.py#L260-L279 |
248 | wrobstory/vincent | vincent/visualization.py | Visualization.y_axis_properties | def y_axis_properties(self, title_size=None, title_offset=None,
label_angle=None, label_align=None, color=None):
"""Change y-axis title font size and label angle
Parameters
----------
title_size: int, default None
Title size, in px
title_off... | python | def y_axis_properties(self, title_size=None, title_offset=None,
label_angle=None, label_align=None, color=None):
self._axis_properties('y', title_size, title_offset, label_angle,
label_align, color)
return self | [
"def",
"y_axis_properties",
"(",
"self",
",",
"title_size",
"=",
"None",
",",
"title_offset",
"=",
"None",
",",
"label_angle",
"=",
"None",
",",
"label_align",
"=",
"None",
",",
"color",
"=",
"None",
")",
":",
"self",
".",
"_axis_properties",
"(",
"'y'",
... | Change y-axis title font size and label angle
Parameters
----------
title_size: int, default None
Title size, in px
title_offset: int, default None
Pixel offset from given axis
label_angle: int, default None
label angle in degrees
labe... | [
"Change",
"y",
"-",
"axis",
"title",
"font",
"size",
"and",
"label",
"angle"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/visualization.py#L281-L300 |
249 | wrobstory/vincent | vincent/visualization.py | Visualization.legend | def legend(self, title=None, scale='color', text_color=None):
"""Convience method for adding a legend to the figure.
Important: This defaults to the color scale that is generated with
Line, Area, Stacked Line, etc charts. For bar charts, the scale ref is
usually 'y'.
Parameters... | python | def legend(self, title=None, scale='color', text_color=None):
self.legends.append(Legend(title=title, fill=scale, offset=0,
properties=LegendProperties()))
if text_color:
color_props = PropertySet(fill=ValueRef(value=text_color))
self.legends[0]... | [
"def",
"legend",
"(",
"self",
",",
"title",
"=",
"None",
",",
"scale",
"=",
"'color'",
",",
"text_color",
"=",
"None",
")",
":",
"self",
".",
"legends",
".",
"append",
"(",
"Legend",
"(",
"title",
"=",
"title",
",",
"fill",
"=",
"scale",
",",
"offs... | Convience method for adding a legend to the figure.
Important: This defaults to the color scale that is generated with
Line, Area, Stacked Line, etc charts. For bar charts, the scale ref is
usually 'y'.
Parameters
----------
title: string, default None
Legen... | [
"Convience",
"method",
"for",
"adding",
"a",
"legend",
"to",
"the",
"figure",
"."
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/visualization.py#L302-L325 |
250 | wrobstory/vincent | vincent/visualization.py | Visualization.colors | def colors(self, brew=None, range_=None):
"""Convenience method for adding color brewer scales to charts with a
color scale, such as stacked or grouped bars.
See the colors here: http://colorbrewer2.org/
Or here: http://bl.ocks.org/mbostock/5577023
This assumes that a 'color' ... | python | def colors(self, brew=None, range_=None):
if brew:
self.scales['color'].range = brews[brew]
elif range_:
self.scales['color'].range = range_
return self | [
"def",
"colors",
"(",
"self",
",",
"brew",
"=",
"None",
",",
"range_",
"=",
"None",
")",
":",
"if",
"brew",
":",
"self",
".",
"scales",
"[",
"'color'",
"]",
".",
"range",
"=",
"brews",
"[",
"brew",
"]",
"elif",
"range_",
":",
"self",
".",
"scales... | Convenience method for adding color brewer scales to charts with a
color scale, such as stacked or grouped bars.
See the colors here: http://colorbrewer2.org/
Or here: http://bl.ocks.org/mbostock/5577023
This assumes that a 'color' scale exists on your chart.
Parameters
... | [
"Convenience",
"method",
"for",
"adding",
"color",
"brewer",
"scales",
"to",
"charts",
"with",
"a",
"color",
"scale",
"such",
"as",
"stacked",
"or",
"grouped",
"bars",
"."
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/visualization.py#L327-L348 |
251 | wrobstory/vincent | vincent/visualization.py | Visualization.validate | def validate(self, require_all=True, scale='colors'):
"""Validate the visualization contents.
Parameters
----------
require_all : boolean, default True
If True (default), then all fields ``data``, ``scales``,
``axes``, and ``marks`` must be defined. The user is a... | python | def validate(self, require_all=True, scale='colors'):
super(self.__class__, self).validate()
required_attribs = ('data', 'scales', 'axes', 'marks')
for elem in required_attribs:
attr = getattr(self, elem)
if attr:
# Validate each element of the sets of dat... | [
"def",
"validate",
"(",
"self",
",",
"require_all",
"=",
"True",
",",
"scale",
"=",
"'colors'",
")",
":",
"super",
"(",
"self",
".",
"__class__",
",",
"self",
")",
".",
"validate",
"(",
")",
"required_attribs",
"=",
"(",
"'data'",
",",
"'scales'",
",",... | Validate the visualization contents.
Parameters
----------
require_all : boolean, default True
If True (default), then all fields ``data``, ``scales``,
``axes``, and ``marks`` must be defined. The user is allowed to
disable this if the intent is to define the... | [
"Validate",
"the",
"visualization",
"contents",
"."
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/visualization.py#L350-L377 |
252 | wrobstory/vincent | vincent/visualization.py | Visualization.display | def display(self):
"""Display the visualization inline in the IPython notebook.
This is deprecated, use the following instead::
from IPython.display import display
display(viz)
"""
from IPython.core.display import display, HTML
display(HTML(self._repr_ht... | python | def display(self):
from IPython.core.display import display, HTML
display(HTML(self._repr_html_())) | [
"def",
"display",
"(",
"self",
")",
":",
"from",
"IPython",
".",
"core",
".",
"display",
"import",
"display",
",",
"HTML",
"display",
"(",
"HTML",
"(",
"self",
".",
"_repr_html_",
"(",
")",
")",
")"
] | Display the visualization inline in the IPython notebook.
This is deprecated, use the following instead::
from IPython.display import display
display(viz) | [
"Display",
"the",
"visualization",
"inline",
"in",
"the",
"IPython",
"notebook",
"."
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/visualization.py#L401-L410 |
253 | wrobstory/vincent | vincent/data.py | Data.validate | def validate(self, *args):
"""Validate contents of class
"""
super(self.__class__, self).validate(*args)
if not self.name:
raise ValidationError('name is required for Data') | python | def validate(self, *args):
super(self.__class__, self).validate(*args)
if not self.name:
raise ValidationError('name is required for Data') | [
"def",
"validate",
"(",
"self",
",",
"*",
"args",
")",
":",
"super",
"(",
"self",
".",
"__class__",
",",
"self",
")",
".",
"validate",
"(",
"*",
"args",
")",
"if",
"not",
"self",
".",
"name",
":",
"raise",
"ValidationError",
"(",
"'name is required for... | Validate contents of class | [
"Validate",
"contents",
"of",
"class"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/data.py#L122-L127 |
254 | wrobstory/vincent | vincent/data.py | Data.serialize | def serialize(obj):
"""Convert an object into a JSON-serializable value
This is used by the ``from_pandas`` and ``from_numpy`` functions to
convert data to JSON-serializable types when loading.
"""
if isinstance(obj, str_types):
return obj
elif hasattr(obj, '... | python | def serialize(obj):
if isinstance(obj, str_types):
return obj
elif hasattr(obj, 'timetuple'):
return int(time.mktime(obj.timetuple())) * 1000
elif hasattr(obj, 'item'):
return obj.item()
elif hasattr(obj, '__float__'):
if isinstance(obj, in... | [
"def",
"serialize",
"(",
"obj",
")",
":",
"if",
"isinstance",
"(",
"obj",
",",
"str_types",
")",
":",
"return",
"obj",
"elif",
"hasattr",
"(",
"obj",
",",
"'timetuple'",
")",
":",
"return",
"int",
"(",
"time",
".",
"mktime",
"(",
"obj",
".",
"timetup... | Convert an object into a JSON-serializable value
This is used by the ``from_pandas`` and ``from_numpy`` functions to
convert data to JSON-serializable types when loading. | [
"Convert",
"an",
"object",
"into",
"a",
"JSON",
"-",
"serializable",
"value"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/data.py#L130-L151 |
255 | wrobstory/vincent | vincent/data.py | Data.from_pandas | def from_pandas(cls, data, columns=None, key_on='idx', name=None,
series_key='data', grouped=False, records=False, **kwargs):
"""Load values from a pandas ``Series`` or ``DataFrame`` object
Parameters
----------
data : pandas ``Series`` or ``DataFrame``
P... | python | def from_pandas(cls, data, columns=None, key_on='idx', name=None,
series_key='data', grouped=False, records=False, **kwargs):
# Note: There's an experimental JSON encoder floating around in
# pandas land that hasn't made it into the main branch. This
# function should be revi... | [
"def",
"from_pandas",
"(",
"cls",
",",
"data",
",",
"columns",
"=",
"None",
",",
"key_on",
"=",
"'idx'",
",",
"name",
"=",
"None",
",",
"series_key",
"=",
"'data'",
",",
"grouped",
"=",
"False",
",",
"records",
"=",
"False",
",",
"*",
"*",
"kwargs",
... | Load values from a pandas ``Series`` or ``DataFrame`` object
Parameters
----------
data : pandas ``Series`` or ``DataFrame``
Pandas object to import data from.
columns: list, default None
DataFrame columns to convert to Data. Keys default to col names.
... | [
"Load",
"values",
"from",
"a",
"pandas",
"Series",
"or",
"DataFrame",
"object"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/data.py#L154-L234 |
256 | wrobstory/vincent | vincent/data.py | Data.from_numpy | def from_numpy(cls, np_obj, name, columns, index=None, index_key=None,
**kwargs):
"""Load values from a numpy array
Parameters
----------
np_obj : numpy.ndarray
numpy array to load data from
name : string
``name`` field for the data
... | python | def from_numpy(cls, np_obj, name, columns, index=None, index_key=None,
**kwargs):
if not np:
raise LoadError('numpy could not be imported')
_assert_is_type('numpy object', np_obj, np.ndarray)
# Integer index if none is provided
index = index or range(np_o... | [
"def",
"from_numpy",
"(",
"cls",
",",
"np_obj",
",",
"name",
",",
"columns",
",",
"index",
"=",
"None",
",",
"index_key",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"not",
"np",
":",
"raise",
"LoadError",
"(",
"'numpy could not be imported'",
... | Load values from a numpy array
Parameters
----------
np_obj : numpy.ndarray
numpy array to load data from
name : string
``name`` field for the data
columns : iterable
Sequence of column names, from left to right. Must have same
len... | [
"Load",
"values",
"from",
"a",
"numpy",
"array"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/data.py#L237-L291 |
257 | wrobstory/vincent | vincent/data.py | Data.from_mult_iters | def from_mult_iters(cls, name=None, idx=None, **kwargs):
"""Load values from multiple iters
Parameters
----------
name : string, default None
Name of the data set. If None (default), the name will be set to
``'table'``.
idx: string, default None
... | python | def from_mult_iters(cls, name=None, idx=None, **kwargs):
if not name:
name = 'table'
lengths = [len(v) for v in kwargs.values()]
if len(set(lengths)) != 1:
raise ValueError('Iterables must all be same length')
if not idx:
raise ValueError('Must prov... | [
"def",
"from_mult_iters",
"(",
"cls",
",",
"name",
"=",
"None",
",",
"idx",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"not",
"name",
":",
"name",
"=",
"'table'",
"lengths",
"=",
"[",
"len",
"(",
"v",
")",
"for",
"v",
"in",
"kwargs",
... | Load values from multiple iters
Parameters
----------
name : string, default None
Name of the data set. If None (default), the name will be set to
``'table'``.
idx: string, default None
Iterable to use for the data index
**kwargs : dict of ite... | [
"Load",
"values",
"from",
"multiple",
"iters"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/data.py#L294-L339 |
258 | wrobstory/vincent | vincent/data.py | Data.from_iter | def from_iter(cls, data, name=None):
"""Convenience method for loading data from an iterable.
Defaults to numerical indexing for x-axis.
Parameters
----------
data: iterable
An iterable of data (list, tuple, dict of key/val pairs)
name: string, default None
... | python | def from_iter(cls, data, name=None):
if not name:
name = 'table'
if isinstance(data, (list, tuple)):
data = {x: y for x, y in enumerate(data)}
values = [{'idx': k, 'col': 'data', 'val': v}
for k, v in sorted(data.items())]
return cls(name, value... | [
"def",
"from_iter",
"(",
"cls",
",",
"data",
",",
"name",
"=",
"None",
")",
":",
"if",
"not",
"name",
":",
"name",
"=",
"'table'",
"if",
"isinstance",
"(",
"data",
",",
"(",
"list",
",",
"tuple",
")",
")",
":",
"data",
"=",
"{",
"x",
":",
"y",
... | Convenience method for loading data from an iterable.
Defaults to numerical indexing for x-axis.
Parameters
----------
data: iterable
An iterable of data (list, tuple, dict of key/val pairs)
name: string, default None
Name of the data set. If None (defau... | [
"Convenience",
"method",
"for",
"loading",
"data",
"from",
"an",
"iterable",
"."
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/data.py#L342-L364 |
259 | wrobstory/vincent | vincent/data.py | Data._numpy_to_values | def _numpy_to_values(data):
'''Convert a NumPy array to values attribute'''
def to_list_no_index(xvals, yvals):
return [{"x": x, "y": np.asscalar(y)}
for x, y in zip(xvals, yvals)]
if len(data.shape) == 1 or data.shape[1] == 1:
xvals = range(data.shap... | python | def _numpy_to_values(data):
'''Convert a NumPy array to values attribute'''
def to_list_no_index(xvals, yvals):
return [{"x": x, "y": np.asscalar(y)}
for x, y in zip(xvals, yvals)]
if len(data.shape) == 1 or data.shape[1] == 1:
xvals = range(data.shap... | [
"def",
"_numpy_to_values",
"(",
"data",
")",
":",
"def",
"to_list_no_index",
"(",
"xvals",
",",
"yvals",
")",
":",
"return",
"[",
"{",
"\"x\"",
":",
"x",
",",
"\"y\"",
":",
"np",
".",
"asscalar",
"(",
"y",
")",
"}",
"for",
"x",
",",
"y",
"in",
"z... | Convert a NumPy array to values attribute | [
"Convert",
"a",
"NumPy",
"array",
"to",
"values",
"attribute"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/data.py#L433-L460 |
260 | wrobstory/vincent | vincent/data.py | Data.to_json | def to_json(self, validate=False, pretty_print=True, data_path=None):
"""Convert data to JSON
Parameters
----------
data_path : string
If not None, then data is written to a separate file at the
specified path. Note that the ``url`` attribute if the data must
... | python | def to_json(self, validate=False, pretty_print=True, data_path=None):
# TODO: support writing to separate file
return super(self.__class__, self).to_json(validate=validate,
pretty_print=pretty_print) | [
"def",
"to_json",
"(",
"self",
",",
"validate",
"=",
"False",
",",
"pretty_print",
"=",
"True",
",",
"data_path",
"=",
"None",
")",
":",
"# TODO: support writing to separate file",
"return",
"super",
"(",
"self",
".",
"__class__",
",",
"self",
")",
".",
"to_... | Convert data to JSON
Parameters
----------
data_path : string
If not None, then data is written to a separate file at the
specified path. Note that the ``url`` attribute if the data must
be set independently for the data to load correctly.
Returns
... | [
"Convert",
"data",
"to",
"JSON"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/data.py#L462-L479 |
261 | wrobstory/vincent | vincent/core.py | _assert_is_type | def _assert_is_type(name, value, value_type):
"""Assert that a value must be a given type."""
if not isinstance(value, value_type):
if type(value_type) is tuple:
types = ', '.join(t.__name__ for t in value_type)
raise ValueError('{0} must be one of ({1})'.format(name, types))
... | python | def _assert_is_type(name, value, value_type):
if not isinstance(value, value_type):
if type(value_type) is tuple:
types = ', '.join(t.__name__ for t in value_type)
raise ValueError('{0} must be one of ({1})'.format(name, types))
else:
raise ValueError('{0} must be... | [
"def",
"_assert_is_type",
"(",
"name",
",",
"value",
",",
"value_type",
")",
":",
"if",
"not",
"isinstance",
"(",
"value",
",",
"value_type",
")",
":",
"if",
"type",
"(",
"value_type",
")",
"is",
"tuple",
":",
"types",
"=",
"', '",
".",
"join",
"(",
... | Assert that a value must be a given type. | [
"Assert",
"that",
"a",
"value",
"must",
"be",
"a",
"given",
"type",
"."
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/core.py#L107-L115 |
262 | wrobstory/vincent | vincent/core.py | grammar | def grammar(grammar_type=None, grammar_name=None):
"""Decorator to define properties that map to the ``grammar``
dict. This dict is the canonical representation of the Vega grammar
within Vincent.
This decorator is intended for classes that map to some pre-defined JSON
structure, such as axes, data... | python | def grammar(grammar_type=None, grammar_name=None):
def grammar_creator(validator, name):
def setter(self, value):
if isinstance(grammar_type, (type, tuple)):
_assert_is_type(validator.__name__, value, grammar_type)
validator(value)
self.grammar[name] = val... | [
"def",
"grammar",
"(",
"grammar_type",
"=",
"None",
",",
"grammar_name",
"=",
"None",
")",
":",
"def",
"grammar_creator",
"(",
"validator",
",",
"name",
")",
":",
"def",
"setter",
"(",
"self",
",",
"value",
")",
":",
"if",
"isinstance",
"(",
"grammar_typ... | Decorator to define properties that map to the ``grammar``
dict. This dict is the canonical representation of the Vega grammar
within Vincent.
This decorator is intended for classes that map to some pre-defined JSON
structure, such as axes, data, marks, scales, etc. It is assumed that this
decorate... | [
"Decorator",
"to",
"define",
"properties",
"that",
"map",
"to",
"the",
"grammar",
"dict",
".",
"This",
"dict",
"is",
"the",
"canonical",
"representation",
"of",
"the",
"Vega",
"grammar",
"within",
"Vincent",
"."
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/core.py#L179-L250 |
263 | wrobstory/vincent | vincent/core.py | GrammarClass.validate | def validate(self):
"""Validate the contents of the object.
This calls ``setattr`` for each of the class's grammar properties. It
will catch ``ValueError``s raised by the grammar property's setters
and re-raise them as :class:`ValidationError`.
"""
for key, val in self.g... | python | def validate(self):
for key, val in self.grammar.items():
try:
setattr(self, key, val)
except ValueError as e:
raise ValidationError('invalid contents: ' + e.args[0]) | [
"def",
"validate",
"(",
"self",
")",
":",
"for",
"key",
",",
"val",
"in",
"self",
".",
"grammar",
".",
"items",
"(",
")",
":",
"try",
":",
"setattr",
"(",
"self",
",",
"key",
",",
"val",
")",
"except",
"ValueError",
"as",
"e",
":",
"raise",
"Vali... | Validate the contents of the object.
This calls ``setattr`` for each of the class's grammar properties. It
will catch ``ValueError``s raised by the grammar property's setters
and re-raise them as :class:`ValidationError`. | [
"Validate",
"the",
"contents",
"of",
"the",
"object",
"."
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/core.py#L302-L313 |
264 | wrobstory/vincent | vincent/core.py | GrammarClass.to_json | def to_json(self, path=None, html_out=False,
html_path='vega_template.html', validate=False,
pretty_print=True):
"""Convert object to JSON
Parameters
----------
path: string, default None
Path to write JSON out. If there is no path provided, J... | python | def to_json(self, path=None, html_out=False,
html_path='vega_template.html', validate=False,
pretty_print=True):
if validate:
self.validate()
if pretty_print:
dumps_args = {'indent': 2, 'separators': (',', ': ')}
else:
dumps_ar... | [
"def",
"to_json",
"(",
"self",
",",
"path",
"=",
"None",
",",
"html_out",
"=",
"False",
",",
"html_path",
"=",
"'vega_template.html'",
",",
"validate",
"=",
"False",
",",
"pretty_print",
"=",
"True",
")",
":",
"if",
"validate",
":",
"self",
".",
"validat... | Convert object to JSON
Parameters
----------
path: string, default None
Path to write JSON out. If there is no path provided, JSON
will be returned as a string to the console.
html_out: boolean, default False
If True, vincent will output an simple HTM... | [
"Convert",
"object",
"to",
"JSON"
] | c5a06e50179015fbb788a7a42e4570ff4467a9e9 | https://github.com/wrobstory/vincent/blob/c5a06e50179015fbb788a7a42e4570ff4467a9e9/vincent/core.py#L315-L366 |
265 | alephdata/pantomime | pantomime/__init__.py | useful_mimetype | def useful_mimetype(text):
"""Check to see if the given mime type is a MIME type
which is useful in terms of how to treat this file.
"""
if text is None:
return False
mimetype = normalize_mimetype(text)
return mimetype not in [DEFAULT, PLAIN, None] | python | def useful_mimetype(text):
if text is None:
return False
mimetype = normalize_mimetype(text)
return mimetype not in [DEFAULT, PLAIN, None] | [
"def",
"useful_mimetype",
"(",
"text",
")",
":",
"if",
"text",
"is",
"None",
":",
"return",
"False",
"mimetype",
"=",
"normalize_mimetype",
"(",
"text",
")",
"return",
"mimetype",
"not",
"in",
"[",
"DEFAULT",
",",
"PLAIN",
",",
"None",
"]"
] | Check to see if the given mime type is a MIME type
which is useful in terms of how to treat this file. | [
"Check",
"to",
"see",
"if",
"the",
"given",
"mime",
"type",
"is",
"a",
"MIME",
"type",
"which",
"is",
"useful",
"in",
"terms",
"of",
"how",
"to",
"treat",
"this",
"file",
"."
] | 818fe5d799ba045c1d908935f24c94a8438c3a60 | https://github.com/alephdata/pantomime/blob/818fe5d799ba045c1d908935f24c94a8438c3a60/pantomime/__init__.py#L19-L26 |
266 | alephdata/pantomime | pantomime/__init__.py | normalize_extension | def normalize_extension(extension):
"""Normalise a file name extension."""
extension = decode_path(extension)
if extension is None:
return
if extension.startswith('.'):
extension = extension[1:]
if '.' in extension:
_, extension = os.path.splitext(extension)
extension = s... | python | def normalize_extension(extension):
extension = decode_path(extension)
if extension is None:
return
if extension.startswith('.'):
extension = extension[1:]
if '.' in extension:
_, extension = os.path.splitext(extension)
extension = slugify(extension, sep='')
if extension ... | [
"def",
"normalize_extension",
"(",
"extension",
")",
":",
"extension",
"=",
"decode_path",
"(",
"extension",
")",
"if",
"extension",
"is",
"None",
":",
"return",
"if",
"extension",
".",
"startswith",
"(",
"'.'",
")",
":",
"extension",
"=",
"extension",
"[",
... | Normalise a file name extension. | [
"Normalise",
"a",
"file",
"name",
"extension",
"."
] | 818fe5d799ba045c1d908935f24c94a8438c3a60 | https://github.com/alephdata/pantomime/blob/818fe5d799ba045c1d908935f24c94a8438c3a60/pantomime/__init__.py#L29-L42 |
267 | alphardex/looter | looter/__init__.py | fetch | def fetch(url: str, **kwargs) -> Selector:
"""
Send HTTP request and parse it as a DOM tree.
Args:
url (str): The url of the site.
Returns:
Selector: allows you to select parts of HTML text using CSS or XPath expressions.
"""
kwargs.setdefault('headers', DEFAULT_HEADERS)
tr... | python | def fetch(url: str, **kwargs) -> Selector:
kwargs.setdefault('headers', DEFAULT_HEADERS)
try:
res = requests.get(url, **kwargs)
res.raise_for_status()
except requests.RequestException as e:
print(e)
else:
html = res.text
tree = Selector(text=html)
return t... | [
"def",
"fetch",
"(",
"url",
":",
"str",
",",
"*",
"*",
"kwargs",
")",
"->",
"Selector",
":",
"kwargs",
".",
"setdefault",
"(",
"'headers'",
",",
"DEFAULT_HEADERS",
")",
"try",
":",
"res",
"=",
"requests",
".",
"get",
"(",
"url",
",",
"*",
"*",
"kwa... | Send HTTP request and parse it as a DOM tree.
Args:
url (str): The url of the site.
Returns:
Selector: allows you to select parts of HTML text using CSS or XPath expressions. | [
"Send",
"HTTP",
"request",
"and",
"parse",
"it",
"as",
"a",
"DOM",
"tree",
"."
] | 47fb7e44fe39c8528c1d6be94791798660d8804e | https://github.com/alphardex/looter/blob/47fb7e44fe39c8528c1d6be94791798660d8804e/looter/__init__.py#L60-L79 |
268 | alphardex/looter | looter/__init__.py | async_fetch | async def async_fetch(url: str, **kwargs) -> Selector:
"""
Do the fetch in an async style.
Args:
url (str): The url of the site.
Returns:
Selector: allows you to select parts of HTML text using CSS or XPath expressions.
"""
kwargs.setdefault('headers', DEFAULT_HEADERS)
asyn... | python | async def async_fetch(url: str, **kwargs) -> Selector:
kwargs.setdefault('headers', DEFAULT_HEADERS)
async with aiohttp.ClientSession(**kwargs) as ses:
async with ses.get(url, **kwargs) as res:
html = await res.text()
tree = Selector(text=html)
return tree | [
"async",
"def",
"async_fetch",
"(",
"url",
":",
"str",
",",
"*",
"*",
"kwargs",
")",
"->",
"Selector",
":",
"kwargs",
".",
"setdefault",
"(",
"'headers'",
",",
"DEFAULT_HEADERS",
")",
"async",
"with",
"aiohttp",
".",
"ClientSession",
"(",
"*",
"*",
"kwar... | Do the fetch in an async style.
Args:
url (str): The url of the site.
Returns:
Selector: allows you to select parts of HTML text using CSS or XPath expressions. | [
"Do",
"the",
"fetch",
"in",
"an",
"async",
"style",
"."
] | 47fb7e44fe39c8528c1d6be94791798660d8804e | https://github.com/alphardex/looter/blob/47fb7e44fe39c8528c1d6be94791798660d8804e/looter/__init__.py#L82-L97 |
269 | alphardex/looter | looter/__init__.py | links | def links(res: requests.models.Response,
search: str = None,
pattern: str = None) -> list:
"""Get the links of the page.
Args:
res (requests.models.Response): The response of the page.
search (str, optional): Defaults to None. Search the links you want.
pattern (str,... | python | def links(res: requests.models.Response,
search: str = None,
pattern: str = None) -> list:
hrefs = [link.to_text() for link in find_all_links(res.text)]
if search:
hrefs = [href for href in hrefs if search in href]
if pattern:
hrefs = [href for href in hrefs if re.findall... | [
"def",
"links",
"(",
"res",
":",
"requests",
".",
"models",
".",
"Response",
",",
"search",
":",
"str",
"=",
"None",
",",
"pattern",
":",
"str",
"=",
"None",
")",
"->",
"list",
":",
"hrefs",
"=",
"[",
"link",
".",
"to_text",
"(",
")",
"for",
"lin... | Get the links of the page.
Args:
res (requests.models.Response): The response of the page.
search (str, optional): Defaults to None. Search the links you want.
pattern (str, optional): Defaults to None. Search the links use a regex pattern.
Returns:
list: All the links of the p... | [
"Get",
"the",
"links",
"of",
"the",
"page",
"."
] | 47fb7e44fe39c8528c1d6be94791798660d8804e | https://github.com/alphardex/looter/blob/47fb7e44fe39c8528c1d6be94791798660d8804e/looter/__init__.py#L118-L136 |
270 | alphardex/looter | looter/__init__.py | save_as_json | def save_as_json(total: list,
name='data.json',
sort_by: str = None,
no_duplicate=False,
order='asc'):
"""Save what you crawled as a json file.
Args:
total (list): Total of data you crawled.
name (str, optional): Defaults to 'd... | python | def save_as_json(total: list,
name='data.json',
sort_by: str = None,
no_duplicate=False,
order='asc'):
if sort_by:
reverse = order == 'desc'
total = sorted(total, key=itemgetter(sort_by), reverse=reverse)
if no_duplicate:
... | [
"def",
"save_as_json",
"(",
"total",
":",
"list",
",",
"name",
"=",
"'data.json'",
",",
"sort_by",
":",
"str",
"=",
"None",
",",
"no_duplicate",
"=",
"False",
",",
"order",
"=",
"'asc'",
")",
":",
"if",
"sort_by",
":",
"reverse",
"=",
"order",
"==",
... | Save what you crawled as a json file.
Args:
total (list): Total of data you crawled.
name (str, optional): Defaults to 'data.json'. The name of the file.
sort_by (str, optional): Defaults to None. Sort items by a specific key.
no_duplicate (bool, optional): Defaults to False. If Tru... | [
"Save",
"what",
"you",
"crawled",
"as",
"a",
"json",
"file",
"."
] | 47fb7e44fe39c8528c1d6be94791798660d8804e | https://github.com/alphardex/looter/blob/47fb7e44fe39c8528c1d6be94791798660d8804e/looter/__init__.py#L139-L159 |
271 | gtaylor/python-colormath | colormath/color_objects.py | IlluminantMixin.set_observer | def set_observer(self, observer):
"""
Validates and sets the color's observer angle.
.. note:: This only changes the observer angle value. It does no conversion
of the color's coordinates.
:param str observer: One of '2' or '10'.
"""
observer = str(observer)... | python | def set_observer(self, observer):
observer = str(observer)
if observer not in color_constants.OBSERVERS:
raise InvalidObserverError(self)
self.observer = observer | [
"def",
"set_observer",
"(",
"self",
",",
"observer",
")",
":",
"observer",
"=",
"str",
"(",
"observer",
")",
"if",
"observer",
"not",
"in",
"color_constants",
".",
"OBSERVERS",
":",
"raise",
"InvalidObserverError",
"(",
"self",
")",
"self",
".",
"observer",
... | Validates and sets the color's observer angle.
.. note:: This only changes the observer angle value. It does no conversion
of the color's coordinates.
:param str observer: One of '2' or '10'. | [
"Validates",
"and",
"sets",
"the",
"color",
"s",
"observer",
"angle",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_objects.py#L71-L83 |
272 | gtaylor/python-colormath | colormath/color_objects.py | IlluminantMixin.set_illuminant | def set_illuminant(self, illuminant):
"""
Validates and sets the color's illuminant.
.. note:: This only changes the illuminant. It does no conversion
of the color's coordinates. For this, you'll want to refer to
:py:meth:`XYZColor.apply_adaptation <colormath.color_objec... | python | def set_illuminant(self, illuminant):
illuminant = illuminant.lower()
if illuminant not in color_constants.ILLUMINANTS[self.observer]:
raise InvalidIlluminantError(illuminant)
self.illuminant = illuminant | [
"def",
"set_illuminant",
"(",
"self",
",",
"illuminant",
")",
":",
"illuminant",
"=",
"illuminant",
".",
"lower",
"(",
")",
"if",
"illuminant",
"not",
"in",
"color_constants",
".",
"ILLUMINANTS",
"[",
"self",
".",
"observer",
"]",
":",
"raise",
"InvalidIllum... | Validates and sets the color's illuminant.
.. note:: This only changes the illuminant. It does no conversion
of the color's coordinates. For this, you'll want to refer to
:py:meth:`XYZColor.apply_adaptation <colormath.color_objects.XYZColor.apply_adaptation>`.
.. tip:: Call thi... | [
"Validates",
"and",
"sets",
"the",
"color",
"s",
"illuminant",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_objects.py#L86-L101 |
273 | gtaylor/python-colormath | colormath/color_objects.py | SpectralColor.get_numpy_array | def get_numpy_array(self):
"""
Dump this color into NumPy array.
"""
# This holds the obect's spectral data, and will be passed to
# numpy.array() to create a numpy array (matrix) for the matrix math
# that will be done during the conversion to XYZ.
values = []
... | python | def get_numpy_array(self):
# This holds the obect's spectral data, and will be passed to
# numpy.array() to create a numpy array (matrix) for the matrix math
# that will be done during the conversion to XYZ.
values = []
# Use the required value list to build this dynamically. De... | [
"def",
"get_numpy_array",
"(",
"self",
")",
":",
"# This holds the obect's spectral data, and will be passed to",
"# numpy.array() to create a numpy array (matrix) for the matrix math",
"# that will be done during the conversion to XYZ.",
"values",
"=",
"[",
"]",
"# Use the required value ... | Dump this color into NumPy array. | [
"Dump",
"this",
"color",
"into",
"NumPy",
"array",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_objects.py#L245-L262 |
274 | gtaylor/python-colormath | colormath/color_objects.py | XYZColor.apply_adaptation | def apply_adaptation(self, target_illuminant, adaptation='bradford'):
"""
This applies an adaptation matrix to change the XYZ color's illuminant.
You'll most likely only need this during RGB conversions.
"""
logger.debug(" \- Original illuminant: %s", self.illuminant)
lo... | python | def apply_adaptation(self, target_illuminant, adaptation='bradford'):
logger.debug(" \- Original illuminant: %s", self.illuminant)
logger.debug(" \- Target illuminant: %s", target_illuminant)
# If the XYZ values were taken with a different reference white than the
# native reference w... | [
"def",
"apply_adaptation",
"(",
"self",
",",
"target_illuminant",
",",
"adaptation",
"=",
"'bradford'",
")",
":",
"logger",
".",
"debug",
"(",
"\" \\- Original illuminant: %s\"",
",",
"self",
".",
"illuminant",
")",
"logger",
".",
"debug",
"(",
"\" \\- Target il... | This applies an adaptation matrix to change the XYZ color's illuminant.
You'll most likely only need this during RGB conversions. | [
"This",
"applies",
"an",
"adaptation",
"matrix",
"to",
"change",
"the",
"XYZ",
"color",
"s",
"illuminant",
".",
"You",
"ll",
"most",
"likely",
"only",
"need",
"this",
"during",
"RGB",
"conversions",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_objects.py#L448-L466 |
275 | gtaylor/python-colormath | colormath/color_objects.py | BaseRGBColor._clamp_rgb_coordinate | def _clamp_rgb_coordinate(self, coord):
"""
Clamps an RGB coordinate, taking into account whether or not the
color is upscaled or not.
:param float coord: The coordinate value.
:rtype: float
:returns: The clamped value.
"""
if not self.is_upscaled:
... | python | def _clamp_rgb_coordinate(self, coord):
if not self.is_upscaled:
return min(max(coord, 0.0), 1.0)
else:
return min(max(coord, 1), 255) | [
"def",
"_clamp_rgb_coordinate",
"(",
"self",
",",
"coord",
")",
":",
"if",
"not",
"self",
".",
"is_upscaled",
":",
"return",
"min",
"(",
"max",
"(",
"coord",
",",
"0.0",
")",
",",
"1.0",
")",
"else",
":",
"return",
"min",
"(",
"max",
"(",
"coord",
... | Clamps an RGB coordinate, taking into account whether or not the
color is upscaled or not.
:param float coord: The coordinate value.
:rtype: float
:returns: The clamped value. | [
"Clamps",
"an",
"RGB",
"coordinate",
"taking",
"into",
"account",
"whether",
"or",
"not",
"the",
"color",
"is",
"upscaled",
"or",
"not",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_objects.py#L530-L542 |
276 | gtaylor/python-colormath | colormath/color_objects.py | BaseRGBColor.get_upscaled_value_tuple | def get_upscaled_value_tuple(self):
"""
Scales an RGB color object from decimal 0.0-1.0 to int 0-255.
"""
# Scale up to 0-255 values.
rgb_r = int(math.floor(0.5 + self.rgb_r * 255))
rgb_g = int(math.floor(0.5 + self.rgb_g * 255))
rgb_b = int(math.floor(0.5 + self.... | python | def get_upscaled_value_tuple(self):
# Scale up to 0-255 values.
rgb_r = int(math.floor(0.5 + self.rgb_r * 255))
rgb_g = int(math.floor(0.5 + self.rgb_g * 255))
rgb_b = int(math.floor(0.5 + self.rgb_b * 255))
return rgb_r, rgb_g, rgb_b | [
"def",
"get_upscaled_value_tuple",
"(",
"self",
")",
":",
"# Scale up to 0-255 values.",
"rgb_r",
"=",
"int",
"(",
"math",
".",
"floor",
"(",
"0.5",
"+",
"self",
".",
"rgb_r",
"*",
"255",
")",
")",
"rgb_g",
"=",
"int",
"(",
"math",
".",
"floor",
"(",
"... | Scales an RGB color object from decimal 0.0-1.0 to int 0-255. | [
"Scales",
"an",
"RGB",
"color",
"object",
"from",
"decimal",
"0",
".",
"0",
"-",
"1",
".",
"0",
"to",
"int",
"0",
"-",
"255",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_objects.py#L565-L574 |
277 | gtaylor/python-colormath | colormath/density.py | auto_density | def auto_density(color):
"""
Given a SpectralColor, automatically choose the correct ANSI T filter.
Returns a tuple with a string representation of the filter the
calculated density.
:param SpectralColor color: The SpectralColor object to calculate
density for.
:rtype: float
:return... | python | def auto_density(color):
blue_density = ansi_density(color, ANSI_STATUS_T_BLUE)
green_density = ansi_density(color, ANSI_STATUS_T_GREEN)
red_density = ansi_density(color, ANSI_STATUS_T_RED)
densities = [blue_density, green_density, red_density]
min_density = min(densities)
max_density = max(den... | [
"def",
"auto_density",
"(",
"color",
")",
":",
"blue_density",
"=",
"ansi_density",
"(",
"color",
",",
"ANSI_STATUS_T_BLUE",
")",
"green_density",
"=",
"ansi_density",
"(",
"color",
",",
"ANSI_STATUS_T_GREEN",
")",
"red_density",
"=",
"ansi_density",
"(",
"color",... | Given a SpectralColor, automatically choose the correct ANSI T filter.
Returns a tuple with a string representation of the filter the
calculated density.
:param SpectralColor color: The SpectralColor object to calculate
density for.
:rtype: float
:returns: The density value, with the filter... | [
"Given",
"a",
"SpectralColor",
"automatically",
"choose",
"the",
"correct",
"ANSI",
"T",
"filter",
".",
"Returns",
"a",
"tuple",
"with",
"a",
"string",
"representation",
"of",
"the",
"filter",
"the",
"calculated",
"density",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/density.py#L38-L67 |
278 | gtaylor/python-colormath | colormath/color_diff.py | _get_lab_color1_vector | def _get_lab_color1_vector(color):
"""
Converts an LabColor into a NumPy vector.
:param LabColor color:
:rtype: numpy.ndarray
"""
if not color.__class__.__name__ == 'LabColor':
raise ValueError(
"Delta E functions can only be used with two LabColor objects.")
return nump... | python | def _get_lab_color1_vector(color):
if not color.__class__.__name__ == 'LabColor':
raise ValueError(
"Delta E functions can only be used with two LabColor objects.")
return numpy.array([color.lab_l, color.lab_a, color.lab_b]) | [
"def",
"_get_lab_color1_vector",
"(",
"color",
")",
":",
"if",
"not",
"color",
".",
"__class__",
".",
"__name__",
"==",
"'LabColor'",
":",
"raise",
"ValueError",
"(",
"\"Delta E functions can only be used with two LabColor objects.\"",
")",
"return",
"numpy",
".",
"ar... | Converts an LabColor into a NumPy vector.
:param LabColor color:
:rtype: numpy.ndarray | [
"Converts",
"an",
"LabColor",
"into",
"a",
"NumPy",
"vector",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_diff.py#L12-L22 |
279 | gtaylor/python-colormath | colormath/chromatic_adaptation.py | _get_adaptation_matrix | def _get_adaptation_matrix(wp_src, wp_dst, observer, adaptation):
"""
Calculate the correct transformation matrix based on origin and target
illuminants. The observer angle must be the same between illuminants.
See colormath.color_constants.ADAPTATION_MATRICES for a list of possible
adaptations.
... | python | def _get_adaptation_matrix(wp_src, wp_dst, observer, adaptation):
# Get the appropriate transformation matrix, [MsubA].
m_sharp = color_constants.ADAPTATION_MATRICES[adaptation]
# In case the white-points are still input as strings
# Get white-points for illuminant
if isinstance(wp_src, str):
... | [
"def",
"_get_adaptation_matrix",
"(",
"wp_src",
",",
"wp_dst",
",",
"observer",
",",
"adaptation",
")",
":",
"# Get the appropriate transformation matrix, [MsubA].",
"m_sharp",
"=",
"color_constants",
".",
"ADAPTATION_MATRICES",
"[",
"adaptation",
"]",
"# In case the white-... | Calculate the correct transformation matrix based on origin and target
illuminants. The observer angle must be the same between illuminants.
See colormath.color_constants.ADAPTATION_MATRICES for a list of possible
adaptations.
Detailed conversion documentation is available at:
http://brucelindbloo... | [
"Calculate",
"the",
"correct",
"transformation",
"matrix",
"based",
"on",
"origin",
"and",
"target",
"illuminants",
".",
"The",
"observer",
"angle",
"must",
"be",
"the",
"same",
"between",
"illuminants",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/chromatic_adaptation.py#L13-L51 |
280 | gtaylor/python-colormath | colormath/chromatic_adaptation.py | apply_chromatic_adaptation | def apply_chromatic_adaptation(val_x, val_y, val_z, orig_illum, targ_illum,
observer='2', adaptation='bradford'):
"""
Applies a chromatic adaptation matrix to convert XYZ values between
illuminants. It is important to recognize that color transformation results
in color er... | python | def apply_chromatic_adaptation(val_x, val_y, val_z, orig_illum, targ_illum,
observer='2', adaptation='bradford'):
# It's silly to have to do this, but some people may want to call this
# function directly, so we'll protect them from messing up upper/lower case.
adaptation = ad... | [
"def",
"apply_chromatic_adaptation",
"(",
"val_x",
",",
"val_y",
",",
"val_z",
",",
"orig_illum",
",",
"targ_illum",
",",
"observer",
"=",
"'2'",
",",
"adaptation",
"=",
"'bradford'",
")",
":",
"# It's silly to have to do this, but some people may want to call this",
"#... | Applies a chromatic adaptation matrix to convert XYZ values between
illuminants. It is important to recognize that color transformation results
in color errors, determined by how far the original illuminant is from the
target illuminant. For example, D65 to A could result in very high maximum
deviance.
... | [
"Applies",
"a",
"chromatic",
"adaptation",
"matrix",
"to",
"convert",
"XYZ",
"values",
"between",
"illuminants",
".",
"It",
"is",
"important",
"to",
"recognize",
"that",
"color",
"transformation",
"results",
"in",
"color",
"errors",
"determined",
"by",
"how",
"f... | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/chromatic_adaptation.py#L55-L97 |
281 | gtaylor/python-colormath | colormath/chromatic_adaptation.py | apply_chromatic_adaptation_on_color | def apply_chromatic_adaptation_on_color(color, targ_illum, adaptation='bradford'):
"""
Convenience function to apply an adaptation directly to a Color object.
"""
xyz_x = color.xyz_x
xyz_y = color.xyz_y
xyz_z = color.xyz_z
orig_illum = color.illuminant
targ_illum = targ_illum.lower()
... | python | def apply_chromatic_adaptation_on_color(color, targ_illum, adaptation='bradford'):
xyz_x = color.xyz_x
xyz_y = color.xyz_y
xyz_z = color.xyz_z
orig_illum = color.illuminant
targ_illum = targ_illum.lower()
observer = color.observer
adaptation = adaptation.lower()
# Return individual X, Y... | [
"def",
"apply_chromatic_adaptation_on_color",
"(",
"color",
",",
"targ_illum",
",",
"adaptation",
"=",
"'bradford'",
")",
":",
"xyz_x",
"=",
"color",
".",
"xyz_x",
"xyz_y",
"=",
"color",
".",
"xyz_y",
"xyz_z",
"=",
"color",
".",
"xyz_z",
"orig_illum",
"=",
"... | Convenience function to apply an adaptation directly to a Color object. | [
"Convenience",
"function",
"to",
"apply",
"an",
"adaptation",
"directly",
"to",
"a",
"Color",
"object",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/chromatic_adaptation.py#L101-L119 |
282 | gtaylor/python-colormath | examples/conversions.py | example_lab_to_xyz | def example_lab_to_xyz():
"""
This function shows a simple conversion of an Lab color to an XYZ color.
"""
print("=== Simple Example: Lab->XYZ ===")
# Instantiate an Lab color object with the given values.
lab = LabColor(0.903, 16.296, -2.22)
# Show a string representation.
print(lab)
... | python | def example_lab_to_xyz():
print("=== Simple Example: Lab->XYZ ===")
# Instantiate an Lab color object with the given values.
lab = LabColor(0.903, 16.296, -2.22)
# Show a string representation.
print(lab)
# Convert to XYZ.
xyz = convert_color(lab, XYZColor)
print(xyz)
print("=== End ... | [
"def",
"example_lab_to_xyz",
"(",
")",
":",
"print",
"(",
"\"=== Simple Example: Lab->XYZ ===\"",
")",
"# Instantiate an Lab color object with the given values.",
"lab",
"=",
"LabColor",
"(",
"0.903",
",",
"16.296",
",",
"-",
"2.22",
")",
"# Show a string representation.",
... | This function shows a simple conversion of an Lab color to an XYZ color. | [
"This",
"function",
"shows",
"a",
"simple",
"conversion",
"of",
"an",
"Lab",
"color",
"to",
"an",
"XYZ",
"color",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/examples/conversions.py#L17-L30 |
283 | gtaylor/python-colormath | examples/conversions.py | example_lchab_to_lchuv | def example_lchab_to_lchuv():
"""
This function shows very complex chain of conversions in action.
LCHab to LCHuv involves four different calculations, making this the
conversion requiring the most steps.
"""
print("=== Complex Example: LCHab->LCHuv ===")
# Instantiate an LCHab color objec... | python | def example_lchab_to_lchuv():
print("=== Complex Example: LCHab->LCHuv ===")
# Instantiate an LCHab color object with the given values.
lchab = LCHabColor(0.903, 16.447, 352.252)
# Show a string representation.
print(lchab)
# Convert to LCHuv.
lchuv = convert_color(lchab, LCHuvColor)
pri... | [
"def",
"example_lchab_to_lchuv",
"(",
")",
":",
"print",
"(",
"\"=== Complex Example: LCHab->LCHuv ===\"",
")",
"# Instantiate an LCHab color object with the given values.",
"lchab",
"=",
"LCHabColor",
"(",
"0.903",
",",
"16.447",
",",
"352.252",
")",
"# Show a string represe... | This function shows very complex chain of conversions in action.
LCHab to LCHuv involves four different calculations, making this the
conversion requiring the most steps. | [
"This",
"function",
"shows",
"very",
"complex",
"chain",
"of",
"conversions",
"in",
"action",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/examples/conversions.py#L33-L49 |
284 | gtaylor/python-colormath | examples/conversions.py | example_lab_to_rgb | def example_lab_to_rgb():
"""
Conversions to RGB are a little more complex mathematically. There are also
several kinds of RGB color spaces. When converting from a device-independent
color space to RGB, sRGB is assumed unless otherwise specified with the
target_rgb keyword arg.
"""
print("=... | python | def example_lab_to_rgb():
print("=== RGB Example: Lab->RGB ===")
# Instantiate an Lab color object with the given values.
lab = LabColor(0.903, 16.296, -2.217)
# Show a string representation.
print(lab)
# Convert to XYZ.
rgb = convert_color(lab, sRGBColor)
print(rgb)
print("=== End E... | [
"def",
"example_lab_to_rgb",
"(",
")",
":",
"print",
"(",
"\"=== RGB Example: Lab->RGB ===\"",
")",
"# Instantiate an Lab color object with the given values.",
"lab",
"=",
"LabColor",
"(",
"0.903",
",",
"16.296",
",",
"-",
"2.217",
")",
"# Show a string representation.",
... | Conversions to RGB are a little more complex mathematically. There are also
several kinds of RGB color spaces. When converting from a device-independent
color space to RGB, sRGB is assumed unless otherwise specified with the
target_rgb keyword arg. | [
"Conversions",
"to",
"RGB",
"are",
"a",
"little",
"more",
"complex",
"mathematically",
".",
"There",
"are",
"also",
"several",
"kinds",
"of",
"RGB",
"color",
"spaces",
".",
"When",
"converting",
"from",
"a",
"device",
"-",
"independent",
"color",
"space",
"t... | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/examples/conversions.py#L52-L68 |
285 | gtaylor/python-colormath | examples/conversions.py | example_rgb_to_xyz | def example_rgb_to_xyz():
"""
The reverse is similar.
"""
print("=== RGB Example: RGB->XYZ ===")
# Instantiate an Lab color object with the given values.
rgb = sRGBColor(120, 130, 140)
# Show a string representation.
print(rgb)
# Convert RGB to XYZ using a D50 illuminant.
xyz = ... | python | def example_rgb_to_xyz():
print("=== RGB Example: RGB->XYZ ===")
# Instantiate an Lab color object with the given values.
rgb = sRGBColor(120, 130, 140)
# Show a string representation.
print(rgb)
# Convert RGB to XYZ using a D50 illuminant.
xyz = convert_color(rgb, XYZColor, target_illuminan... | [
"def",
"example_rgb_to_xyz",
"(",
")",
":",
"print",
"(",
"\"=== RGB Example: RGB->XYZ ===\"",
")",
"# Instantiate an Lab color object with the given values.",
"rgb",
"=",
"sRGBColor",
"(",
"120",
",",
"130",
",",
"140",
")",
"# Show a string representation.",
"print",
"(... | The reverse is similar. | [
"The",
"reverse",
"is",
"similar",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/examples/conversions.py#L71-L84 |
286 | gtaylor/python-colormath | examples/conversions.py | example_spectral_to_xyz | def example_spectral_to_xyz():
"""
Instantiate an Lab color object with the given values. Note that the
spectral range can run from 340nm to 830nm. Any omitted values assume a
value of 0.0, which is more or less ignored. For the distribution below,
we are providing an example reading from an X-Rite ... | python | def example_spectral_to_xyz():
print("=== Example: Spectral->XYZ ===")
spc = SpectralColor(
observer='2', illuminant='d50',
spec_380nm=0.0600, spec_390nm=0.0600, spec_400nm=0.0641,
spec_410nm=0.0654, spec_420nm=0.0645, spec_430nm=0.0605,
spec_440nm=0.0562, spec_450nm=0.0543, spec... | [
"def",
"example_spectral_to_xyz",
"(",
")",
":",
"print",
"(",
"\"=== Example: Spectral->XYZ ===\"",
")",
"spc",
"=",
"SpectralColor",
"(",
"observer",
"=",
"'2'",
",",
"illuminant",
"=",
"'d50'",
",",
"spec_380nm",
"=",
"0.0600",
",",
"spec_390nm",
"=",
"0.0600... | Instantiate an Lab color object with the given values. Note that the
spectral range can run from 340nm to 830nm. Any omitted values assume a
value of 0.0, which is more or less ignored. For the distribution below,
we are providing an example reading from an X-Rite i1 Pro, which only
measures between 380... | [
"Instantiate",
"an",
"Lab",
"color",
"object",
"with",
"the",
"given",
"values",
".",
"Note",
"that",
"the",
"spectral",
"range",
"can",
"run",
"from",
"340nm",
"to",
"830nm",
".",
"Any",
"omitted",
"values",
"assume",
"a",
"value",
"of",
"0",
".",
"0",
... | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/examples/conversions.py#L87-L113 |
287 | gtaylor/python-colormath | examples/conversions.py | example_lab_to_ipt | def example_lab_to_ipt():
"""
This function shows a simple conversion of an XYZ color to an IPT color.
"""
print("=== Simple Example: XYZ->IPT ===")
# Instantiate an XYZ color object with the given values.
xyz = XYZColor(0.5, 0.5, 0.5, illuminant='d65')
# Show a string representation.
p... | python | def example_lab_to_ipt():
print("=== Simple Example: XYZ->IPT ===")
# Instantiate an XYZ color object with the given values.
xyz = XYZColor(0.5, 0.5, 0.5, illuminant='d65')
# Show a string representation.
print(xyz)
# Convert to IPT.
ipt = convert_color(xyz, IPTColor)
print(ipt)
prin... | [
"def",
"example_lab_to_ipt",
"(",
")",
":",
"print",
"(",
"\"=== Simple Example: XYZ->IPT ===\"",
")",
"# Instantiate an XYZ color object with the given values.",
"xyz",
"=",
"XYZColor",
"(",
"0.5",
",",
"0.5",
",",
"0.5",
",",
"illuminant",
"=",
"'d65'",
")",
"# Show... | This function shows a simple conversion of an XYZ color to an IPT color. | [
"This",
"function",
"shows",
"a",
"simple",
"conversion",
"of",
"an",
"XYZ",
"color",
"to",
"an",
"IPT",
"color",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/examples/conversions.py#L116-L129 |
288 | gtaylor/python-colormath | colormath/color_conversions.py | apply_RGB_matrix | def apply_RGB_matrix(var1, var2, var3, rgb_type, convtype="xyz_to_rgb"):
"""
Applies an RGB working matrix to convert from XYZ to RGB.
The arguments are tersely named var1, var2, and var3 to allow for the
passing of XYZ _or_ RGB values. var1 is X for XYZ, and R for RGB. var2 and
var3 follow suite.
... | python | def apply_RGB_matrix(var1, var2, var3, rgb_type, convtype="xyz_to_rgb"):
convtype = convtype.lower()
# Retrieve the appropriate transformation matrix from the constants.
rgb_matrix = rgb_type.conversion_matrices[convtype]
logger.debug(" \* Applying RGB conversion matrix: %s->%s",
rgb_... | [
"def",
"apply_RGB_matrix",
"(",
"var1",
",",
"var2",
",",
"var3",
",",
"rgb_type",
",",
"convtype",
"=",
"\"xyz_to_rgb\"",
")",
":",
"convtype",
"=",
"convtype",
".",
"lower",
"(",
")",
"# Retrieve the appropriate transformation matrix from the constants.",
"rgb_matri... | Applies an RGB working matrix to convert from XYZ to RGB.
The arguments are tersely named var1, var2, and var3 to allow for the
passing of XYZ _or_ RGB values. var1 is X for XYZ, and R for RGB. var2 and
var3 follow suite. | [
"Applies",
"an",
"RGB",
"working",
"matrix",
"to",
"convert",
"from",
"XYZ",
"to",
"RGB",
".",
"The",
"arguments",
"are",
"tersely",
"named",
"var1",
"var2",
"and",
"var3",
"to",
"allow",
"for",
"the",
"passing",
"of",
"XYZ",
"_or_",
"RGB",
"values",
"."... | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_conversions.py#L31-L55 |
289 | gtaylor/python-colormath | colormath/color_conversions.py | color_conversion_function | def color_conversion_function(start_type, target_type):
"""
Decorator to indicate a function that performs a conversion from one color
space to another.
This decorator will return the original function unmodified, however it will
be registered in the _conversion_manager so it can be used to perform... | python | def color_conversion_function(start_type, target_type):
def decorator(f):
f.start_type = start_type
f.target_type = target_type
_conversion_manager.add_type_conversion(start_type, target_type, f)
return f
return decorator | [
"def",
"color_conversion_function",
"(",
"start_type",
",",
"target_type",
")",
":",
"def",
"decorator",
"(",
"f",
")",
":",
"f",
".",
"start_type",
"=",
"start_type",
"f",
".",
"target_type",
"=",
"target_type",
"_conversion_manager",
".",
"add_type_conversion",
... | Decorator to indicate a function that performs a conversion from one color
space to another.
This decorator will return the original function unmodified, however it will
be registered in the _conversion_manager so it can be used to perform color
space transformations between color spaces that do not ha... | [
"Decorator",
"to",
"indicate",
"a",
"function",
"that",
"performs",
"a",
"conversion",
"from",
"one",
"color",
"space",
"to",
"another",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_conversions.py#L152-L173 |
290 | gtaylor/python-colormath | colormath/color_conversions.py | Spectral_to_XYZ | def Spectral_to_XYZ(cobj, illuminant_override=None, *args, **kwargs):
"""
Converts spectral readings to XYZ.
"""
# If the user provides an illuminant_override numpy array, use it.
if illuminant_override:
reference_illum = illuminant_override
else:
# Otherwise, look up the illumin... | python | def Spectral_to_XYZ(cobj, illuminant_override=None, *args, **kwargs):
# If the user provides an illuminant_override numpy array, use it.
if illuminant_override:
reference_illum = illuminant_override
else:
# Otherwise, look up the illuminant from known standards based
# on the value o... | [
"def",
"Spectral_to_XYZ",
"(",
"cobj",
",",
"illuminant_override",
"=",
"None",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"# If the user provides an illuminant_override numpy array, use it.",
"if",
"illuminant_override",
":",
"reference_illum",
"=",
"illumina... | Converts spectral readings to XYZ. | [
"Converts",
"spectral",
"readings",
"to",
"XYZ",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_conversions.py#L178-L226 |
291 | gtaylor/python-colormath | colormath/color_conversions.py | Lab_to_XYZ | def Lab_to_XYZ(cobj, *args, **kwargs):
"""
Convert from Lab to XYZ
"""
illum = cobj.get_illuminant_xyz()
xyz_y = (cobj.lab_l + 16.0) / 116.0
xyz_x = cobj.lab_a / 500.0 + xyz_y
xyz_z = xyz_y - cobj.lab_b / 200.0
if math.pow(xyz_y, 3) > color_constants.CIE_E:
xyz_y = math.pow(xyz_... | python | def Lab_to_XYZ(cobj, *args, **kwargs):
illum = cobj.get_illuminant_xyz()
xyz_y = (cobj.lab_l + 16.0) / 116.0
xyz_x = cobj.lab_a / 500.0 + xyz_y
xyz_z = xyz_y - cobj.lab_b / 200.0
if math.pow(xyz_y, 3) > color_constants.CIE_E:
xyz_y = math.pow(xyz_y, 3)
else:
xyz_y = (xyz_y - 16.... | [
"def",
"Lab_to_XYZ",
"(",
"cobj",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"illum",
"=",
"cobj",
".",
"get_illuminant_xyz",
"(",
")",
"xyz_y",
"=",
"(",
"cobj",
".",
"lab_l",
"+",
"16.0",
")",
"/",
"116.0",
"xyz_x",
"=",
"cobj",
".",
... | Convert from Lab to XYZ | [
"Convert",
"from",
"Lab",
"to",
"XYZ"
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_conversions.py#L251-L280 |
292 | gtaylor/python-colormath | colormath/color_conversions.py | Luv_to_XYZ | def Luv_to_XYZ(cobj, *args, **kwargs):
"""
Convert from Luv to XYZ.
"""
illum = cobj.get_illuminant_xyz()
# Without Light, there is no color. Short-circuit this and avoid some
# zero division errors in the var_a_frac calculation.
if cobj.luv_l <= 0.0:
xyz_x = 0.0
xyz_y = 0.0
... | python | def Luv_to_XYZ(cobj, *args, **kwargs):
illum = cobj.get_illuminant_xyz()
# Without Light, there is no color. Short-circuit this and avoid some
# zero division errors in the var_a_frac calculation.
if cobj.luv_l <= 0.0:
xyz_x = 0.0
xyz_y = 0.0
xyz_z = 0.0
return XYZColor(
... | [
"def",
"Luv_to_XYZ",
"(",
"cobj",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"illum",
"=",
"cobj",
".",
"get_illuminant_xyz",
"(",
")",
"# Without Light, there is no color. Short-circuit this and avoid some",
"# zero division errors in the var_a_frac calculation."... | Convert from Luv to XYZ. | [
"Convert",
"from",
"Luv",
"to",
"XYZ",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_conversions.py#L303-L337 |
293 | gtaylor/python-colormath | colormath/color_conversions.py | xyY_to_XYZ | def xyY_to_XYZ(cobj, *args, **kwargs):
"""
Convert from xyY to XYZ.
"""
# avoid division by zero
if cobj.xyy_y == 0.0:
xyz_x = 0.0
xyz_y = 0.0
xyz_z = 0.0
else:
xyz_x = (cobj.xyy_x * cobj.xyy_Y) / cobj.xyy_y
xyz_y = cobj.xyy_Y
xyz_z = ((1.0 - cobj.... | python | def xyY_to_XYZ(cobj, *args, **kwargs):
# avoid division by zero
if cobj.xyy_y == 0.0:
xyz_x = 0.0
xyz_y = 0.0
xyz_z = 0.0
else:
xyz_x = (cobj.xyy_x * cobj.xyy_Y) / cobj.xyy_y
xyz_y = cobj.xyy_Y
xyz_z = ((1.0 - cobj.xyy_x - cobj.xyy_y) * xyz_y) / cobj.xyy_y
... | [
"def",
"xyY_to_XYZ",
"(",
"cobj",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"# avoid division by zero",
"if",
"cobj",
".",
"xyy_y",
"==",
"0.0",
":",
"xyz_x",
"=",
"0.0",
"xyz_y",
"=",
"0.0",
"xyz_z",
"=",
"0.0",
"else",
":",
"xyz_x",
"=",... | Convert from xyY to XYZ. | [
"Convert",
"from",
"xyY",
"to",
"XYZ",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_conversions.py#L368-L383 |
294 | gtaylor/python-colormath | colormath/color_conversions.py | XYZ_to_xyY | def XYZ_to_xyY(cobj, *args, **kwargs):
"""
Convert from XYZ to xyY.
"""
xyz_sum = cobj.xyz_x + cobj.xyz_y + cobj.xyz_z
# avoid division by zero
if xyz_sum == 0.0:
xyy_x = 0.0
xyy_y = 0.0
else:
xyy_x = cobj.xyz_x / xyz_sum
xyy_y = cobj.xyz_y / xyz_sum
xyy_Y... | python | def XYZ_to_xyY(cobj, *args, **kwargs):
xyz_sum = cobj.xyz_x + cobj.xyz_y + cobj.xyz_z
# avoid division by zero
if xyz_sum == 0.0:
xyy_x = 0.0
xyy_y = 0.0
else:
xyy_x = cobj.xyz_x / xyz_sum
xyy_y = cobj.xyz_y / xyz_sum
xyy_Y = cobj.xyz_y
return xyYColor(
x... | [
"def",
"XYZ_to_xyY",
"(",
"cobj",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"xyz_sum",
"=",
"cobj",
".",
"xyz_x",
"+",
"cobj",
".",
"xyz_y",
"+",
"cobj",
".",
"xyz_z",
"# avoid division by zero",
"if",
"xyz_sum",
"==",
"0.0",
":",
"xyy_x",
... | Convert from XYZ to xyY. | [
"Convert",
"from",
"XYZ",
"to",
"xyY",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_conversions.py#L388-L403 |
295 | gtaylor/python-colormath | colormath/color_conversions.py | XYZ_to_Luv | def XYZ_to_Luv(cobj, *args, **kwargs):
"""
Convert from XYZ to Luv
"""
temp_x = cobj.xyz_x
temp_y = cobj.xyz_y
temp_z = cobj.xyz_z
denom = temp_x + (15.0 * temp_y) + (3.0 * temp_z)
# avoid division by zero
if denom == 0.0:
luv_u = 0.0
luv_v = 0.0
else:
luv... | python | def XYZ_to_Luv(cobj, *args, **kwargs):
temp_x = cobj.xyz_x
temp_y = cobj.xyz_y
temp_z = cobj.xyz_z
denom = temp_x + (15.0 * temp_y) + (3.0 * temp_z)
# avoid division by zero
if denom == 0.0:
luv_u = 0.0
luv_v = 0.0
else:
luv_u = (4.0 * temp_x) / denom
luv_v = ... | [
"def",
"XYZ_to_Luv",
"(",
"cobj",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"temp_x",
"=",
"cobj",
".",
"xyz_x",
"temp_y",
"=",
"cobj",
".",
"xyz_y",
"temp_z",
"=",
"cobj",
".",
"xyz_z",
"denom",
"=",
"temp_x",
"+",
"(",
"15.0",
"*",
"... | Convert from XYZ to Luv | [
"Convert",
"from",
"XYZ",
"to",
"Luv"
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_conversions.py#L408-L439 |
296 | gtaylor/python-colormath | colormath/color_conversions.py | XYZ_to_Lab | def XYZ_to_Lab(cobj, *args, **kwargs):
"""
Converts XYZ to Lab.
"""
illum = cobj.get_illuminant_xyz()
temp_x = cobj.xyz_x / illum["X"]
temp_y = cobj.xyz_y / illum["Y"]
temp_z = cobj.xyz_z / illum["Z"]
if temp_x > color_constants.CIE_E:
temp_x = math.pow(temp_x, (1.0 / 3.0))
... | python | def XYZ_to_Lab(cobj, *args, **kwargs):
illum = cobj.get_illuminant_xyz()
temp_x = cobj.xyz_x / illum["X"]
temp_y = cobj.xyz_y / illum["Y"]
temp_z = cobj.xyz_z / illum["Z"]
if temp_x > color_constants.CIE_E:
temp_x = math.pow(temp_x, (1.0 / 3.0))
else:
temp_x = (7.787 * temp_x) +... | [
"def",
"XYZ_to_Lab",
"(",
"cobj",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"illum",
"=",
"cobj",
".",
"get_illuminant_xyz",
"(",
")",
"temp_x",
"=",
"cobj",
".",
"xyz_x",
"/",
"illum",
"[",
"\"X\"",
"]",
"temp_y",
"=",
"cobj",
".",
"xyz... | Converts XYZ to Lab. | [
"Converts",
"XYZ",
"to",
"Lab",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_conversions.py#L444-L472 |
297 | gtaylor/python-colormath | colormath/color_conversions.py | XYZ_to_RGB | def XYZ_to_RGB(cobj, target_rgb, *args, **kwargs):
"""
XYZ to RGB conversion.
"""
temp_X = cobj.xyz_x
temp_Y = cobj.xyz_y
temp_Z = cobj.xyz_z
logger.debug(" \- Target RGB space: %s", target_rgb)
target_illum = target_rgb.native_illuminant
logger.debug(" \- Target native illuminant... | python | def XYZ_to_RGB(cobj, target_rgb, *args, **kwargs):
temp_X = cobj.xyz_x
temp_Y = cobj.xyz_y
temp_Z = cobj.xyz_z
logger.debug(" \- Target RGB space: %s", target_rgb)
target_illum = target_rgb.native_illuminant
logger.debug(" \- Target native illuminant: %s", target_illum)
logger.debug(" \-... | [
"def",
"XYZ_to_RGB",
"(",
"cobj",
",",
"target_rgb",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"temp_X",
"=",
"cobj",
".",
"xyz_x",
"temp_Y",
"=",
"cobj",
".",
"xyz_y",
"temp_Z",
"=",
"cobj",
".",
"xyz_z",
"logger",
".",
"debug",
"(",
"\... | XYZ to RGB conversion. | [
"XYZ",
"to",
"RGB",
"conversion",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_conversions.py#L477-L537 |
298 | gtaylor/python-colormath | colormath/color_conversions.py | RGB_to_XYZ | def RGB_to_XYZ(cobj, target_illuminant=None, *args, **kwargs):
"""
RGB to XYZ conversion. Expects 0-255 RGB values.
Based off of: http://www.brucelindbloom.com/index.html?Eqn_RGB_to_XYZ.html
"""
# Will contain linearized RGB channels (removed the gamma func).
linear_channels = {}
if isinst... | python | def RGB_to_XYZ(cobj, target_illuminant=None, *args, **kwargs):
# Will contain linearized RGB channels (removed the gamma func).
linear_channels = {}
if isinstance(cobj, sRGBColor):
for channel in ['r', 'g', 'b']:
V = getattr(cobj, 'rgb_' + channel)
if V <= 0.04045:
... | [
"def",
"RGB_to_XYZ",
"(",
"cobj",
",",
"target_illuminant",
"=",
"None",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"# Will contain linearized RGB channels (removed the gamma func).",
"linear_channels",
"=",
"{",
"}",
"if",
"isinstance",
"(",
"cobj",
","... | RGB to XYZ conversion. Expects 0-255 RGB values.
Based off of: http://www.brucelindbloom.com/index.html?Eqn_RGB_to_XYZ.html | [
"RGB",
"to",
"XYZ",
"conversion",
".",
"Expects",
"0",
"-",
"255",
"RGB",
"values",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_conversions.py#L542-L593 |
299 | gtaylor/python-colormath | colormath/color_conversions.py | RGB_to_HSV | def RGB_to_HSV(cobj, *args, **kwargs):
"""
Converts from RGB to HSV.
H values are in degrees and are 0 to 360.
S values are a percentage, 0.0 to 1.0.
V values are a percentage, 0.0 to 1.0.
"""
var_R = cobj.rgb_r
var_G = cobj.rgb_g
var_B = cobj.rgb_b
var_max = max(var_R, var_G, ... | python | def RGB_to_HSV(cobj, *args, **kwargs):
var_R = cobj.rgb_r
var_G = cobj.rgb_g
var_B = cobj.rgb_b
var_max = max(var_R, var_G, var_B)
var_min = min(var_R, var_G, var_B)
var_H = __RGB_to_Hue(var_R, var_G, var_B, var_min, var_max)
if var_max == 0:
var_S = 0
else:
var_S = 1.... | [
"def",
"RGB_to_HSV",
"(",
"cobj",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"var_R",
"=",
"cobj",
".",
"rgb_r",
"var_G",
"=",
"cobj",
".",
"rgb_g",
"var_B",
"=",
"cobj",
".",
"rgb_b",
"var_max",
"=",
"max",
"(",
"var_R",
",",
"var_G",
... | Converts from RGB to HSV.
H values are in degrees and are 0 to 360.
S values are a percentage, 0.0 to 1.0.
V values are a percentage, 0.0 to 1.0. | [
"Converts",
"from",
"RGB",
"to",
"HSV",
"."
] | 1d168613718d2d7d31ec4230524e987ef66823c7 | https://github.com/gtaylor/python-colormath/blob/1d168613718d2d7d31ec4230524e987ef66823c7/colormath/color_conversions.py#L614-L639 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.