index
int64 0
731k
| package
stringlengths 2
98
⌀ | name
stringlengths 1
76
| docstring
stringlengths 0
281k
⌀ | code
stringlengths 4
1.07M
⌀ | signature
stringlengths 2
42.8k
⌀ |
|---|---|---|---|---|---|
5,591 | meld3 | sharedlineage | null | def sharedlineage(srcelement, tgtelement):
srcparent = srcelement.parent
tgtparent = tgtelement.parent
srcparenttag = getattr(srcparent, 'tag', None)
tgtparenttag = getattr(tgtparent, 'tag', None)
if srcparenttag != tgtparenttag:
return False
elif tgtparenttag is None and srcparenttag is None:
return True
elif tgtparent and srcparent:
return sharedlineage(srcparent, tgtparent)
return False
| (srcelement, tgtelement) |
5,593 | gptfunction.GPTFunction | GPTFunction |
A class representing a GPT callable function. GPT functions are defined using a JSON
schema which GPT uses to make a call.
GPT functions created using this wrapper must follow a strict definition.
1. Parameters should use type hinting, and can only be of the following types:
1. str
2. int
3. float
4. typing.Literal
5. a subclass of Enum (with string values)
2. The doc string should begin with a concise description of what the function does.
3. Parameters should be documented using the rST standard format.
A GPT function may optionally return a string which will be passed to GPT as the result. If no
value is returned then some arbitrary success string will be sent.
:example:
```py
def output_user(name: str, age: int) -> None:
"""
Outputs a user's name and age to the console.
:param name: The name of the user.
:param age: The age of the user.
"""
print(f"Name: {name}, Age: {age}")
my_gpt_func = GPTFunction(output_user)
gpt_tools = [my_gpt_func.schema()]
```
| class GPTFunction:
"""
A class representing a GPT callable function. GPT functions are defined using a JSON
schema which GPT uses to make a call.
GPT functions created using this wrapper must follow a strict definition.
1. Parameters should use type hinting, and can only be of the following types:
1. str
2. int
3. float
4. typing.Literal
5. a subclass of Enum (with string values)
2. The doc string should begin with a concise description of what the function does.
3. Parameters should be documented using the rST standard format.
A GPT function may optionally return a string which will be passed to GPT as the result. If no
value is returned then some arbitrary success string will be sent.
:example:
```py
def output_user(name: str, age: int) -> None:
\"""
Outputs a user's name and age to the console.
:param name: The name of the user.
:param age: The age of the user.
\"""
print(f"Name: {name}, Age: {age}")
my_gpt_func = GPTFunction(output_user)
gpt_tools = [my_gpt_func.schema()]
```
"""
@dataclass
class _FunctionParam:
name: str
typing: type
description: str
def __init__(self, func: Callable[..., Any]) -> None:
self.func = func
@no_type_check
def __call__(self, *args, **kwargs) -> Optional[str]:
result = self.func(*args, **kwargs)
# GPT expects function calls to return a string.
if isinstance(result, str):
return result
if getattr(result, "__str__"):
return str(result)
return ""
def schema(self) -> object:
"""
Generates the schema required for passing a function to GPT.
"""
docstring = docstring_parser.parse(self.func.__doc__)
return {
"type": "function",
"function": {
"name": self.func.__name__,
"description": docstring.short_description,
"parameters": GPTFunction._parse_params(
GPTFunction._create_function_params(
self.func.__annotations__, docstring.params
),
),
},
}
def name(self) -> str:
"""
Get the name of this function.
:return: The function name.
"""
return self.func.__name__
def description(self) -> str:
"""
Get the description of this function.
:return: The function description
"""
return docstring_parser.parse(self.func.__doc__).short_description
@staticmethod
def _create_function_params(
annotations: Dict[str, type], docstring_params: List[DocstringParam]
) -> List[_FunctionParam]:
"""
Combines annotation data with param documentation into a unified data storing the GPT
function's parameters in order.
:param annotations: The type annotation of the function.
:param docstring_params: The docstring of the parameters of the function.
:return: An list of the unified function data in order.
:example:
```python
def my_func(a: int, b: int) -> int:
\"""
My function.
:param a: This is param a!
:param b: Param b
spans multiple lines.
:return: An int.
\"""
return a + b
import docstring_parser
docstring_params = docstring_parser.parse(my_func.__doc__)
function_params = create_function_params(my_func.__annotations__, docstring_params)
assert len(function_params) == 2
assert function_params[0].name == "a"
assert function_params[0].typing == str
assert function_params[0].description == "This is param a!"
```
"""
if "return" in annotations:
del annotations["return"]
keyed_docstring_params = {p.arg_name: p for p in docstring_params}
function_params = []
for key in annotations:
desc = ""
if key in keyed_docstring_params:
desc = keyed_docstring_params[key].description
else:
logging.warning(
f"Function param {key} has no docstring description. Add a docstring description for more accurate use by GPT."
)
function_params.append(
GPTFunction._FunctionParam(key, annotations[key], desc)
)
return function_params
@staticmethod
def _parse_params(params: List[_FunctionParam]) -> Dict[str, Any]:
"""
Converts a function's params into a 'parameters' object used by the function calling schema.
:param params: The function parameters to parse into the schema.
:return: The parameters part of the function calling schema.
"""
schema_params: Dict[str, Any] = {}
for param in params:
schema_params |= {
param.name: GPTFunction._parse_param_type(param.typing)
| {"description": param.description}
}
return {"type": "object", "properties": schema_params}
@staticmethod
def _parse_param_type(
param_type: Union[type, object],
) -> Dict[str, Union[str, List[str]]]:
"""
Converts a `typing` hint into a param object used by the function calling schema.
:param param_type: The type of the parameter.
:return: The parameter part of the function calling schema.
Example1
```python
def my_func(a: int, b: str) -> None:
pass
a_param = parse_param_type(my_func.__annotations__[0])
assert a_param == {"type": "int"}
```
Example2
```python
class Fruit:
ORANGE = "orange"
BANANA = "banana"
def my_func(fruit: Fruit) -> None:
pass
fruit_param = parse_param_type(my_func.__annotations[0])
assert fruit_param == {"type": "string", "enum": ["orange", "banana"]}
```
"""
if param_type == str:
return {"type": "string"}
elif param_type == int:
return {"type": "int"}
elif param_type == float:
return {"type": "float"}
elif types := get_args(param_type):
return {"type": "string", "enum": list(types)}
elif isinstance(param_type, type) and issubclass(param_type, Enum):
return {"type": "string", "enum": [e.value for e in param_type]}
raise ValueError(
f"Unexpected type found while parsing parameter type: {param_type}"
)
| (func: Callable[..., Any]) -> None |
5,594 | gptfunction.GPTFunction | __call__ | null | @no_type_check
def __call__(self, *args, **kwargs) -> Optional[str]:
result = self.func(*args, **kwargs)
# GPT expects function calls to return a string.
if isinstance(result, str):
return result
if getattr(result, "__str__"):
return str(result)
return ""
| (self, *args, **kwargs) -> Optional[str] |
5,595 | gptfunction.GPTFunction | __init__ | null | def __init__(self, func: Callable[..., Any]) -> None:
self.func = func
| (self, func: Callable[..., Any]) -> NoneType |
5,596 | gptfunction.GPTFunction | _create_function_params |
Combines annotation data with param documentation into a unified data storing the GPT
function's parameters in order.
:param annotations: The type annotation of the function.
:param docstring_params: The docstring of the parameters of the function.
:return: An list of the unified function data in order.
:example:
```python
def my_func(a: int, b: int) -> int:
"""
My function.
:param a: This is param a!
:param b: Param b
spans multiple lines.
:return: An int.
"""
return a + b
import docstring_parser
docstring_params = docstring_parser.parse(my_func.__doc__)
function_params = create_function_params(my_func.__annotations__, docstring_params)
assert len(function_params) == 2
assert function_params[0].name == "a"
assert function_params[0].typing == str
assert function_params[0].description == "This is param a!"
```
| @staticmethod
def _create_function_params(
annotations: Dict[str, type], docstring_params: List[DocstringParam]
) -> List[_FunctionParam]:
"""
Combines annotation data with param documentation into a unified data storing the GPT
function's parameters in order.
:param annotations: The type annotation of the function.
:param docstring_params: The docstring of the parameters of the function.
:return: An list of the unified function data in order.
:example:
```python
def my_func(a: int, b: int) -> int:
\"""
My function.
:param a: This is param a!
:param b: Param b
spans multiple lines.
:return: An int.
\"""
return a + b
import docstring_parser
docstring_params = docstring_parser.parse(my_func.__doc__)
function_params = create_function_params(my_func.__annotations__, docstring_params)
assert len(function_params) == 2
assert function_params[0].name == "a"
assert function_params[0].typing == str
assert function_params[0].description == "This is param a!"
```
"""
if "return" in annotations:
del annotations["return"]
keyed_docstring_params = {p.arg_name: p for p in docstring_params}
function_params = []
for key in annotations:
desc = ""
if key in keyed_docstring_params:
desc = keyed_docstring_params[key].description
else:
logging.warning(
f"Function param {key} has no docstring description. Add a docstring description for more accurate use by GPT."
)
function_params.append(
GPTFunction._FunctionParam(key, annotations[key], desc)
)
return function_params
| (annotations: Dict[str, type], docstring_params: List[docstring_parser.common.DocstringParam]) -> List[gptfunction.GPTFunction.GPTFunction._FunctionParam] |
5,597 | gptfunction.GPTFunction | _parse_param_type |
Converts a `typing` hint into a param object used by the function calling schema.
:param param_type: The type of the parameter.
:return: The parameter part of the function calling schema.
Example1
```python
def my_func(a: int, b: str) -> None:
pass
a_param = parse_param_type(my_func.__annotations__[0])
assert a_param == {"type": "int"}
```
Example2
```python
class Fruit:
ORANGE = "orange"
BANANA = "banana"
def my_func(fruit: Fruit) -> None:
pass
fruit_param = parse_param_type(my_func.__annotations[0])
assert fruit_param == {"type": "string", "enum": ["orange", "banana"]}
```
| @staticmethod
def _parse_param_type(
param_type: Union[type, object],
) -> Dict[str, Union[str, List[str]]]:
"""
Converts a `typing` hint into a param object used by the function calling schema.
:param param_type: The type of the parameter.
:return: The parameter part of the function calling schema.
Example1
```python
def my_func(a: int, b: str) -> None:
pass
a_param = parse_param_type(my_func.__annotations__[0])
assert a_param == {"type": "int"}
```
Example2
```python
class Fruit:
ORANGE = "orange"
BANANA = "banana"
def my_func(fruit: Fruit) -> None:
pass
fruit_param = parse_param_type(my_func.__annotations[0])
assert fruit_param == {"type": "string", "enum": ["orange", "banana"]}
```
"""
if param_type == str:
return {"type": "string"}
elif param_type == int:
return {"type": "int"}
elif param_type == float:
return {"type": "float"}
elif types := get_args(param_type):
return {"type": "string", "enum": list(types)}
elif isinstance(param_type, type) and issubclass(param_type, Enum):
return {"type": "string", "enum": [e.value for e in param_type]}
raise ValueError(
f"Unexpected type found while parsing parameter type: {param_type}"
)
| (param_type: Union[type, object]) -> Dict[str, Union[str, List[str]]] |
5,598 | gptfunction.GPTFunction | _parse_params |
Converts a function's params into a 'parameters' object used by the function calling schema.
:param params: The function parameters to parse into the schema.
:return: The parameters part of the function calling schema.
| @staticmethod
def _parse_params(params: List[_FunctionParam]) -> Dict[str, Any]:
"""
Converts a function's params into a 'parameters' object used by the function calling schema.
:param params: The function parameters to parse into the schema.
:return: The parameters part of the function calling schema.
"""
schema_params: Dict[str, Any] = {}
for param in params:
schema_params |= {
param.name: GPTFunction._parse_param_type(param.typing)
| {"description": param.description}
}
return {"type": "object", "properties": schema_params}
| (params: List[gptfunction.GPTFunction.GPTFunction._FunctionParam]) -> Dict[str, Any] |
5,599 | gptfunction.GPTFunction | description |
Get the description of this function.
:return: The function description
| def description(self) -> str:
"""
Get the description of this function.
:return: The function description
"""
return docstring_parser.parse(self.func.__doc__).short_description
| (self) -> str |
5,600 | gptfunction.GPTFunction | name |
Get the name of this function.
:return: The function name.
| def name(self) -> str:
"""
Get the name of this function.
:return: The function name.
"""
return self.func.__name__
| (self) -> str |
5,601 | gptfunction.GPTFunction | schema |
Generates the schema required for passing a function to GPT.
| def schema(self) -> object:
"""
Generates the schema required for passing a function to GPT.
"""
docstring = docstring_parser.parse(self.func.__doc__)
return {
"type": "function",
"function": {
"name": self.func.__name__,
"description": docstring.short_description,
"parameters": GPTFunction._parse_params(
GPTFunction._create_function_params(
self.func.__annotations__, docstring.params
),
),
},
}
| (self) -> object |
5,602 | gptfunction.GPTFunction | gptfunction | null | def gptfunction(func: Callable[..., Any]) -> GPTFunction:
return GPTFunction(func)
| (func: Callable[..., Any]) -> gptfunction.GPTFunction.GPTFunction |
5,603 | flask.blueprints | Blueprint | null | class Blueprint(SansioBlueprint):
def __init__(
self,
name: str,
import_name: str,
static_folder: str | os.PathLike[str] | None = None,
static_url_path: str | None = None,
template_folder: str | os.PathLike[str] | None = None,
url_prefix: str | None = None,
subdomain: str | None = None,
url_defaults: dict[str, t.Any] | None = None,
root_path: str | None = None,
cli_group: str | None = _sentinel, # type: ignore
) -> None:
super().__init__(
name,
import_name,
static_folder,
static_url_path,
template_folder,
url_prefix,
subdomain,
url_defaults,
root_path,
cli_group,
)
#: The Click command group for registering CLI commands for this
#: object. The commands are available from the ``flask`` command
#: once the application has been discovered and blueprints have
#: been registered.
self.cli = AppGroup()
# Set the name of the Click group in case someone wants to add
# the app's commands to another CLI tool.
self.cli.name = self.name
def get_send_file_max_age(self, filename: str | None) -> int | None:
"""Used by :func:`send_file` to determine the ``max_age`` cache
value for a given file path if it wasn't passed.
By default, this returns :data:`SEND_FILE_MAX_AGE_DEFAULT` from
the configuration of :data:`~flask.current_app`. This defaults
to ``None``, which tells the browser to use conditional requests
instead of a timed cache, which is usually preferable.
Note this is a duplicate of the same method in the Flask
class.
.. versionchanged:: 2.0
The default configuration is ``None`` instead of 12 hours.
.. versionadded:: 0.9
"""
value = current_app.config["SEND_FILE_MAX_AGE_DEFAULT"]
if value is None:
return None
if isinstance(value, timedelta):
return int(value.total_seconds())
return value # type: ignore[no-any-return]
def send_static_file(self, filename: str) -> Response:
"""The view function used to serve files from
:attr:`static_folder`. A route is automatically registered for
this view at :attr:`static_url_path` if :attr:`static_folder` is
set.
Note this is a duplicate of the same method in the Flask
class.
.. versionadded:: 0.5
"""
if not self.has_static_folder:
raise RuntimeError("'static_folder' must be set to serve static_files.")
# send_file only knows to call get_send_file_max_age on the app,
# call it here so it works for blueprints too.
max_age = self.get_send_file_max_age(filename)
return send_from_directory(
t.cast(str, self.static_folder), filename, max_age=max_age
)
def open_resource(self, resource: str, mode: str = "rb") -> t.IO[t.AnyStr]:
"""Open a resource file relative to :attr:`root_path` for
reading.
For example, if the file ``schema.sql`` is next to the file
``app.py`` where the ``Flask`` app is defined, it can be opened
with:
.. code-block:: python
with app.open_resource("schema.sql") as f:
conn.executescript(f.read())
:param resource: Path to the resource relative to
:attr:`root_path`.
:param mode: Open the file in this mode. Only reading is
supported, valid values are "r" (or "rt") and "rb".
Note this is a duplicate of the same method in the Flask
class.
"""
if mode not in {"r", "rt", "rb"}:
raise ValueError("Resources can only be opened for reading.")
return open(os.path.join(self.root_path, resource), mode)
| (name: 'str', import_name: 'str', static_folder: 'str | os.PathLike[str] | None' = None, static_url_path: 'str | None' = None, template_folder: 'str | os.PathLike[str] | None' = None, url_prefix: 'str | None' = None, subdomain: 'str | None' = None, url_defaults: 'dict[str, t.Any] | None' = None, root_path: 'str | None' = None, cli_group: 'str | None' = <object object at 0x7f459ae22350>) -> 'None' |
5,604 | flask.blueprints | __init__ | null | def __init__(
self,
name: str,
import_name: str,
static_folder: str | os.PathLike[str] | None = None,
static_url_path: str | None = None,
template_folder: str | os.PathLike[str] | None = None,
url_prefix: str | None = None,
subdomain: str | None = None,
url_defaults: dict[str, t.Any] | None = None,
root_path: str | None = None,
cli_group: str | None = _sentinel, # type: ignore
) -> None:
super().__init__(
name,
import_name,
static_folder,
static_url_path,
template_folder,
url_prefix,
subdomain,
url_defaults,
root_path,
cli_group,
)
#: The Click command group for registering CLI commands for this
#: object. The commands are available from the ``flask`` command
#: once the application has been discovered and blueprints have
#: been registered.
self.cli = AppGroup()
# Set the name of the Click group in case someone wants to add
# the app's commands to another CLI tool.
self.cli.name = self.name
| (self, name: str, import_name: str, static_folder: Union[str, os.PathLike[str], NoneType] = None, static_url_path: Optional[str] = None, template_folder: Union[str, os.PathLike[str], NoneType] = None, url_prefix: Optional[str] = None, subdomain: Optional[str] = None, url_defaults: Optional[dict[str, Any]] = None, root_path: Optional[str] = None, cli_group: str | None = <object object at 0x7f459ae22350>) -> NoneType |
5,605 | flask.sansio.scaffold | __repr__ | null | def __repr__(self) -> str:
return f"<{type(self).__name__} {self.name!r}>"
| (self) -> str |
5,606 | flask.sansio.blueprints | _check_setup_finished | null | def _check_setup_finished(self, f_name: str) -> None:
if self._got_registered_once:
raise AssertionError(
f"The setup method '{f_name}' can no longer be called on the blueprint"
f" '{self.name}'. It has already been registered at least once, any"
" changes will not be applied consistently.\n"
"Make sure all imports, decorators, functions, etc. needed to set up"
" the blueprint are done before registering it."
)
| (self, f_name: str) -> NoneType |
5,607 | flask.sansio.scaffold | _get_exc_class_and_code | Get the exception class being handled. For HTTP status codes
or ``HTTPException`` subclasses, return both the exception and
status code.
:param exc_class_or_code: Any exception class, or an HTTP status
code as an integer.
| @staticmethod
def _get_exc_class_and_code(
exc_class_or_code: type[Exception] | int,
) -> tuple[type[Exception], int | None]:
"""Get the exception class being handled. For HTTP status codes
or ``HTTPException`` subclasses, return both the exception and
status code.
:param exc_class_or_code: Any exception class, or an HTTP status
code as an integer.
"""
exc_class: type[Exception]
if isinstance(exc_class_or_code, int):
try:
exc_class = default_exceptions[exc_class_or_code]
except KeyError:
raise ValueError(
f"'{exc_class_or_code}' is not a recognized HTTP"
" error code. Use a subclass of HTTPException with"
" that code instead."
) from None
else:
exc_class = exc_class_or_code
if isinstance(exc_class, Exception):
raise TypeError(
f"{exc_class!r} is an instance, not a class. Handlers"
" can only be registered for Exception classes or HTTP"
" error codes."
)
if not issubclass(exc_class, Exception):
raise ValueError(
f"'{exc_class.__name__}' is not a subclass of Exception."
" Handlers can only be registered for Exception classes"
" or HTTP error codes."
)
if issubclass(exc_class, HTTPException):
return exc_class, exc_class.code
else:
return exc_class, None
| (exc_class_or_code: type[Exception] | int) -> tuple[type[Exception], int | None] |
5,608 | flask.sansio.blueprints | _merge_blueprint_funcs | null | def _merge_blueprint_funcs(self, app: App, name: str) -> None:
def extend(
bp_dict: dict[ft.AppOrBlueprintKey, list[t.Any]],
parent_dict: dict[ft.AppOrBlueprintKey, list[t.Any]],
) -> None:
for key, values in bp_dict.items():
key = name if key is None else f"{name}.{key}"
parent_dict[key].extend(values)
for key, value in self.error_handler_spec.items():
key = name if key is None else f"{name}.{key}"
value = defaultdict(
dict,
{
code: {exc_class: func for exc_class, func in code_values.items()}
for code, code_values in value.items()
},
)
app.error_handler_spec[key] = value
for endpoint, func in self.view_functions.items():
app.view_functions[endpoint] = func
extend(self.before_request_funcs, app.before_request_funcs)
extend(self.after_request_funcs, app.after_request_funcs)
extend(
self.teardown_request_funcs,
app.teardown_request_funcs,
)
extend(self.url_default_functions, app.url_default_functions)
extend(self.url_value_preprocessors, app.url_value_preprocessors)
extend(self.template_context_processors, app.template_context_processors)
| (self, app: 'App', name: 'str') -> 'None' |
5,609 | flask.sansio.scaffold | _method_route | null | def _method_route(
self,
method: str,
rule: str,
options: dict[str, t.Any],
) -> t.Callable[[T_route], T_route]:
if "methods" in options:
raise TypeError("Use the 'route' decorator to use the 'methods' argument.")
return self.route(rule, methods=[method], **options)
| (self, method: str, rule: str, options: dict[str, typing.Any]) -> Callable[[~T_route], ~T_route] |
5,610 | flask.sansio.blueprints | add_app_template_filter | Register a template filter, available in any template rendered by the
application. Works like the :meth:`app_template_filter` decorator. Equivalent to
:meth:`.Flask.add_template_filter`.
:param name: the optional name of the filter, otherwise the
function name will be used.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, f: Callable[..., Any], name: str | None = None) -> NoneType |
5,611 | flask.sansio.blueprints | add_app_template_global | Register a template global, available in any template rendered by the
application. Works like the :meth:`app_template_global` decorator. Equivalent to
:meth:`.Flask.add_template_global`.
.. versionadded:: 0.10
:param name: the optional name of the global, otherwise the
function name will be used.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, f: Callable[..., Any], name: str | None = None) -> NoneType |
5,612 | flask.sansio.blueprints | add_app_template_test | Register a template test, available in any template rendered by the
application. Works like the :meth:`app_template_test` decorator. Equivalent to
:meth:`.Flask.add_template_test`.
.. versionadded:: 0.10
:param name: the optional name of the test, otherwise the
function name will be used.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, f: Callable[..., bool], name: str | None = None) -> NoneType |
5,613 | flask.sansio.blueprints | add_url_rule | Register a URL rule with the blueprint. See :meth:`.Flask.add_url_rule` for
full documentation.
The URL rule is prefixed with the blueprint's URL prefix. The endpoint name,
used with :func:`url_for`, is prefixed with the blueprint's name.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, rule: 'str', endpoint: 'str | None' = None, view_func: 'ft.RouteCallable | None' = None, provide_automatic_options: 'bool | None' = None, **options: 't.Any') -> 'None' |
5,614 | flask.sansio.blueprints | after_app_request | Like :meth:`after_request`, but after every request, not only those handled
by the blueprint. Equivalent to :meth:`.Flask.after_request`.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, f: ~T_after_request) -> ~T_after_request |
5,615 | flask.sansio.scaffold | after_request | Register a function to run after each request to this object.
The function is called with the response object, and must return
a response object. This allows the functions to modify or
replace the response before it is sent.
If a function raises an exception, any remaining
``after_request`` functions will not be called. Therefore, this
should not be used for actions that must execute, such as to
close resources. Use :meth:`teardown_request` for that.
This is available on both app and blueprint objects. When used on an app, this
executes after every request. When used on a blueprint, this executes after
every request that the blueprint handles. To register with a blueprint and
execute after every request, use :meth:`.Blueprint.after_app_request`.
| def setupmethod(f: F) -> F:
f_name = f.__name__
def wrapper_func(self: Scaffold, *args: t.Any, **kwargs: t.Any) -> t.Any:
self._check_setup_finished(f_name)
return f(self, *args, **kwargs)
return t.cast(F, update_wrapper(wrapper_func, f))
| (self, f: ~T_after_request) -> ~T_after_request |
5,616 | flask.sansio.blueprints | app_context_processor | Like :meth:`context_processor`, but for templates rendered by every view, not
only by the blueprint. Equivalent to :meth:`.Flask.context_processor`.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, f: ~T_template_context_processor) -> ~T_template_context_processor |
5,617 | flask.sansio.blueprints | app_errorhandler | Like :meth:`errorhandler`, but for every request, not only those handled by
the blueprint. Equivalent to :meth:`.Flask.errorhandler`.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, code: type[Exception] | int) -> Callable[[~T_error_handler], ~T_error_handler] |
5,618 | flask.sansio.blueprints | app_template_filter | Register a template filter, available in any template rendered by the
application. Equivalent to :meth:`.Flask.template_filter`.
:param name: the optional name of the filter, otherwise the
function name will be used.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, name: str | None = None) -> Callable[[~T_template_filter], ~T_template_filter] |
5,619 | flask.sansio.blueprints | app_template_global | Register a template global, available in any template rendered by the
application. Equivalent to :meth:`.Flask.template_global`.
.. versionadded:: 0.10
:param name: the optional name of the global, otherwise the
function name will be used.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, name: str | None = None) -> Callable[[~T_template_global], ~T_template_global] |
5,620 | flask.sansio.blueprints | app_template_test | Register a template test, available in any template rendered by the
application. Equivalent to :meth:`.Flask.template_test`.
.. versionadded:: 0.10
:param name: the optional name of the test, otherwise the
function name will be used.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, name: str | None = None) -> Callable[[~T_template_test], ~T_template_test] |
5,621 | flask.sansio.blueprints | app_url_defaults | Like :meth:`url_defaults`, but for every request, not only those handled by
the blueprint. Equivalent to :meth:`.Flask.url_defaults`.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, f: ~T_url_defaults) -> ~T_url_defaults |
5,622 | flask.sansio.blueprints | app_url_value_preprocessor | Like :meth:`url_value_preprocessor`, but for every request, not only those
handled by the blueprint. Equivalent to :meth:`.Flask.url_value_preprocessor`.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, f: ~T_url_value_preprocessor) -> ~T_url_value_preprocessor |
5,623 | flask.sansio.blueprints | before_app_request | Like :meth:`before_request`, but before every request, not only those handled
by the blueprint. Equivalent to :meth:`.Flask.before_request`.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, f: ~T_before_request) -> ~T_before_request |
5,624 | flask.sansio.scaffold | before_request | Register a function to run before each request.
For example, this can be used to open a database connection, or
to load the logged in user from the session.
.. code-block:: python
@app.before_request
def load_user():
if "user_id" in session:
g.user = db.session.get(session["user_id"])
The function will be called without any arguments. If it returns
a non-``None`` value, the value is handled as if it was the
return value from the view, and further request handling is
stopped.
This is available on both app and blueprint objects. When used on an app, this
executes before every request. When used on a blueprint, this executes before
every request that the blueprint handles. To register with a blueprint and
execute before every request, use :meth:`.Blueprint.before_app_request`.
| def setupmethod(f: F) -> F:
f_name = f.__name__
def wrapper_func(self: Scaffold, *args: t.Any, **kwargs: t.Any) -> t.Any:
self._check_setup_finished(f_name)
return f(self, *args, **kwargs)
return t.cast(F, update_wrapper(wrapper_func, f))
| (self, f: ~T_before_request) -> ~T_before_request |
5,625 | flask.sansio.scaffold | context_processor | Registers a template context processor function. These functions run before
rendering a template. The keys of the returned dict are added as variables
available in the template.
This is available on both app and blueprint objects. When used on an app, this
is called for every rendered template. When used on a blueprint, this is called
for templates rendered from the blueprint's views. To register with a blueprint
and affect every template, use :meth:`.Blueprint.app_context_processor`.
| def setupmethod(f: F) -> F:
f_name = f.__name__
def wrapper_func(self: Scaffold, *args: t.Any, **kwargs: t.Any) -> t.Any:
self._check_setup_finished(f_name)
return f(self, *args, **kwargs)
return t.cast(F, update_wrapper(wrapper_func, f))
| (self, f: ~T_template_context_processor) -> ~T_template_context_processor |
5,626 | flask.sansio.scaffold | delete | Shortcut for :meth:`route` with ``methods=["DELETE"]``.
.. versionadded:: 2.0
| def setupmethod(f: F) -> F:
f_name = f.__name__
def wrapper_func(self: Scaffold, *args: t.Any, **kwargs: t.Any) -> t.Any:
self._check_setup_finished(f_name)
return f(self, *args, **kwargs)
return t.cast(F, update_wrapper(wrapper_func, f))
| (self, rule: str, **options: Any) -> Callable[[~T_route], ~T_route] |
5,627 | flask.sansio.scaffold | endpoint | Decorate a view function to register it for the given
endpoint. Used if a rule is added without a ``view_func`` with
:meth:`add_url_rule`.
.. code-block:: python
app.add_url_rule("/ex", endpoint="example")
@app.endpoint("example")
def example():
...
:param endpoint: The endpoint name to associate with the view
function.
| def setupmethod(f: F) -> F:
f_name = f.__name__
def wrapper_func(self: Scaffold, *args: t.Any, **kwargs: t.Any) -> t.Any:
self._check_setup_finished(f_name)
return f(self, *args, **kwargs)
return t.cast(F, update_wrapper(wrapper_func, f))
| (self, endpoint: str) -> Callable[[~F], ~F] |
5,628 | flask.sansio.scaffold | errorhandler | Register a function to handle errors by code or exception class.
A decorator that is used to register a function given an
error code. Example::
@app.errorhandler(404)
def page_not_found(error):
return 'This page does not exist', 404
You can also register handlers for arbitrary exceptions::
@app.errorhandler(DatabaseError)
def special_exception_handler(error):
return 'Database connection failed', 500
This is available on both app and blueprint objects. When used on an app, this
can handle errors from every request. When used on a blueprint, this can handle
errors from requests that the blueprint handles. To register with a blueprint
and affect every request, use :meth:`.Blueprint.app_errorhandler`.
.. versionadded:: 0.7
Use :meth:`register_error_handler` instead of modifying
:attr:`error_handler_spec` directly, for application wide error
handlers.
.. versionadded:: 0.7
One can now additionally also register custom exception types
that do not necessarily have to be a subclass of the
:class:`~werkzeug.exceptions.HTTPException` class.
:param code_or_exception: the code as integer for the handler, or
an arbitrary exception
| def setupmethod(f: F) -> F:
f_name = f.__name__
def wrapper_func(self: Scaffold, *args: t.Any, **kwargs: t.Any) -> t.Any:
self._check_setup_finished(f_name)
return f(self, *args, **kwargs)
return t.cast(F, update_wrapper(wrapper_func, f))
| (self, code_or_exception: type[Exception] | int) -> Callable[[~T_error_handler], ~T_error_handler] |
5,629 | flask.sansio.scaffold | get | Shortcut for :meth:`route` with ``methods=["GET"]``.
.. versionadded:: 2.0
| def setupmethod(f: F) -> F:
f_name = f.__name__
def wrapper_func(self: Scaffold, *args: t.Any, **kwargs: t.Any) -> t.Any:
self._check_setup_finished(f_name)
return f(self, *args, **kwargs)
return t.cast(F, update_wrapper(wrapper_func, f))
| (self, rule: str, **options: Any) -> Callable[[~T_route], ~T_route] |
5,630 | flask.blueprints | get_send_file_max_age | Used by :func:`send_file` to determine the ``max_age`` cache
value for a given file path if it wasn't passed.
By default, this returns :data:`SEND_FILE_MAX_AGE_DEFAULT` from
the configuration of :data:`~flask.current_app`. This defaults
to ``None``, which tells the browser to use conditional requests
instead of a timed cache, which is usually preferable.
Note this is a duplicate of the same method in the Flask
class.
.. versionchanged:: 2.0
The default configuration is ``None`` instead of 12 hours.
.. versionadded:: 0.9
| def get_send_file_max_age(self, filename: str | None) -> int | None:
"""Used by :func:`send_file` to determine the ``max_age`` cache
value for a given file path if it wasn't passed.
By default, this returns :data:`SEND_FILE_MAX_AGE_DEFAULT` from
the configuration of :data:`~flask.current_app`. This defaults
to ``None``, which tells the browser to use conditional requests
instead of a timed cache, which is usually preferable.
Note this is a duplicate of the same method in the Flask
class.
.. versionchanged:: 2.0
The default configuration is ``None`` instead of 12 hours.
.. versionadded:: 0.9
"""
value = current_app.config["SEND_FILE_MAX_AGE_DEFAULT"]
if value is None:
return None
if isinstance(value, timedelta):
return int(value.total_seconds())
return value # type: ignore[no-any-return]
| (self, filename: str | None) -> int | None |
5,631 | flask.sansio.blueprints | make_setup_state | Creates an instance of :meth:`~flask.blueprints.BlueprintSetupState`
object that is later passed to the register callback functions.
Subclasses can override this to return a subclass of the setup state.
| def make_setup_state(
self, app: App, options: dict[str, t.Any], first_registration: bool = False
) -> BlueprintSetupState:
"""Creates an instance of :meth:`~flask.blueprints.BlueprintSetupState`
object that is later passed to the register callback functions.
Subclasses can override this to return a subclass of the setup state.
"""
return BlueprintSetupState(self, app, options, first_registration)
| (self, app: 'App', options: 'dict[str, t.Any]', first_registration: 'bool' = False) -> 'BlueprintSetupState' |
5,632 | flask.blueprints | open_resource | Open a resource file relative to :attr:`root_path` for
reading.
For example, if the file ``schema.sql`` is next to the file
``app.py`` where the ``Flask`` app is defined, it can be opened
with:
.. code-block:: python
with app.open_resource("schema.sql") as f:
conn.executescript(f.read())
:param resource: Path to the resource relative to
:attr:`root_path`.
:param mode: Open the file in this mode. Only reading is
supported, valid values are "r" (or "rt") and "rb".
Note this is a duplicate of the same method in the Flask
class.
| def open_resource(self, resource: str, mode: str = "rb") -> t.IO[t.AnyStr]:
"""Open a resource file relative to :attr:`root_path` for
reading.
For example, if the file ``schema.sql`` is next to the file
``app.py`` where the ``Flask`` app is defined, it can be opened
with:
.. code-block:: python
with app.open_resource("schema.sql") as f:
conn.executescript(f.read())
:param resource: Path to the resource relative to
:attr:`root_path`.
:param mode: Open the file in this mode. Only reading is
supported, valid values are "r" (or "rt") and "rb".
Note this is a duplicate of the same method in the Flask
class.
"""
if mode not in {"r", "rt", "rb"}:
raise ValueError("Resources can only be opened for reading.")
return open(os.path.join(self.root_path, resource), mode)
| (self, resource: str, mode: str = 'rb') -> IO[~AnyStr] |
5,633 | flask.sansio.scaffold | patch | Shortcut for :meth:`route` with ``methods=["PATCH"]``.
.. versionadded:: 2.0
| def setupmethod(f: F) -> F:
f_name = f.__name__
def wrapper_func(self: Scaffold, *args: t.Any, **kwargs: t.Any) -> t.Any:
self._check_setup_finished(f_name)
return f(self, *args, **kwargs)
return t.cast(F, update_wrapper(wrapper_func, f))
| (self, rule: str, **options: Any) -> Callable[[~T_route], ~T_route] |
5,634 | flask.sansio.scaffold | post | Shortcut for :meth:`route` with ``methods=["POST"]``.
.. versionadded:: 2.0
| def setupmethod(f: F) -> F:
f_name = f.__name__
def wrapper_func(self: Scaffold, *args: t.Any, **kwargs: t.Any) -> t.Any:
self._check_setup_finished(f_name)
return f(self, *args, **kwargs)
return t.cast(F, update_wrapper(wrapper_func, f))
| (self, rule: str, **options: Any) -> Callable[[~T_route], ~T_route] |
5,635 | flask.sansio.scaffold | put | Shortcut for :meth:`route` with ``methods=["PUT"]``.
.. versionadded:: 2.0
| def setupmethod(f: F) -> F:
f_name = f.__name__
def wrapper_func(self: Scaffold, *args: t.Any, **kwargs: t.Any) -> t.Any:
self._check_setup_finished(f_name)
return f(self, *args, **kwargs)
return t.cast(F, update_wrapper(wrapper_func, f))
| (self, rule: str, **options: Any) -> Callable[[~T_route], ~T_route] |
5,636 | flask.sansio.blueprints | record | Registers a function that is called when the blueprint is
registered on the application. This function is called with the
state as argument as returned by the :meth:`make_setup_state`
method.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, func: Callable[[flask.sansio.blueprints.BlueprintSetupState], NoneType]) -> NoneType |
5,637 | flask.sansio.blueprints | record_once | Works like :meth:`record` but wraps the function in another
function that will ensure the function is only called once. If the
blueprint is registered a second time on the application, the
function passed is not called.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, func: Callable[[flask.sansio.blueprints.BlueprintSetupState], NoneType]) -> NoneType |
5,638 | flask.sansio.blueprints | register | Called by :meth:`Flask.register_blueprint` to register all
views and callbacks registered on the blueprint with the
application. Creates a :class:`.BlueprintSetupState` and calls
each :meth:`record` callback with it.
:param app: The application this blueprint is being registered
with.
:param options: Keyword arguments forwarded from
:meth:`~Flask.register_blueprint`.
.. versionchanged:: 2.3
Nested blueprints now correctly apply subdomains.
.. versionchanged:: 2.1
Registering the same blueprint with the same name multiple
times is an error.
.. versionchanged:: 2.0.1
Nested blueprints are registered with their dotted name.
This allows different blueprints with the same name to be
nested at different locations.
.. versionchanged:: 2.0.1
The ``name`` option can be used to change the (pre-dotted)
name the blueprint is registered with. This allows the same
blueprint to be registered multiple times with unique names
for ``url_for``.
| def register(self, app: App, options: dict[str, t.Any]) -> None:
"""Called by :meth:`Flask.register_blueprint` to register all
views and callbacks registered on the blueprint with the
application. Creates a :class:`.BlueprintSetupState` and calls
each :meth:`record` callback with it.
:param app: The application this blueprint is being registered
with.
:param options: Keyword arguments forwarded from
:meth:`~Flask.register_blueprint`.
.. versionchanged:: 2.3
Nested blueprints now correctly apply subdomains.
.. versionchanged:: 2.1
Registering the same blueprint with the same name multiple
times is an error.
.. versionchanged:: 2.0.1
Nested blueprints are registered with their dotted name.
This allows different blueprints with the same name to be
nested at different locations.
.. versionchanged:: 2.0.1
The ``name`` option can be used to change the (pre-dotted)
name the blueprint is registered with. This allows the same
blueprint to be registered multiple times with unique names
for ``url_for``.
"""
name_prefix = options.get("name_prefix", "")
self_name = options.get("name", self.name)
name = f"{name_prefix}.{self_name}".lstrip(".")
if name in app.blueprints:
bp_desc = "this" if app.blueprints[name] is self else "a different"
existing_at = f" '{name}'" if self_name != name else ""
raise ValueError(
f"The name '{self_name}' is already registered for"
f" {bp_desc} blueprint{existing_at}. Use 'name=' to"
f" provide a unique name."
)
first_bp_registration = not any(bp is self for bp in app.blueprints.values())
first_name_registration = name not in app.blueprints
app.blueprints[name] = self
self._got_registered_once = True
state = self.make_setup_state(app, options, first_bp_registration)
if self.has_static_folder:
state.add_url_rule(
f"{self.static_url_path}/<path:filename>",
view_func=self.send_static_file, # type: ignore[attr-defined]
endpoint="static",
)
# Merge blueprint data into parent.
if first_bp_registration or first_name_registration:
self._merge_blueprint_funcs(app, name)
for deferred in self.deferred_functions:
deferred(state)
cli_resolved_group = options.get("cli_group", self.cli_group)
if self.cli.commands:
if cli_resolved_group is None:
app.cli.commands.update(self.cli.commands)
elif cli_resolved_group is _sentinel:
self.cli.name = name
app.cli.add_command(self.cli)
else:
self.cli.name = cli_resolved_group
app.cli.add_command(self.cli)
for blueprint, bp_options in self._blueprints:
bp_options = bp_options.copy()
bp_url_prefix = bp_options.get("url_prefix")
bp_subdomain = bp_options.get("subdomain")
if bp_subdomain is None:
bp_subdomain = blueprint.subdomain
if state.subdomain is not None and bp_subdomain is not None:
bp_options["subdomain"] = bp_subdomain + "." + state.subdomain
elif bp_subdomain is not None:
bp_options["subdomain"] = bp_subdomain
elif state.subdomain is not None:
bp_options["subdomain"] = state.subdomain
if bp_url_prefix is None:
bp_url_prefix = blueprint.url_prefix
if state.url_prefix is not None and bp_url_prefix is not None:
bp_options["url_prefix"] = (
state.url_prefix.rstrip("/") + "/" + bp_url_prefix.lstrip("/")
)
elif bp_url_prefix is not None:
bp_options["url_prefix"] = bp_url_prefix
elif state.url_prefix is not None:
bp_options["url_prefix"] = state.url_prefix
bp_options["name_prefix"] = name
blueprint.register(app, bp_options)
| (self, app: 'App', options: 'dict[str, t.Any]') -> 'None' |
5,639 | flask.sansio.blueprints | register_blueprint | Register a :class:`~flask.Blueprint` on this blueprint. Keyword
arguments passed to this method will override the defaults set
on the blueprint.
.. versionchanged:: 2.0.1
The ``name`` option can be used to change the (pre-dotted)
name the blueprint is registered with. This allows the same
blueprint to be registered multiple times with unique names
for ``url_for``.
.. versionadded:: 2.0
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, blueprint: flask.sansio.blueprints.Blueprint, **options: Any) -> NoneType |
5,640 | flask.sansio.scaffold | register_error_handler | Alternative error attach function to the :meth:`errorhandler`
decorator that is more straightforward to use for non decorator
usage.
.. versionadded:: 0.7
| def setupmethod(f: F) -> F:
f_name = f.__name__
def wrapper_func(self: Scaffold, *args: t.Any, **kwargs: t.Any) -> t.Any:
self._check_setup_finished(f_name)
return f(self, *args, **kwargs)
return t.cast(F, update_wrapper(wrapper_func, f))
| (self, code_or_exception: 'type[Exception] | int', f: 'ft.ErrorHandlerCallable') -> 'None' |
5,641 | flask.sansio.scaffold | route | Decorate a view function to register it with the given URL
rule and options. Calls :meth:`add_url_rule`, which has more
details about the implementation.
.. code-block:: python
@app.route("/")
def index():
return "Hello, World!"
See :ref:`url-route-registrations`.
The endpoint name for the route defaults to the name of the view
function if the ``endpoint`` parameter isn't passed.
The ``methods`` parameter defaults to ``["GET"]``. ``HEAD`` and
``OPTIONS`` are added automatically.
:param rule: The URL rule string.
:param options: Extra options passed to the
:class:`~werkzeug.routing.Rule` object.
| def setupmethod(f: F) -> F:
f_name = f.__name__
def wrapper_func(self: Scaffold, *args: t.Any, **kwargs: t.Any) -> t.Any:
self._check_setup_finished(f_name)
return f(self, *args, **kwargs)
return t.cast(F, update_wrapper(wrapper_func, f))
| (self, rule: str, **options: Any) -> Callable[[~T_route], ~T_route] |
5,642 | flask.blueprints | send_static_file | The view function used to serve files from
:attr:`static_folder`. A route is automatically registered for
this view at :attr:`static_url_path` if :attr:`static_folder` is
set.
Note this is a duplicate of the same method in the Flask
class.
.. versionadded:: 0.5
| def send_static_file(self, filename: str) -> Response:
"""The view function used to serve files from
:attr:`static_folder`. A route is automatically registered for
this view at :attr:`static_url_path` if :attr:`static_folder` is
set.
Note this is a duplicate of the same method in the Flask
class.
.. versionadded:: 0.5
"""
if not self.has_static_folder:
raise RuntimeError("'static_folder' must be set to serve static_files.")
# send_file only knows to call get_send_file_max_age on the app,
# call it here so it works for blueprints too.
max_age = self.get_send_file_max_age(filename)
return send_from_directory(
t.cast(str, self.static_folder), filename, max_age=max_age
)
| (self, filename: 'str') -> 'Response' |
5,643 | flask.sansio.blueprints | teardown_app_request | Like :meth:`teardown_request`, but after every request, not only those
handled by the blueprint. Equivalent to :meth:`.Flask.teardown_request`.
| def __init__(
self,
blueprint: Blueprint,
app: App,
options: t.Any,
first_registration: bool,
) -> None:
#: a reference to the current application
self.app = app
#: a reference to the blueprint that created this setup state.
self.blueprint = blueprint
#: a dictionary with all options that were passed to the
#: :meth:`~flask.Flask.register_blueprint` method.
self.options = options
#: as blueprints can be registered multiple times with the
#: application and not everything wants to be registered
#: multiple times on it, this attribute can be used to figure
#: out if the blueprint was registered in the past already.
self.first_registration = first_registration
subdomain = self.options.get("subdomain")
if subdomain is None:
subdomain = self.blueprint.subdomain
#: The subdomain that the blueprint should be active for, ``None``
#: otherwise.
self.subdomain = subdomain
url_prefix = self.options.get("url_prefix")
if url_prefix is None:
url_prefix = self.blueprint.url_prefix
#: The prefix that should be used for all URLs defined on the
#: blueprint.
self.url_prefix = url_prefix
self.name = self.options.get("name", blueprint.name)
self.name_prefix = self.options.get("name_prefix", "")
#: A dictionary with URL defaults that is added to each and every
#: URL that was defined with the blueprint.
self.url_defaults = dict(self.blueprint.url_values_defaults)
self.url_defaults.update(self.options.get("url_defaults", ()))
| (self, f: ~T_teardown) -> ~T_teardown |
5,644 | flask.sansio.scaffold | teardown_request | Register a function to be called when the request context is
popped. Typically this happens at the end of each request, but
contexts may be pushed manually as well during testing.
.. code-block:: python
with app.test_request_context():
...
When the ``with`` block exits (or ``ctx.pop()`` is called), the
teardown functions are called just before the request context is
made inactive.
When a teardown function was called because of an unhandled
exception it will be passed an error object. If an
:meth:`errorhandler` is registered, it will handle the exception
and the teardown will not receive it.
Teardown functions must avoid raising exceptions. If they
execute code that might fail they must surround that code with a
``try``/``except`` block and log any errors.
The return values of teardown functions are ignored.
This is available on both app and blueprint objects. When used on an app, this
executes after every request. When used on a blueprint, this executes after
every request that the blueprint handles. To register with a blueprint and
execute after every request, use :meth:`.Blueprint.teardown_app_request`.
| def setupmethod(f: F) -> F:
f_name = f.__name__
def wrapper_func(self: Scaffold, *args: t.Any, **kwargs: t.Any) -> t.Any:
self._check_setup_finished(f_name)
return f(self, *args, **kwargs)
return t.cast(F, update_wrapper(wrapper_func, f))
| (self, f: ~T_teardown) -> ~T_teardown |
5,645 | flask.sansio.scaffold | url_defaults | Callback function for URL defaults for all view functions of the
application. It's called with the endpoint and values and should
update the values passed in place.
This is available on both app and blueprint objects. When used on an app, this
is called for every request. When used on a blueprint, this is called for
requests that the blueprint handles. To register with a blueprint and affect
every request, use :meth:`.Blueprint.app_url_defaults`.
| def setupmethod(f: F) -> F:
f_name = f.__name__
def wrapper_func(self: Scaffold, *args: t.Any, **kwargs: t.Any) -> t.Any:
self._check_setup_finished(f_name)
return f(self, *args, **kwargs)
return t.cast(F, update_wrapper(wrapper_func, f))
| (self, f: ~T_url_defaults) -> ~T_url_defaults |
5,646 | flask.sansio.scaffold | url_value_preprocessor | Register a URL value preprocessor function for all view
functions in the application. These functions will be called before the
:meth:`before_request` functions.
The function can modify the values captured from the matched url before
they are passed to the view. For example, this can be used to pop a
common language code value and place it in ``g`` rather than pass it to
every view.
The function is passed the endpoint name and values dict. The return
value is ignored.
This is available on both app and blueprint objects. When used on an app, this
is called for every request. When used on a blueprint, this is called for
requests that the blueprint handles. To register with a blueprint and affect
every request, use :meth:`.Blueprint.app_url_value_preprocessor`.
| def setupmethod(f: F) -> F:
f_name = f.__name__
def wrapper_func(self: Scaffold, *args: t.Any, **kwargs: t.Any) -> t.Any:
self._check_setup_finished(f_name)
return f(self, *args, **kwargs)
return t.cast(F, update_wrapper(wrapper_func, f))
| (self, f: ~T_url_value_preprocessor) -> ~T_url_value_preprocessor |
5,647 | flask_bower | Bower | null | class Bower(object):
def __init__(self, app=None):
if app is not None:
self.init_app(app)
def init_app(self, app):
app.config.setdefault('BOWER_COMPONENTS_ROOT', 'bower_components')
app.config.setdefault('BOWER_KEEP_DEPRECATED', True)
app.config.setdefault('BOWER_QUERYSTRING_REVVING', True)
app.config.setdefault('BOWER_REPLACE_URL_FOR', False)
app.config.setdefault('BOWER_SUBDOMAIN', None)
app.config.setdefault('BOWER_TRY_MINIFIED', True)
app.config.setdefault('BOWER_URL_PREFIX', '/bower')
blueprint = Blueprint(
'bower',
__name__,
url_prefix=app.config['BOWER_URL_PREFIX'],
subdomain=app.config['BOWER_SUBDOMAIN'])
blueprint.add_url_rule('/<component>/<path:filename>', 'serve', serve)
app.register_blueprint(blueprint)
if app.config['BOWER_KEEP_DEPRECATED'] is True:
app.jinja_env.globals['bower_url_for'] = bower_url_for
if app.config['BOWER_REPLACE_URL_FOR'] is True:
app.jinja_env.globals['url_for'] = replaced_url_for
app.url_build_error_handlers.append(handle_url_error)
| (app=None) |
5,648 | flask_bower | __init__ | null | def __init__(self, app=None):
if app is not None:
self.init_app(app)
| (self, app=None) |
5,649 | flask_bower | init_app | null | def init_app(self, app):
app.config.setdefault('BOWER_COMPONENTS_ROOT', 'bower_components')
app.config.setdefault('BOWER_KEEP_DEPRECATED', True)
app.config.setdefault('BOWER_QUERYSTRING_REVVING', True)
app.config.setdefault('BOWER_REPLACE_URL_FOR', False)
app.config.setdefault('BOWER_SUBDOMAIN', None)
app.config.setdefault('BOWER_TRY_MINIFIED', True)
app.config.setdefault('BOWER_URL_PREFIX', '/bower')
blueprint = Blueprint(
'bower',
__name__,
url_prefix=app.config['BOWER_URL_PREFIX'],
subdomain=app.config['BOWER_SUBDOMAIN'])
blueprint.add_url_rule('/<component>/<path:filename>', 'serve', serve)
app.register_blueprint(blueprint)
if app.config['BOWER_KEEP_DEPRECATED'] is True:
app.jinja_env.globals['bower_url_for'] = bower_url_for
if app.config['BOWER_REPLACE_URL_FOR'] is True:
app.jinja_env.globals['url_for'] = replaced_url_for
app.url_build_error_handlers.append(handle_url_error)
| (self, app) |
5,650 | flask.helpers | abort | Raise an :exc:`~werkzeug.exceptions.HTTPException` for the given
status code.
If :data:`~flask.current_app` is available, it will call its
:attr:`~flask.Flask.aborter` object, otherwise it will use
:func:`werkzeug.exceptions.abort`.
:param code: The status code for the exception, which must be
registered in ``app.aborter``.
:param args: Passed to the exception.
:param kwargs: Passed to the exception.
.. versionadded:: 2.2
Calls ``current_app.aborter`` if available instead of always
using Werkzeug's default ``abort``.
| def abort(code: int | BaseResponse, *args: t.Any, **kwargs: t.Any) -> t.NoReturn:
"""Raise an :exc:`~werkzeug.exceptions.HTTPException` for the given
status code.
If :data:`~flask.current_app` is available, it will call its
:attr:`~flask.Flask.aborter` object, otherwise it will use
:func:`werkzeug.exceptions.abort`.
:param code: The status code for the exception, which must be
registered in ``app.aborter``.
:param args: Passed to the exception.
:param kwargs: Passed to the exception.
.. versionadded:: 2.2
Calls ``current_app.aborter`` if available instead of always
using Werkzeug's default ``abort``.
"""
if current_app:
current_app.aborter(code, *args, **kwargs)
_wz_abort(code, *args, **kwargs)
| (code: int | werkzeug.wrappers.response.Response, *args: Any, **kwargs: Any) -> NoReturn |
5,651 | flask_bower | bower_url_for |
DEPRECATED
This function provides backward compatibility - please migrate to the approach using "bower.static"
:param component: bower component (package)
:type component: str
:param filename: filename in bower component - can contain directories (like dist/jquery.js)
:type filename: str
:param values: additional url parameters
:type values: dict[str, str]
:return: url
:rtype: str
| def bower_url_for(component, filename, **values):
"""
DEPRECATED
This function provides backward compatibility - please migrate to the approach using "bower.static"
:param component: bower component (package)
:type component: str
:param filename: filename in bower component - can contain directories (like dist/jquery.js)
:type filename: str
:param values: additional url parameters
:type values: dict[str, str]
:return: url
:rtype: str
"""
return build_url(component, filename, **values)
| (component, filename, **values) |
5,652 | flask_bower | build_url |
search bower asset and build url
:param component: bower component (package)
:type component: str
:param filename: filename in bower component - can contain directories (like dist/jquery.js)
:type filename: str
:param values: additional url parameters
:type values: dict[str, str]
:return: url
:rtype: str | None
| def build_url(component, filename, **values):
"""
search bower asset and build url
:param component: bower component (package)
:type component: str
:param filename: filename in bower component - can contain directories (like dist/jquery.js)
:type filename: str
:param values: additional url parameters
:type values: dict[str, str]
:return: url
:rtype: str | None
"""
root = current_app.config['BOWER_COMPONENTS_ROOT']
bower_data = None
package_data = None
# check if component exists in bower_components directory
if not os.path.isdir(os.path.join(current_app.root_path, root, component)):
# FallBack to default url_for flask
return None
# load bower.json of specified component
bower_file_path = os.path.join(current_app.root_path, root, component, '.bower.json')
if os.path.exists(bower_file_path):
with open(bower_file_path, 'r') as bower_file:
bower_data = json.load(bower_file)
# check if package.json exists and load package.json data
package_file_path = os.path.join(current_app.root_path, root, component, 'package.json')
if os.path.exists(package_file_path):
with open(package_file_path, 'r') as package_file:
package_data = json.load(package_file)
# check if specified file actually exists
if not os.path.exists(os.path.join(current_app.root_path, root, component, filename)):
return None
# check if minified file exists (by pattern <filename>.min.<ext>
# returns filename if successful
if current_app.config['BOWER_TRY_MINIFIED']:
if '.min.' not in filename:
minified_filename = '%s.min.%s' % tuple(filename.rsplit('.', 1))
minified_path = os.path.join(root, component, minified_filename)
if os.path.exists(os.path.join(current_app.root_path, minified_path)):
filename = minified_filename
# determine version of component and append as ?version= parameter to allow cache busting
if current_app.config['BOWER_QUERYSTRING_REVVING']:
if bower_data is not None and 'version' in bower_data:
values['version'] = bower_data['version']
elif package_data is not None and 'version' in package_data:
values['version'] = package_data['version']
else:
values['version'] = os.path.getmtime(os.path.join(current_app.root_path, root, component, filename))
return url_for('bower.serve', component=component, filename=filename, **values)
| (component, filename, **values) |
5,653 | flask_bower | handle_url_error |
Intercept BuildErrors of url_for() using flasks build_error_handler API
| def handle_url_error(error, endpoint, values):
"""
Intercept BuildErrors of url_for() using flasks build_error_handler API
"""
url = overlay_url_for(endpoint, **values)
if url is None:
exc_type, exc_value, tb = sys.exc_info()
if exc_value is error:
raise exc_type(exc_value, endpoint, values).with_traceback(tb)
else:
raise error
# url_for will use this result, instead of raising BuildError.
return url
| (error, endpoint, values) |
5,656 | flask_bower | overlay_url_for |
Replace flasks url_for() function to allow usage without template changes
If the requested endpoint is static or ending in .static, it tries to serve a bower asset, otherwise it will pass
the arguments to flask.url_for()
See http://flask.pocoo.org/docs/0.10/api/#flask.url_for
| def overlay_url_for(endpoint, filename=None, **values):
"""
Replace flasks url_for() function to allow usage without template changes
If the requested endpoint is static or ending in .static, it tries to serve a bower asset, otherwise it will pass
the arguments to flask.url_for()
See http://flask.pocoo.org/docs/0.10/api/#flask.url_for
"""
default_url_for_args = values.copy()
if filename:
default_url_for_args['filename'] = filename
if endpoint == 'static' or endpoint.endswith('.static'):
if os.path.sep in filename:
filename_parts = filename.split(os.path.sep)
component = filename_parts[0]
# Using * magic here to expand list
filename = os.path.join(*filename_parts[1:])
returned_url = build_url(component, filename, **values)
if returned_url is not None:
return returned_url
return None
| (endpoint, filename=None, **values) |
5,657 | flask_bower | replaced_url_for |
This function acts as "replacement" for the default url_for() and intercepts if it is a request for bower assets
If the file is not available in bower, the result is passed to flasks url_for().
This is useful - but not recommended - for "overlaying" the static directory (see README.rst).
| def replaced_url_for(endpoint, filename=None, **values):
"""
This function acts as "replacement" for the default url_for() and intercepts if it is a request for bower assets
If the file is not available in bower, the result is passed to flasks url_for().
This is useful - but not recommended - for "overlaying" the static directory (see README.rst).
"""
lookup_result = overlay_url_for(endpoint, filename, **values)
if lookup_result is not None:
return lookup_result
return url_for(endpoint, filename=filename, **values)
| (endpoint, filename=None, **values) |
5,658 | flask.helpers | send_file | Send the contents of a file to the client.
The first argument can be a file path or a file-like object. Paths
are preferred in most cases because Werkzeug can manage the file and
get extra information from the path. Passing a file-like object
requires that the file is opened in binary mode, and is mostly
useful when building a file in memory with :class:`io.BytesIO`.
Never pass file paths provided by a user. The path is assumed to be
trusted, so a user could craft a path to access a file you didn't
intend. Use :func:`send_from_directory` to safely serve
user-requested paths from within a directory.
If the WSGI server sets a ``file_wrapper`` in ``environ``, it is
used, otherwise Werkzeug's built-in wrapper is used. Alternatively,
if the HTTP server supports ``X-Sendfile``, configuring Flask with
``USE_X_SENDFILE = True`` will tell the server to send the given
path, which is much more efficient than reading it in Python.
:param path_or_file: The path to the file to send, relative to the
current working directory if a relative path is given.
Alternatively, a file-like object opened in binary mode. Make
sure the file pointer is seeked to the start of the data.
:param mimetype: The MIME type to send for the file. If not
provided, it will try to detect it from the file name.
:param as_attachment: Indicate to a browser that it should offer to
save the file instead of displaying it.
:param download_name: The default name browsers will use when saving
the file. Defaults to the passed file name.
:param conditional: Enable conditional and range responses based on
request headers. Requires passing a file path and ``environ``.
:param etag: Calculate an ETag for the file, which requires passing
a file path. Can also be a string to use instead.
:param last_modified: The last modified time to send for the file,
in seconds. If not provided, it will try to detect it from the
file path.
:param max_age: How long the client should cache the file, in
seconds. If set, ``Cache-Control`` will be ``public``, otherwise
it will be ``no-cache`` to prefer conditional caching.
.. versionchanged:: 2.0
``download_name`` replaces the ``attachment_filename``
parameter. If ``as_attachment=False``, it is passed with
``Content-Disposition: inline`` instead.
.. versionchanged:: 2.0
``max_age`` replaces the ``cache_timeout`` parameter.
``conditional`` is enabled and ``max_age`` is not set by
default.
.. versionchanged:: 2.0
``etag`` replaces the ``add_etags`` parameter. It can be a
string to use instead of generating one.
.. versionchanged:: 2.0
Passing a file-like object that inherits from
:class:`~io.TextIOBase` will raise a :exc:`ValueError` rather
than sending an empty file.
.. versionadded:: 2.0
Moved the implementation to Werkzeug. This is now a wrapper to
pass some Flask-specific arguments.
.. versionchanged:: 1.1
``filename`` may be a :class:`~os.PathLike` object.
.. versionchanged:: 1.1
Passing a :class:`~io.BytesIO` object supports range requests.
.. versionchanged:: 1.0.3
Filenames are encoded with ASCII instead of Latin-1 for broader
compatibility with WSGI servers.
.. versionchanged:: 1.0
UTF-8 filenames as specified in :rfc:`2231` are supported.
.. versionchanged:: 0.12
The filename is no longer automatically inferred from file
objects. If you want to use automatic MIME and etag support,
pass a filename via ``filename_or_fp`` or
``attachment_filename``.
.. versionchanged:: 0.12
``attachment_filename`` is preferred over ``filename`` for MIME
detection.
.. versionchanged:: 0.9
``cache_timeout`` defaults to
:meth:`Flask.get_send_file_max_age`.
.. versionchanged:: 0.7
MIME guessing and etag support for file-like objects was
removed because it was unreliable. Pass a filename if you are
able to, otherwise attach an etag yourself.
.. versionchanged:: 0.5
The ``add_etags``, ``cache_timeout`` and ``conditional``
parameters were added. The default behavior is to add etags.
.. versionadded:: 0.2
| def send_file(
path_or_file: os.PathLike[t.AnyStr] | str | t.BinaryIO,
mimetype: str | None = None,
as_attachment: bool = False,
download_name: str | None = None,
conditional: bool = True,
etag: bool | str = True,
last_modified: datetime | int | float | None = None,
max_age: None | (int | t.Callable[[str | None], int | None]) = None,
) -> Response:
"""Send the contents of a file to the client.
The first argument can be a file path or a file-like object. Paths
are preferred in most cases because Werkzeug can manage the file and
get extra information from the path. Passing a file-like object
requires that the file is opened in binary mode, and is mostly
useful when building a file in memory with :class:`io.BytesIO`.
Never pass file paths provided by a user. The path is assumed to be
trusted, so a user could craft a path to access a file you didn't
intend. Use :func:`send_from_directory` to safely serve
user-requested paths from within a directory.
If the WSGI server sets a ``file_wrapper`` in ``environ``, it is
used, otherwise Werkzeug's built-in wrapper is used. Alternatively,
if the HTTP server supports ``X-Sendfile``, configuring Flask with
``USE_X_SENDFILE = True`` will tell the server to send the given
path, which is much more efficient than reading it in Python.
:param path_or_file: The path to the file to send, relative to the
current working directory if a relative path is given.
Alternatively, a file-like object opened in binary mode. Make
sure the file pointer is seeked to the start of the data.
:param mimetype: The MIME type to send for the file. If not
provided, it will try to detect it from the file name.
:param as_attachment: Indicate to a browser that it should offer to
save the file instead of displaying it.
:param download_name: The default name browsers will use when saving
the file. Defaults to the passed file name.
:param conditional: Enable conditional and range responses based on
request headers. Requires passing a file path and ``environ``.
:param etag: Calculate an ETag for the file, which requires passing
a file path. Can also be a string to use instead.
:param last_modified: The last modified time to send for the file,
in seconds. If not provided, it will try to detect it from the
file path.
:param max_age: How long the client should cache the file, in
seconds. If set, ``Cache-Control`` will be ``public``, otherwise
it will be ``no-cache`` to prefer conditional caching.
.. versionchanged:: 2.0
``download_name`` replaces the ``attachment_filename``
parameter. If ``as_attachment=False``, it is passed with
``Content-Disposition: inline`` instead.
.. versionchanged:: 2.0
``max_age`` replaces the ``cache_timeout`` parameter.
``conditional`` is enabled and ``max_age`` is not set by
default.
.. versionchanged:: 2.0
``etag`` replaces the ``add_etags`` parameter. It can be a
string to use instead of generating one.
.. versionchanged:: 2.0
Passing a file-like object that inherits from
:class:`~io.TextIOBase` will raise a :exc:`ValueError` rather
than sending an empty file.
.. versionadded:: 2.0
Moved the implementation to Werkzeug. This is now a wrapper to
pass some Flask-specific arguments.
.. versionchanged:: 1.1
``filename`` may be a :class:`~os.PathLike` object.
.. versionchanged:: 1.1
Passing a :class:`~io.BytesIO` object supports range requests.
.. versionchanged:: 1.0.3
Filenames are encoded with ASCII instead of Latin-1 for broader
compatibility with WSGI servers.
.. versionchanged:: 1.0
UTF-8 filenames as specified in :rfc:`2231` are supported.
.. versionchanged:: 0.12
The filename is no longer automatically inferred from file
objects. If you want to use automatic MIME and etag support,
pass a filename via ``filename_or_fp`` or
``attachment_filename``.
.. versionchanged:: 0.12
``attachment_filename`` is preferred over ``filename`` for MIME
detection.
.. versionchanged:: 0.9
``cache_timeout`` defaults to
:meth:`Flask.get_send_file_max_age`.
.. versionchanged:: 0.7
MIME guessing and etag support for file-like objects was
removed because it was unreliable. Pass a filename if you are
able to, otherwise attach an etag yourself.
.. versionchanged:: 0.5
The ``add_etags``, ``cache_timeout`` and ``conditional``
parameters were added. The default behavior is to add etags.
.. versionadded:: 0.2
"""
return werkzeug.utils.send_file( # type: ignore[return-value]
**_prepare_send_file_kwargs(
path_or_file=path_or_file,
environ=request.environ,
mimetype=mimetype,
as_attachment=as_attachment,
download_name=download_name,
conditional=conditional,
etag=etag,
last_modified=last_modified,
max_age=max_age,
)
)
| (path_or_file: 'os.PathLike[t.AnyStr] | str | t.BinaryIO', mimetype: 'str | None' = None, as_attachment: 'bool' = False, download_name: 'str | None' = None, conditional: 'bool' = True, etag: 'bool | str' = True, last_modified: 'datetime | int | float | None' = None, max_age: 'None | (int | t.Callable[[str | None], int | None])' = None) -> 'Response' |
5,659 | flask_bower | serve | null | def serve(component, filename):
validate_parameter(component)
validate_parameter(filename)
root = current_app.config['BOWER_COMPONENTS_ROOT']
return send_file(os.path.join(root, component, filename), conditional=True)
| (component, filename) |
5,661 | flask.helpers | url_for | Generate a URL to the given endpoint with the given values.
This requires an active request or application context, and calls
:meth:`current_app.url_for() <flask.Flask.url_for>`. See that method
for full documentation.
:param endpoint: The endpoint name associated with the URL to
generate. If this starts with a ``.``, the current blueprint
name (if any) will be used.
:param _anchor: If given, append this as ``#anchor`` to the URL.
:param _method: If given, generate the URL associated with this
method for the endpoint.
:param _scheme: If given, the URL will have this scheme if it is
external.
:param _external: If given, prefer the URL to be internal (False) or
require it to be external (True). External URLs include the
scheme and domain. When not in an active request, URLs are
external by default.
:param values: Values to use for the variable parts of the URL rule.
Unknown keys are appended as query string arguments, like
``?a=b&c=d``.
.. versionchanged:: 2.2
Calls ``current_app.url_for``, allowing an app to override the
behavior.
.. versionchanged:: 0.10
The ``_scheme`` parameter was added.
.. versionchanged:: 0.9
The ``_anchor`` and ``_method`` parameters were added.
.. versionchanged:: 0.9
Calls ``app.handle_url_build_error`` on build errors.
| def url_for(
endpoint: str,
*,
_anchor: str | None = None,
_method: str | None = None,
_scheme: str | None = None,
_external: bool | None = None,
**values: t.Any,
) -> str:
"""Generate a URL to the given endpoint with the given values.
This requires an active request or application context, and calls
:meth:`current_app.url_for() <flask.Flask.url_for>`. See that method
for full documentation.
:param endpoint: The endpoint name associated with the URL to
generate. If this starts with a ``.``, the current blueprint
name (if any) will be used.
:param _anchor: If given, append this as ``#anchor`` to the URL.
:param _method: If given, generate the URL associated with this
method for the endpoint.
:param _scheme: If given, the URL will have this scheme if it is
external.
:param _external: If given, prefer the URL to be internal (False) or
require it to be external (True). External URLs include the
scheme and domain. When not in an active request, URLs are
external by default.
:param values: Values to use for the variable parts of the URL rule.
Unknown keys are appended as query string arguments, like
``?a=b&c=d``.
.. versionchanged:: 2.2
Calls ``current_app.url_for``, allowing an app to override the
behavior.
.. versionchanged:: 0.10
The ``_scheme`` parameter was added.
.. versionchanged:: 0.9
The ``_anchor`` and ``_method`` parameters were added.
.. versionchanged:: 0.9
Calls ``app.handle_url_build_error`` on build errors.
"""
return current_app.url_for(
endpoint,
_anchor=_anchor,
_method=_method,
_scheme=_scheme,
_external=_external,
**values,
)
| (endpoint: str, *, _anchor: Optional[str] = None, _method: Optional[str] = None, _scheme: Optional[str] = None, _external: Optional[bool] = None, **values: Any) -> str |
5,662 | flask_bower | validate_parameter | null | def validate_parameter(param):
if '..' in param or param.startswith('/'):
abort(404)
| (param) |
5,663 | builtins | CozoDbMulTx | null | from builtins import CozoDbMulTx
| null |
5,664 | builtins | CozoDbPy | from builtins import CozoDbPy
| (engine, path, options) |
|
5,666 | wordcloud.color_from_image | ImageColorGenerator | Color generator based on a color image.
Generates colors based on an RGB image. A word will be colored using
the mean color of the enclosing rectangle in the color image.
After construction, the object acts as a callable that can be passed as
color_func to the word cloud constructor or to the recolor method.
Parameters
----------
image : nd-array, shape (height, width, 3)
Image to use to generate word colors. Alpha channels are ignored.
This should be the same size as the canvas. for the wordcloud.
default_color : tuple or None, default=None
Fallback colour to use if the canvas is larger than the image,
in the format (r, g, b). If None, raise ValueError instead.
| class ImageColorGenerator(object):
"""Color generator based on a color image.
Generates colors based on an RGB image. A word will be colored using
the mean color of the enclosing rectangle in the color image.
After construction, the object acts as a callable that can be passed as
color_func to the word cloud constructor or to the recolor method.
Parameters
----------
image : nd-array, shape (height, width, 3)
Image to use to generate word colors. Alpha channels are ignored.
This should be the same size as the canvas. for the wordcloud.
default_color : tuple or None, default=None
Fallback colour to use if the canvas is larger than the image,
in the format (r, g, b). If None, raise ValueError instead.
"""
# returns the average color of the image in that region
def __init__(self, image, default_color=None):
if image.ndim not in [2, 3]:
raise ValueError("ImageColorGenerator needs an image with ndim 2 or"
" 3, got %d" % image.ndim)
if image.ndim == 3 and image.shape[2] not in [3, 4]:
raise ValueError("A color image needs to have 3 or 4 channels, got %d"
% image.shape[2])
self.image = image
self.default_color = default_color
def __call__(self, word, font_size, font_path, position, orientation, **kwargs):
"""Generate a color for a given word using a fixed image."""
# get the font to get the box size
font = ImageFont.truetype(font_path, font_size)
transposed_font = ImageFont.TransposedFont(font,
orientation=orientation)
# get size of resulting text
box_size = transposed_font.getbbox(word)
x = position[0]
y = position[1]
# cut out patch under word box
patch = self.image[x:x + box_size[2], y:y + box_size[3]]
if patch.ndim == 3:
# drop alpha channel if any
patch = patch[:, :, :3]
if patch.ndim == 2:
raise NotImplementedError("Gray-scale images TODO")
# check if the text is within the bounds of the image
reshape = patch.reshape(-1, 3)
if not np.all(reshape.shape):
if self.default_color is None:
raise ValueError('ImageColorGenerator is smaller than the canvas')
return "rgb(%d, %d, %d)" % tuple(self.default_color)
color = np.mean(reshape, axis=0)
return "rgb(%d, %d, %d)" % tuple(color)
| (image, default_color=None) |
5,667 | wordcloud.color_from_image | __call__ | Generate a color for a given word using a fixed image. | def __call__(self, word, font_size, font_path, position, orientation, **kwargs):
"""Generate a color for a given word using a fixed image."""
# get the font to get the box size
font = ImageFont.truetype(font_path, font_size)
transposed_font = ImageFont.TransposedFont(font,
orientation=orientation)
# get size of resulting text
box_size = transposed_font.getbbox(word)
x = position[0]
y = position[1]
# cut out patch under word box
patch = self.image[x:x + box_size[2], y:y + box_size[3]]
if patch.ndim == 3:
# drop alpha channel if any
patch = patch[:, :, :3]
if patch.ndim == 2:
raise NotImplementedError("Gray-scale images TODO")
# check if the text is within the bounds of the image
reshape = patch.reshape(-1, 3)
if not np.all(reshape.shape):
if self.default_color is None:
raise ValueError('ImageColorGenerator is smaller than the canvas')
return "rgb(%d, %d, %d)" % tuple(self.default_color)
color = np.mean(reshape, axis=0)
return "rgb(%d, %d, %d)" % tuple(color)
| (self, word, font_size, font_path, position, orientation, **kwargs) |
5,668 | wordcloud.color_from_image | __init__ | null | def __init__(self, image, default_color=None):
if image.ndim not in [2, 3]:
raise ValueError("ImageColorGenerator needs an image with ndim 2 or"
" 3, got %d" % image.ndim)
if image.ndim == 3 and image.shape[2] not in [3, 4]:
raise ValueError("A color image needs to have 3 or 4 channels, got %d"
% image.shape[2])
self.image = image
self.default_color = default_color
| (self, image, default_color=None) |
5,669 | wordcloud.wordcloud | WordCloud | Word cloud object for generating and drawing.
Parameters
----------
font_path : string
Font path to the font that will be used (OTF or TTF).
Defaults to DroidSansMono path on a Linux machine. If you are on
another OS or don't have this font, you need to adjust this path.
width : int (default=400)
Width of the canvas.
height : int (default=200)
Height of the canvas.
prefer_horizontal : float (default=0.90)
The ratio of times to try horizontal fitting as opposed to vertical.
If prefer_horizontal < 1, the algorithm will try rotating the word
if it doesn't fit. (There is currently no built-in way to get only
vertical words.)
mask : nd-array or None (default=None)
If not None, gives a binary mask on where to draw words. If mask is not
None, width and height will be ignored and the shape of mask will be
used instead. All white (#FF or #FFFFFF) entries will be considerd
"masked out" while other entries will be free to draw on. [This
changed in the most recent version!]
contour_width: float (default=0)
If mask is not None and contour_width > 0, draw the mask contour.
contour_color: color value (default="black")
Mask contour color.
scale : float (default=1)
Scaling between computation and drawing. For large word-cloud images,
using scale instead of larger canvas size is significantly faster, but
might lead to a coarser fit for the words.
min_font_size : int (default=4)
Smallest font size to use. Will stop when there is no more room in this
size.
font_step : int (default=1)
Step size for the font. font_step > 1 might speed up computation but
give a worse fit.
max_words : number (default=200)
The maximum number of words.
stopwords : set of strings or None
The words that will be eliminated. If None, the build-in STOPWORDS
list will be used. Ignored if using generate_from_frequencies.
background_color : color value (default="black")
Background color for the word cloud image.
max_font_size : int or None (default=None)
Maximum font size for the largest word. If None, height of the image is
used.
mode : string (default="RGB")
Transparent background will be generated when mode is "RGBA" and
background_color is None.
relative_scaling : float (default='auto')
Importance of relative word frequencies for font-size. With
relative_scaling=0, only word-ranks are considered. With
relative_scaling=1, a word that is twice as frequent will have twice
the size. If you want to consider the word frequencies and not only
their rank, relative_scaling around .5 often looks good.
If 'auto' it will be set to 0.5 unless repeat is true, in which
case it will be set to 0.
.. versionchanged: 2.0
Default is now 'auto'.
color_func : callable, default=None
Callable with parameters word, font_size, position, orientation,
font_path, random_state that returns a PIL color for each word.
Overwrites "colormap".
See colormap for specifying a matplotlib colormap instead.
To create a word cloud with a single color, use
``color_func=lambda *args, **kwargs: "white"``.
The single color can also be specified using RGB code. For example
``color_func=lambda *args, **kwargs: (255,0,0)`` sets color to red.
regexp : string or None (optional)
Regular expression to split the input text into tokens in process_text.
If None is specified, ``r"\w[\w']+"`` is used. Ignored if using
generate_from_frequencies.
collocations : bool, default=True
Whether to include collocations (bigrams) of two words. Ignored if using
generate_from_frequencies.
.. versionadded: 2.0
colormap : string or matplotlib colormap, default="viridis"
Matplotlib colormap to randomly draw colors from for each word.
Ignored if "color_func" is specified.
.. versionadded: 2.0
normalize_plurals : bool, default=True
Whether to remove trailing 's' from words. If True and a word
appears with and without a trailing 's', the one with trailing 's'
is removed and its counts are added to the version without
trailing 's' -- unless the word ends with 'ss'. Ignored if using
generate_from_frequencies.
repeat : bool, default=False
Whether to repeat words and phrases until max_words or min_font_size
is reached.
include_numbers : bool, default=False
Whether to include numbers as phrases or not.
min_word_length : int, default=0
Minimum number of letters a word must have to be included.
collocation_threshold: int, default=30
Bigrams must have a Dunning likelihood collocation score greater than this
parameter to be counted as bigrams. Default of 30 is arbitrary.
See Manning, C.D., Manning, C.D. and Schütze, H., 1999. Foundations of
Statistical Natural Language Processing. MIT press, p. 162
https://nlp.stanford.edu/fsnlp/promo/colloc.pdf#page=22
Attributes
----------
``words_`` : dict of string to float
Word tokens with associated frequency.
.. versionchanged: 2.0
``words_`` is now a dictionary
``layout_`` : list of tuples ((string, float), int, (int, int), int, color))
Encodes the fitted word cloud. For each word, it encodes the string,
normalized frequency, font size, position, orientation, and color.
The frequencies are normalized by the most commonly occurring word.
The color is in the format of 'rgb(R, G, B).'
Notes
-----
Larger canvases make the code significantly slower. If you need a
large word cloud, try a lower canvas size, and set the scale parameter.
The algorithm might give more weight to the ranking of the words
than their actual frequencies, depending on the ``max_font_size`` and the
scaling heuristic.
| class WordCloud(object):
r"""Word cloud object for generating and drawing.
Parameters
----------
font_path : string
Font path to the font that will be used (OTF or TTF).
Defaults to DroidSansMono path on a Linux machine. If you are on
another OS or don't have this font, you need to adjust this path.
width : int (default=400)
Width of the canvas.
height : int (default=200)
Height of the canvas.
prefer_horizontal : float (default=0.90)
The ratio of times to try horizontal fitting as opposed to vertical.
If prefer_horizontal < 1, the algorithm will try rotating the word
if it doesn't fit. (There is currently no built-in way to get only
vertical words.)
mask : nd-array or None (default=None)
If not None, gives a binary mask on where to draw words. If mask is not
None, width and height will be ignored and the shape of mask will be
used instead. All white (#FF or #FFFFFF) entries will be considerd
"masked out" while other entries will be free to draw on. [This
changed in the most recent version!]
contour_width: float (default=0)
If mask is not None and contour_width > 0, draw the mask contour.
contour_color: color value (default="black")
Mask contour color.
scale : float (default=1)
Scaling between computation and drawing. For large word-cloud images,
using scale instead of larger canvas size is significantly faster, but
might lead to a coarser fit for the words.
min_font_size : int (default=4)
Smallest font size to use. Will stop when there is no more room in this
size.
font_step : int (default=1)
Step size for the font. font_step > 1 might speed up computation but
give a worse fit.
max_words : number (default=200)
The maximum number of words.
stopwords : set of strings or None
The words that will be eliminated. If None, the build-in STOPWORDS
list will be used. Ignored if using generate_from_frequencies.
background_color : color value (default="black")
Background color for the word cloud image.
max_font_size : int or None (default=None)
Maximum font size for the largest word. If None, height of the image is
used.
mode : string (default="RGB")
Transparent background will be generated when mode is "RGBA" and
background_color is None.
relative_scaling : float (default='auto')
Importance of relative word frequencies for font-size. With
relative_scaling=0, only word-ranks are considered. With
relative_scaling=1, a word that is twice as frequent will have twice
the size. If you want to consider the word frequencies and not only
their rank, relative_scaling around .5 often looks good.
If 'auto' it will be set to 0.5 unless repeat is true, in which
case it will be set to 0.
.. versionchanged: 2.0
Default is now 'auto'.
color_func : callable, default=None
Callable with parameters word, font_size, position, orientation,
font_path, random_state that returns a PIL color for each word.
Overwrites "colormap".
See colormap for specifying a matplotlib colormap instead.
To create a word cloud with a single color, use
``color_func=lambda *args, **kwargs: "white"``.
The single color can also be specified using RGB code. For example
``color_func=lambda *args, **kwargs: (255,0,0)`` sets color to red.
regexp : string or None (optional)
Regular expression to split the input text into tokens in process_text.
If None is specified, ``r"\w[\w']+"`` is used. Ignored if using
generate_from_frequencies.
collocations : bool, default=True
Whether to include collocations (bigrams) of two words. Ignored if using
generate_from_frequencies.
.. versionadded: 2.0
colormap : string or matplotlib colormap, default="viridis"
Matplotlib colormap to randomly draw colors from for each word.
Ignored if "color_func" is specified.
.. versionadded: 2.0
normalize_plurals : bool, default=True
Whether to remove trailing 's' from words. If True and a word
appears with and without a trailing 's', the one with trailing 's'
is removed and its counts are added to the version without
trailing 's' -- unless the word ends with 'ss'. Ignored if using
generate_from_frequencies.
repeat : bool, default=False
Whether to repeat words and phrases until max_words or min_font_size
is reached.
include_numbers : bool, default=False
Whether to include numbers as phrases or not.
min_word_length : int, default=0
Minimum number of letters a word must have to be included.
collocation_threshold: int, default=30
Bigrams must have a Dunning likelihood collocation score greater than this
parameter to be counted as bigrams. Default of 30 is arbitrary.
See Manning, C.D., Manning, C.D. and Schütze, H., 1999. Foundations of
Statistical Natural Language Processing. MIT press, p. 162
https://nlp.stanford.edu/fsnlp/promo/colloc.pdf#page=22
Attributes
----------
``words_`` : dict of string to float
Word tokens with associated frequency.
.. versionchanged: 2.0
``words_`` is now a dictionary
``layout_`` : list of tuples ((string, float), int, (int, int), int, color))
Encodes the fitted word cloud. For each word, it encodes the string,
normalized frequency, font size, position, orientation, and color.
The frequencies are normalized by the most commonly occurring word.
The color is in the format of 'rgb(R, G, B).'
Notes
-----
Larger canvases make the code significantly slower. If you need a
large word cloud, try a lower canvas size, and set the scale parameter.
The algorithm might give more weight to the ranking of the words
than their actual frequencies, depending on the ``max_font_size`` and the
scaling heuristic.
"""
def __init__(self, font_path=None, width=400, height=200, margin=2,
ranks_only=None, prefer_horizontal=.9, mask=None, scale=1,
color_func=None, max_words=200, min_font_size=4,
stopwords=None, random_state=None, background_color='black',
max_font_size=None, font_step=1, mode="RGB",
relative_scaling='auto', regexp=None, collocations=True,
colormap=None, normalize_plurals=True, contour_width=0,
contour_color='black', repeat=False,
include_numbers=False, min_word_length=0, collocation_threshold=30):
if font_path is None:
font_path = FONT_PATH
if color_func is None and colormap is None:
version = matplotlib.__version__
if version[0] < "2" and version[2] < "5":
colormap = "hsv"
else:
colormap = "viridis"
self.colormap = colormap
self.collocations = collocations
self.font_path = font_path
self.width = width
self.height = height
self.margin = margin
self.prefer_horizontal = prefer_horizontal
self.mask = mask
self.contour_color = contour_color
self.contour_width = contour_width
self.scale = scale
self.color_func = color_func or colormap_color_func(colormap)
self.max_words = max_words
self.stopwords = stopwords if stopwords is not None else STOPWORDS
self.min_font_size = min_font_size
self.font_step = font_step
self.regexp = regexp
if isinstance(random_state, int):
random_state = Random(random_state)
self.random_state = random_state
self.background_color = background_color
self.max_font_size = max_font_size
self.mode = mode
if relative_scaling == "auto":
if repeat:
relative_scaling = 0
else:
relative_scaling = .5
if relative_scaling < 0 or relative_scaling > 1:
raise ValueError("relative_scaling needs to be "
"between 0 and 1, got %f." % relative_scaling)
self.relative_scaling = relative_scaling
if ranks_only is not None:
warnings.warn("ranks_only is deprecated and will be removed as"
" it had no effect. Look into relative_scaling.",
DeprecationWarning)
self.normalize_plurals = normalize_plurals
self.repeat = repeat
self.include_numbers = include_numbers
self.min_word_length = min_word_length
self.collocation_threshold = collocation_threshold
# Override the width and height if there is a mask
if mask is not None:
self.width = mask.shape[1]
self.height = mask.shape[0]
def fit_words(self, frequencies):
"""Create a word_cloud from words and frequencies.
Alias to generate_from_frequencies.
Parameters
----------
frequencies : dict from string to float
A contains words and associated frequency.
Returns
-------
self
"""
return self.generate_from_frequencies(frequencies)
def generate_from_frequencies(self, frequencies, max_font_size=None): # noqa: C901
"""Create a word_cloud from words and frequencies.
Parameters
----------
frequencies : dict from string to float
A contains words and associated frequency.
max_font_size : int
Use this font-size instead of self.max_font_size
Returns
-------
self
"""
# make sure frequencies are sorted and normalized
frequencies = sorted(frequencies.items(), key=itemgetter(1), reverse=True)
if len(frequencies) <= 0:
raise ValueError("We need at least 1 word to plot a word cloud, "
"got %d." % len(frequencies))
frequencies = frequencies[:self.max_words]
# largest entry will be 1
max_frequency = float(frequencies[0][1])
frequencies = [(word, freq / max_frequency)
for word, freq in frequencies]
if self.random_state is not None:
random_state = self.random_state
else:
random_state = Random()
if self.mask is not None:
boolean_mask = self._get_bolean_mask(self.mask)
width = self.mask.shape[1]
height = self.mask.shape[0]
else:
boolean_mask = None
height, width = self.height, self.width
occupancy = IntegralOccupancyMap(height, width, boolean_mask)
# create image
img_grey = Image.new("L", (width, height))
draw = ImageDraw.Draw(img_grey)
img_array = np.asarray(img_grey)
font_sizes, positions, orientations, colors = [], [], [], []
last_freq = 1.
if max_font_size is None:
# if not provided use default font_size
max_font_size = self.max_font_size
if max_font_size is None:
# figure out a good font size by trying to draw with
# just the first two words
if len(frequencies) == 1:
# we only have one word. We make it big!
font_size = self.height
else:
self.generate_from_frequencies(dict(frequencies[:2]),
max_font_size=self.height)
# find font sizes
sizes = [x[1] for x in self.layout_]
try:
font_size = int(2 * sizes[0] * sizes[1]
/ (sizes[0] + sizes[1]))
# quick fix for if self.layout_ contains less than 2 values
# on very small images it can be empty
except IndexError:
try:
font_size = sizes[0]
except IndexError:
raise ValueError(
"Couldn't find space to draw. Either the Canvas size"
" is too small or too much of the image is masked "
"out.")
else:
font_size = max_font_size
# we set self.words_ here because we called generate_from_frequencies
# above... hurray for good design?
self.words_ = dict(frequencies)
if self.repeat and len(frequencies) < self.max_words:
# pad frequencies with repeating words.
times_extend = int(np.ceil(self.max_words / len(frequencies))) - 1
# get smallest frequency
frequencies_org = list(frequencies)
downweight = frequencies[-1][1]
for i in range(times_extend):
frequencies.extend([(word, freq * downweight ** (i + 1))
for word, freq in frequencies_org])
# start drawing grey image
for word, freq in frequencies:
if freq == 0:
continue
# select the font size
rs = self.relative_scaling
if rs != 0:
font_size = int(round((rs * (freq / float(last_freq))
+ (1 - rs)) * font_size))
if random_state.random() < self.prefer_horizontal:
orientation = None
else:
orientation = Image.ROTATE_90
tried_other_orientation = False
while True:
if font_size < self.min_font_size:
# font-size went too small
break
# try to find a position
font = ImageFont.truetype(self.font_path, font_size)
# transpose font optionally
transposed_font = ImageFont.TransposedFont(
font, orientation=orientation)
# get size of resulting text
box_size = draw.textbbox((0, 0), word, font=transposed_font, anchor="lt")
# find possible places using integral image:
result = occupancy.sample_position(box_size[3] + self.margin,
box_size[2] + self.margin,
random_state)
if result is not None:
# Found a place
break
# if we didn't find a place, make font smaller
# but first try to rotate!
if not tried_other_orientation and self.prefer_horizontal < 1:
orientation = (Image.ROTATE_90 if orientation is None else
Image.ROTATE_90)
tried_other_orientation = True
else:
font_size -= self.font_step
orientation = None
if font_size < self.min_font_size:
# we were unable to draw any more
break
x, y = np.array(result) + self.margin // 2
# actually draw the text
draw.text((y, x), word, fill="white", font=transposed_font)
positions.append((x, y))
orientations.append(orientation)
font_sizes.append(font_size)
colors.append(self.color_func(word, font_size=font_size,
position=(x, y),
orientation=orientation,
random_state=random_state,
font_path=self.font_path))
# recompute integral image
if self.mask is None:
img_array = np.asarray(img_grey)
else:
img_array = np.asarray(img_grey) + boolean_mask
# recompute bottom right
# the order of the cumsum's is important for speed ?!
occupancy.update(img_array, x, y)
last_freq = freq
self.layout_ = list(zip(frequencies, font_sizes, positions,
orientations, colors))
return self
def process_text(self, text):
"""Splits a long text into words, eliminates the stopwords.
Parameters
----------
text : string
The text to be processed.
Returns
-------
words : dict (string, int)
Word tokens with associated frequency.
..versionchanged:: 1.2.2
Changed return type from list of tuples to dict.
Notes
-----
There are better ways to do word tokenization, but I don't want to
include all those things.
"""
flags = (re.UNICODE if sys.version < '3' and type(text) is unicode # noqa: F821
else 0)
pattern = r"\w[\w']*" if self.min_word_length <= 1 else r"\w[\w']+"
regexp = self.regexp if self.regexp is not None else pattern
words = re.findall(regexp, text, flags)
# remove 's
words = [word[:-2] if word.lower().endswith("'s") else word
for word in words]
# remove numbers
if not self.include_numbers:
words = [word for word in words if not word.isdigit()]
# remove short words
if self.min_word_length:
words = [word for word in words if len(word) >= self.min_word_length]
stopwords = set([i.lower() for i in self.stopwords])
if self.collocations:
word_counts = unigrams_and_bigrams(words, stopwords, self.normalize_plurals, self.collocation_threshold)
else:
# remove stopwords
words = [word for word in words if word.lower() not in stopwords]
word_counts, _ = process_tokens(words, self.normalize_plurals)
return word_counts
def generate_from_text(self, text):
"""Generate wordcloud from text.
The input "text" is expected to be a natural text. If you pass a sorted
list of words, words will appear in your output twice. To remove this
duplication, set ``collocations=False``.
Calls process_text and generate_from_frequencies.
..versionchanged:: 1.2.2
Argument of generate_from_frequencies() is not return of
process_text() any more.
Returns
-------
self
"""
words = self.process_text(text)
self.generate_from_frequencies(words)
return self
def generate(self, text):
"""Generate wordcloud from text.
The input "text" is expected to be a natural text. If you pass a sorted
list of words, words will appear in your output twice. To remove this
duplication, set ``collocations=False``.
Alias to generate_from_text.
Calls process_text and generate_from_frequencies.
Returns
-------
self
"""
return self.generate_from_text(text)
def _check_generated(self):
"""Check if ``layout_`` was computed, otherwise raise error."""
if not hasattr(self, "layout_"):
raise ValueError("WordCloud has not been calculated, call generate"
" first.")
def to_image(self):
self._check_generated()
if self.mask is not None:
width = self.mask.shape[1]
height = self.mask.shape[0]
else:
height, width = self.height, self.width
img = Image.new(self.mode, (int(width * self.scale),
int(height * self.scale)),
self.background_color)
draw = ImageDraw.Draw(img)
for (word, count), font_size, position, orientation, color in self.layout_:
font = ImageFont.truetype(self.font_path,
int(font_size * self.scale))
transposed_font = ImageFont.TransposedFont(
font, orientation=orientation)
pos = (int(position[1] * self.scale),
int(position[0] * self.scale))
draw.text(pos, word, fill=color, font=transposed_font)
return self._draw_contour(img=img)
def recolor(self, random_state=None, color_func=None, colormap=None):
"""Recolor existing layout.
Applying a new coloring is much faster than generating the whole
wordcloud.
Parameters
----------
random_state : RandomState, int, or None, default=None
If not None, a fixed random state is used. If an int is given, this
is used as seed for a random.Random state.
color_func : function or None, default=None
Function to generate new color from word count, font size, position
and orientation. If None, self.color_func is used.
colormap : string or matplotlib colormap, default=None
Use this colormap to generate new colors. Ignored if color_func
is specified. If None, self.color_func (or self.color_map) is used.
Returns
-------
self
"""
if isinstance(random_state, int):
random_state = Random(random_state)
self._check_generated()
if color_func is None:
if colormap is None:
color_func = self.color_func
else:
color_func = colormap_color_func(colormap)
self.layout_ = [(word_freq, font_size, position, orientation,
color_func(word=word_freq[0], font_size=font_size,
position=position, orientation=orientation,
random_state=random_state,
font_path=self.font_path))
for word_freq, font_size, position, orientation, _
in self.layout_]
return self
def to_file(self, filename):
"""Export to image file.
Parameters
----------
filename : string
Location to write to.
Returns
-------
self
"""
img = self.to_image()
img.save(filename, optimize=True)
return self
def to_array(self):
"""Convert to numpy array.
Returns
-------
image : nd-array size (width, height, 3)
Word cloud image as numpy matrix.
"""
return np.array(self.to_image())
def __array__(self):
"""Convert to numpy array.
Returns
-------
image : nd-array size (width, height, 3)
Word cloud image as numpy matrix.
"""
return self.to_array()
def to_svg(self, embed_font=False, optimize_embedded_font=True, embed_image=False):
"""Export to SVG.
Font is assumed to be available to the SVG reader. Otherwise, text
coordinates may produce artifacts when rendered with replacement font.
It is also possible to include a subset of the original font in WOFF
format using ``embed_font`` (requires `fontTools`).
Note that some renderers do not handle glyphs the same way, and may
differ from ``to_image`` result. In particular, Complex Text Layout may
not be supported. In this typesetting, the shape or positioning of a
grapheme depends on its relation to other graphemes.
Pillow, since version 4.2.0, supports CTL using ``libraqm``. However,
due to dependencies, this feature is not always enabled. Hence, the
same rendering differences may appear in ``to_image``. As this
rasterized output is used to compute the layout, this also affects the
layout generation. Use ``PIL.features.check`` to test availability of
``raqm``.
Consistant rendering is therefore expected if both Pillow and the SVG
renderer have the same support of CTL.
Contour drawing is not supported.
Parameters
----------
embed_font : bool, default=False
Whether to include font inside resulting SVG file.
optimize_embedded_font : bool, default=True
Whether to be aggressive when embedding a font, to reduce size. In
particular, hinting tables are dropped, which may introduce slight
changes to character shapes (w.r.t. `to_image` baseline).
embed_image : bool, default=False
Whether to include rasterized image inside resulting SVG file.
Useful for debugging.
Returns
-------
content : string
Word cloud image as SVG string
"""
# TODO should add option to specify URL for font (i.e. WOFF file)
# Make sure layout is generated
self._check_generated()
# Get output size, in pixels
if self.mask is not None:
width = self.mask.shape[1]
height = self.mask.shape[0]
else:
height, width = self.height, self.width
# Get max font size
if self.max_font_size is None:
max_font_size = max(w[1] for w in self.layout_)
else:
max_font_size = self.max_font_size
# Text buffer
result = []
# Get font information
font = ImageFont.truetype(self.font_path, int(max_font_size * self.scale))
raw_font_family, raw_font_style = font.getname()
# TODO properly escape/quote this name?
font_family = repr(raw_font_family)
# TODO better support for uncommon font styles/weights?
raw_font_style = raw_font_style.lower()
if 'bold' in raw_font_style:
font_weight = 'bold'
else:
font_weight = 'normal'
if 'italic' in raw_font_style:
font_style = 'italic'
elif 'oblique' in raw_font_style:
font_style = 'oblique'
else:
font_style = 'normal'
# Add header
result.append(
'<svg'
' xmlns="http://www.w3.org/2000/svg"'
' width="{}"'
' height="{}"'
'>'
.format(
width * self.scale,
height * self.scale
)
)
# Embed font, if requested
if embed_font:
# Import here, to avoid hard dependency on fonttools
import fontTools
import fontTools.subset
# Subset options
options = fontTools.subset.Options(
# Small impact on character shapes, but reduce size a lot
hinting=not optimize_embedded_font,
# On small subsets, can improve size
desubroutinize=optimize_embedded_font,
# Try to be lenient
ignore_missing_glyphs=True,
)
# Load and subset font
ttf = fontTools.subset.load_font(self.font_path, options)
subsetter = fontTools.subset.Subsetter(options)
characters = {c for item in self.layout_ for c in item[0][0]}
text = ''.join(characters)
subsetter.populate(text=text)
subsetter.subset(ttf)
# Export as WOFF
# TODO is there a better method, i.e. directly export to WOFF?
buffer = io.BytesIO()
ttf.saveXML(buffer)
buffer.seek(0)
woff = fontTools.ttLib.TTFont(flavor='woff')
woff.importXML(buffer)
# Create stylesheet with embedded font face
buffer = io.BytesIO()
woff.save(buffer)
data = base64.b64encode(buffer.getbuffer()).decode('ascii')
url = 'data:application/font-woff;charset=utf-8;base64,' + data
result.append(
'<style>'
'@font-face{{'
'font-family:{};'
'font-weight:{};'
'font-style:{};'
'src:url("{}")format("woff");'
'}}'
'</style>'
.format(
font_family,
font_weight,
font_style,
url
)
)
# Select global style
result.append(
'<style>'
'text{{'
'font-family:{};'
'font-weight:{};'
'font-style:{};'
'}}'
'</style>'
.format(
font_family,
font_weight,
font_style
)
)
# Add background
if self.background_color is not None:
result.append(
'<rect'
' width="100%"'
' height="100%"'
' style="fill:{}"'
'>'
'</rect>'
.format(self.background_color)
)
# Embed image, useful for debug purpose
if embed_image:
image = self.to_image()
data = io.BytesIO()
image.save(data, format='JPEG')
data = base64.b64encode(data.getbuffer()).decode('ascii')
result.append(
'<image'
' width="100%"'
' height="100%"'
' href="data:image/jpg;base64,{}"'
'/>'
.format(data)
)
# For each word in layout
for (word, count), font_size, (y, x), orientation, color in self.layout_:
x *= self.scale
y *= self.scale
# Get text metrics
font = ImageFont.truetype(self.font_path, int(font_size * self.scale))
(size_x, size_y), (offset_x, offset_y) = font.font.getsize(word)
ascent, descent = font.getmetrics()
# Compute text bounding box
min_x = -offset_x
max_x = size_x - offset_x
max_y = ascent - offset_y
# Compute text attributes
attributes = {}
if orientation == Image.ROTATE_90:
x += max_y
y += max_x - min_x
transform = 'translate({},{}) rotate(-90)'.format(x, y)
else:
x += min_x
y += max_y
transform = 'translate({},{})'.format(x, y)
# Create node
attributes = ' '.join('{}="{}"'.format(k, v) for k, v in attributes.items())
result.append(
'<text'
' transform="{}"'
' font-size="{}"'
' style="fill:{}"'
'>'
'{}'
'</text>'
.format(
transform,
font_size * self.scale,
color,
saxutils.escape(word)
)
)
# TODO draw contour
# Complete SVG file
result.append('</svg>')
return '\n'.join(result)
def _get_bolean_mask(self, mask):
"""Cast to two dimensional boolean mask."""
if mask.dtype.kind == 'f':
warnings.warn("mask image should be unsigned byte between 0"
" and 255. Got a float array")
if mask.ndim == 2:
boolean_mask = mask == 255
elif mask.ndim == 3:
# if all channels are white, mask out
boolean_mask = np.all(mask[:, :, :3] == 255, axis=-1)
else:
raise ValueError("Got mask of invalid shape: %s" % str(mask.shape))
return boolean_mask
def _draw_contour(self, img):
"""Draw mask contour on a pillow image."""
if self.mask is None or self.contour_width == 0:
return img
mask = self._get_bolean_mask(self.mask) * 255
contour = Image.fromarray(mask.astype(np.uint8))
contour = contour.resize(img.size)
contour = contour.filter(ImageFilter.FIND_EDGES)
contour = np.array(contour)
# make sure borders are not drawn before changing width
contour[[0, -1], :] = 0
contour[:, [0, -1]] = 0
# use gaussian to change width, divide by 10 to give more resolution
radius = self.contour_width / 10
contour = Image.fromarray(contour)
contour = contour.filter(ImageFilter.GaussianBlur(radius=radius))
contour = np.array(contour) > 0
contour = np.dstack((contour, contour, contour))
# color the contour
ret = np.array(img) * np.invert(contour)
if self.contour_color != 'black':
color = Image.new(img.mode, img.size, self.contour_color)
ret += np.array(color) * contour
return Image.fromarray(ret)
| (font_path=None, width=400, height=200, margin=2, ranks_only=None, prefer_horizontal=0.9, mask=None, scale=1, color_func=None, max_words=200, min_font_size=4, stopwords=None, random_state=None, background_color='black', max_font_size=None, font_step=1, mode='RGB', relative_scaling='auto', regexp=None, collocations=True, colormap=None, normalize_plurals=True, contour_width=0, contour_color='black', repeat=False, include_numbers=False, min_word_length=0, collocation_threshold=30) |
5,670 | wordcloud.wordcloud | __array__ | Convert to numpy array.
Returns
-------
image : nd-array size (width, height, 3)
Word cloud image as numpy matrix.
| def __array__(self):
"""Convert to numpy array.
Returns
-------
image : nd-array size (width, height, 3)
Word cloud image as numpy matrix.
"""
return self.to_array()
| (self) |
5,671 | wordcloud.wordcloud | __init__ | null | def __init__(self, font_path=None, width=400, height=200, margin=2,
ranks_only=None, prefer_horizontal=.9, mask=None, scale=1,
color_func=None, max_words=200, min_font_size=4,
stopwords=None, random_state=None, background_color='black',
max_font_size=None, font_step=1, mode="RGB",
relative_scaling='auto', regexp=None, collocations=True,
colormap=None, normalize_plurals=True, contour_width=0,
contour_color='black', repeat=False,
include_numbers=False, min_word_length=0, collocation_threshold=30):
if font_path is None:
font_path = FONT_PATH
if color_func is None and colormap is None:
version = matplotlib.__version__
if version[0] < "2" and version[2] < "5":
colormap = "hsv"
else:
colormap = "viridis"
self.colormap = colormap
self.collocations = collocations
self.font_path = font_path
self.width = width
self.height = height
self.margin = margin
self.prefer_horizontal = prefer_horizontal
self.mask = mask
self.contour_color = contour_color
self.contour_width = contour_width
self.scale = scale
self.color_func = color_func or colormap_color_func(colormap)
self.max_words = max_words
self.stopwords = stopwords if stopwords is not None else STOPWORDS
self.min_font_size = min_font_size
self.font_step = font_step
self.regexp = regexp
if isinstance(random_state, int):
random_state = Random(random_state)
self.random_state = random_state
self.background_color = background_color
self.max_font_size = max_font_size
self.mode = mode
if relative_scaling == "auto":
if repeat:
relative_scaling = 0
else:
relative_scaling = .5
if relative_scaling < 0 or relative_scaling > 1:
raise ValueError("relative_scaling needs to be "
"between 0 and 1, got %f." % relative_scaling)
self.relative_scaling = relative_scaling
if ranks_only is not None:
warnings.warn("ranks_only is deprecated and will be removed as"
" it had no effect. Look into relative_scaling.",
DeprecationWarning)
self.normalize_plurals = normalize_plurals
self.repeat = repeat
self.include_numbers = include_numbers
self.min_word_length = min_word_length
self.collocation_threshold = collocation_threshold
# Override the width and height if there is a mask
if mask is not None:
self.width = mask.shape[1]
self.height = mask.shape[0]
| (self, font_path=None, width=400, height=200, margin=2, ranks_only=None, prefer_horizontal=0.9, mask=None, scale=1, color_func=None, max_words=200, min_font_size=4, stopwords=None, random_state=None, background_color='black', max_font_size=None, font_step=1, mode='RGB', relative_scaling='auto', regexp=None, collocations=True, colormap=None, normalize_plurals=True, contour_width=0, contour_color='black', repeat=False, include_numbers=False, min_word_length=0, collocation_threshold=30) |
5,672 | wordcloud.wordcloud | _check_generated | Check if ``layout_`` was computed, otherwise raise error. | def _check_generated(self):
"""Check if ``layout_`` was computed, otherwise raise error."""
if not hasattr(self, "layout_"):
raise ValueError("WordCloud has not been calculated, call generate"
" first.")
| (self) |
5,673 | wordcloud.wordcloud | _draw_contour | Draw mask contour on a pillow image. | def _draw_contour(self, img):
"""Draw mask contour on a pillow image."""
if self.mask is None or self.contour_width == 0:
return img
mask = self._get_bolean_mask(self.mask) * 255
contour = Image.fromarray(mask.astype(np.uint8))
contour = contour.resize(img.size)
contour = contour.filter(ImageFilter.FIND_EDGES)
contour = np.array(contour)
# make sure borders are not drawn before changing width
contour[[0, -1], :] = 0
contour[:, [0, -1]] = 0
# use gaussian to change width, divide by 10 to give more resolution
radius = self.contour_width / 10
contour = Image.fromarray(contour)
contour = contour.filter(ImageFilter.GaussianBlur(radius=radius))
contour = np.array(contour) > 0
contour = np.dstack((contour, contour, contour))
# color the contour
ret = np.array(img) * np.invert(contour)
if self.contour_color != 'black':
color = Image.new(img.mode, img.size, self.contour_color)
ret += np.array(color) * contour
return Image.fromarray(ret)
| (self, img) |
5,674 | wordcloud.wordcloud | _get_bolean_mask | Cast to two dimensional boolean mask. | def _get_bolean_mask(self, mask):
"""Cast to two dimensional boolean mask."""
if mask.dtype.kind == 'f':
warnings.warn("mask image should be unsigned byte between 0"
" and 255. Got a float array")
if mask.ndim == 2:
boolean_mask = mask == 255
elif mask.ndim == 3:
# if all channels are white, mask out
boolean_mask = np.all(mask[:, :, :3] == 255, axis=-1)
else:
raise ValueError("Got mask of invalid shape: %s" % str(mask.shape))
return boolean_mask
| (self, mask) |
5,675 | wordcloud.wordcloud | fit_words | Create a word_cloud from words and frequencies.
Alias to generate_from_frequencies.
Parameters
----------
frequencies : dict from string to float
A contains words and associated frequency.
Returns
-------
self
| def fit_words(self, frequencies):
"""Create a word_cloud from words and frequencies.
Alias to generate_from_frequencies.
Parameters
----------
frequencies : dict from string to float
A contains words and associated frequency.
Returns
-------
self
"""
return self.generate_from_frequencies(frequencies)
| (self, frequencies) |
5,676 | wordcloud.wordcloud | generate | Generate wordcloud from text.
The input "text" is expected to be a natural text. If you pass a sorted
list of words, words will appear in your output twice. To remove this
duplication, set ``collocations=False``.
Alias to generate_from_text.
Calls process_text and generate_from_frequencies.
Returns
-------
self
| def generate(self, text):
"""Generate wordcloud from text.
The input "text" is expected to be a natural text. If you pass a sorted
list of words, words will appear in your output twice. To remove this
duplication, set ``collocations=False``.
Alias to generate_from_text.
Calls process_text and generate_from_frequencies.
Returns
-------
self
"""
return self.generate_from_text(text)
| (self, text) |
5,677 | wordcloud.wordcloud | generate_from_frequencies | Create a word_cloud from words and frequencies.
Parameters
----------
frequencies : dict from string to float
A contains words and associated frequency.
max_font_size : int
Use this font-size instead of self.max_font_size
Returns
-------
self
| def generate_from_frequencies(self, frequencies, max_font_size=None): # noqa: C901
"""Create a word_cloud from words and frequencies.
Parameters
----------
frequencies : dict from string to float
A contains words and associated frequency.
max_font_size : int
Use this font-size instead of self.max_font_size
Returns
-------
self
"""
# make sure frequencies are sorted and normalized
frequencies = sorted(frequencies.items(), key=itemgetter(1), reverse=True)
if len(frequencies) <= 0:
raise ValueError("We need at least 1 word to plot a word cloud, "
"got %d." % len(frequencies))
frequencies = frequencies[:self.max_words]
# largest entry will be 1
max_frequency = float(frequencies[0][1])
frequencies = [(word, freq / max_frequency)
for word, freq in frequencies]
if self.random_state is not None:
random_state = self.random_state
else:
random_state = Random()
if self.mask is not None:
boolean_mask = self._get_bolean_mask(self.mask)
width = self.mask.shape[1]
height = self.mask.shape[0]
else:
boolean_mask = None
height, width = self.height, self.width
occupancy = IntegralOccupancyMap(height, width, boolean_mask)
# create image
img_grey = Image.new("L", (width, height))
draw = ImageDraw.Draw(img_grey)
img_array = np.asarray(img_grey)
font_sizes, positions, orientations, colors = [], [], [], []
last_freq = 1.
if max_font_size is None:
# if not provided use default font_size
max_font_size = self.max_font_size
if max_font_size is None:
# figure out a good font size by trying to draw with
# just the first two words
if len(frequencies) == 1:
# we only have one word. We make it big!
font_size = self.height
else:
self.generate_from_frequencies(dict(frequencies[:2]),
max_font_size=self.height)
# find font sizes
sizes = [x[1] for x in self.layout_]
try:
font_size = int(2 * sizes[0] * sizes[1]
/ (sizes[0] + sizes[1]))
# quick fix for if self.layout_ contains less than 2 values
# on very small images it can be empty
except IndexError:
try:
font_size = sizes[0]
except IndexError:
raise ValueError(
"Couldn't find space to draw. Either the Canvas size"
" is too small or too much of the image is masked "
"out.")
else:
font_size = max_font_size
# we set self.words_ here because we called generate_from_frequencies
# above... hurray for good design?
self.words_ = dict(frequencies)
if self.repeat and len(frequencies) < self.max_words:
# pad frequencies with repeating words.
times_extend = int(np.ceil(self.max_words / len(frequencies))) - 1
# get smallest frequency
frequencies_org = list(frequencies)
downweight = frequencies[-1][1]
for i in range(times_extend):
frequencies.extend([(word, freq * downweight ** (i + 1))
for word, freq in frequencies_org])
# start drawing grey image
for word, freq in frequencies:
if freq == 0:
continue
# select the font size
rs = self.relative_scaling
if rs != 0:
font_size = int(round((rs * (freq / float(last_freq))
+ (1 - rs)) * font_size))
if random_state.random() < self.prefer_horizontal:
orientation = None
else:
orientation = Image.ROTATE_90
tried_other_orientation = False
while True:
if font_size < self.min_font_size:
# font-size went too small
break
# try to find a position
font = ImageFont.truetype(self.font_path, font_size)
# transpose font optionally
transposed_font = ImageFont.TransposedFont(
font, orientation=orientation)
# get size of resulting text
box_size = draw.textbbox((0, 0), word, font=transposed_font, anchor="lt")
# find possible places using integral image:
result = occupancy.sample_position(box_size[3] + self.margin,
box_size[2] + self.margin,
random_state)
if result is not None:
# Found a place
break
# if we didn't find a place, make font smaller
# but first try to rotate!
if not tried_other_orientation and self.prefer_horizontal < 1:
orientation = (Image.ROTATE_90 if orientation is None else
Image.ROTATE_90)
tried_other_orientation = True
else:
font_size -= self.font_step
orientation = None
if font_size < self.min_font_size:
# we were unable to draw any more
break
x, y = np.array(result) + self.margin // 2
# actually draw the text
draw.text((y, x), word, fill="white", font=transposed_font)
positions.append((x, y))
orientations.append(orientation)
font_sizes.append(font_size)
colors.append(self.color_func(word, font_size=font_size,
position=(x, y),
orientation=orientation,
random_state=random_state,
font_path=self.font_path))
# recompute integral image
if self.mask is None:
img_array = np.asarray(img_grey)
else:
img_array = np.asarray(img_grey) + boolean_mask
# recompute bottom right
# the order of the cumsum's is important for speed ?!
occupancy.update(img_array, x, y)
last_freq = freq
self.layout_ = list(zip(frequencies, font_sizes, positions,
orientations, colors))
return self
| (self, frequencies, max_font_size=None) |
5,678 | wordcloud.wordcloud | generate_from_text | Generate wordcloud from text.
The input "text" is expected to be a natural text. If you pass a sorted
list of words, words will appear in your output twice. To remove this
duplication, set ``collocations=False``.
Calls process_text and generate_from_frequencies.
..versionchanged:: 1.2.2
Argument of generate_from_frequencies() is not return of
process_text() any more.
Returns
-------
self
| def generate_from_text(self, text):
"""Generate wordcloud from text.
The input "text" is expected to be a natural text. If you pass a sorted
list of words, words will appear in your output twice. To remove this
duplication, set ``collocations=False``.
Calls process_text and generate_from_frequencies.
..versionchanged:: 1.2.2
Argument of generate_from_frequencies() is not return of
process_text() any more.
Returns
-------
self
"""
words = self.process_text(text)
self.generate_from_frequencies(words)
return self
| (self, text) |
5,679 | wordcloud.wordcloud | process_text | Splits a long text into words, eliminates the stopwords.
Parameters
----------
text : string
The text to be processed.
Returns
-------
words : dict (string, int)
Word tokens with associated frequency.
..versionchanged:: 1.2.2
Changed return type from list of tuples to dict.
Notes
-----
There are better ways to do word tokenization, but I don't want to
include all those things.
| def process_text(self, text):
"""Splits a long text into words, eliminates the stopwords.
Parameters
----------
text : string
The text to be processed.
Returns
-------
words : dict (string, int)
Word tokens with associated frequency.
..versionchanged:: 1.2.2
Changed return type from list of tuples to dict.
Notes
-----
There are better ways to do word tokenization, but I don't want to
include all those things.
"""
flags = (re.UNICODE if sys.version < '3' and type(text) is unicode # noqa: F821
else 0)
pattern = r"\w[\w']*" if self.min_word_length <= 1 else r"\w[\w']+"
regexp = self.regexp if self.regexp is not None else pattern
words = re.findall(regexp, text, flags)
# remove 's
words = [word[:-2] if word.lower().endswith("'s") else word
for word in words]
# remove numbers
if not self.include_numbers:
words = [word for word in words if not word.isdigit()]
# remove short words
if self.min_word_length:
words = [word for word in words if len(word) >= self.min_word_length]
stopwords = set([i.lower() for i in self.stopwords])
if self.collocations:
word_counts = unigrams_and_bigrams(words, stopwords, self.normalize_plurals, self.collocation_threshold)
else:
# remove stopwords
words = [word for word in words if word.lower() not in stopwords]
word_counts, _ = process_tokens(words, self.normalize_plurals)
return word_counts
| (self, text) |
5,680 | wordcloud.wordcloud | recolor | Recolor existing layout.
Applying a new coloring is much faster than generating the whole
wordcloud.
Parameters
----------
random_state : RandomState, int, or None, default=None
If not None, a fixed random state is used. If an int is given, this
is used as seed for a random.Random state.
color_func : function or None, default=None
Function to generate new color from word count, font size, position
and orientation. If None, self.color_func is used.
colormap : string or matplotlib colormap, default=None
Use this colormap to generate new colors. Ignored if color_func
is specified. If None, self.color_func (or self.color_map) is used.
Returns
-------
self
| def recolor(self, random_state=None, color_func=None, colormap=None):
"""Recolor existing layout.
Applying a new coloring is much faster than generating the whole
wordcloud.
Parameters
----------
random_state : RandomState, int, or None, default=None
If not None, a fixed random state is used. If an int is given, this
is used as seed for a random.Random state.
color_func : function or None, default=None
Function to generate new color from word count, font size, position
and orientation. If None, self.color_func is used.
colormap : string or matplotlib colormap, default=None
Use this colormap to generate new colors. Ignored if color_func
is specified. If None, self.color_func (or self.color_map) is used.
Returns
-------
self
"""
if isinstance(random_state, int):
random_state = Random(random_state)
self._check_generated()
if color_func is None:
if colormap is None:
color_func = self.color_func
else:
color_func = colormap_color_func(colormap)
self.layout_ = [(word_freq, font_size, position, orientation,
color_func(word=word_freq[0], font_size=font_size,
position=position, orientation=orientation,
random_state=random_state,
font_path=self.font_path))
for word_freq, font_size, position, orientation, _
in self.layout_]
return self
| (self, random_state=None, color_func=None, colormap=None) |
5,681 | wordcloud.wordcloud | to_array | Convert to numpy array.
Returns
-------
image : nd-array size (width, height, 3)
Word cloud image as numpy matrix.
| def to_array(self):
"""Convert to numpy array.
Returns
-------
image : nd-array size (width, height, 3)
Word cloud image as numpy matrix.
"""
return np.array(self.to_image())
| (self) |
5,682 | wordcloud.wordcloud | to_file | Export to image file.
Parameters
----------
filename : string
Location to write to.
Returns
-------
self
| def to_file(self, filename):
"""Export to image file.
Parameters
----------
filename : string
Location to write to.
Returns
-------
self
"""
img = self.to_image()
img.save(filename, optimize=True)
return self
| (self, filename) |
5,683 | wordcloud.wordcloud | to_image | null | def to_image(self):
self._check_generated()
if self.mask is not None:
width = self.mask.shape[1]
height = self.mask.shape[0]
else:
height, width = self.height, self.width
img = Image.new(self.mode, (int(width * self.scale),
int(height * self.scale)),
self.background_color)
draw = ImageDraw.Draw(img)
for (word, count), font_size, position, orientation, color in self.layout_:
font = ImageFont.truetype(self.font_path,
int(font_size * self.scale))
transposed_font = ImageFont.TransposedFont(
font, orientation=orientation)
pos = (int(position[1] * self.scale),
int(position[0] * self.scale))
draw.text(pos, word, fill=color, font=transposed_font)
return self._draw_contour(img=img)
| (self) |
5,684 | wordcloud.wordcloud | to_svg | Export to SVG.
Font is assumed to be available to the SVG reader. Otherwise, text
coordinates may produce artifacts when rendered with replacement font.
It is also possible to include a subset of the original font in WOFF
format using ``embed_font`` (requires `fontTools`).
Note that some renderers do not handle glyphs the same way, and may
differ from ``to_image`` result. In particular, Complex Text Layout may
not be supported. In this typesetting, the shape or positioning of a
grapheme depends on its relation to other graphemes.
Pillow, since version 4.2.0, supports CTL using ``libraqm``. However,
due to dependencies, this feature is not always enabled. Hence, the
same rendering differences may appear in ``to_image``. As this
rasterized output is used to compute the layout, this also affects the
layout generation. Use ``PIL.features.check`` to test availability of
``raqm``.
Consistant rendering is therefore expected if both Pillow and the SVG
renderer have the same support of CTL.
Contour drawing is not supported.
Parameters
----------
embed_font : bool, default=False
Whether to include font inside resulting SVG file.
optimize_embedded_font : bool, default=True
Whether to be aggressive when embedding a font, to reduce size. In
particular, hinting tables are dropped, which may introduce slight
changes to character shapes (w.r.t. `to_image` baseline).
embed_image : bool, default=False
Whether to include rasterized image inside resulting SVG file.
Useful for debugging.
Returns
-------
content : string
Word cloud image as SVG string
| def to_svg(self, embed_font=False, optimize_embedded_font=True, embed_image=False):
"""Export to SVG.
Font is assumed to be available to the SVG reader. Otherwise, text
coordinates may produce artifacts when rendered with replacement font.
It is also possible to include a subset of the original font in WOFF
format using ``embed_font`` (requires `fontTools`).
Note that some renderers do not handle glyphs the same way, and may
differ from ``to_image`` result. In particular, Complex Text Layout may
not be supported. In this typesetting, the shape or positioning of a
grapheme depends on its relation to other graphemes.
Pillow, since version 4.2.0, supports CTL using ``libraqm``. However,
due to dependencies, this feature is not always enabled. Hence, the
same rendering differences may appear in ``to_image``. As this
rasterized output is used to compute the layout, this also affects the
layout generation. Use ``PIL.features.check`` to test availability of
``raqm``.
Consistant rendering is therefore expected if both Pillow and the SVG
renderer have the same support of CTL.
Contour drawing is not supported.
Parameters
----------
embed_font : bool, default=False
Whether to include font inside resulting SVG file.
optimize_embedded_font : bool, default=True
Whether to be aggressive when embedding a font, to reduce size. In
particular, hinting tables are dropped, which may introduce slight
changes to character shapes (w.r.t. `to_image` baseline).
embed_image : bool, default=False
Whether to include rasterized image inside resulting SVG file.
Useful for debugging.
Returns
-------
content : string
Word cloud image as SVG string
"""
# TODO should add option to specify URL for font (i.e. WOFF file)
# Make sure layout is generated
self._check_generated()
# Get output size, in pixels
if self.mask is not None:
width = self.mask.shape[1]
height = self.mask.shape[0]
else:
height, width = self.height, self.width
# Get max font size
if self.max_font_size is None:
max_font_size = max(w[1] for w in self.layout_)
else:
max_font_size = self.max_font_size
# Text buffer
result = []
# Get font information
font = ImageFont.truetype(self.font_path, int(max_font_size * self.scale))
raw_font_family, raw_font_style = font.getname()
# TODO properly escape/quote this name?
font_family = repr(raw_font_family)
# TODO better support for uncommon font styles/weights?
raw_font_style = raw_font_style.lower()
if 'bold' in raw_font_style:
font_weight = 'bold'
else:
font_weight = 'normal'
if 'italic' in raw_font_style:
font_style = 'italic'
elif 'oblique' in raw_font_style:
font_style = 'oblique'
else:
font_style = 'normal'
# Add header
result.append(
'<svg'
' xmlns="http://www.w3.org/2000/svg"'
' width="{}"'
' height="{}"'
'>'
.format(
width * self.scale,
height * self.scale
)
)
# Embed font, if requested
if embed_font:
# Import here, to avoid hard dependency on fonttools
import fontTools
import fontTools.subset
# Subset options
options = fontTools.subset.Options(
# Small impact on character shapes, but reduce size a lot
hinting=not optimize_embedded_font,
# On small subsets, can improve size
desubroutinize=optimize_embedded_font,
# Try to be lenient
ignore_missing_glyphs=True,
)
# Load and subset font
ttf = fontTools.subset.load_font(self.font_path, options)
subsetter = fontTools.subset.Subsetter(options)
characters = {c for item in self.layout_ for c in item[0][0]}
text = ''.join(characters)
subsetter.populate(text=text)
subsetter.subset(ttf)
# Export as WOFF
# TODO is there a better method, i.e. directly export to WOFF?
buffer = io.BytesIO()
ttf.saveXML(buffer)
buffer.seek(0)
woff = fontTools.ttLib.TTFont(flavor='woff')
woff.importXML(buffer)
# Create stylesheet with embedded font face
buffer = io.BytesIO()
woff.save(buffer)
data = base64.b64encode(buffer.getbuffer()).decode('ascii')
url = 'data:application/font-woff;charset=utf-8;base64,' + data
result.append(
'<style>'
'@font-face{{'
'font-family:{};'
'font-weight:{};'
'font-style:{};'
'src:url("{}")format("woff");'
'}}'
'</style>'
.format(
font_family,
font_weight,
font_style,
url
)
)
# Select global style
result.append(
'<style>'
'text{{'
'font-family:{};'
'font-weight:{};'
'font-style:{};'
'}}'
'</style>'
.format(
font_family,
font_weight,
font_style
)
)
# Add background
if self.background_color is not None:
result.append(
'<rect'
' width="100%"'
' height="100%"'
' style="fill:{}"'
'>'
'</rect>'
.format(self.background_color)
)
# Embed image, useful for debug purpose
if embed_image:
image = self.to_image()
data = io.BytesIO()
image.save(data, format='JPEG')
data = base64.b64encode(data.getbuffer()).decode('ascii')
result.append(
'<image'
' width="100%"'
' height="100%"'
' href="data:image/jpg;base64,{}"'
'/>'
.format(data)
)
# For each word in layout
for (word, count), font_size, (y, x), orientation, color in self.layout_:
x *= self.scale
y *= self.scale
# Get text metrics
font = ImageFont.truetype(self.font_path, int(font_size * self.scale))
(size_x, size_y), (offset_x, offset_y) = font.font.getsize(word)
ascent, descent = font.getmetrics()
# Compute text bounding box
min_x = -offset_x
max_x = size_x - offset_x
max_y = ascent - offset_y
# Compute text attributes
attributes = {}
if orientation == Image.ROTATE_90:
x += max_y
y += max_x - min_x
transform = 'translate({},{}) rotate(-90)'.format(x, y)
else:
x += min_x
y += max_y
transform = 'translate({},{})'.format(x, y)
# Create node
attributes = ' '.join('{}="{}"'.format(k, v) for k, v in attributes.items())
result.append(
'<text'
' transform="{}"'
' font-size="{}"'
' style="fill:{}"'
'>'
'{}'
'</text>'
.format(
transform,
font_size * self.scale,
color,
saxutils.escape(word)
)
)
# TODO draw contour
# Complete SVG file
result.append('</svg>')
return '\n'.join(result)
| (self, embed_font=False, optimize_embedded_font=True, embed_image=False) |
5,687 | wordcloud.wordcloud | get_single_color_func | Create a color function which returns a single hue and saturation with.
different values (HSV). Accepted values are color strings as usable by
PIL/Pillow.
>>> color_func1 = get_single_color_func('deepskyblue')
>>> color_func2 = get_single_color_func('#00b4d2')
| def get_single_color_func(color):
"""Create a color function which returns a single hue and saturation with.
different values (HSV). Accepted values are color strings as usable by
PIL/Pillow.
>>> color_func1 = get_single_color_func('deepskyblue')
>>> color_func2 = get_single_color_func('#00b4d2')
"""
old_r, old_g, old_b = ImageColor.getrgb(color)
rgb_max = 255.
h, s, v = colorsys.rgb_to_hsv(old_r / rgb_max, old_g / rgb_max,
old_b / rgb_max)
def single_color_func(word=None, font_size=None, position=None,
orientation=None, font_path=None, random_state=None):
"""Random color generation.
Additional coloring method. It picks a random value with hue and
saturation based on the color given to the generating function.
Parameters
----------
word, font_size, position, orientation : ignored.
random_state : random.Random object or None, (default=None)
If a random object is given, this is used for generating random
numbers.
"""
if random_state is None:
random_state = Random()
r, g, b = colorsys.hsv_to_rgb(h, s, random_state.uniform(0.2, 1))
return 'rgb({:.0f}, {:.0f}, {:.0f})'.format(r * rgb_max, g * rgb_max,
b * rgb_max)
return single_color_func
| (color) |
5,689 | wordcloud.wordcloud | random_color_func | Random hue color generation.
Default coloring method. This just picks a random hue with value 80% and
lumination 50%.
Parameters
----------
word, font_size, position, orientation : ignored.
random_state : random.Random object or None, (default=None)
If a random object is given, this is used for generating random
numbers.
| def random_color_func(word=None, font_size=None, position=None,
orientation=None, font_path=None, random_state=None):
"""Random hue color generation.
Default coloring method. This just picks a random hue with value 80% and
lumination 50%.
Parameters
----------
word, font_size, position, orientation : ignored.
random_state : random.Random object or None, (default=None)
If a random object is given, this is used for generating random
numbers.
"""
if random_state is None:
random_state = Random()
return "hsl(%d, 80%%, 50%%)" % random_state.randint(0, 255)
| (word=None, font_size=None, position=None, orientation=None, font_path=None, random_state=None) |
5,693 | simple_di | Provider |
the base class for Provider implementations. Could be used as the type annotations
of all the implementations.
| class Provider(Generic[VT]):
"""
the base class for Provider implementations. Could be used as the type annotations
of all the implementations.
"""
STATE_FIELDS: Tuple[str, ...] = ("_override",)
def __init__(self) -> None:
self._override: Union[_SentinelClass, VT] = sentinel
def _provide(self) -> VT:
raise NotImplementedError
def set(self, value: Union[_SentinelClass, VT]) -> None:
"""
set the value to this provider, overriding the original values
"""
if isinstance(value, _SentinelClass):
return
self._override = value
@contextlib.contextmanager
def patch(self, value: Union[_SentinelClass, VT]) -> Generator[None, None, None]:
"""
patch the value of this provider, restoring the original value after the context
"""
if isinstance(value, _SentinelClass):
yield
return
original = self._override
self._override = value
yield
self._override = original
def get(self) -> VT:
"""
get the value of this provider
"""
if not isinstance(self._override, _SentinelClass):
return self._override
return self._provide()
def reset(self) -> None:
"""
remove the overriding and restore the original value
"""
self._override = sentinel
def __getstate__(self) -> Dict[str, Any]:
return {f: getattr(self, f) for f in self.STATE_FIELDS}
def __setstate__(self, state: Dict[str, Any]) -> None:
for i in self.STATE_FIELDS:
setattr(self, i, state[i])
| () -> None |
5,694 | simple_di | __getstate__ | null | def __getstate__(self) -> Dict[str, Any]:
return {f: getattr(self, f) for f in self.STATE_FIELDS}
| (self) -> Dict[str, Any] |
5,695 | simple_di | __init__ | null | def __init__(self) -> None:
self._override: Union[_SentinelClass, VT] = sentinel
| (self) -> NoneType |
5,696 | simple_di | __setstate__ | null | def __setstate__(self, state: Dict[str, Any]) -> None:
for i in self.STATE_FIELDS:
setattr(self, i, state[i])
| (self, state: Dict[str, Any]) -> NoneType |
5,697 | simple_di | _provide | null | def _provide(self) -> VT:
raise NotImplementedError
| (self) -> ~VT |
5,698 | simple_di | get |
get the value of this provider
| def get(self) -> VT:
"""
get the value of this provider
"""
if not isinstance(self._override, _SentinelClass):
return self._override
return self._provide()
| (self) -> ~VT |
5,699 | simple_di | patch |
patch the value of this provider, restoring the original value after the context
| null | (self, value: Union[simple_di._SentinelClass, ~VT]) -> Generator[NoneType, NoneType, NoneType] |
5,700 | simple_di | reset |
remove the overriding and restore the original value
| def reset(self) -> None:
"""
remove the overriding and restore the original value
"""
self._override = sentinel
| (self) -> NoneType |
5,701 | simple_di | set |
set the value to this provider, overriding the original values
| def set(self, value: Union[_SentinelClass, VT]) -> None:
"""
set the value to this provider, overriding the original values
"""
if isinstance(value, _SentinelClass):
return
self._override = value
| (self, value: Union[simple_di._SentinelClass, ~VT]) -> NoneType |
Subsets and Splits