list[importlib.metadata.EntryPoint]:\n \"\"\"Get the list of installed `ibis.backend` entrypoints.\"\"\"\n\n if sys.version_info < (3, 10):\n eps = importlib.metadata.entry_points()[\"ibis.backends\"]\n else:\n eps = importlib.metadata.entry_points(group=\"ibis.backends\")\n return sorted(eps)\n\n\ndef import_object(qualname: str) -> Any:\n \"\"\"Attempt to import an object given its full qualname.\n\n Examples\n --------\n >>> ex = import_object(\"ibis.examples\")\n\n Is the same as\n\n >>> from ibis import examples as ex\n \"\"\"\n mod_name, name = qualname.rsplit(\".\", 1)\n mod = importlib.import_module(mod_name)\n try:\n return getattr(mod, name)\n except AttributeError:\n raise ImportError(f\"cannot import name {name!r} from {mod_name!r}\") from None\n\n\ndef normalize_filename(source: str | Path) -> str:\n def _removeprefix(text, prefix):\n # TODO: remove when we drop Python 3.8\n try:\n return text.removeprefix(prefix)\n except AttributeError:\n return text[text.startswith(prefix) and len(prefix) :]\n\n source = str(source)\n for prefix in (\n \"parquet\",\n \"csv\",\n \"csv.gz\",\n \"txt\",\n \"txt.gz\",\n \"tsv\",\n \"tsv.gz\",\n \"file\",\n ):\n source = _removeprefix(source, f\"{prefix}://\")\n\n def _absolufy_paths(name):\n if not name.startswith((\"http\", \"s3\")):\n return os.path.abspath(name)\n return name\n\n source = _absolufy_paths(source)\n return source\n\n\ndef gen_name(namespace: str) -> str:\n \"\"\"Create a case-insensitive uuid4 unique table name.\"\"\"\n uid = base64.b32encode(uuid.uuid4().bytes).decode().rstrip(\"=\").lower()\n return f\"_ibis_{namespace}_{uid}\"\n","path":"ibis/util.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"Ibis utility functions.\\\"\\\"\\\"\\nfrom __future__ import annotations\\n\\nimport base64\\nimport collections\\nimport functools\\nimport importlib.metadata\\nimport itertools\\nimport logging\\nimport operator\\nimport os\\nimport sys\\nimport textwrap\\nimport types\\nimport uuid\\nimport warnings\\nfrom typing import (\\n TYPE_CHECKING,\\n Any,\\n Callable,\\n Iterator,\\n Mapping,\\n Sequence,\\n TypeVar,\\n)\\nfrom uuid import uuid4\\n\\nimport toolz\\n\\nif TYPE_CHECKING:\\n from numbers import Real\\n from pathlib import Path\\n\\n import ibis.expr.operations as ops\\n\\n Graph = Mapping[ops.Node, Sequence[ops.Node]]\\n\\nT = TypeVar(\\\"T\\\", covariant=True)\\nU = TypeVar(\\\"U\\\", covariant=True)\\nK = TypeVar(\\\"K\\\")\\nV = TypeVar(\\\"V\\\")\\n\\n\\n# https://www.compart.com/en/unicode/U+22EE\\nVERTICAL_ELLIPSIS = \\\"\\\\u22EE\\\"\\n# https://www.compart.com/en/unicode/U+2026\\nHORIZONTAL_ELLIPSIS = \\\"\\\\u2026\\\"\\n\\n\\ndef guid() -> str:\\n \\\"\\\"\\\"Return a uuid4 hexadecimal value.\\\"\\\"\\\"\\n return uuid4().hex\\n\\n\\ndef indent(text: str, spaces: int) -> str:\\n \\\"\\\"\\\"Apply an indentation using the given spaces into the given text.\\n\\n Parameters\\n ----------\\n text\\n Text to indent\\n spaces\\n Number of leading spaces per line\\n\\n Returns\\n -------\\n str\\n Indented text\\n \\\"\\\"\\\"\\n prefix = \\\" \\\" * spaces\\n return textwrap.indent(text, prefix=prefix)\\n\\n\\ndef is_one_of(values: Sequence[T], t: type[U]) -> Iterator[bool]:\\n \\\"\\\"\\\"Check if the type of each value is the same of the given type.\\n\\n Parameters\\n ----------\\n values\\n Input values\\n t\\n Type to check against\\n\\n Returns\\n -------\\n tuple\\n \\\"\\\"\\\"\\n return (isinstance(x, t) for x in values)\\n\\n\\nany_of = toolz.compose(any, is_one_of)\\nall_of = toolz.compose(all, is_one_of)\\n\\n\\ndef promote_list(val: V | Sequence[V]) -> list[V]:\\n \\\"\\\"\\\"Ensure that the value is a list.\\n\\n Parameters\\n ----------\\n val\\n Value to promote\\n\\n Returns\\n -------\\n list\\n \\\"\\\"\\\"\\n if isinstance(val, list):\\n return val\\n elif is_iterable(val):\\n return list(val)\\n elif val is None:\\n return []\\n else:\\n return [val]\\n\\n\\ndef promote_tuple(val: V | Sequence[V]) -> tuple[V]:\\n \\\"\\\"\\\"Ensure that the value is a tuple.\\n\\n Parameters\\n ----------\\n val\\n Value to promote\\n\\n Returns\\n -------\\n tuple\\n \\\"\\\"\\\"\\n if isinstance(val, tuple):\\n return val\\n elif is_iterable(val):\\n return tuple(val)\\n elif val is None:\\n return ()\\n else:\\n return (val,)\\n\\n\\ndef is_function(v: Any) -> bool:\\n \\\"\\\"\\\"Check if the given object is a function.\\n\\n Returns\\n -------\\n bool\\n Whether `v` is a function\\n \\\"\\\"\\\"\\n return isinstance(v, (types.FunctionType, types.LambdaType))\\n\\n\\ndef log(msg: str) -> None:\\n \\\"\\\"\\\"Log `msg` using ``options.verbose_log`` if set, otherwise ``print``.\\\"\\\"\\\"\\n from ibis.config import options\\n\\n if options.verbose:\\n (options.verbose_log or print)(msg)\\n\\n\\ndef approx_equal(a: Real, b: Real, eps: Real):\\n \\\"\\\"\\\"Return whether the difference between `a` and `b` is less than `eps`.\\n\\n Raises\\n ------\\n AssertionError\\n \\\"\\\"\\\"\\n assert abs(a - b) < eps\\n\\n\\ndef safe_index(elements: Sequence[int], value: int) -> int:\\n \\\"\\\"\\\"Find the location of `value` in `elements`.\\n\\n Return -1 if `value` is not found instead of raising ``ValueError``.\\n\\n Parameters\\n ----------\\n elements\\n Elements to index into\\n value : int\\n Index of the given sequence/elements\\n\\n Returns\\n -------\\n int\\n\\n Examples\\n --------\\n >>> sequence = [1, 2, 3]\\n >>> safe_index(sequence, 2)\\n 1\\n >>> safe_index(sequence, 4)\\n -1\\n \\\"\\\"\\\"\\n try:\\n return elements.index(value)\\n except ValueError:\\n return -1\\n\\n\\ndef is_iterable(o: Any) -> bool:\\n \\\"\\\"\\\"Return whether `o` is iterable and not a :class:`str` or :class:`bytes`.\\n\\n Parameters\\n ----------\\n o : object\\n Any python object\\n\\n Returns\\n -------\\n bool\\n\\n Examples\\n --------\\n >>> is_iterable('1')\\n False\\n >>> is_iterable(b'1')\\n False\\n >>> is_iterable(iter('1'))\\n True\\n >>> is_iterable(i for i in range(1))\\n True\\n >>> is_iterable(1)\\n False\\n >>> is_iterable([])\\n True\\n \\\"\\\"\\\"\\n return not isinstance(o, (str, bytes)) and isinstance(o, collections.abc.Iterable)\\n\\n\\ndef convert_unit(value, unit, to, floor: bool = True):\\n \\\"\\\"\\\"Convert a value between different units.\\n\\n Convert `value`, is assumed to be in units of `unit`, to units of `to`.\\n If `floor` is true, then use floor division on `value` if necessary.\\n\\n Parameters\\n ----------\\n value\\n Number or numeric ibis expression\\n unit\\n Unit of `value`\\n to\\n Unit to convert to\\n floor\\n Whether or not to use floor division on `value` if necessary.\\n\\n Returns\\n -------\\n Union[numbers.Integral, ibis.expr.types.NumericValue]\\n Integer converted unit\\n\\n Examples\\n --------\\n >>> one_second = 1000\\n >>> x = convert_unit(one_second, 'ms', 's')\\n >>> x\\n 1\\n >>> one_second = 1\\n >>> x = convert_unit(one_second, 's', 'ms')\\n >>> x\\n 1000\\n >>> x = convert_unit(one_second, 's', 's')\\n >>> x\\n 1\\n >>> x = convert_unit(one_second, 's', 'M')\\n Traceback (most recent call last):\\n ...\\n ValueError: Cannot convert to or from variable length interval\\n \\\"\\\"\\\"\\n # Don't do anything if from and to units are equivalent\\n if unit == to:\\n return value\\n\\n units = ('W', 'D', 'h', 'm', 's', 'ms', 'us', 'ns')\\n factors = (7, 24, 60, 60, 1000, 1000, 1000)\\n\\n monthly_units = ('Y', 'Q', 'M')\\n monthly_factors = (4, 3)\\n\\n try:\\n i, j = units.index(unit), units.index(to)\\n except ValueError:\\n try:\\n i, j = monthly_units.index(unit), monthly_units.index(to)\\n factors = monthly_factors\\n except ValueError:\\n raise ValueError('Cannot convert to or from variable length interval')\\n\\n factor = functools.reduce(operator.mul, factors[min(i, j) : max(i, j)], 1)\\n assert factor > 1\\n\\n if i < j:\\n op = operator.mul\\n else:\\n assert i > j\\n op = operator.floordiv if floor else operator.truediv\\n try:\\n return op(value.to_expr(), factor).op()\\n except AttributeError:\\n return op(value, factor)\\n\\n\\ndef get_logger(\\n name: str,\\n level: str | None = None,\\n format: str | None = None,\\n propagate: bool = False,\\n) -> logging.Logger:\\n \\\"\\\"\\\"Get a logger.\\n\\n Parameters\\n ----------\\n name\\n Logger name\\n level\\n Logging level\\n format\\n Format string\\n propagate\\n Propagate the logger\\n\\n Returns\\n -------\\n logging.Logger\\n \\\"\\\"\\\"\\n logging.basicConfig()\\n handler = logging.StreamHandler()\\n\\n if format is None:\\n format = (\\n '%(relativeCreated)6d '\\n '%(name)-20s '\\n '%(levelname)-8s '\\n '%(threadName)-25s '\\n '%(message)s'\\n )\\n handler.setFormatter(logging.Formatter(fmt=format))\\n logger = logging.getLogger(name)\\n logger.propagate = propagate\\n logger.setLevel(\\n level or getattr(logging, os.environ.get('LOGLEVEL', 'WARNING').upper())\\n )\\n logger.addHandler(handler)\\n return logger\\n\\n\\n# taken from the itertools documentation\\ndef consume(iterator: Iterator[T], n: int | None = None) -> None:\\n \\\"\\\"\\\"Advance `iterator` n-steps ahead. If `n` is `None`, consume entirely.\\\"\\\"\\\"\\n # Use functions that consume iterators at C speed.\\n if n is None:\\n # feed the entire iterator into a zero-length deque\\n collections.deque(iterator, maxlen=0)\\n else:\\n # advance to the empty slice starting at position n\\n next(itertools.islice(iterator, n, n), None)\\n\\n\\n# TODO(kszucs): make it a more robust to better align with graph._flatten_collections()\\ndef recursive_get(obj, mapping):\\n if isinstance(obj, tuple):\\n return tuple(recursive_get(o, mapping) for o in obj)\\n elif isinstance(obj, dict):\\n return {k: recursive_get(v, mapping) for k, v in obj.items()}\\n else:\\n return mapping.get(obj, obj)\\n\\n\\ndef flatten_iterable(iterable):\\n \\\"\\\"\\\"Recursively flatten the iterable `iterable`.\\\"\\\"\\\"\\n if not is_iterable(iterable):\\n raise TypeError(\\\"flatten is only defined for non-str iterables\\\")\\n\\n for item in iterable:\\n if is_iterable(item):\\n yield from flatten_iterable(item)\\n else:\\n yield item\\n\\n\\ndef deprecated_msg(name, *, instead, as_of=\\\"\\\", removed_in=\\\"\\\"):\\n msg = f\\\"`{name}` is deprecated\\\"\\n\\n msgs = []\\n\\n if as_of:\\n msgs.append(f\\\"as of v{as_of}\\\")\\n\\n if removed_in:\\n msgs.append(f\\\"removed in v{removed_in}\\\")\\n\\n if msgs:\\n msg += f\\\" {', '.join(msgs)}\\\"\\n msg += f'; {instead}'\\n return msg\\n\\n\\ndef warn_deprecated(name, *, instead, as_of=\\\"\\\", removed_in=\\\"\\\", stacklevel=1):\\n \\\"\\\"\\\"Warn about deprecated usage.\\n\\n The message includes a stacktrace and what to do instead.\\n \\\"\\\"\\\"\\n\\n msg = deprecated_msg(name, instead=instead, as_of=as_of, removed_in=removed_in)\\n warnings.warn(msg, FutureWarning, stacklevel=stacklevel + 1)\\n\\n\\ndef append_admonition(\\n func: Callable, *, msg: str, body: str = \\\"\\\", kind: str = \\\"warning\\\"\\n) -> str:\\n \\\"\\\"\\\"Append a `kind` admonition with `msg` to `func`'s docstring.\\\"\\\"\\\"\\n if docstr := func.__doc__:\\n preamble, *rest = docstr.split(\\\"\\\\n\\\\n\\\", maxsplit=1)\\n\\n # count leading spaces and add them to the deprecation warning so the\\n # docstring parses correctly\\n leading_spaces = \\\" \\\" * sum(\\n 1 for _ in itertools.takewhile(str.isspace, rest[0] if rest else [])\\n )\\n\\n admonition_doc = f'{leading_spaces}!!! {kind} \\\"{msg}\\\"'\\n\\n if body:\\n rest = [indent(body, spaces=len(leading_spaces) + 4), *rest]\\n\\n docstr = \\\"\\\\n\\\\n\\\".join([preamble, admonition_doc, *rest])\\n else:\\n admonition_doc = f'!!! {kind} \\\"{msg}\\\"'\\n if body:\\n admonition_doc += f\\\"\\\\n\\\\n{indent(body, spaces=4)}\\\"\\n docstr = admonition_doc\\n return docstr\\n\\n\\ndef deprecated(*, instead: str, as_of: str = \\\"\\\", removed_in: str = \\\"\\\"):\\n \\\"\\\"\\\"Decorate to warn of deprecated usage and what to do instead.\\\"\\\"\\\"\\n\\n def decorator(func):\\n msg = deprecated_msg(\\n func.__qualname__, instead=instead, as_of=as_of, removed_in=removed_in\\n )\\n\\n func.__doc__ = append_admonition(func, msg=f\\\"DEPRECATED: {msg}\\\")\\n\\n @functools.wraps(func)\\n def wrapper(*args, **kwargs):\\n warn_deprecated(\\n func.__qualname__,\\n instead=instead,\\n as_of=as_of,\\n removed_in=removed_in,\\n stacklevel=2,\\n )\\n return func(*args, **kwargs)\\n\\n return wrapper\\n\\n return decorator\\n\\n\\ndef backend_sensitive(\\n *,\\n msg: str = \\\"This operation differs between backends.\\\",\\n why: str = \\\"\\\",\\n):\\n \\\"\\\"\\\"Indicate that an API may be sensitive to a backend.\\\"\\\"\\\"\\n\\n def wrapper(func):\\n func.__doc__ = append_admonition(func, msg=msg, body=why, kind=\\\"info\\\")\\n return func\\n\\n return wrapper\\n\\n\\ndef experimental(func):\\n \\\"\\\"\\\"Decorate a callable to add warning about API instability in docstring.\\\"\\\"\\\"\\n\\n func.__doc__ = append_admonition(\\n func, msg=\\\"This API is experimental and subject to change.\\\"\\n )\\n return func\\n\\n\\ndef backend_entry_points() -> list[importlib.metadata.EntryPoint]:\\n \\\"\\\"\\\"Get the list of installed `ibis.backend` entrypoints.\\\"\\\"\\\"\\n\\n if sys.version_info < (3, 10):\\n eps = importlib.metadata.entry_points()[\\\"ibis.backends\\\"]\\n else:\\n eps = importlib.metadata.entry_points(group=\\\"ibis.backends\\\")\\n return sorted(eps)\\n\\n\\ndef import_object(qualname: str) -> Any:\\n \\\"\\\"\\\"Attempt to import an object given its full qualname.\\n\\n Examples\\n --------\\n >>> ex = import_object(\\\"ibis.examples\\\")\\n\\n Is the same as\\n\\n >>> from ibis import examples as ex\\n \\\"\\\"\\\"\\n mod_name, name = qualname.rsplit(\\\".\\\", 1)\\n mod = importlib.import_module(mod_name)\\n try:\\n return getattr(mod, name)\\n except AttributeError:\\n raise ImportError(f\\\"cannot import name {name!r} from {mod_name!r}\\\") from None\\n\\n\\ndef normalize_filename(source: str | Path) -> str:\\n def _removeprefix(text, prefix):\\n # TODO: remove when we drop Python 3.8\\n try:\\n return text.removeprefix(prefix)\\n except AttributeError:\\n return text[text.startswith(prefix) and len(prefix) :]\\n\\n source = str(source)\\n for prefix in (\\n \\\"parquet\\\",\\n \\\"csv\\\",\\n \\\"csv.gz\\\",\\n \\\"txt\\\",\\n \\\"txt.gz\\\",\\n \\\"tsv\\\",\\n \\\"tsv.gz\\\",\\n \\\"file\\\",\\n ):\\n source = _removeprefix(source, f\\\"{prefix}://\\\")\\n\\n def _absolufy_paths(name):\\n if not name.startswith((\\\"http\\\", \\\"s3\\\")):\\n return os.path.abspath(name)\\n return name\\n\\n source = _absolufy_paths(source)\\n return source\\n\\n\\ndef gen_name(namespace: str) -> str:\\n \\\"\\\"\\\"Create a case-insensitive uuid4 unique table name.\\\"\\\"\\\"\\n uid = base64.b32encode(uuid.uuid4().bytes).decode().rstrip(\\\"=\\\").lower()\\n return f\\\"_ibis_{namespace}_{uid}\\\"\\n\",\n \"path\": \"ibis/util.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"\"\"\"Ibis utility functions.\"\"\"\nfrom __future__ import annotations\n\nimport base64\nimport collections\nimport functools\nimport importlib.metadata\nimport itertools\nimport logging\nimport operator\nimport os\nimport sys\nimport textwrap\nimport types\nimport uuid\nimport warnings\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Callable,\n Iterator,\n Mapping,\n Sequence,\n TypeVar,\n)\nfrom uuid import uuid4\n\nimport toolz\n\nif TYPE_CHECKING:\n from numbers import Real\n from pathlib import Path\n\n import ibis.expr.operations as ops\n\n Graph = Mapping[ops.Node, Sequence[ops.Node]]\n\nT = TypeVar(\"T\", covariant=True)\nU = TypeVar(\"U\", covariant=True)\nK = TypeVar(\"K\")\nV = TypeVar(\"V\")\n\n\n# https://www.compart.com/en/unicode/U+22EE\nVERTICAL_ELLIPSIS = \"\\u22EE\"\n# https://www.compart.com/en/unicode/U+2026\nHORIZONTAL_ELLIPSIS = \"\\u2026\"\n\n\ndef guid() -> str:\n \"\"\"Return a uuid4 hexadecimal value.\"\"\"\n return uuid4().hex\n\n\ndef indent(text: str, spaces: int) -> str:\n \"\"\"Apply an indentation using the given spaces into the given text.\n\n Parameters\n ----------\n text\n Text to indent\n spaces\n Number of leading spaces per line\n\n Returns\n -------\n str\n Indented text\n \"\"\"\n prefix = \" \" * spaces\n return textwrap.indent(text, prefix=prefix)\n\n\ndef is_one_of(values: Sequence[T], t: type[U]) -> Iterator[bool]:\n \"\"\"Check if the type of each value is the same of the given type.\n\n Parameters\n ----------\n values\n Input values\n t\n Type to check against\n\n Returns\n -------\n tuple\n \"\"\"\n return (isinstance(x, t) for x in values)\n\n\nany_of = toolz.compose(any, is_one_of)\nall_of = toolz.compose(all, is_one_of)\n\n\ndef promote_list(val: V | Sequence[V]) -> list[V]:\n \"\"\"Ensure that the value is a list.\n\n Parameters\n ----------\n val\n Value to promote\n\n Returns\n -------\n list\n \"\"\"\n if isinstance(val, list):\n return val\n elif is_iterable(val):\n return list(val)\n elif val is None:\n return []\n else:\n return [val]\n\n\ndef promote_tuple(val: V | Sequence[V]) -> tuple[V]:\n \"\"\"Ensure that the value is a tuple.\n\n Parameters\n ----------\n val\n Value to promote\n\n Returns\n -------\n tuple\n \"\"\"\n if isinstance(val, tuple):\n return val\n elif is_iterable(val):\n return tuple(val)\n elif val is None:\n return ()\n else:\n return (val,)\n\n\ndef is_function(v: Any) -> bool:\n \"\"\"Check if the given object is a function.\n\n Returns\n -------\n bool\n Whether `v` is a function\n \"\"\"\n return isinstance(v, (types.FunctionType, types.LambdaType))\n\n\ndef log(msg: str) -> None:\n \"\"\"Log `msg` using ``options.verbose_log`` if set, otherwise ``print``.\"\"\"\n from ibis.config import options\n\n if options.verbose:\n (options.verbose_log or print)(msg)\n\n\ndef approx_equal(a: Real, b: Real, eps: Real):\n \"\"\"Return whether the difference between `a` and `b` is less than `eps`.\n\n Raises\n ------\n AssertionError\n \"\"\"\n assert abs(a - b) < eps\n\n\ndef safe_index(elements: Sequence[int], value: int) -> int:\n \"\"\"Find the location of `value` in `elements`.\n\n Return -1 if `value` is not found instead of raising ``ValueError``.\n\n Parameters\n ----------\n elements\n Elements to index into\n value : int\n Index of the given sequence/elements\n\n Returns\n -------\n int\n\n Examples\n --------\n >>> sequence = [1, 2, 3]\n >>> safe_index(sequence, 2)\n 1\n >>> safe_index(sequence, 4)\n -1\n \"\"\"\n try:\n return elements.index(value)\n except ValueError:\n return -1\n\n\ndef is_iterable(o: Any) -> bool:\n \"\"\"Return whether `o` is iterable and not a :class:`str` or :class:`bytes`.\n\n Parameters\n ----------\n o : object\n Any python object\n\n Returns\n -------\n bool\n\n Examples\n --------\n >>> is_iterable('1')\n False\n >>> is_iterable(b'1')\n False\n >>> is_iterable(iter('1'))\n True\n >>> is_iterable(i for i in range(1))\n True\n >>> is_iterable(1)\n False\n >>> is_iterable([])\n True\n \"\"\"\n return not isinstance(o, (str, bytes)) and isinstance(o, collections.abc.Iterable)\n\n\ndef convert_unit(value, unit, to, floor: bool = True):\n \"\"\"Convert a value between different units.\n\n Convert `value`, is assumed to be in units of `unit`, to units of `to`.\n If `floor` is true, then use floor division on `value` if necessary.\n\n Parameters\n ----------\n value\n Number or numeric ibis expression\n unit\n Unit of `value`\n to\n Unit to convert to\n floor\n Whether or not to use floor division on `value` if necessary.\n\n Returns\n -------\n Union[numbers.Integral, ibis.expr.types.NumericValue]\n Integer converted unit\n\n Examples\n --------\n >>> one_second = 1000\n >>> x = convert_unit(one_second, 'ms', 's')\n >>> x\n 1\n >>> one_second = 1\n >>> x = convert_unit(one_second, 's', 'ms')\n >>> x\n 1000\n >>> x = convert_unit(one_second, 's', 's')\n >>> x\n 1\n >>> x = convert_unit(one_second, 's', 'M')\n Traceback (most recent call last):\n ...\n ValueError: Cannot convert to or from variable length interval\n \"\"\"\n # Don't do anything if from and to units are equivalent\n if unit == to:\n return value\n\n units = ('W', 'D', 'h', 'm', 's', 'ms', 'us', 'ns')\n factors = (7, 24, 60, 60, 1000, 1000, 1000)\n\n monthly_units = ('Y', 'Q', 'M')\n monthly_factors = (4, 3)\n\n try:\n i, j = units.index(unit), units.index(to)\n except ValueError:\n try:\n i, j = monthly_units.index(unit), monthly_units.index(to)\n factors = monthly_factors\n except ValueError:\n raise ValueError('Cannot convert to or from variable length interval')\n\n factor = functools.reduce(operator.mul, factors[min(i, j) : max(i, j)], 1)\n assert factor > 1\n\n if i < j:\n op = operator.mul\n else:\n assert i > j\n op = operator.floordiv if floor else operator.truediv\n try:\n return op(value.to_expr(), factor).op()\n except AttributeError:\n return op(value, factor)\n\n\ndef get_logger(\n name: str,\n level: str | None = None,\n format: str | None = None,\n propagate: bool = False,\n) -> logging.Logger:\n \"\"\"Get a logger.\n\n Parameters\n ----------\n name\n Logger name\n level\n Logging level\n format\n Format string\n propagate\n Propagate the logger\n\n Returns\n -------\n logging.Logger\n \"\"\"\n logging.basicConfig()\n handler = logging.StreamHandler()\n\n if format is None:\n format = (\n '%(relativeCreated)6d '\n '%(name)-20s '\n '%(levelname)-8s '\n '%(threadName)-25s '\n '%(message)s'\n )\n handler.setFormatter(logging.Formatter(fmt=format))\n logger = logging.getLogger(name)\n logger.propagate = propagate\n logger.setLevel(\n level or getattr(logging, os.environ.get('LOGLEVEL', 'WARNING').upper())\n )\n logger.addHandler(handler)\n return logger\n\n\n# taken from the itertools documentation\ndef consume(iterator: Iterator[T], n: int | None = None) -> None:\n \"\"\"Advance `iterator` n-steps ahead. If `n` is `None`, consume entirely.\"\"\"\n # Use functions that consume iterators at C speed.\n if n is None:\n # feed the entire iterator into a zero-length deque\n collections.deque(iterator, maxlen=0)\n else:\n # advance to the empty slice starting at position n\n next(itertools.islice(iterator, n, n), None)\n\n\n# TODO(kszucs): make it a more robust to better align with graph._flatten_collections()\ndef recursive_get(obj, mapping):\n if isinstance(obj, tuple):\n return tuple(recursive_get(o, mapping) for o in obj)\n elif isinstance(obj, dict):\n return {k: recursive_get(v, mapping) for k, v in obj.items()}\n else:\n return mapping.get(obj, obj)\n\n\ndef flatten_iterable(iterable):\n \"\"\"Recursively flatten the iterable `iterable`.\"\"\"\n if not is_iterable(iterable):\n raise TypeError(\"flatten is only defined for non-str iterables\")\n\n for item in iterable:\n if is_iterable(item):\n yield from flatten_iterable(item)\n else:\n yield item\n\n\ndef deprecated_msg(name, *, instead, as_of=\"\", removed_in=\"\"):\n msg = f\"`{name}` is deprecated\"\n\n msgs = []\n\n if as_of:\n msgs.append(f\"as of v{as_of}\")\n\n if removed_in:\n msgs.append(f\"removed in v{removed_in}\")\n\n if msgs:\n msg += f\" {', '.join(msgs)}\"\n msg += f'; {instead}'\n return msg\n\n\ndef warn_deprecated(name, *, instead, as_of=\"\", removed_in=\"\", stacklevel=1):\n \"\"\"Warn about deprecated usage.\n\n The message includes a stacktrace and what to do instead.\n \"\"\"\n\n msg = deprecated_msg(name, instead=instead, as_of=as_of, removed_in=removed_in)\n warnings.warn(msg, FutureWarning, stacklevel=stacklevel + 1)\n\n\ndef append_admonition(\n func: Callable, *, msg: str, body: str = \"\", kind: str = \"warning\"\n) -> str:\n \"\"\"Append a `kind` admonition with `msg` to `func`'s docstring.\"\"\"\n if docstr := func.__doc__:\n preamble, *rest = docstr.split(\"\\n\\n\", maxsplit=1)\n\n # count leading spaces and add them to the deprecation warning so the\n # docstring parses correctly\n leading_spaces = \" \" * sum(\n 1 for _ in itertools.takewhile(str.isspace, rest[0] if rest else [])\n )\n\n admonition_doc = f'{leading_spaces}!!! {kind} \"{msg}\"'\n\n if body:\n rest = [indent(body, spaces=len(leading_spaces) + 4), *rest]\n\n docstr = \"\\n\\n\".join([preamble, admonition_doc, *rest])\n else:\n admonition_doc = f'!!! {kind} \"{msg}\"'\n if body:\n admonition_doc += f\"\\n\\n{indent(body, spaces=4)}\"\n docstr = admonition_doc\n return docstr\n\n\ndef deprecated(*, instead: str, as_of: str = \"\", removed_in: str = \"\"):\n \"\"\"Decorate to warn of deprecated usage and what to do instead.\"\"\"\n\n def decorator(func):\n msg = deprecated_msg(\n func.__qualname__, instead=instead, as_of=as_of, removed_in=removed_in\n )\n\n func.__doc__ = append_admonition(func, msg=f\"DEPRECATED: {msg}\")\n\n @functools.wraps(func)\n def wrapper(*args, **kwargs):\n warn_deprecated(\n func.__qualname__,\n instead=instead,\n as_of=as_of,\n removed_in=removed_in,\n stacklevel=2,\n )\n return func(*args, **kwargs)\n\n return wrapper\n\n return decorator\n\n\ndef backend_sensitive(\n *,\n msg: str = \"This operation differs between backends.\",\n why: str = \"\",\n):\n \"\"\"Indicate that an API may be sensitive to a backend.\"\"\"\n\n def wrapper(func):\n func.__doc__ = append_admonition(func, msg=msg, body=why, kind=\"info\")\n return func\n\n return wrapper\n\n\ndef experimental(func):\n \"\"\"Decorate a callable to add warning about API instability in docstring.\"\"\"\n\n func.__doc__ = append_admonition(\n func, msg=\"This API is experimental and subject to change.\"\n )\n return func\n\n\ndef backend_entry_points() -> list[importlib.metadata.EntryPoint]:\n \"\"\"Get the list of installed `ibis.backend` entrypoints.\"\"\"\n\n if sys.version_info < (3, 10):\n eps = importlib.metadata.entry_points()[\"ibis.backends\"]\n else:\n eps = importlib.metadata.entry_points(group=\"ibis.backends\")\n return sorted(eps)\n\n\ndef import_object(qualname: str) -> Any:\n \"\"\"Attempt to import an object given its full qualname.\n\n Examples\n --------\n >>> ex = import_object(\"ibis.examples\")\n\n Is the same as\n\n >>> from ibis import examples as ex\n \"\"\"\n mod_name, name = qualname.rsplit(\".\", 1)\n mod = importlib.import_module(mod_name)\n try:\n return getattr(mod, name)\n except AttributeError:\n raise ImportError(f\"cannot import name {name!r} from {mod_name!r}\") from None\n\n\ndef normalize_filename(source: str | Path) -> str:\n def _removeprefix(text, prefix):\n # TODO: remove when we drop Python 3.8\n try:\n return text.removeprefix(prefix)\n except AttributeError:\n return text[text.startswith(prefix) and len(prefix) :]\n\n source = str(source)\n for prefix in (\n \"parquet\",\n \"csv\",\n \"csv.gz\",\n \"txt\",\n \"txt.gz\",\n \"tsv\",\n \"tsv.gz\",\n \"file\",\n ):\n source = _removeprefix(source, f\"{prefix}://\")\n\n def _absolufy_paths(name):\n if not name.startswith((\"http\", \"s3\", \"az\", \"abfs\", \"abfss\", \"adl\", \"gs\")):\n return os.path.abspath(name)\n return name\n\n source = _absolufy_paths(source)\n return source\n\n\ndef gen_name(namespace: str) -> str:\n \"\"\"Create a case-insensitive uuid4 unique table name.\"\"\"\n uid = base64.b32encode(uuid.uuid4().bytes).decode().rstrip(\"=\").lower()\n return f\"_ibis_{namespace}_{uid}\"\n","path":"ibis/util.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"Ibis utility functions.\\\"\\\"\\\"\\nfrom __future__ import annotations\\n\\nimport base64\\nimport collections\\nimport functools\\nimport importlib.metadata\\nimport itertools\\nimport logging\\nimport operator\\nimport os\\nimport sys\\nimport textwrap\\nimport types\\nimport uuid\\nimport warnings\\nfrom typing import (\\n TYPE_CHECKING,\\n Any,\\n Callable,\\n Iterator,\\n Mapping,\\n Sequence,\\n TypeVar,\\n)\\nfrom uuid import uuid4\\n\\nimport toolz\\n\\nif TYPE_CHECKING:\\n from numbers import Real\\n from pathlib import Path\\n\\n import ibis.expr.operations as ops\\n\\n Graph = Mapping[ops.Node, Sequence[ops.Node]]\\n\\nT = TypeVar(\\\"T\\\", covariant=True)\\nU = TypeVar(\\\"U\\\", covariant=True)\\nK = TypeVar(\\\"K\\\")\\nV = TypeVar(\\\"V\\\")\\n\\n\\n# https://www.compart.com/en/unicode/U+22EE\\nVERTICAL_ELLIPSIS = \\\"\\\\u22EE\\\"\\n# https://www.compart.com/en/unicode/U+2026\\nHORIZONTAL_ELLIPSIS = \\\"\\\\u2026\\\"\\n\\n\\ndef guid() -> str:\\n \\\"\\\"\\\"Return a uuid4 hexadecimal value.\\\"\\\"\\\"\\n return uuid4().hex\\n\\n\\ndef indent(text: str, spaces: int) -> str:\\n \\\"\\\"\\\"Apply an indentation using the given spaces into the given text.\\n\\n Parameters\\n ----------\\n text\\n Text to indent\\n spaces\\n Number of leading spaces per line\\n\\n Returns\\n -------\\n str\\n Indented text\\n \\\"\\\"\\\"\\n prefix = \\\" \\\" * spaces\\n return textwrap.indent(text, prefix=prefix)\\n\\n\\ndef is_one_of(values: Sequence[T], t: type[U]) -> Iterator[bool]:\\n \\\"\\\"\\\"Check if the type of each value is the same of the given type.\\n\\n Parameters\\n ----------\\n values\\n Input values\\n t\\n Type to check against\\n\\n Returns\\n -------\\n tuple\\n \\\"\\\"\\\"\\n return (isinstance(x, t) for x in values)\\n\\n\\nany_of = toolz.compose(any, is_one_of)\\nall_of = toolz.compose(all, is_one_of)\\n\\n\\ndef promote_list(val: V | Sequence[V]) -> list[V]:\\n \\\"\\\"\\\"Ensure that the value is a list.\\n\\n Parameters\\n ----------\\n val\\n Value to promote\\n\\n Returns\\n -------\\n list\\n \\\"\\\"\\\"\\n if isinstance(val, list):\\n return val\\n elif is_iterable(val):\\n return list(val)\\n elif val is None:\\n return []\\n else:\\n return [val]\\n\\n\\ndef promote_tuple(val: V | Sequence[V]) -> tuple[V]:\\n \\\"\\\"\\\"Ensure that the value is a tuple.\\n\\n Parameters\\n ----------\\n val\\n Value to promote\\n\\n Returns\\n -------\\n tuple\\n \\\"\\\"\\\"\\n if isinstance(val, tuple):\\n return val\\n elif is_iterable(val):\\n return tuple(val)\\n elif val is None:\\n return ()\\n else:\\n return (val,)\\n\\n\\ndef is_function(v: Any) -> bool:\\n \\\"\\\"\\\"Check if the given object is a function.\\n\\n Returns\\n -------\\n bool\\n Whether `v` is a function\\n \\\"\\\"\\\"\\n return isinstance(v, (types.FunctionType, types.LambdaType))\\n\\n\\ndef log(msg: str) -> None:\\n \\\"\\\"\\\"Log `msg` using ``options.verbose_log`` if set, otherwise ``print``.\\\"\\\"\\\"\\n from ibis.config import options\\n\\n if options.verbose:\\n (options.verbose_log or print)(msg)\\n\\n\\ndef approx_equal(a: Real, b: Real, eps: Real):\\n \\\"\\\"\\\"Return whether the difference between `a` and `b` is less than `eps`.\\n\\n Raises\\n ------\\n AssertionError\\n \\\"\\\"\\\"\\n assert abs(a - b) < eps\\n\\n\\ndef safe_index(elements: Sequence[int], value: int) -> int:\\n \\\"\\\"\\\"Find the location of `value` in `elements`.\\n\\n Return -1 if `value` is not found instead of raising ``ValueError``.\\n\\n Parameters\\n ----------\\n elements\\n Elements to index into\\n value : int\\n Index of the given sequence/elements\\n\\n Returns\\n -------\\n int\\n\\n Examples\\n --------\\n >>> sequence = [1, 2, 3]\\n >>> safe_index(sequence, 2)\\n 1\\n >>> safe_index(sequence, 4)\\n -1\\n \\\"\\\"\\\"\\n try:\\n return elements.index(value)\\n except ValueError:\\n return -1\\n\\n\\ndef is_iterable(o: Any) -> bool:\\n \\\"\\\"\\\"Return whether `o` is iterable and not a :class:`str` or :class:`bytes`.\\n\\n Parameters\\n ----------\\n o : object\\n Any python object\\n\\n Returns\\n -------\\n bool\\n\\n Examples\\n --------\\n >>> is_iterable('1')\\n False\\n >>> is_iterable(b'1')\\n False\\n >>> is_iterable(iter('1'))\\n True\\n >>> is_iterable(i for i in range(1))\\n True\\n >>> is_iterable(1)\\n False\\n >>> is_iterable([])\\n True\\n \\\"\\\"\\\"\\n return not isinstance(o, (str, bytes)) and isinstance(o, collections.abc.Iterable)\\n\\n\\ndef convert_unit(value, unit, to, floor: bool = True):\\n \\\"\\\"\\\"Convert a value between different units.\\n\\n Convert `value`, is assumed to be in units of `unit`, to units of `to`.\\n If `floor` is true, then use floor division on `value` if necessary.\\n\\n Parameters\\n ----------\\n value\\n Number or numeric ibis expression\\n unit\\n Unit of `value`\\n to\\n Unit to convert to\\n floor\\n Whether or not to use floor division on `value` if necessary.\\n\\n Returns\\n -------\\n Union[numbers.Integral, ibis.expr.types.NumericValue]\\n Integer converted unit\\n\\n Examples\\n --------\\n >>> one_second = 1000\\n >>> x = convert_unit(one_second, 'ms', 's')\\n >>> x\\n 1\\n >>> one_second = 1\\n >>> x = convert_unit(one_second, 's', 'ms')\\n >>> x\\n 1000\\n >>> x = convert_unit(one_second, 's', 's')\\n >>> x\\n 1\\n >>> x = convert_unit(one_second, 's', 'M')\\n Traceback (most recent call last):\\n ...\\n ValueError: Cannot convert to or from variable length interval\\n \\\"\\\"\\\"\\n # Don't do anything if from and to units are equivalent\\n if unit == to:\\n return value\\n\\n units = ('W', 'D', 'h', 'm', 's', 'ms', 'us', 'ns')\\n factors = (7, 24, 60, 60, 1000, 1000, 1000)\\n\\n monthly_units = ('Y', 'Q', 'M')\\n monthly_factors = (4, 3)\\n\\n try:\\n i, j = units.index(unit), units.index(to)\\n except ValueError:\\n try:\\n i, j = monthly_units.index(unit), monthly_units.index(to)\\n factors = monthly_factors\\n except ValueError:\\n raise ValueError('Cannot convert to or from variable length interval')\\n\\n factor = functools.reduce(operator.mul, factors[min(i, j) : max(i, j)], 1)\\n assert factor > 1\\n\\n if i < j:\\n op = operator.mul\\n else:\\n assert i > j\\n op = operator.floordiv if floor else operator.truediv\\n try:\\n return op(value.to_expr(), factor).op()\\n except AttributeError:\\n return op(value, factor)\\n\\n\\ndef get_logger(\\n name: str,\\n level: str | None = None,\\n format: str | None = None,\\n propagate: bool = False,\\n) -> logging.Logger:\\n \\\"\\\"\\\"Get a logger.\\n\\n Parameters\\n ----------\\n name\\n Logger name\\n level\\n Logging level\\n format\\n Format string\\n propagate\\n Propagate the logger\\n\\n Returns\\n -------\\n logging.Logger\\n \\\"\\\"\\\"\\n logging.basicConfig()\\n handler = logging.StreamHandler()\\n\\n if format is None:\\n format = (\\n '%(relativeCreated)6d '\\n '%(name)-20s '\\n '%(levelname)-8s '\\n '%(threadName)-25s '\\n '%(message)s'\\n )\\n handler.setFormatter(logging.Formatter(fmt=format))\\n logger = logging.getLogger(name)\\n logger.propagate = propagate\\n logger.setLevel(\\n level or getattr(logging, os.environ.get('LOGLEVEL', 'WARNING').upper())\\n )\\n logger.addHandler(handler)\\n return logger\\n\\n\\n# taken from the itertools documentation\\ndef consume(iterator: Iterator[T], n: int | None = None) -> None:\\n \\\"\\\"\\\"Advance `iterator` n-steps ahead. If `n` is `None`, consume entirely.\\\"\\\"\\\"\\n # Use functions that consume iterators at C speed.\\n if n is None:\\n # feed the entire iterator into a zero-length deque\\n collections.deque(iterator, maxlen=0)\\n else:\\n # advance to the empty slice starting at position n\\n next(itertools.islice(iterator, n, n), None)\\n\\n\\n# TODO(kszucs): make it a more robust to better align with graph._flatten_collections()\\ndef recursive_get(obj, mapping):\\n if isinstance(obj, tuple):\\n return tuple(recursive_get(o, mapping) for o in obj)\\n elif isinstance(obj, dict):\\n return {k: recursive_get(v, mapping) for k, v in obj.items()}\\n else:\\n return mapping.get(obj, obj)\\n\\n\\ndef flatten_iterable(iterable):\\n \\\"\\\"\\\"Recursively flatten the iterable `iterable`.\\\"\\\"\\\"\\n if not is_iterable(iterable):\\n raise TypeError(\\\"flatten is only defined for non-str iterables\\\")\\n\\n for item in iterable:\\n if is_iterable(item):\\n yield from flatten_iterable(item)\\n else:\\n yield item\\n\\n\\ndef deprecated_msg(name, *, instead, as_of=\\\"\\\", removed_in=\\\"\\\"):\\n msg = f\\\"`{name}` is deprecated\\\"\\n\\n msgs = []\\n\\n if as_of:\\n msgs.append(f\\\"as of v{as_of}\\\")\\n\\n if removed_in:\\n msgs.append(f\\\"removed in v{removed_in}\\\")\\n\\n if msgs:\\n msg += f\\\" {', '.join(msgs)}\\\"\\n msg += f'; {instead}'\\n return msg\\n\\n\\ndef warn_deprecated(name, *, instead, as_of=\\\"\\\", removed_in=\\\"\\\", stacklevel=1):\\n \\\"\\\"\\\"Warn about deprecated usage.\\n\\n The message includes a stacktrace and what to do instead.\\n \\\"\\\"\\\"\\n\\n msg = deprecated_msg(name, instead=instead, as_of=as_of, removed_in=removed_in)\\n warnings.warn(msg, FutureWarning, stacklevel=stacklevel + 1)\\n\\n\\ndef append_admonition(\\n func: Callable, *, msg: str, body: str = \\\"\\\", kind: str = \\\"warning\\\"\\n) -> str:\\n \\\"\\\"\\\"Append a `kind` admonition with `msg` to `func`'s docstring.\\\"\\\"\\\"\\n if docstr := func.__doc__:\\n preamble, *rest = docstr.split(\\\"\\\\n\\\\n\\\", maxsplit=1)\\n\\n # count leading spaces and add them to the deprecation warning so the\\n # docstring parses correctly\\n leading_spaces = \\\" \\\" * sum(\\n 1 for _ in itertools.takewhile(str.isspace, rest[0] if rest else [])\\n )\\n\\n admonition_doc = f'{leading_spaces}!!! {kind} \\\"{msg}\\\"'\\n\\n if body:\\n rest = [indent(body, spaces=len(leading_spaces) + 4), *rest]\\n\\n docstr = \\\"\\\\n\\\\n\\\".join([preamble, admonition_doc, *rest])\\n else:\\n admonition_doc = f'!!! {kind} \\\"{msg}\\\"'\\n if body:\\n admonition_doc += f\\\"\\\\n\\\\n{indent(body, spaces=4)}\\\"\\n docstr = admonition_doc\\n return docstr\\n\\n\\ndef deprecated(*, instead: str, as_of: str = \\\"\\\", removed_in: str = \\\"\\\"):\\n \\\"\\\"\\\"Decorate to warn of deprecated usage and what to do instead.\\\"\\\"\\\"\\n\\n def decorator(func):\\n msg = deprecated_msg(\\n func.__qualname__, instead=instead, as_of=as_of, removed_in=removed_in\\n )\\n\\n func.__doc__ = append_admonition(func, msg=f\\\"DEPRECATED: {msg}\\\")\\n\\n @functools.wraps(func)\\n def wrapper(*args, **kwargs):\\n warn_deprecated(\\n func.__qualname__,\\n instead=instead,\\n as_of=as_of,\\n removed_in=removed_in,\\n stacklevel=2,\\n )\\n return func(*args, **kwargs)\\n\\n return wrapper\\n\\n return decorator\\n\\n\\ndef backend_sensitive(\\n *,\\n msg: str = \\\"This operation differs between backends.\\\",\\n why: str = \\\"\\\",\\n):\\n \\\"\\\"\\\"Indicate that an API may be sensitive to a backend.\\\"\\\"\\\"\\n\\n def wrapper(func):\\n func.__doc__ = append_admonition(func, msg=msg, body=why, kind=\\\"info\\\")\\n return func\\n\\n return wrapper\\n\\n\\ndef experimental(func):\\n \\\"\\\"\\\"Decorate a callable to add warning about API instability in docstring.\\\"\\\"\\\"\\n\\n func.__doc__ = append_admonition(\\n func, msg=\\\"This API is experimental and subject to change.\\\"\\n )\\n return func\\n\\n\\ndef backend_entry_points() -> list[importlib.metadata.EntryPoint]:\\n \\\"\\\"\\\"Get the list of installed `ibis.backend` entrypoints.\\\"\\\"\\\"\\n\\n if sys.version_info < (3, 10):\\n eps = importlib.metadata.entry_points()[\\\"ibis.backends\\\"]\\n else:\\n eps = importlib.metadata.entry_points(group=\\\"ibis.backends\\\")\\n return sorted(eps)\\n\\n\\ndef import_object(qualname: str) -> Any:\\n \\\"\\\"\\\"Attempt to import an object given its full qualname.\\n\\n Examples\\n --------\\n >>> ex = import_object(\\\"ibis.examples\\\")\\n\\n Is the same as\\n\\n >>> from ibis import examples as ex\\n \\\"\\\"\\\"\\n mod_name, name = qualname.rsplit(\\\".\\\", 1)\\n mod = importlib.import_module(mod_name)\\n try:\\n return getattr(mod, name)\\n except AttributeError:\\n raise ImportError(f\\\"cannot import name {name!r} from {mod_name!r}\\\") from None\\n\\n\\ndef normalize_filename(source: str | Path) -> str:\\n def _removeprefix(text, prefix):\\n # TODO: remove when we drop Python 3.8\\n try:\\n return text.removeprefix(prefix)\\n except AttributeError:\\n return text[text.startswith(prefix) and len(prefix) :]\\n\\n source = str(source)\\n for prefix in (\\n \\\"parquet\\\",\\n \\\"csv\\\",\\n \\\"csv.gz\\\",\\n \\\"txt\\\",\\n \\\"txt.gz\\\",\\n \\\"tsv\\\",\\n \\\"tsv.gz\\\",\\n \\\"file\\\",\\n ):\\n source = _removeprefix(source, f\\\"{prefix}://\\\")\\n\\n def _absolufy_paths(name):\\n if not name.startswith((\\\"http\\\", \\\"s3\\\", \\\"az\\\", \\\"abfs\\\", \\\"abfss\\\", \\\"adl\\\", \\\"gs\\\")):\\n return os.path.abspath(name)\\n return name\\n\\n source = _absolufy_paths(source)\\n return source\\n\\n\\ndef gen_name(namespace: str) -> str:\\n \\\"\\\"\\\"Create a case-insensitive uuid4 unique table name.\\\"\\\"\\\"\\n uid = base64.b32encode(uuid.uuid4().bytes).decode().rstrip(\\\"=\\\").lower()\\n return f\\\"_ibis_{namespace}_{uid}\\\"\\n\",\n \"path\": \"ibis/util.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/ibis/util.py b/ibis/util.py\nindex 1c2c50fecd43..2506ab006731 100644\n--- a/ibis/util.py\n+++ b/ibis/util.py\n@@ -530,7 +530,7 @@ def _removeprefix(text, prefix):\n source = _removeprefix(source, f\"{prefix}://\")\n \n def _absolufy_paths(name):\n- if not name.startswith((\"http\", \"s3\")):\n+ if not name.startswith((\"http\", \"s3\", \"az\", \"abfs\", \"abfss\", \"adl\", \"gs\")):\n return os.path.abspath(name)\n return name\n \n"}}},{"rowIdx":2680,"cells":{"in_source_id":{"kind":"string","value":"biopython__biopython-4545"},"issue":{"kind":"string","value":"ScanProsite no longer working\n### Setup\r\n\r\nI am reporting a problem with Biopython version, Python version, and operating\r\nsystem as follows:\r\n\r\n```python\r\nimport sys; print(sys.version)\r\nimport platform; print(platform.python_implementation()); print(platform.platform())\r\nimport Bio; print(Bio.__version__)\r\n```\r\n\r\n(*Please copy and run the above in your Python, and copy-and-paste the output*)\r\n3.7.16 (default, Mar 10 2023, 03:25:26) \r\n[GCC 7.3.1 20180712 (Red Hat 7.3.1-15)]\r\nCPython\r\nLinux-5.10.177-158.645.amzn2.x86_64-x86_64-with-glibc2.2.5\r\n1.81\r\n\r\n### Expected behaviour\r\n\r\nHi, I have been recently having difficulty with the ScanProsite module. I am wondering if the ScanProsite mirror needs to updated. Thank you in advance.\r\n\r\n### Actual behaviour\r\n\r\nTraceback (most recent call last):\r\n File \"<stdin>\", line 1, in <module>\r\n File \"/usr/lib64/python3.7/urllib/request.py\", line 222, in urlopen\r\n return opener.open(url, data, timeout)\r\n File \"/usr/lib64/python3.7/urllib/request.py\", line 531, in open\r\n response = meth(req, response)\r\n File \"/usr/lib64/python3.7/urllib/request.py\", line 641, in http_response\r\n 'http', request, response, code, msg, hdrs)\r\n File \"/usr/lib64/python3.7/urllib/request.py\", line 569, in error\r\n return self._call_chain(*args)\r\n File \"/usr/lib64/python3.7/urllib/request.py\", line 503, in _call_chain\r\n result = func(*args)\r\n File \"/usr/lib64/python3.7/urllib/request.py\", line 649, in http_error_default\r\n raise HTTPError(req.full_url, code, msg, hdrs, fp)\r\nurllib.error.HTTPError: HTTP Error 308: Permanent Redirect\r\n\r\n### Steps to reproduce\r\n\r\n from Bio import ExPASy\r\n from Bio.ExPASy import ScanProsite\r\n import pandas as pd\r\n # Run input sequence through ScanProsite\r\n handle = ScanProsite.scan(sig = sequence, output = 'xml', lineage='Homo sapiens', mirror = 'https://prosite.expasy.org/cgi-bin/prosite/scanprosite/PSScan.cgi')\r\n result = ScanProsite.read(handle)\r\n df = pd.DataFrame(handle)\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"# Copyright 2009 by Michiel de Hoon. All rights reserved.\n# This code is part of the Biopython distribution and governed by its\n# license. Please see the LICENSE file that should have been included\n# as part of this package.\n\n\"\"\"Code for calling and parsing ScanProsite from ExPASy.\"\"\"\n\n# Importing these functions with leading underscore as not intended for reuse\nfrom urllib.request import urlopen\nfrom urllib.parse import urlencode\n\nfrom xml.sax import handler\nfrom xml.sax.expatreader import ExpatParser\n\n\nclass Record(list):\n \"\"\"Represents search results returned by ScanProsite.\n\n This record is a list containing the search results returned by\n ScanProsite. The record also contains the data members n_match,\n n_seq, capped, and warning.\n \"\"\"\n\n def __init__(self):\n \"\"\"Initialize the class.\"\"\"\n self.n_match = None\n self.n_seq = None\n self.capped = None\n self.warning = None\n\n\n# October 28th 2020 it was recognised that between October 10th 2020 and October\n# 28th the main url of prosite changed from https://www.expasy.org to\n# https://prosite.expasy.org. Thus a change in the mirror was issued from\n# https://www.expasy.org to https://prosite.expasy.org.\ndef scan(seq=\"\", mirror=\"https://prosite.expasy.org\", output=\"xml\", **keywords):\n \"\"\"Execute a ScanProsite search.\n\n Arguments:\n - mirror: The ScanProsite mirror to be used\n (default: https://prosite.expasy.org).\n - seq: The query sequence, or UniProtKB (Swiss-Prot,\n TrEMBL) accession\n - output: Format of the search results\n (default: xml)\n\n Further search parameters can be passed as keywords; see the\n documentation for programmatic access to ScanProsite at\n https://prosite.expasy.org/scanprosite/scanprosite_doc.html\n for a description of such parameters.\n\n This function returns a handle to the search results returned by\n ScanProsite. Search results in the XML format can be parsed into a\n Python object, by using the Bio.ExPASy.ScanProsite.read function.\n\n \"\"\"\n parameters = {\"seq\": seq, \"output\": output}\n for key, value in keywords.items():\n if value is not None:\n parameters[key] = value\n command = urlencode(parameters)\n url = f\"{mirror}/cgi-bin/prosite/PSScan.cgi?{command}\"\n handle = urlopen(url)\n return handle\n\n\ndef read(handle):\n \"\"\"Parse search results returned by ScanProsite into a Python object.\"\"\"\n content_handler = ContentHandler()\n saxparser = Parser()\n saxparser.setContentHandler(content_handler)\n saxparser.parse(handle)\n record = content_handler.record\n return record\n\n\n# The classes below are considered private\n\n\nclass Parser(ExpatParser):\n \"\"\"Process the result from a ScanProsite search (PRIVATE).\"\"\"\n\n def __init__(self):\n \"\"\"Initialize the class.\"\"\"\n ExpatParser.__init__(self)\n self.firsttime = True\n\n def feed(self, data, isFinal=0):\n \"\"\"Raise an Error if plain text is received in the data.\n\n This is to show the Error messages returned by ScanProsite.\n \"\"\"\n # Error messages returned by the ScanProsite server are formatted as\n # as plain text instead of an XML document. To catch such error\n # messages, we override the feed method of the Expat parser.\n # The error message is (hopefully) contained in the data that was just\n # fed to the parser.\n if self.firsttime:\n if data[:5].decode(\"utf-8\") != \"<?xml\":\n raise ValueError(data)\n self.firsttime = False\n return ExpatParser.feed(self, data, isFinal)\n\n\nclass ContentHandler(handler.ContentHandler):\n \"\"\"Process and fill in the records, results of the search (PRIVATE).\"\"\"\n\n integers = (\"start\", \"stop\")\n strings = (\n \"sequence_ac\",\n \"sequence_id\",\n \"sequence_db\",\n \"signature_ac\",\n \"level\",\n \"level_tag\",\n )\n\n def __init__(self):\n \"\"\"Initialize the class.\"\"\"\n self.element = []\n\n def startElement(self, name, attrs):\n \"\"\"Define the beginning of a record and stores the search record.\"\"\"\n self.element.append(name)\n self.content = \"\"\n if self.element == [\"matchset\"]:\n self.record = Record()\n self.record.n_match = int(attrs[\"n_match\"])\n self.record.n_seq = int(attrs[\"n_seq\"])\n elif self.element == [\"matchset\", \"match\"]:\n match = {}\n self.record.append(match)\n\n def endElement(self, name):\n \"\"\"Define the end of the search record.\"\"\"\n assert name == self.element.pop()\n if self.element == [\"matchset\", \"match\"]:\n match = self.record[-1]\n if name in ContentHandler.integers:\n match[name] = int(self.content)\n elif name in ContentHandler.strings:\n match[name] = self.content\n else:\n # Unknown type, treat it as a string\n match[name] = self.content\n\n def characters(self, content):\n \"\"\"Store the record content.\"\"\"\n self.content += content\n","path":"Bio/ExPASy/ScanProsite.py"}],"string":"[\n {\n \"content\": \"# Copyright 2009 by Michiel de Hoon. All rights reserved.\\n# This code is part of the Biopython distribution and governed by its\\n# license. Please see the LICENSE file that should have been included\\n# as part of this package.\\n\\n\\\"\\\"\\\"Code for calling and parsing ScanProsite from ExPASy.\\\"\\\"\\\"\\n\\n# Importing these functions with leading underscore as not intended for reuse\\nfrom urllib.request import urlopen\\nfrom urllib.parse import urlencode\\n\\nfrom xml.sax import handler\\nfrom xml.sax.expatreader import ExpatParser\\n\\n\\nclass Record(list):\\n \\\"\\\"\\\"Represents search results returned by ScanProsite.\\n\\n This record is a list containing the search results returned by\\n ScanProsite. The record also contains the data members n_match,\\n n_seq, capped, and warning.\\n \\\"\\\"\\\"\\n\\n def __init__(self):\\n \\\"\\\"\\\"Initialize the class.\\\"\\\"\\\"\\n self.n_match = None\\n self.n_seq = None\\n self.capped = None\\n self.warning = None\\n\\n\\n# October 28th 2020 it was recognised that between October 10th 2020 and October\\n# 28th the main url of prosite changed from https://www.expasy.org to\\n# https://prosite.expasy.org. Thus a change in the mirror was issued from\\n# https://www.expasy.org to https://prosite.expasy.org.\\ndef scan(seq=\\\"\\\", mirror=\\\"https://prosite.expasy.org\\\", output=\\\"xml\\\", **keywords):\\n \\\"\\\"\\\"Execute a ScanProsite search.\\n\\n Arguments:\\n - mirror: The ScanProsite mirror to be used\\n (default: https://prosite.expasy.org).\\n - seq: The query sequence, or UniProtKB (Swiss-Prot,\\n TrEMBL) accession\\n - output: Format of the search results\\n (default: xml)\\n\\n Further search parameters can be passed as keywords; see the\\n documentation for programmatic access to ScanProsite at\\n https://prosite.expasy.org/scanprosite/scanprosite_doc.html\\n for a description of such parameters.\\n\\n This function returns a handle to the search results returned by\\n ScanProsite. Search results in the XML format can be parsed into a\\n Python object, by using the Bio.ExPASy.ScanProsite.read function.\\n\\n \\\"\\\"\\\"\\n parameters = {\\\"seq\\\": seq, \\\"output\\\": output}\\n for key, value in keywords.items():\\n if value is not None:\\n parameters[key] = value\\n command = urlencode(parameters)\\n url = f\\\"{mirror}/cgi-bin/prosite/PSScan.cgi?{command}\\\"\\n handle = urlopen(url)\\n return handle\\n\\n\\ndef read(handle):\\n \\\"\\\"\\\"Parse search results returned by ScanProsite into a Python object.\\\"\\\"\\\"\\n content_handler = ContentHandler()\\n saxparser = Parser()\\n saxparser.setContentHandler(content_handler)\\n saxparser.parse(handle)\\n record = content_handler.record\\n return record\\n\\n\\n# The classes below are considered private\\n\\n\\nclass Parser(ExpatParser):\\n \\\"\\\"\\\"Process the result from a ScanProsite search (PRIVATE).\\\"\\\"\\\"\\n\\n def __init__(self):\\n \\\"\\\"\\\"Initialize the class.\\\"\\\"\\\"\\n ExpatParser.__init__(self)\\n self.firsttime = True\\n\\n def feed(self, data, isFinal=0):\\n \\\"\\\"\\\"Raise an Error if plain text is received in the data.\\n\\n This is to show the Error messages returned by ScanProsite.\\n \\\"\\\"\\\"\\n # Error messages returned by the ScanProsite server are formatted as\\n # as plain text instead of an XML document. To catch such error\\n # messages, we override the feed method of the Expat parser.\\n # The error message is (hopefully) contained in the data that was just\\n # fed to the parser.\\n if self.firsttime:\\n if data[:5].decode(\\\"utf-8\\\") != \\\"<?xml\\\":\\n raise ValueError(data)\\n self.firsttime = False\\n return ExpatParser.feed(self, data, isFinal)\\n\\n\\nclass ContentHandler(handler.ContentHandler):\\n \\\"\\\"\\\"Process and fill in the records, results of the search (PRIVATE).\\\"\\\"\\\"\\n\\n integers = (\\\"start\\\", \\\"stop\\\")\\n strings = (\\n \\\"sequence_ac\\\",\\n \\\"sequence_id\\\",\\n \\\"sequence_db\\\",\\n \\\"signature_ac\\\",\\n \\\"level\\\",\\n \\\"level_tag\\\",\\n )\\n\\n def __init__(self):\\n \\\"\\\"\\\"Initialize the class.\\\"\\\"\\\"\\n self.element = []\\n\\n def startElement(self, name, attrs):\\n \\\"\\\"\\\"Define the beginning of a record and stores the search record.\\\"\\\"\\\"\\n self.element.append(name)\\n self.content = \\\"\\\"\\n if self.element == [\\\"matchset\\\"]:\\n self.record = Record()\\n self.record.n_match = int(attrs[\\\"n_match\\\"])\\n self.record.n_seq = int(attrs[\\\"n_seq\\\"])\\n elif self.element == [\\\"matchset\\\", \\\"match\\\"]:\\n match = {}\\n self.record.append(match)\\n\\n def endElement(self, name):\\n \\\"\\\"\\\"Define the end of the search record.\\\"\\\"\\\"\\n assert name == self.element.pop()\\n if self.element == [\\\"matchset\\\", \\\"match\\\"]:\\n match = self.record[-1]\\n if name in ContentHandler.integers:\\n match[name] = int(self.content)\\n elif name in ContentHandler.strings:\\n match[name] = self.content\\n else:\\n # Unknown type, treat it as a string\\n match[name] = self.content\\n\\n def characters(self, content):\\n \\\"\\\"\\\"Store the record content.\\\"\\\"\\\"\\n self.content += content\\n\",\n \"path\": \"Bio/ExPASy/ScanProsite.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# Copyright 2009 by Michiel de Hoon. All rights reserved.\n# This code is part of the Biopython distribution and governed by its\n# license. Please see the LICENSE file that should have been included\n# as part of this package.\n\n\"\"\"Code for calling and parsing ScanProsite from ExPASy.\"\"\"\n\n# Importing these functions with leading underscore as not intended for reuse\nfrom urllib.request import urlopen\nfrom urllib.parse import urlencode\n\nfrom xml.sax import handler\nfrom xml.sax.expatreader import ExpatParser\n\n\nclass Record(list):\n \"\"\"Represents search results returned by ScanProsite.\n\n This record is a list containing the search results returned by\n ScanProsite. The record also contains the data members n_match,\n n_seq, capped, and warning.\n \"\"\"\n\n def __init__(self):\n \"\"\"Initialize the class.\"\"\"\n self.n_match = None\n self.n_seq = None\n self.capped = None\n self.warning = None\n\n\n# October 28th 2020 it was recognised that between October 10th 2020 and October\n# 28th the main url of prosite changed from https://www.expasy.org to\n# https://prosite.expasy.org. Thus a change in the mirror was issued from\n# https://www.expasy.org to https://prosite.expasy.org.\ndef scan(seq=\"\", mirror=\"https://prosite.expasy.org\", output=\"xml\", **keywords):\n \"\"\"Execute a ScanProsite search.\n\n Arguments:\n - mirror: The ScanProsite mirror to be used\n (default: https://prosite.expasy.org).\n - seq: The query sequence, or UniProtKB (Swiss-Prot,\n TrEMBL) accession\n - output: Format of the search results\n (default: xml)\n\n Further search parameters can be passed as keywords; see the\n documentation for programmatic access to ScanProsite at\n https://prosite.expasy.org/scanprosite/scanprosite_doc.html\n for a description of such parameters.\n\n This function returns a handle to the search results returned by\n ScanProsite. Search results in the XML format can be parsed into a\n Python object, by using the Bio.ExPASy.ScanProsite.read function.\n\n \"\"\"\n parameters = {\"seq\": seq, \"output\": output}\n for key, value in keywords.items():\n if value is not None:\n parameters[key] = value\n command = urlencode(parameters)\n url = f\"{mirror}/cgi-bin/prosite/scanprosite/PSScan.cgi?{command}\"\n handle = urlopen(url)\n return handle\n\n\ndef read(handle):\n \"\"\"Parse search results returned by ScanProsite into a Python object.\"\"\"\n content_handler = ContentHandler()\n saxparser = Parser()\n saxparser.setContentHandler(content_handler)\n saxparser.parse(handle)\n record = content_handler.record\n return record\n\n\n# The classes below are considered private\n\n\nclass Parser(ExpatParser):\n \"\"\"Process the result from a ScanProsite search (PRIVATE).\"\"\"\n\n def __init__(self):\n \"\"\"Initialize the class.\"\"\"\n ExpatParser.__init__(self)\n self.firsttime = True\n\n def feed(self, data, isFinal=0):\n \"\"\"Raise an Error if plain text is received in the data.\n\n This is to show the Error messages returned by ScanProsite.\n \"\"\"\n # Error messages returned by the ScanProsite server are formatted as\n # as plain text instead of an XML document. To catch such error\n # messages, we override the feed method of the Expat parser.\n # The error message is (hopefully) contained in the data that was just\n # fed to the parser.\n if self.firsttime:\n if data[:5].decode(\"utf-8\") != \"<?xml\":\n raise ValueError(data)\n self.firsttime = False\n return ExpatParser.feed(self, data, isFinal)\n\n\nclass ContentHandler(handler.ContentHandler):\n \"\"\"Process and fill in the records, results of the search (PRIVATE).\"\"\"\n\n integers = (\"start\", \"stop\")\n strings = (\n \"sequence_ac\",\n \"sequence_id\",\n \"sequence_db\",\n \"signature_ac\",\n \"level\",\n \"level_tag\",\n )\n\n def __init__(self):\n \"\"\"Initialize the class.\"\"\"\n self.element = []\n\n def startElement(self, name, attrs):\n \"\"\"Define the beginning of a record and stores the search record.\"\"\"\n self.element.append(name)\n self.content = \"\"\n if self.element == [\"matchset\"]:\n self.record = Record()\n self.record.n_match = int(attrs[\"n_match\"])\n self.record.n_seq = int(attrs[\"n_seq\"])\n elif self.element == [\"matchset\", \"match\"]:\n match = {}\n self.record.append(match)\n\n def endElement(self, name):\n \"\"\"Define the end of the search record.\"\"\"\n assert name == self.element.pop()\n if self.element == [\"matchset\", \"match\"]:\n match = self.record[-1]\n if name in ContentHandler.integers:\n match[name] = int(self.content)\n elif name in ContentHandler.strings:\n match[name] = self.content\n else:\n # Unknown type, treat it as a string\n match[name] = self.content\n\n def characters(self, content):\n \"\"\"Store the record content.\"\"\"\n self.content += content\n","path":"Bio/ExPASy/ScanProsite.py"}],"string":"[\n {\n \"content\": \"# Copyright 2009 by Michiel de Hoon. All rights reserved.\\n# This code is part of the Biopython distribution and governed by its\\n# license. Please see the LICENSE file that should have been included\\n# as part of this package.\\n\\n\\\"\\\"\\\"Code for calling and parsing ScanProsite from ExPASy.\\\"\\\"\\\"\\n\\n# Importing these functions with leading underscore as not intended for reuse\\nfrom urllib.request import urlopen\\nfrom urllib.parse import urlencode\\n\\nfrom xml.sax import handler\\nfrom xml.sax.expatreader import ExpatParser\\n\\n\\nclass Record(list):\\n \\\"\\\"\\\"Represents search results returned by ScanProsite.\\n\\n This record is a list containing the search results returned by\\n ScanProsite. The record also contains the data members n_match,\\n n_seq, capped, and warning.\\n \\\"\\\"\\\"\\n\\n def __init__(self):\\n \\\"\\\"\\\"Initialize the class.\\\"\\\"\\\"\\n self.n_match = None\\n self.n_seq = None\\n self.capped = None\\n self.warning = None\\n\\n\\n# October 28th 2020 it was recognised that between October 10th 2020 and October\\n# 28th the main url of prosite changed from https://www.expasy.org to\\n# https://prosite.expasy.org. Thus a change in the mirror was issued from\\n# https://www.expasy.org to https://prosite.expasy.org.\\ndef scan(seq=\\\"\\\", mirror=\\\"https://prosite.expasy.org\\\", output=\\\"xml\\\", **keywords):\\n \\\"\\\"\\\"Execute a ScanProsite search.\\n\\n Arguments:\\n - mirror: The ScanProsite mirror to be used\\n (default: https://prosite.expasy.org).\\n - seq: The query sequence, or UniProtKB (Swiss-Prot,\\n TrEMBL) accession\\n - output: Format of the search results\\n (default: xml)\\n\\n Further search parameters can be passed as keywords; see the\\n documentation for programmatic access to ScanProsite at\\n https://prosite.expasy.org/scanprosite/scanprosite_doc.html\\n for a description of such parameters.\\n\\n This function returns a handle to the search results returned by\\n ScanProsite. Search results in the XML format can be parsed into a\\n Python object, by using the Bio.ExPASy.ScanProsite.read function.\\n\\n \\\"\\\"\\\"\\n parameters = {\\\"seq\\\": seq, \\\"output\\\": output}\\n for key, value in keywords.items():\\n if value is not None:\\n parameters[key] = value\\n command = urlencode(parameters)\\n url = f\\\"{mirror}/cgi-bin/prosite/scanprosite/PSScan.cgi?{command}\\\"\\n handle = urlopen(url)\\n return handle\\n\\n\\ndef read(handle):\\n \\\"\\\"\\\"Parse search results returned by ScanProsite into a Python object.\\\"\\\"\\\"\\n content_handler = ContentHandler()\\n saxparser = Parser()\\n saxparser.setContentHandler(content_handler)\\n saxparser.parse(handle)\\n record = content_handler.record\\n return record\\n\\n\\n# The classes below are considered private\\n\\n\\nclass Parser(ExpatParser):\\n \\\"\\\"\\\"Process the result from a ScanProsite search (PRIVATE).\\\"\\\"\\\"\\n\\n def __init__(self):\\n \\\"\\\"\\\"Initialize the class.\\\"\\\"\\\"\\n ExpatParser.__init__(self)\\n self.firsttime = True\\n\\n def feed(self, data, isFinal=0):\\n \\\"\\\"\\\"Raise an Error if plain text is received in the data.\\n\\n This is to show the Error messages returned by ScanProsite.\\n \\\"\\\"\\\"\\n # Error messages returned by the ScanProsite server are formatted as\\n # as plain text instead of an XML document. To catch such error\\n # messages, we override the feed method of the Expat parser.\\n # The error message is (hopefully) contained in the data that was just\\n # fed to the parser.\\n if self.firsttime:\\n if data[:5].decode(\\\"utf-8\\\") != \\\"<?xml\\\":\\n raise ValueError(data)\\n self.firsttime = False\\n return ExpatParser.feed(self, data, isFinal)\\n\\n\\nclass ContentHandler(handler.ContentHandler):\\n \\\"\\\"\\\"Process and fill in the records, results of the search (PRIVATE).\\\"\\\"\\\"\\n\\n integers = (\\\"start\\\", \\\"stop\\\")\\n strings = (\\n \\\"sequence_ac\\\",\\n \\\"sequence_id\\\",\\n \\\"sequence_db\\\",\\n \\\"signature_ac\\\",\\n \\\"level\\\",\\n \\\"level_tag\\\",\\n )\\n\\n def __init__(self):\\n \\\"\\\"\\\"Initialize the class.\\\"\\\"\\\"\\n self.element = []\\n\\n def startElement(self, name, attrs):\\n \\\"\\\"\\\"Define the beginning of a record and stores the search record.\\\"\\\"\\\"\\n self.element.append(name)\\n self.content = \\\"\\\"\\n if self.element == [\\\"matchset\\\"]:\\n self.record = Record()\\n self.record.n_match = int(attrs[\\\"n_match\\\"])\\n self.record.n_seq = int(attrs[\\\"n_seq\\\"])\\n elif self.element == [\\\"matchset\\\", \\\"match\\\"]:\\n match = {}\\n self.record.append(match)\\n\\n def endElement(self, name):\\n \\\"\\\"\\\"Define the end of the search record.\\\"\\\"\\\"\\n assert name == self.element.pop()\\n if self.element == [\\\"matchset\\\", \\\"match\\\"]:\\n match = self.record[-1]\\n if name in ContentHandler.integers:\\n match[name] = int(self.content)\\n elif name in ContentHandler.strings:\\n match[name] = self.content\\n else:\\n # Unknown type, treat it as a string\\n match[name] = self.content\\n\\n def characters(self, content):\\n \\\"\\\"\\\"Store the record content.\\\"\\\"\\\"\\n self.content += content\\n\",\n \"path\": \"Bio/ExPASy/ScanProsite.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/Bio/ExPASy/ScanProsite.py b/Bio/ExPASy/ScanProsite.py\nindex 629ec15f159..e05570b5421 100644\n--- a/Bio/ExPASy/ScanProsite.py\n+++ b/Bio/ExPASy/ScanProsite.py\n@@ -59,7 +59,7 @@ def scan(seq=\"\", mirror=\"https://prosite.expasy.org\", output=\"xml\", **keywords):\n if value is not None:\n parameters[key] = value\n command = urlencode(parameters)\n- url = f\"{mirror}/cgi-bin/prosite/PSScan.cgi?{command}\"\n+ url = f\"{mirror}/cgi-bin/prosite/scanprosite/PSScan.cgi?{command}\"\n handle = urlopen(url)\n return handle\n \n"}}},{"rowIdx":2681,"cells":{"in_source_id":{"kind":"string","value":"streamlit__streamlit-724"},"issue":{"kind":"string","value":"Fix Danny's S3 sharing issue\nIt looks like `[s3] keyPrefix=...` isn't making it into the URLs being fetched from S3.\r\n\r\nThis is the address of a manifest protobuf we want to fetch:\r\n`https://yelp-people-dev.s3-us-west-2.amazonaws.com/~dqn/st/0.49.0-A8NT/reports/NJphBiGR4twz88mU9wTegn/manifest.pb`\r\n\r\nAnd this is the address that's being generated:\r\n`https://yelp-people-dev.s3.amazonaws.com/~dqn/reports/NJphBiGR4twz88mU9wTegn/manifest.pb`\r\n\r\nThe generated address is missing the `st/<streamlit version>` bits. Looks like we're splitting on a forward slash on the pathname in `ConnectionManager.fetchManifest`, which is giving us the wrong result because the keyPrefix itself has a forward slash.\n"},"before_files":{"kind":"list like","value":[{"content":"# -*- coding: utf-8 -*-\n# Copyright 2018-2019 Streamlit Inc.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport copy\nfrom urllib.parse import urljoin\nimport pandas as pd\nimport streamlit as st\n\n\nst.title(\"BART stops vs. bike rentals\")\n\nst.write(\n \"\"\"\n This plot shows two things:\n * Bay Area Rapit Transit (BART) train lines plotted as arcs connecting the\n stations.\n * A 3D hexagonal histogram plot of bike-sharing rentals (origin locations).\n\"\"\"\n)\n\n\n@st.cache\ndef from_data_file(filename):\n dirname = \"https://raw.githubusercontent.com/streamlit/streamlit/develop/examples/data/\" \n url = urljoin(dirname, filename)\n return pd.read_json(url)\n\n\n# Grab some data\nbart_stop_stats = copy.deepcopy(from_data_file(\"bart_stop_stats.json\"))\nbart_path_stats = from_data_file(\"bart_path_stats.json\")\nbike_rental_stats = from_data_file(\"bike_rental_stats.json\")\n\n# Move bart stop name to the 1st column, so it looks nicer when printed as a\n# table.\nbart_stop_names = bart_stop_stats[\"name\"]\nbart_stop_stats.drop(labels=[\"name\"], axis=1, inplace=True)\nbart_stop_stats.insert(0, \"name\", bart_stop_names)\n\nst.deck_gl_chart(\n viewport={\"latitude\": 37.76, \"longitude\": -122.4, \"zoom\": 11, \"pitch\": 50},\n layers=[\n {\n # Plot number of bike rentals throughtout the city\n \"type\": \"HexagonLayer\",\n \"data\": bike_rental_stats,\n \"radius\": 200,\n \"elevationScale\": 4,\n \"elevationRange\": [0, 1000],\n \"pickable\": True,\n \"extruded\": True,\n },\n {\n # Now plot locations of Bart stops\n # ...and let's size the stops according to traffic\n \"type\": \"ScatterplotLayer\",\n \"data\": bart_stop_stats,\n \"radiusScale\": 10,\n \"getRadius\": 50,\n },\n {\n # Now Add names of Bart stops\n \"type\": \"TextLayer\",\n \"data\": bart_stop_stats,\n \"getText\": \"name\",\n \"getColor\": [0, 0, 0, 200],\n \"getSize\": 15,\n },\n {\n # And draw some arcs connecting the stops\n \"type\": \"ArcLayer\",\n \"data\": bart_path_stats,\n \"pickable\": True,\n \"autoHighlight\": True,\n \"getStrokeWidth\": 10,\n },\n ],\n)\n","path":"examples/bart_vs_bikes.py"}],"string":"[\n {\n \"content\": \"# -*- coding: utf-8 -*-\\n# Copyright 2018-2019 Streamlit Inc.\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport copy\\nfrom urllib.parse import urljoin\\nimport pandas as pd\\nimport streamlit as st\\n\\n\\nst.title(\\\"BART stops vs. bike rentals\\\")\\n\\nst.write(\\n \\\"\\\"\\\"\\n This plot shows two things:\\n * Bay Area Rapit Transit (BART) train lines plotted as arcs connecting the\\n stations.\\n * A 3D hexagonal histogram plot of bike-sharing rentals (origin locations).\\n\\\"\\\"\\\"\\n)\\n\\n\\n@st.cache\\ndef from_data_file(filename):\\n dirname = \\\"https://raw.githubusercontent.com/streamlit/streamlit/develop/examples/data/\\\" \\n url = urljoin(dirname, filename)\\n return pd.read_json(url)\\n\\n\\n# Grab some data\\nbart_stop_stats = copy.deepcopy(from_data_file(\\\"bart_stop_stats.json\\\"))\\nbart_path_stats = from_data_file(\\\"bart_path_stats.json\\\")\\nbike_rental_stats = from_data_file(\\\"bike_rental_stats.json\\\")\\n\\n# Move bart stop name to the 1st column, so it looks nicer when printed as a\\n# table.\\nbart_stop_names = bart_stop_stats[\\\"name\\\"]\\nbart_stop_stats.drop(labels=[\\\"name\\\"], axis=1, inplace=True)\\nbart_stop_stats.insert(0, \\\"name\\\", bart_stop_names)\\n\\nst.deck_gl_chart(\\n viewport={\\\"latitude\\\": 37.76, \\\"longitude\\\": -122.4, \\\"zoom\\\": 11, \\\"pitch\\\": 50},\\n layers=[\\n {\\n # Plot number of bike rentals throughtout the city\\n \\\"type\\\": \\\"HexagonLayer\\\",\\n \\\"data\\\": bike_rental_stats,\\n \\\"radius\\\": 200,\\n \\\"elevationScale\\\": 4,\\n \\\"elevationRange\\\": [0, 1000],\\n \\\"pickable\\\": True,\\n \\\"extruded\\\": True,\\n },\\n {\\n # Now plot locations of Bart stops\\n # ...and let's size the stops according to traffic\\n \\\"type\\\": \\\"ScatterplotLayer\\\",\\n \\\"data\\\": bart_stop_stats,\\n \\\"radiusScale\\\": 10,\\n \\\"getRadius\\\": 50,\\n },\\n {\\n # Now Add names of Bart stops\\n \\\"type\\\": \\\"TextLayer\\\",\\n \\\"data\\\": bart_stop_stats,\\n \\\"getText\\\": \\\"name\\\",\\n \\\"getColor\\\": [0, 0, 0, 200],\\n \\\"getSize\\\": 15,\\n },\\n {\\n # And draw some arcs connecting the stops\\n \\\"type\\\": \\\"ArcLayer\\\",\\n \\\"data\\\": bart_path_stats,\\n \\\"pickable\\\": True,\\n \\\"autoHighlight\\\": True,\\n \\\"getStrokeWidth\\\": 10,\\n },\\n ],\\n)\\n\",\n \"path\": \"examples/bart_vs_bikes.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# -*- coding: utf-8 -*-\n# Copyright 2018-2019 Streamlit Inc.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport copy\nfrom urllib.parse import urljoin\nimport pandas as pd\nimport streamlit as st\n\n\nst.title(\"BART stops vs. bike rentals\")\n\nst.write(\n \"\"\"\n This plot shows two things:\n * Bay Area Rapit Transit (BART) train lines plotted as arcs connecting the\n stations.\n * A 3D hexagonal histogram plot of bike-sharing rentals (origin locations).\n\"\"\"\n)\n\n\n@st.cache\ndef from_data_file(filename):\n dirname = (\n \"https://raw.githubusercontent.com/streamlit/streamlit/develop/examples/data/\"\n )\n url = urljoin(dirname, filename)\n return pd.read_json(url)\n\n\n# Grab some data\nbart_stop_stats = copy.deepcopy(from_data_file(\"bart_stop_stats.json\"))\nbart_path_stats = from_data_file(\"bart_path_stats.json\")\nbike_rental_stats = from_data_file(\"bike_rental_stats.json\")\n\n# Move bart stop name to the 1st column, so it looks nicer when printed as a\n# table.\nbart_stop_names = bart_stop_stats[\"name\"]\nbart_stop_stats.drop(labels=[\"name\"], axis=1, inplace=True)\nbart_stop_stats.insert(0, \"name\", bart_stop_names)\n\nst.deck_gl_chart(\n viewport={\"latitude\": 37.76, \"longitude\": -122.4, \"zoom\": 11, \"pitch\": 50},\n layers=[\n {\n # Plot number of bike rentals throughtout the city\n \"type\": \"HexagonLayer\",\n \"data\": bike_rental_stats,\n \"radius\": 200,\n \"elevationScale\": 4,\n \"elevationRange\": [0, 1000],\n \"pickable\": True,\n \"extruded\": True,\n },\n {\n # Now plot locations of Bart stops\n # ...and let's size the stops according to traffic\n \"type\": \"ScatterplotLayer\",\n \"data\": bart_stop_stats,\n \"radiusScale\": 10,\n \"getRadius\": 50,\n },\n {\n # Now Add names of Bart stops\n \"type\": \"TextLayer\",\n \"data\": bart_stop_stats,\n \"getText\": \"name\",\n \"getColor\": [0, 0, 0, 200],\n \"getSize\": 15,\n },\n {\n # And draw some arcs connecting the stops\n \"type\": \"ArcLayer\",\n \"data\": bart_path_stats,\n \"pickable\": True,\n \"autoHighlight\": True,\n \"getStrokeWidth\": 10,\n },\n ],\n)\n","path":"examples/bart_vs_bikes.py"}],"string":"[\n {\n \"content\": \"# -*- coding: utf-8 -*-\\n# Copyright 2018-2019 Streamlit Inc.\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport copy\\nfrom urllib.parse import urljoin\\nimport pandas as pd\\nimport streamlit as st\\n\\n\\nst.title(\\\"BART stops vs. bike rentals\\\")\\n\\nst.write(\\n \\\"\\\"\\\"\\n This plot shows two things:\\n * Bay Area Rapit Transit (BART) train lines plotted as arcs connecting the\\n stations.\\n * A 3D hexagonal histogram plot of bike-sharing rentals (origin locations).\\n\\\"\\\"\\\"\\n)\\n\\n\\n@st.cache\\ndef from_data_file(filename):\\n dirname = (\\n \\\"https://raw.githubusercontent.com/streamlit/streamlit/develop/examples/data/\\\"\\n )\\n url = urljoin(dirname, filename)\\n return pd.read_json(url)\\n\\n\\n# Grab some data\\nbart_stop_stats = copy.deepcopy(from_data_file(\\\"bart_stop_stats.json\\\"))\\nbart_path_stats = from_data_file(\\\"bart_path_stats.json\\\")\\nbike_rental_stats = from_data_file(\\\"bike_rental_stats.json\\\")\\n\\n# Move bart stop name to the 1st column, so it looks nicer when printed as a\\n# table.\\nbart_stop_names = bart_stop_stats[\\\"name\\\"]\\nbart_stop_stats.drop(labels=[\\\"name\\\"], axis=1, inplace=True)\\nbart_stop_stats.insert(0, \\\"name\\\", bart_stop_names)\\n\\nst.deck_gl_chart(\\n viewport={\\\"latitude\\\": 37.76, \\\"longitude\\\": -122.4, \\\"zoom\\\": 11, \\\"pitch\\\": 50},\\n layers=[\\n {\\n # Plot number of bike rentals throughtout the city\\n \\\"type\\\": \\\"HexagonLayer\\\",\\n \\\"data\\\": bike_rental_stats,\\n \\\"radius\\\": 200,\\n \\\"elevationScale\\\": 4,\\n \\\"elevationRange\\\": [0, 1000],\\n \\\"pickable\\\": True,\\n \\\"extruded\\\": True,\\n },\\n {\\n # Now plot locations of Bart stops\\n # ...and let's size the stops according to traffic\\n \\\"type\\\": \\\"ScatterplotLayer\\\",\\n \\\"data\\\": bart_stop_stats,\\n \\\"radiusScale\\\": 10,\\n \\\"getRadius\\\": 50,\\n },\\n {\\n # Now Add names of Bart stops\\n \\\"type\\\": \\\"TextLayer\\\",\\n \\\"data\\\": bart_stop_stats,\\n \\\"getText\\\": \\\"name\\\",\\n \\\"getColor\\\": [0, 0, 0, 200],\\n \\\"getSize\\\": 15,\\n },\\n {\\n # And draw some arcs connecting the stops\\n \\\"type\\\": \\\"ArcLayer\\\",\\n \\\"data\\\": bart_path_stats,\\n \\\"pickable\\\": True,\\n \\\"autoHighlight\\\": True,\\n \\\"getStrokeWidth\\\": 10,\\n },\\n ],\\n)\\n\",\n \"path\": \"examples/bart_vs_bikes.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/examples/bart_vs_bikes.py b/examples/bart_vs_bikes.py\nindex 13284d5c8180..e79247600639 100644\n--- a/examples/bart_vs_bikes.py\n+++ b/examples/bart_vs_bikes.py\n@@ -33,7 +33,9 @@\n \n @st.cache\n def from_data_file(filename):\n- dirname = \"https://raw.githubusercontent.com/streamlit/streamlit/develop/examples/data/\" \n+ dirname = (\n+ \"https://raw.githubusercontent.com/streamlit/streamlit/develop/examples/data/\"\n+ )\n url = urljoin(dirname, filename)\n return pd.read_json(url)\n \ndiff --git a/frontend/src/lib/ConnectionManager.ts b/frontend/src/lib/ConnectionManager.ts\nold mode 100644\nnew mode 100755\nindex cf5c78545b77..4be8a19ddbd8\n--- a/frontend/src/lib/ConnectionManager.ts\n+++ b/frontend/src/lib/ConnectionManager.ts\n@@ -23,7 +23,11 @@ import { IS_SHARED_REPORT } from \"./baseconsts\"\n \n import { ConnectionState } from \"./ConnectionState\"\n import { logError } from \"./log\"\n-import { configureCredentials, getObject } from \"./s3helper\"\n+import {\n+ configureCredentials,\n+ getBucketAndResourceRoot,\n+ getObject,\n+} from \"./s3helper\"\n import { StaticConnection } from \"./StaticConnection\"\n import { WebsocketConnection } from \"./WebsocketConnection\"\n \n@@ -246,15 +250,12 @@ export class ConnectionManager {\n }\n \n async function fetchManifest(reportId: string): Promise<StaticManifest> {\n- const { hostname, pathname } = url.parse(window.location.href, true)\n- if (pathname == null) {\n- throw new Error(`No pathname in URL ${window.location.href}`)\n+ const { bucket, resourceRoot } = getBucketAndResourceRoot()\n+ if (resourceRoot == null) {\n+ throw new Error(`No resourceRoot in URL ${window.location.href}`)\n }\n \n- // IMPORTANT: The bucket name must match the host name!\n- const bucket = hostname\n- const version = pathname.split(\"/\")[1]\n- const manifestKey = `${version}/reports/${reportId}/manifest.pb`\n+ const manifestKey = `${resourceRoot}/reports/${reportId}/manifest.pb`\n const data = await getObject({ Bucket: String(bucket), Key: manifestKey })\n const arrayBuffer = await data.arrayBuffer()\n return StaticManifest.decode(new Uint8Array(arrayBuffer))\ndiff --git a/frontend/src/lib/StaticConnection.ts b/frontend/src/lib/StaticConnection.ts\nold mode 100644\nnew mode 100755\nindex fcb187dbc184..dd5992a82e81\n--- a/frontend/src/lib/StaticConnection.ts\n+++ b/frontend/src/lib/StaticConnection.ts\n@@ -15,10 +15,9 @@\n * limitations under the License.\n */\n \n-import url from \"url\"\n import { ConnectionState } from \"lib/ConnectionState\"\n import { ForwardMsg, StaticManifest } from \"autogen/proto\"\n-import { getObject } from \"lib/s3helper\"\n+import { getBucketAndResourceRoot, getObject } from \"lib/s3helper\"\n import { logError } from \"lib/log\"\n \n interface Props {\n@@ -50,10 +49,10 @@ export class StaticConnection {\n \n private static async getAllMessages(props: Props): Promise<void> {\n const { numMessages } = props.manifest\n- const { bucket, version } = getBucketAndVersion()\n+ const { bucket, resourceRoot } = getBucketAndResourceRoot()\n \n for (let msgIdx = 0; msgIdx < numMessages; msgIdx++) {\n- const messageKey = `${version}/reports/${props.reportId}/${msgIdx}.pb`\n+ const messageKey = `${resourceRoot}/reports/${props.reportId}/${msgIdx}.pb`\n \n try {\n const response = await getObject({ Bucket: bucket, Key: messageKey })\n@@ -65,14 +64,3 @@ export class StaticConnection {\n }\n }\n }\n-\n-/**\n- * Parses the S3 data bucket name and report version from the window location href\n- */\n-function getBucketAndVersion(): { bucket: string; version: string } {\n- // TODO: Unify with ConnectionManager.ts\n- const { hostname, pathname } = url.parse(window.location.href, true)\n- const bucket = String(hostname)\n- const version = pathname != null ? pathname.split(\"/\")[1] : \"null\"\n- return { bucket, version }\n-}\ndiff --git a/frontend/src/lib/s3helper.test.ts b/frontend/src/lib/s3helper.test.ts\nnew file mode 100644\nindex 000000000000..5fe511772cdf\n--- /dev/null\n+++ b/frontend/src/lib/s3helper.test.ts\n@@ -0,0 +1,53 @@\n+/**\n+ * @license\n+ * Copyright 2018-2019 Streamlit Inc.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+\n+import { getBucketAndResourceRoot } from \"./s3helper\"\n+\n+describe(\"getBucketAndResourceRoot\", () => {\n+ test(\"handles no resource root\", () => {\n+ mockWindowLocationHref(\"https://example.com\")\n+ expect(getBucketAndResourceRoot()).toStrictEqual({\n+ bucket: \"example.com\",\n+ resourceRoot: \"\",\n+ })\n+\n+ mockWindowLocationHref(\"https://example.com/\")\n+ expect(getBucketAndResourceRoot()).toStrictEqual({\n+ bucket: \"example.com\",\n+ resourceRoot: \"\",\n+ })\n+ })\n+\n+ test(\"handles resource root\", () => {\n+ mockWindowLocationHref(\n+ \"https://example.com/some/path/0.49.0/index.html?id=1234\"\n+ )\n+ expect(getBucketAndResourceRoot()).toStrictEqual({\n+ bucket: \"example.com\",\n+ resourceRoot: \"some/path/0.49.0\",\n+ })\n+ })\n+})\n+\n+function mockWindowLocationHref(href: string): void {\n+ delete global.window.location\n+ global.window = Object.create(window)\n+ Object.defineProperty(window, \"location\", {\n+ value: { href: href },\n+ writable: true,\n+ })\n+}\ndiff --git a/frontend/src/lib/s3helper.ts b/frontend/src/lib/s3helper.ts\nold mode 100644\nnew mode 100755\nindex 0de8bc11be20..70c1d32a4f5a\n--- a/frontend/src/lib/s3helper.ts\n+++ b/frontend/src/lib/s3helper.ts\n@@ -23,10 +23,38 @@ import {\n COGNITO_IDENTITY_POOL_ID,\n } from \"./baseconsts\"\n import { logError } from \"./log\"\n+import url from \"url\"\n \n let s3: any = null\n let haveCredentials = false\n \n+/**\n+ * Parses the S3 data bucket name and the resource root for the current\n+ * report from the window location href.\n+ */\n+export function getBucketAndResourceRoot(): {\n+ bucket: string\n+ resourceRoot: string\n+} {\n+ const { hostname, pathname } = url.parse(window.location.href, true)\n+\n+ // Bucket name is always equal to the hostname\n+ const bucket = String(hostname)\n+\n+ // We may not have a pathname\n+ if (pathname == null || pathname === \"/\") {\n+ return { bucket, resourceRoot: \"\" }\n+ }\n+\n+ // Our pathname will look something like /some/s3/path/0.49.0-HdbX/index.html?id=9zttR9BsCpG6YP1fMD8rjj\n+ // Everything after that initial '/ and before the final '/' is the resource root.\n+ const startIdx = pathname.startsWith(\"/\") ? 1 : 0\n+ const endIdx = pathname.lastIndexOf(\"/\")\n+ const resourceRoot = pathname.substring(startIdx, endIdx)\n+\n+ return { bucket, resourceRoot }\n+}\n+\n /**\n * Set up AWS credentials, given an OAuth ID token from Google.\n * Only needs to be called once ever.\n"}}},{"rowIdx":2682,"cells":{"in_source_id":{"kind":"string","value":"semgrep__semgrep-rules-1051"},"issue":{"kind":"string","value":"python tempfile-without-flush: Don't require .write() for exception?\n**Describe the bug**\r\nThe `python.lang.correctness.tempfile.flush.tempfile-without-flush` rule has [exceptions](https://github.com/returntocorp/semgrep-rules/blob/35e9f350a5d0190c936502fff179ba2c465c4438/python/lang/correctness/tempfile/flush.yaml#L5-L20) if `.write()` and then `.close()` or `.flush()` is used on a tempfile. However, this doesn't cover code which calls `.close()` immediately, without writing:\r\n\r\n```\r\n$ semgrep --config=p/r2c-ci --verbose test.py\r\n[...]\r\nseverity:error rule:python.lang.correctness.tempfile.flush.tempfile-without-flush: possibly missing a .flush() or .close() call to temporary file handle; file may or may not exist when handle.name is used\r\n3:handle = tempfile.NamedTemporaryFile(delete=False)\r\n4:handle.close()\r\n5:print(handle.name)\r\n```\r\n\r\n**To Reproduce**\r\n```python3\r\nimport tempfile\r\n\r\nhandle = tempfile.NamedTemporaryFile(delete=False)\r\nhandle.close()\r\nprint(handle.name)\r\n```\r\n\r\n**Expected behavior**\r\nIt seems to me like the exception should trigger whenever `.close()` is invoked, no matter if `.write()` is called before that or not?\npython tempfile-without-flush: Don't require .write() for exception?\n**Describe the bug**\r\nThe `python.lang.correctness.tempfile.flush.tempfile-without-flush` rule has [exceptions](https://github.com/returntocorp/semgrep-rules/blob/35e9f350a5d0190c936502fff179ba2c465c4438/python/lang/correctness/tempfile/flush.yaml#L5-L20) if `.write()` and then `.close()` or `.flush()` is used on a tempfile. However, this doesn't cover code which calls `.close()` immediately, without writing:\r\n\r\n```\r\n$ semgrep --config=p/r2c-ci --verbose test.py\r\n[...]\r\nseverity:error rule:python.lang.correctness.tempfile.flush.tempfile-without-flush: possibly missing a .flush() or .close() call to temporary file handle; file may or may not exist when handle.name is used\r\n3:handle = tempfile.NamedTemporaryFile(delete=False)\r\n4:handle.close()\r\n5:print(handle.name)\r\n```\r\n\r\n**To Reproduce**\r\n```python3\r\nimport tempfile\r\n\r\nhandle = tempfile.NamedTemporaryFile(delete=False)\r\nhandle.close()\r\nprint(handle.name)\r\n```\r\n\r\n**Expected behavior**\r\nIt seems to me like the exception should trigger whenever `.close()` is invoked, no matter if `.write()` is called before that or not?\n"},"before_files":{"kind":"list like","value":[{"content":"import tempfile\n\nimport at\nimport tf\n\n\ndef main():\n with tempfile.NamedTemporaryFile(\"w\") as fout:\n debug_print(astr)\n fout.write(astr)\n # ok:tempfile-without-flush\n fout.flush()\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\n\n\ndef main_b():\n with tempfile.NamedTemporaryFile(\"w\") as fout:\n debug_print(astr)\n fout.write(astr)\n # ok:tempfile-without-flush\n fout.close()\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\n\n\ndef main_c():\n with tempfile.NamedTemporaryFile(\"w\") as fout:\n debug_print(astr)\n fout.write(astr)\n\n # ok:tempfile-without-flush\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\n\n\ndef main_c():\n with tempfile.NamedTemporaryFile(\"w\") as fout:\n debug_print(astr)\n fout.write(astr)\n debug_print('wrote file')\n\n # ruleid:tempfile-without-flush\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\n\n\ndef main_d():\n fout = tempfile.NamedTemporaryFile('w')\n debug_print(astr)\n fout.write(astr)\n\n # ruleid:tempfile-without-flush\n fout.name\n # ruleid:tempfile-without-flush\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\n\n\ndef main_e():\n fout = tempfile.NamedTemporaryFile('w')\n debug_print(astr)\n fout.write(astr)\n\n # ruleid:tempfile-without-flush\n print(fout.name)\n # ruleid:tempfile-without-flush\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\n","path":"python/lang/correctness/tempfile/flush.py"}],"string":"[\n {\n \"content\": \"import tempfile\\n\\nimport at\\nimport tf\\n\\n\\ndef main():\\n with tempfile.NamedTemporaryFile(\\\"w\\\") as fout:\\n debug_print(astr)\\n fout.write(astr)\\n # ok:tempfile-without-flush\\n fout.flush()\\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\\n\\n\\ndef main_b():\\n with tempfile.NamedTemporaryFile(\\\"w\\\") as fout:\\n debug_print(astr)\\n fout.write(astr)\\n # ok:tempfile-without-flush\\n fout.close()\\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\\n\\n\\ndef main_c():\\n with tempfile.NamedTemporaryFile(\\\"w\\\") as fout:\\n debug_print(astr)\\n fout.write(astr)\\n\\n # ok:tempfile-without-flush\\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\\n\\n\\ndef main_c():\\n with tempfile.NamedTemporaryFile(\\\"w\\\") as fout:\\n debug_print(astr)\\n fout.write(astr)\\n debug_print('wrote file')\\n\\n # ruleid:tempfile-without-flush\\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\\n\\n\\ndef main_d():\\n fout = tempfile.NamedTemporaryFile('w')\\n debug_print(astr)\\n fout.write(astr)\\n\\n # ruleid:tempfile-without-flush\\n fout.name\\n # ruleid:tempfile-without-flush\\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\\n\\n\\ndef main_e():\\n fout = tempfile.NamedTemporaryFile('w')\\n debug_print(astr)\\n fout.write(astr)\\n\\n # ruleid:tempfile-without-flush\\n print(fout.name)\\n # ruleid:tempfile-without-flush\\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\\n\",\n \"path\": \"python/lang/correctness/tempfile/flush.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import tempfile\n\nimport at\nimport tf\n\n\ndef main():\n with tempfile.NamedTemporaryFile(\"w\") as fout:\n debug_print(astr)\n fout.write(astr)\n # ok:tempfile-without-flush\n fout.flush()\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\n\n\ndef main_b():\n with tempfile.NamedTemporaryFile(\"w\") as fout:\n debug_print(astr)\n fout.write(astr)\n # ok:tempfile-without-flush\n fout.close()\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\n\n\ndef main_c():\n with tempfile.NamedTemporaryFile(\"w\") as fout:\n debug_print(astr)\n fout.write(astr)\n\n # ok:tempfile-without-flush\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\n\n\ndef main_c():\n with tempfile.NamedTemporaryFile(\"w\") as fout:\n debug_print(astr)\n fout.write(astr)\n debug_print('wrote file')\n\n # ruleid:tempfile-without-flush\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\n\n\ndef main_d():\n fout = tempfile.NamedTemporaryFile('w')\n debug_print(astr)\n fout.write(astr)\n\n # ruleid:tempfile-without-flush\n fout.name\n # ruleid:tempfile-without-flush\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\n\n\ndef main_e():\n fout = tempfile.NamedTemporaryFile('w')\n debug_print(astr)\n fout.write(astr)\n\n # ruleid:tempfile-without-flush\n print(fout.name)\n # ruleid:tempfile-without-flush\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\n\n\ndef main_f():\n fout = tempfile.NamedTemporaryFile('w', delete=False)\n debug_print(astr)\n fout.close()\n\n # ok:tempfile-without-flush\n print(fout.name)\n","path":"python/lang/correctness/tempfile/flush.py"}],"string":"[\n {\n \"content\": \"import tempfile\\n\\nimport at\\nimport tf\\n\\n\\ndef main():\\n with tempfile.NamedTemporaryFile(\\\"w\\\") as fout:\\n debug_print(astr)\\n fout.write(astr)\\n # ok:tempfile-without-flush\\n fout.flush()\\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\\n\\n\\ndef main_b():\\n with tempfile.NamedTemporaryFile(\\\"w\\\") as fout:\\n debug_print(astr)\\n fout.write(astr)\\n # ok:tempfile-without-flush\\n fout.close()\\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\\n\\n\\ndef main_c():\\n with tempfile.NamedTemporaryFile(\\\"w\\\") as fout:\\n debug_print(astr)\\n fout.write(astr)\\n\\n # ok:tempfile-without-flush\\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\\n\\n\\ndef main_c():\\n with tempfile.NamedTemporaryFile(\\\"w\\\") as fout:\\n debug_print(astr)\\n fout.write(astr)\\n debug_print('wrote file')\\n\\n # ruleid:tempfile-without-flush\\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\\n\\n\\ndef main_d():\\n fout = tempfile.NamedTemporaryFile('w')\\n debug_print(astr)\\n fout.write(astr)\\n\\n # ruleid:tempfile-without-flush\\n fout.name\\n # ruleid:tempfile-without-flush\\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\\n\\n\\ndef main_e():\\n fout = tempfile.NamedTemporaryFile('w')\\n debug_print(astr)\\n fout.write(astr)\\n\\n # ruleid:tempfile-without-flush\\n print(fout.name)\\n # ruleid:tempfile-without-flush\\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\\n\\n\\ndef main_f():\\n fout = tempfile.NamedTemporaryFile('w', delete=False)\\n debug_print(astr)\\n fout.close()\\n\\n # ok:tempfile-without-flush\\n print(fout.name)\\n\",\n \"path\": \"python/lang/correctness/tempfile/flush.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/python/lang/correctness/tempfile/flush.py b/python/lang/correctness/tempfile/flush.py\nindex 020f6f7050..07b5183327 100644\n--- a/python/lang/correctness/tempfile/flush.py\n+++ b/python/lang/correctness/tempfile/flush.py\n@@ -61,3 +61,12 @@ def main_e():\n print(fout.name)\n # ruleid:tempfile-without-flush\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\n+\n+\n+def main_f():\n+ fout = tempfile.NamedTemporaryFile('w', delete=False)\n+ debug_print(astr)\n+ fout.close()\n+\n+ # ok:tempfile-without-flush\n+ print(fout.name)\ndiff --git a/python/lang/correctness/tempfile/flush.yaml b/python/lang/correctness/tempfile/flush.yaml\nindex e84e5e680a..e6295b3e22 100644\n--- a/python/lang/correctness/tempfile/flush.yaml\n+++ b/python/lang/correctness/tempfile/flush.yaml\n@@ -18,6 +18,12 @@ rules:\n $F.close()\n ...\n $F.name\n+ - pattern-not-inside: |\n+ $F = tempfile.NamedTemporaryFile(..., delete=False, ...)\n+ ...\n+ $F.close()\n+ ...\n+ $F.name\n - pattern-inside: |\n $F = tempfile.NamedTemporaryFile(...)\n ...\n"}}},{"rowIdx":2683,"cells":{"in_source_id":{"kind":"string","value":"encode__httpx-2523"},"issue":{"kind":"string","value":"Support passing bytes keys/values in `params=...`\n``` python\r\n>>> httpx.get('https://example.org', params={b'testparam': b'testvalue'}).url\r\nURL('https://example.org?b%27testparam%27=b%27testvalue%27')\r\n```\r\n\r\nI don't think this is intentional, as there is an isinstance check for bytes in the ``flatten_queryparams`` function, I'd expect anyone involved to have raised an exception instead of letting it go through like that, and that would be an undocumented divergence from requests compatibility.\r\n\r\nI have tested with ``httpx==0.7.8`` as well as ``httpx==0.11.0``.\n"},"before_files":{"kind":"list like","value":[{"content":"import codecs\nimport email.message\nimport logging\nimport mimetypes\nimport netrc\nimport os\nimport re\nimport sys\nimport time\nimport typing\nfrom pathlib import Path\nfrom urllib.request import getproxies\n\nimport sniffio\n\nfrom ._types import PrimitiveData\n\nif typing.TYPE_CHECKING: # pragma: no cover\n from ._urls import URL\n\n\n_HTML5_FORM_ENCODING_REPLACEMENTS = {'\"': \"%22\", \"\\\\\": \"\\\\\\\\\"}\n_HTML5_FORM_ENCODING_REPLACEMENTS.update(\n {chr(c): \"%{:02X}\".format(c) for c in range(0x1F + 1) if c != 0x1B}\n)\n_HTML5_FORM_ENCODING_RE = re.compile(\n r\"|\".join([re.escape(c) for c in _HTML5_FORM_ENCODING_REPLACEMENTS.keys()])\n)\n\n\ndef normalize_header_key(\n value: typing.Union[str, bytes],\n lower: bool,\n encoding: typing.Optional[str] = None,\n) -> bytes:\n \"\"\"\n Coerce str/bytes into a strictly byte-wise HTTP header key.\n \"\"\"\n if isinstance(value, bytes):\n bytes_value = value\n else:\n bytes_value = value.encode(encoding or \"ascii\")\n\n return bytes_value.lower() if lower else bytes_value\n\n\ndef normalize_header_value(\n value: typing.Union[str, bytes], encoding: typing.Optional[str] = None\n) -> bytes:\n \"\"\"\n Coerce str/bytes into a strictly byte-wise HTTP header value.\n \"\"\"\n if isinstance(value, bytes):\n return value\n return value.encode(encoding or \"ascii\")\n\n\ndef primitive_value_to_str(value: \"PrimitiveData\") -> str:\n \"\"\"\n Coerce a primitive data type into a string value.\n\n Note that we prefer JSON-style 'true'/'false' for boolean values here.\n \"\"\"\n if value is True:\n return \"true\"\n elif value is False:\n return \"false\"\n elif value is None:\n return \"\"\n return str(value)\n\n\ndef is_known_encoding(encoding: str) -> bool:\n \"\"\"\n Return `True` if `encoding` is a known codec.\n \"\"\"\n try:\n codecs.lookup(encoding)\n except LookupError:\n return False\n return True\n\n\ndef format_form_param(name: str, value: str) -> bytes:\n \"\"\"\n Encode a name/value pair within a multipart form.\n \"\"\"\n\n def replacer(match: typing.Match[str]) -> str:\n return _HTML5_FORM_ENCODING_REPLACEMENTS[match.group(0)]\n\n value = _HTML5_FORM_ENCODING_RE.sub(replacer, value)\n return f'{name}=\"{value}\"'.encode()\n\n\n# Null bytes; no need to recreate these on each call to guess_json_utf\n_null = b\"\\x00\"\n_null2 = _null * 2\n_null3 = _null * 3\n\n\ndef guess_json_utf(data: bytes) -> typing.Optional[str]:\n # JSON always starts with two ASCII characters, so detection is as\n # easy as counting the nulls and from their location and count\n # determine the encoding. Also detect a BOM, if present.\n sample = data[:4]\n if sample in (codecs.BOM_UTF32_LE, codecs.BOM_UTF32_BE):\n return \"utf-32\" # BOM included\n if sample[:3] == codecs.BOM_UTF8:\n return \"utf-8-sig\" # BOM included, MS style (discouraged)\n if sample[:2] in (codecs.BOM_UTF16_LE, codecs.BOM_UTF16_BE):\n return \"utf-16\" # BOM included\n nullcount = sample.count(_null)\n if nullcount == 0:\n return \"utf-8\"\n if nullcount == 2:\n if sample[::2] == _null2: # 1st and 3rd are null\n return \"utf-16-be\"\n if sample[1::2] == _null2: # 2nd and 4th are null\n return \"utf-16-le\"\n # Did not detect 2 valid UTF-16 ascii-range characters\n if nullcount == 3:\n if sample[:3] == _null3:\n return \"utf-32-be\"\n if sample[1:] == _null3:\n return \"utf-32-le\"\n # Did not detect a valid UTF-32 ascii-range character\n return None\n\n\nclass NetRCInfo:\n def __init__(self, files: typing.Optional[typing.List[str]] = None) -> None:\n if files is None:\n files = [os.getenv(\"NETRC\", \"\"), \"~/.netrc\", \"~/_netrc\"]\n self.netrc_files = files\n\n @property\n def netrc_info(self) -> typing.Optional[netrc.netrc]:\n if not hasattr(self, \"_netrc_info\"):\n self._netrc_info = None\n for file_path in self.netrc_files:\n expanded_path = Path(file_path).expanduser()\n try:\n if expanded_path.is_file():\n self._netrc_info = netrc.netrc(str(expanded_path))\n break\n except (netrc.NetrcParseError, IOError): # pragma: no cover\n # Issue while reading the netrc file, ignore...\n pass\n return self._netrc_info\n\n def get_credentials(self, host: str) -> typing.Optional[typing.Tuple[str, str]]:\n if self.netrc_info is None:\n return None\n\n auth_info = self.netrc_info.authenticators(host)\n if auth_info is None or auth_info[2] is None:\n return None\n return (auth_info[0], auth_info[2])\n\n\ndef get_ca_bundle_from_env() -> typing.Optional[str]:\n if \"SSL_CERT_FILE\" in os.environ:\n ssl_file = Path(os.environ[\"SSL_CERT_FILE\"])\n if ssl_file.is_file():\n return str(ssl_file)\n if \"SSL_CERT_DIR\" in os.environ:\n ssl_path = Path(os.environ[\"SSL_CERT_DIR\"])\n if ssl_path.is_dir():\n return str(ssl_path)\n return None\n\n\ndef parse_header_links(value: str) -> typing.List[typing.Dict[str, str]]:\n \"\"\"\n Returns a list of parsed link headers, for more info see:\n https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link\n The generic syntax of those is:\n Link: < uri-reference >; param1=value1; param2=\"value2\"\n So for instance:\n Link; '<http:/.../front.jpeg>; type=\"image/jpeg\",<http://.../back.jpeg>;'\n would return\n [\n {\"url\": \"http:/.../front.jpeg\", \"type\": \"image/jpeg\"},\n {\"url\": \"http://.../back.jpeg\"},\n ]\n :param value: HTTP Link entity-header field\n :return: list of parsed link headers\n \"\"\"\n links: typing.List[typing.Dict[str, str]] = []\n replace_chars = \" '\\\"\"\n value = value.strip(replace_chars)\n if not value:\n return links\n for val in re.split(\", *<\", value):\n try:\n url, params = val.split(\";\", 1)\n except ValueError:\n url, params = val, \"\"\n link = {\"url\": url.strip(\"<> '\\\"\")}\n for param in params.split(\";\"):\n try:\n key, value = param.split(\"=\")\n except ValueError:\n break\n link[key.strip(replace_chars)] = value.strip(replace_chars)\n links.append(link)\n return links\n\n\ndef parse_content_type_charset(content_type: str) -> typing.Optional[str]:\n # We used to use `cgi.parse_header()` here, but `cgi` became a dead battery.\n # See: https://peps.python.org/pep-0594/#cgi\n msg = email.message.Message()\n msg[\"content-type\"] = content_type\n return msg.get_content_charset(failobj=None)\n\n\nSENSITIVE_HEADERS = {\"authorization\", \"proxy-authorization\"}\n\n\ndef obfuscate_sensitive_headers(\n items: typing.Iterable[typing.Tuple[typing.AnyStr, typing.AnyStr]]\n) -> typing.Iterator[typing.Tuple[typing.AnyStr, typing.AnyStr]]:\n for k, v in items:\n if to_str(k.lower()) in SENSITIVE_HEADERS:\n v = to_bytes_or_str(\"[secure]\", match_type_of=v)\n yield k, v\n\n\n_LOGGER_INITIALIZED = False\nTRACE_LOG_LEVEL = 5\n\n\nclass Logger(logging.Logger):\n # Stub for type checkers.\n def trace(self, message: str, *args: typing.Any, **kwargs: typing.Any) -> None:\n ... # pragma: no cover\n\n\ndef get_logger(name: str) -> Logger:\n \"\"\"\n Get a `logging.Logger` instance, and optionally\n set up debug logging based on the HTTPX_LOG_LEVEL environment variable.\n \"\"\"\n global _LOGGER_INITIALIZED\n\n if not _LOGGER_INITIALIZED:\n _LOGGER_INITIALIZED = True\n logging.addLevelName(TRACE_LOG_LEVEL, \"TRACE\")\n\n log_level = os.environ.get(\"HTTPX_LOG_LEVEL\", \"\").upper()\n if log_level in (\"DEBUG\", \"TRACE\"):\n logger = logging.getLogger(\"httpx\")\n logger.setLevel(logging.DEBUG if log_level == \"DEBUG\" else TRACE_LOG_LEVEL)\n handler = logging.StreamHandler(sys.stderr)\n handler.setFormatter(\n logging.Formatter(\n fmt=\"%(levelname)s [%(asctime)s] %(name)s - %(message)s\",\n datefmt=\"%Y-%m-%d %H:%M:%S\",\n )\n )\n logger.addHandler(handler)\n\n logger = logging.getLogger(name)\n\n def trace(message: str, *args: typing.Any, **kwargs: typing.Any) -> None:\n logger.log(TRACE_LOG_LEVEL, message, *args, **kwargs)\n\n logger.trace = trace # type: ignore\n\n return typing.cast(Logger, logger)\n\n\ndef port_or_default(url: \"URL\") -> typing.Optional[int]:\n if url.port is not None:\n return url.port\n return {\"http\": 80, \"https\": 443}.get(url.scheme)\n\n\ndef same_origin(url: \"URL\", other: \"URL\") -> bool:\n \"\"\"\n Return 'True' if the given URLs share the same origin.\n \"\"\"\n return (\n url.scheme == other.scheme\n and url.host == other.host\n and port_or_default(url) == port_or_default(other)\n )\n\n\ndef is_https_redirect(url: \"URL\", location: \"URL\") -> bool:\n \"\"\"\n Return 'True' if 'location' is a HTTPS upgrade of 'url'\n \"\"\"\n if url.host != location.host:\n return False\n\n return (\n url.scheme == \"http\"\n and port_or_default(url) == 80\n and location.scheme == \"https\"\n and port_or_default(location) == 443\n )\n\n\ndef get_environment_proxies() -> typing.Dict[str, typing.Optional[str]]:\n \"\"\"Gets proxy information from the environment\"\"\"\n\n # urllib.request.getproxies() falls back on System\n # Registry and Config for proxies on Windows and macOS.\n # We don't want to propagate non-HTTP proxies into\n # our configuration such as 'TRAVIS_APT_PROXY'.\n proxy_info = getproxies()\n mounts: typing.Dict[str, typing.Optional[str]] = {}\n\n for scheme in (\"http\", \"https\", \"all\"):\n if proxy_info.get(scheme):\n hostname = proxy_info[scheme]\n mounts[f\"{scheme}://\"] = (\n hostname if \"://\" in hostname else f\"http://{hostname}\"\n )\n\n no_proxy_hosts = [host.strip() for host in proxy_info.get(\"no\", \"\").split(\",\")]\n for hostname in no_proxy_hosts:\n # See https://curl.haxx.se/libcurl/c/CURLOPT_NOPROXY.html for details\n # on how names in `NO_PROXY` are handled.\n if hostname == \"*\":\n # If NO_PROXY=* is used or if \"*\" occurs as any one of the comma\n # separated hostnames, then we should just bypass any information\n # from HTTP_PROXY, HTTPS_PROXY, ALL_PROXY, and always ignore\n # proxies.\n return {}\n elif hostname:\n # NO_PROXY=.google.com is marked as \"all://*.google.com,\n # which disables \"www.google.com\" but not \"google.com\"\n # NO_PROXY=google.com is marked as \"all://*google.com,\n # which disables \"www.google.com\" and \"google.com\".\n # (But not \"wwwgoogle.com\")\n mounts[f\"all://*{hostname}\"] = None\n\n return mounts\n\n\ndef to_bytes(value: typing.Union[str, bytes], encoding: str = \"utf-8\") -> bytes:\n return value.encode(encoding) if isinstance(value, str) else value\n\n\ndef to_str(value: typing.Union[str, bytes], encoding: str = \"utf-8\") -> str:\n return value if isinstance(value, str) else value.decode(encoding)\n\n\ndef to_bytes_or_str(value: str, match_type_of: typing.AnyStr) -> typing.AnyStr:\n return value if isinstance(match_type_of, str) else value.encode()\n\n\ndef unquote(value: str) -> str:\n return value[1:-1] if value[0] == value[-1] == '\"' else value\n\n\ndef guess_content_type(filename: typing.Optional[str]) -> typing.Optional[str]:\n if filename:\n return mimetypes.guess_type(filename)[0] or \"application/octet-stream\"\n return None\n\n\ndef peek_filelike_length(stream: typing.Any) -> typing.Optional[int]:\n \"\"\"\n Given a file-like stream object, return its length in number of bytes\n without reading it into memory.\n \"\"\"\n try:\n # Is it an actual file?\n fd = stream.fileno()\n # Yup, seems to be an actual file.\n length = os.fstat(fd).st_size\n except (AttributeError, OSError):\n # No... Maybe it's something that supports random access, like `io.BytesIO`?\n try:\n # Assuming so, go to end of stream to figure out its length,\n # then put it back in place.\n offset = stream.tell()\n length = stream.seek(0, os.SEEK_END)\n stream.seek(offset)\n except (AttributeError, OSError):\n # Not even that? Sorry, we're doomed...\n return None\n\n return length\n\n\nclass Timer:\n async def _get_time(self) -> float:\n library = sniffio.current_async_library()\n if library == \"trio\":\n import trio\n\n return trio.current_time()\n elif library == \"curio\": # pragma: no cover\n import curio\n\n return typing.cast(float, await curio.clock())\n\n import asyncio\n\n return asyncio.get_event_loop().time()\n\n def sync_start(self) -> None:\n self.started = time.perf_counter()\n\n async def async_start(self) -> None:\n self.started = await self._get_time()\n\n def sync_elapsed(self) -> float:\n now = time.perf_counter()\n return now - self.started\n\n async def async_elapsed(self) -> float:\n now = await self._get_time()\n return now - self.started\n\n\nclass URLPattern:\n \"\"\"\n A utility class currently used for making lookups against proxy keys...\n\n # Wildcard matching...\n >>> pattern = URLPattern(\"all\")\n >>> pattern.matches(httpx.URL(\"http://example.com\"))\n True\n\n # Witch scheme matching...\n >>> pattern = URLPattern(\"https\")\n >>> pattern.matches(httpx.URL(\"https://example.com\"))\n True\n >>> pattern.matches(httpx.URL(\"http://example.com\"))\n False\n\n # With domain matching...\n >>> pattern = URLPattern(\"https://example.com\")\n >>> pattern.matches(httpx.URL(\"https://example.com\"))\n True\n >>> pattern.matches(httpx.URL(\"http://example.com\"))\n False\n >>> pattern.matches(httpx.URL(\"https://other.com\"))\n False\n\n # Wildcard scheme, with domain matching...\n >>> pattern = URLPattern(\"all://example.com\")\n >>> pattern.matches(httpx.URL(\"https://example.com\"))\n True\n >>> pattern.matches(httpx.URL(\"http://example.com\"))\n True\n >>> pattern.matches(httpx.URL(\"https://other.com\"))\n False\n\n # With port matching...\n >>> pattern = URLPattern(\"https://example.com:1234\")\n >>> pattern.matches(httpx.URL(\"https://example.com:1234\"))\n True\n >>> pattern.matches(httpx.URL(\"https://example.com\"))\n False\n \"\"\"\n\n def __init__(self, pattern: str) -> None:\n from ._urls import URL\n\n if pattern and \":\" not in pattern:\n raise ValueError(\n f\"Proxy keys should use proper URL forms rather \"\n f\"than plain scheme strings. \"\n f'Instead of \"{pattern}\", use \"{pattern}://\"'\n )\n\n url = URL(pattern)\n self.pattern = pattern\n self.scheme = \"\" if url.scheme == \"all\" else url.scheme\n self.host = \"\" if url.host == \"*\" else url.host\n self.port = url.port\n if not url.host or url.host == \"*\":\n self.host_regex: typing.Optional[typing.Pattern[str]] = None\n elif url.host.startswith(\"*.\"):\n # *.example.com should match \"www.example.com\", but not \"example.com\"\n domain = re.escape(url.host[2:])\n self.host_regex = re.compile(f\"^.+\\\\.{domain}$\")\n elif url.host.startswith(\"*\"):\n # *example.com should match \"www.example.com\" and \"example.com\"\n domain = re.escape(url.host[1:])\n self.host_regex = re.compile(f\"^(.+\\\\.)?{domain}$\")\n else:\n # example.com should match \"example.com\" but not \"www.example.com\"\n domain = re.escape(url.host)\n self.host_regex = re.compile(f\"^{domain}$\")\n\n def matches(self, other: \"URL\") -> bool:\n if self.scheme and self.scheme != other.scheme:\n return False\n if (\n self.host\n and self.host_regex is not None\n and not self.host_regex.match(other.host)\n ):\n return False\n if self.port is not None and self.port != other.port:\n return False\n return True\n\n @property\n def priority(self) -> typing.Tuple[int, int, int]:\n \"\"\"\n The priority allows URLPattern instances to be sortable, so that\n we can match from most specific to least specific.\n \"\"\"\n # URLs with a port should take priority over URLs without a port.\n port_priority = 0 if self.port is not None else 1\n # Longer hostnames should match first.\n host_priority = -len(self.host)\n # Longer schemes should match first.\n scheme_priority = -len(self.scheme)\n return (port_priority, host_priority, scheme_priority)\n\n def __hash__(self) -> int:\n return hash(self.pattern)\n\n def __lt__(self, other: \"URLPattern\") -> bool:\n return self.priority < other.priority\n\n def __eq__(self, other: typing.Any) -> bool:\n return isinstance(other, URLPattern) and self.pattern == other.pattern\n","path":"httpx/_utils.py"}],"string":"[\n {\n \"content\": \"import codecs\\nimport email.message\\nimport logging\\nimport mimetypes\\nimport netrc\\nimport os\\nimport re\\nimport sys\\nimport time\\nimport typing\\nfrom pathlib import Path\\nfrom urllib.request import getproxies\\n\\nimport sniffio\\n\\nfrom ._types import PrimitiveData\\n\\nif typing.TYPE_CHECKING: # pragma: no cover\\n from ._urls import URL\\n\\n\\n_HTML5_FORM_ENCODING_REPLACEMENTS = {'\\\"': \\\"%22\\\", \\\"\\\\\\\\\\\": \\\"\\\\\\\\\\\\\\\\\\\"}\\n_HTML5_FORM_ENCODING_REPLACEMENTS.update(\\n {chr(c): \\\"%{:02X}\\\".format(c) for c in range(0x1F + 1) if c != 0x1B}\\n)\\n_HTML5_FORM_ENCODING_RE = re.compile(\\n r\\\"|\\\".join([re.escape(c) for c in _HTML5_FORM_ENCODING_REPLACEMENTS.keys()])\\n)\\n\\n\\ndef normalize_header_key(\\n value: typing.Union[str, bytes],\\n lower: bool,\\n encoding: typing.Optional[str] = None,\\n) -> bytes:\\n \\\"\\\"\\\"\\n Coerce str/bytes into a strictly byte-wise HTTP header key.\\n \\\"\\\"\\\"\\n if isinstance(value, bytes):\\n bytes_value = value\\n else:\\n bytes_value = value.encode(encoding or \\\"ascii\\\")\\n\\n return bytes_value.lower() if lower else bytes_value\\n\\n\\ndef normalize_header_value(\\n value: typing.Union[str, bytes], encoding: typing.Optional[str] = None\\n) -> bytes:\\n \\\"\\\"\\\"\\n Coerce str/bytes into a strictly byte-wise HTTP header value.\\n \\\"\\\"\\\"\\n if isinstance(value, bytes):\\n return value\\n return value.encode(encoding or \\\"ascii\\\")\\n\\n\\ndef primitive_value_to_str(value: \\\"PrimitiveData\\\") -> str:\\n \\\"\\\"\\\"\\n Coerce a primitive data type into a string value.\\n\\n Note that we prefer JSON-style 'true'/'false' for boolean values here.\\n \\\"\\\"\\\"\\n if value is True:\\n return \\\"true\\\"\\n elif value is False:\\n return \\\"false\\\"\\n elif value is None:\\n return \\\"\\\"\\n return str(value)\\n\\n\\ndef is_known_encoding(encoding: str) -> bool:\\n \\\"\\\"\\\"\\n Return `True` if `encoding` is a known codec.\\n \\\"\\\"\\\"\\n try:\\n codecs.lookup(encoding)\\n except LookupError:\\n return False\\n return True\\n\\n\\ndef format_form_param(name: str, value: str) -> bytes:\\n \\\"\\\"\\\"\\n Encode a name/value pair within a multipart form.\\n \\\"\\\"\\\"\\n\\n def replacer(match: typing.Match[str]) -> str:\\n return _HTML5_FORM_ENCODING_REPLACEMENTS[match.group(0)]\\n\\n value = _HTML5_FORM_ENCODING_RE.sub(replacer, value)\\n return f'{name}=\\\"{value}\\\"'.encode()\\n\\n\\n# Null bytes; no need to recreate these on each call to guess_json_utf\\n_null = b\\\"\\\\x00\\\"\\n_null2 = _null * 2\\n_null3 = _null * 3\\n\\n\\ndef guess_json_utf(data: bytes) -> typing.Optional[str]:\\n # JSON always starts with two ASCII characters, so detection is as\\n # easy as counting the nulls and from their location and count\\n # determine the encoding. Also detect a BOM, if present.\\n sample = data[:4]\\n if sample in (codecs.BOM_UTF32_LE, codecs.BOM_UTF32_BE):\\n return \\\"utf-32\\\" # BOM included\\n if sample[:3] == codecs.BOM_UTF8:\\n return \\\"utf-8-sig\\\" # BOM included, MS style (discouraged)\\n if sample[:2] in (codecs.BOM_UTF16_LE, codecs.BOM_UTF16_BE):\\n return \\\"utf-16\\\" # BOM included\\n nullcount = sample.count(_null)\\n if nullcount == 0:\\n return \\\"utf-8\\\"\\n if nullcount == 2:\\n if sample[::2] == _null2: # 1st and 3rd are null\\n return \\\"utf-16-be\\\"\\n if sample[1::2] == _null2: # 2nd and 4th are null\\n return \\\"utf-16-le\\\"\\n # Did not detect 2 valid UTF-16 ascii-range characters\\n if nullcount == 3:\\n if sample[:3] == _null3:\\n return \\\"utf-32-be\\\"\\n if sample[1:] == _null3:\\n return \\\"utf-32-le\\\"\\n # Did not detect a valid UTF-32 ascii-range character\\n return None\\n\\n\\nclass NetRCInfo:\\n def __init__(self, files: typing.Optional[typing.List[str]] = None) -> None:\\n if files is None:\\n files = [os.getenv(\\\"NETRC\\\", \\\"\\\"), \\\"~/.netrc\\\", \\\"~/_netrc\\\"]\\n self.netrc_files = files\\n\\n @property\\n def netrc_info(self) -> typing.Optional[netrc.netrc]:\\n if not hasattr(self, \\\"_netrc_info\\\"):\\n self._netrc_info = None\\n for file_path in self.netrc_files:\\n expanded_path = Path(file_path).expanduser()\\n try:\\n if expanded_path.is_file():\\n self._netrc_info = netrc.netrc(str(expanded_path))\\n break\\n except (netrc.NetrcParseError, IOError): # pragma: no cover\\n # Issue while reading the netrc file, ignore...\\n pass\\n return self._netrc_info\\n\\n def get_credentials(self, host: str) -> typing.Optional[typing.Tuple[str, str]]:\\n if self.netrc_info is None:\\n return None\\n\\n auth_info = self.netrc_info.authenticators(host)\\n if auth_info is None or auth_info[2] is None:\\n return None\\n return (auth_info[0], auth_info[2])\\n\\n\\ndef get_ca_bundle_from_env() -> typing.Optional[str]:\\n if \\\"SSL_CERT_FILE\\\" in os.environ:\\n ssl_file = Path(os.environ[\\\"SSL_CERT_FILE\\\"])\\n if ssl_file.is_file():\\n return str(ssl_file)\\n if \\\"SSL_CERT_DIR\\\" in os.environ:\\n ssl_path = Path(os.environ[\\\"SSL_CERT_DIR\\\"])\\n if ssl_path.is_dir():\\n return str(ssl_path)\\n return None\\n\\n\\ndef parse_header_links(value: str) -> typing.List[typing.Dict[str, str]]:\\n \\\"\\\"\\\"\\n Returns a list of parsed link headers, for more info see:\\n https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link\\n The generic syntax of those is:\\n Link: < uri-reference >; param1=value1; param2=\\\"value2\\\"\\n So for instance:\\n Link; '<http:/.../front.jpeg>; type=\\\"image/jpeg\\\",<http://.../back.jpeg>;'\\n would return\\n [\\n {\\\"url\\\": \\\"http:/.../front.jpeg\\\", \\\"type\\\": \\\"image/jpeg\\\"},\\n {\\\"url\\\": \\\"http://.../back.jpeg\\\"},\\n ]\\n :param value: HTTP Link entity-header field\\n :return: list of parsed link headers\\n \\\"\\\"\\\"\\n links: typing.List[typing.Dict[str, str]] = []\\n replace_chars = \\\" '\\\\\\\"\\\"\\n value = value.strip(replace_chars)\\n if not value:\\n return links\\n for val in re.split(\\\", *<\\\", value):\\n try:\\n url, params = val.split(\\\";\\\", 1)\\n except ValueError:\\n url, params = val, \\\"\\\"\\n link = {\\\"url\\\": url.strip(\\\"<> '\\\\\\\"\\\")}\\n for param in params.split(\\\";\\\"):\\n try:\\n key, value = param.split(\\\"=\\\")\\n except ValueError:\\n break\\n link[key.strip(replace_chars)] = value.strip(replace_chars)\\n links.append(link)\\n return links\\n\\n\\ndef parse_content_type_charset(content_type: str) -> typing.Optional[str]:\\n # We used to use `cgi.parse_header()` here, but `cgi` became a dead battery.\\n # See: https://peps.python.org/pep-0594/#cgi\\n msg = email.message.Message()\\n msg[\\\"content-type\\\"] = content_type\\n return msg.get_content_charset(failobj=None)\\n\\n\\nSENSITIVE_HEADERS = {\\\"authorization\\\", \\\"proxy-authorization\\\"}\\n\\n\\ndef obfuscate_sensitive_headers(\\n items: typing.Iterable[typing.Tuple[typing.AnyStr, typing.AnyStr]]\\n) -> typing.Iterator[typing.Tuple[typing.AnyStr, typing.AnyStr]]:\\n for k, v in items:\\n if to_str(k.lower()) in SENSITIVE_HEADERS:\\n v = to_bytes_or_str(\\\"[secure]\\\", match_type_of=v)\\n yield k, v\\n\\n\\n_LOGGER_INITIALIZED = False\\nTRACE_LOG_LEVEL = 5\\n\\n\\nclass Logger(logging.Logger):\\n # Stub for type checkers.\\n def trace(self, message: str, *args: typing.Any, **kwargs: typing.Any) -> None:\\n ... # pragma: no cover\\n\\n\\ndef get_logger(name: str) -> Logger:\\n \\\"\\\"\\\"\\n Get a `logging.Logger` instance, and optionally\\n set up debug logging based on the HTTPX_LOG_LEVEL environment variable.\\n \\\"\\\"\\\"\\n global _LOGGER_INITIALIZED\\n\\n if not _LOGGER_INITIALIZED:\\n _LOGGER_INITIALIZED = True\\n logging.addLevelName(TRACE_LOG_LEVEL, \\\"TRACE\\\")\\n\\n log_level = os.environ.get(\\\"HTTPX_LOG_LEVEL\\\", \\\"\\\").upper()\\n if log_level in (\\\"DEBUG\\\", \\\"TRACE\\\"):\\n logger = logging.getLogger(\\\"httpx\\\")\\n logger.setLevel(logging.DEBUG if log_level == \\\"DEBUG\\\" else TRACE_LOG_LEVEL)\\n handler = logging.StreamHandler(sys.stderr)\\n handler.setFormatter(\\n logging.Formatter(\\n fmt=\\\"%(levelname)s [%(asctime)s] %(name)s - %(message)s\\\",\\n datefmt=\\\"%Y-%m-%d %H:%M:%S\\\",\\n )\\n )\\n logger.addHandler(handler)\\n\\n logger = logging.getLogger(name)\\n\\n def trace(message: str, *args: typing.Any, **kwargs: typing.Any) -> None:\\n logger.log(TRACE_LOG_LEVEL, message, *args, **kwargs)\\n\\n logger.trace = trace # type: ignore\\n\\n return typing.cast(Logger, logger)\\n\\n\\ndef port_or_default(url: \\\"URL\\\") -> typing.Optional[int]:\\n if url.port is not None:\\n return url.port\\n return {\\\"http\\\": 80, \\\"https\\\": 443}.get(url.scheme)\\n\\n\\ndef same_origin(url: \\\"URL\\\", other: \\\"URL\\\") -> bool:\\n \\\"\\\"\\\"\\n Return 'True' if the given URLs share the same origin.\\n \\\"\\\"\\\"\\n return (\\n url.scheme == other.scheme\\n and url.host == other.host\\n and port_or_default(url) == port_or_default(other)\\n )\\n\\n\\ndef is_https_redirect(url: \\\"URL\\\", location: \\\"URL\\\") -> bool:\\n \\\"\\\"\\\"\\n Return 'True' if 'location' is a HTTPS upgrade of 'url'\\n \\\"\\\"\\\"\\n if url.host != location.host:\\n return False\\n\\n return (\\n url.scheme == \\\"http\\\"\\n and port_or_default(url) == 80\\n and location.scheme == \\\"https\\\"\\n and port_or_default(location) == 443\\n )\\n\\n\\ndef get_environment_proxies() -> typing.Dict[str, typing.Optional[str]]:\\n \\\"\\\"\\\"Gets proxy information from the environment\\\"\\\"\\\"\\n\\n # urllib.request.getproxies() falls back on System\\n # Registry and Config for proxies on Windows and macOS.\\n # We don't want to propagate non-HTTP proxies into\\n # our configuration such as 'TRAVIS_APT_PROXY'.\\n proxy_info = getproxies()\\n mounts: typing.Dict[str, typing.Optional[str]] = {}\\n\\n for scheme in (\\\"http\\\", \\\"https\\\", \\\"all\\\"):\\n if proxy_info.get(scheme):\\n hostname = proxy_info[scheme]\\n mounts[f\\\"{scheme}://\\\"] = (\\n hostname if \\\"://\\\" in hostname else f\\\"http://{hostname}\\\"\\n )\\n\\n no_proxy_hosts = [host.strip() for host in proxy_info.get(\\\"no\\\", \\\"\\\").split(\\\",\\\")]\\n for hostname in no_proxy_hosts:\\n # See https://curl.haxx.se/libcurl/c/CURLOPT_NOPROXY.html for details\\n # on how names in `NO_PROXY` are handled.\\n if hostname == \\\"*\\\":\\n # If NO_PROXY=* is used or if \\\"*\\\" occurs as any one of the comma\\n # separated hostnames, then we should just bypass any information\\n # from HTTP_PROXY, HTTPS_PROXY, ALL_PROXY, and always ignore\\n # proxies.\\n return {}\\n elif hostname:\\n # NO_PROXY=.google.com is marked as \\\"all://*.google.com,\\n # which disables \\\"www.google.com\\\" but not \\\"google.com\\\"\\n # NO_PROXY=google.com is marked as \\\"all://*google.com,\\n # which disables \\\"www.google.com\\\" and \\\"google.com\\\".\\n # (But not \\\"wwwgoogle.com\\\")\\n mounts[f\\\"all://*{hostname}\\\"] = None\\n\\n return mounts\\n\\n\\ndef to_bytes(value: typing.Union[str, bytes], encoding: str = \\\"utf-8\\\") -> bytes:\\n return value.encode(encoding) if isinstance(value, str) else value\\n\\n\\ndef to_str(value: typing.Union[str, bytes], encoding: str = \\\"utf-8\\\") -> str:\\n return value if isinstance(value, str) else value.decode(encoding)\\n\\n\\ndef to_bytes_or_str(value: str, match_type_of: typing.AnyStr) -> typing.AnyStr:\\n return value if isinstance(match_type_of, str) else value.encode()\\n\\n\\ndef unquote(value: str) -> str:\\n return value[1:-1] if value[0] == value[-1] == '\\\"' else value\\n\\n\\ndef guess_content_type(filename: typing.Optional[str]) -> typing.Optional[str]:\\n if filename:\\n return mimetypes.guess_type(filename)[0] or \\\"application/octet-stream\\\"\\n return None\\n\\n\\ndef peek_filelike_length(stream: typing.Any) -> typing.Optional[int]:\\n \\\"\\\"\\\"\\n Given a file-like stream object, return its length in number of bytes\\n without reading it into memory.\\n \\\"\\\"\\\"\\n try:\\n # Is it an actual file?\\n fd = stream.fileno()\\n # Yup, seems to be an actual file.\\n length = os.fstat(fd).st_size\\n except (AttributeError, OSError):\\n # No... Maybe it's something that supports random access, like `io.BytesIO`?\\n try:\\n # Assuming so, go to end of stream to figure out its length,\\n # then put it back in place.\\n offset = stream.tell()\\n length = stream.seek(0, os.SEEK_END)\\n stream.seek(offset)\\n except (AttributeError, OSError):\\n # Not even that? Sorry, we're doomed...\\n return None\\n\\n return length\\n\\n\\nclass Timer:\\n async def _get_time(self) -> float:\\n library = sniffio.current_async_library()\\n if library == \\\"trio\\\":\\n import trio\\n\\n return trio.current_time()\\n elif library == \\\"curio\\\": # pragma: no cover\\n import curio\\n\\n return typing.cast(float, await curio.clock())\\n\\n import asyncio\\n\\n return asyncio.get_event_loop().time()\\n\\n def sync_start(self) -> None:\\n self.started = time.perf_counter()\\n\\n async def async_start(self) -> None:\\n self.started = await self._get_time()\\n\\n def sync_elapsed(self) -> float:\\n now = time.perf_counter()\\n return now - self.started\\n\\n async def async_elapsed(self) -> float:\\n now = await self._get_time()\\n return now - self.started\\n\\n\\nclass URLPattern:\\n \\\"\\\"\\\"\\n A utility class currently used for making lookups against proxy keys...\\n\\n # Wildcard matching...\\n >>> pattern = URLPattern(\\\"all\\\")\\n >>> pattern.matches(httpx.URL(\\\"http://example.com\\\"))\\n True\\n\\n # Witch scheme matching...\\n >>> pattern = URLPattern(\\\"https\\\")\\n >>> pattern.matches(httpx.URL(\\\"https://example.com\\\"))\\n True\\n >>> pattern.matches(httpx.URL(\\\"http://example.com\\\"))\\n False\\n\\n # With domain matching...\\n >>> pattern = URLPattern(\\\"https://example.com\\\")\\n >>> pattern.matches(httpx.URL(\\\"https://example.com\\\"))\\n True\\n >>> pattern.matches(httpx.URL(\\\"http://example.com\\\"))\\n False\\n >>> pattern.matches(httpx.URL(\\\"https://other.com\\\"))\\n False\\n\\n # Wildcard scheme, with domain matching...\\n >>> pattern = URLPattern(\\\"all://example.com\\\")\\n >>> pattern.matches(httpx.URL(\\\"https://example.com\\\"))\\n True\\n >>> pattern.matches(httpx.URL(\\\"http://example.com\\\"))\\n True\\n >>> pattern.matches(httpx.URL(\\\"https://other.com\\\"))\\n False\\n\\n # With port matching...\\n >>> pattern = URLPattern(\\\"https://example.com:1234\\\")\\n >>> pattern.matches(httpx.URL(\\\"https://example.com:1234\\\"))\\n True\\n >>> pattern.matches(httpx.URL(\\\"https://example.com\\\"))\\n False\\n \\\"\\\"\\\"\\n\\n def __init__(self, pattern: str) -> None:\\n from ._urls import URL\\n\\n if pattern and \\\":\\\" not in pattern:\\n raise ValueError(\\n f\\\"Proxy keys should use proper URL forms rather \\\"\\n f\\\"than plain scheme strings. \\\"\\n f'Instead of \\\"{pattern}\\\", use \\\"{pattern}://\\\"'\\n )\\n\\n url = URL(pattern)\\n self.pattern = pattern\\n self.scheme = \\\"\\\" if url.scheme == \\\"all\\\" else url.scheme\\n self.host = \\\"\\\" if url.host == \\\"*\\\" else url.host\\n self.port = url.port\\n if not url.host or url.host == \\\"*\\\":\\n self.host_regex: typing.Optional[typing.Pattern[str]] = None\\n elif url.host.startswith(\\\"*.\\\"):\\n # *.example.com should match \\\"www.example.com\\\", but not \\\"example.com\\\"\\n domain = re.escape(url.host[2:])\\n self.host_regex = re.compile(f\\\"^.+\\\\\\\\.{domain}$\\\")\\n elif url.host.startswith(\\\"*\\\"):\\n # *example.com should match \\\"www.example.com\\\" and \\\"example.com\\\"\\n domain = re.escape(url.host[1:])\\n self.host_regex = re.compile(f\\\"^(.+\\\\\\\\.)?{domain}$\\\")\\n else:\\n # example.com should match \\\"example.com\\\" but not \\\"www.example.com\\\"\\n domain = re.escape(url.host)\\n self.host_regex = re.compile(f\\\"^{domain}$\\\")\\n\\n def matches(self, other: \\\"URL\\\") -> bool:\\n if self.scheme and self.scheme != other.scheme:\\n return False\\n if (\\n self.host\\n and self.host_regex is not None\\n and not self.host_regex.match(other.host)\\n ):\\n return False\\n if self.port is not None and self.port != other.port:\\n return False\\n return True\\n\\n @property\\n def priority(self) -> typing.Tuple[int, int, int]:\\n \\\"\\\"\\\"\\n The priority allows URLPattern instances to be sortable, so that\\n we can match from most specific to least specific.\\n \\\"\\\"\\\"\\n # URLs with a port should take priority over URLs without a port.\\n port_priority = 0 if self.port is not None else 1\\n # Longer hostnames should match first.\\n host_priority = -len(self.host)\\n # Longer schemes should match first.\\n scheme_priority = -len(self.scheme)\\n return (port_priority, host_priority, scheme_priority)\\n\\n def __hash__(self) -> int:\\n return hash(self.pattern)\\n\\n def __lt__(self, other: \\\"URLPattern\\\") -> bool:\\n return self.priority < other.priority\\n\\n def __eq__(self, other: typing.Any) -> bool:\\n return isinstance(other, URLPattern) and self.pattern == other.pattern\\n\",\n \"path\": \"httpx/_utils.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import codecs\nimport email.message\nimport logging\nimport mimetypes\nimport netrc\nimport os\nimport re\nimport sys\nimport time\nimport typing\nfrom pathlib import Path\nfrom urllib.request import getproxies\n\nimport sniffio\n\nfrom ._types import PrimitiveData\n\nif typing.TYPE_CHECKING: # pragma: no cover\n from ._urls import URL\n\n\n_HTML5_FORM_ENCODING_REPLACEMENTS = {'\"': \"%22\", \"\\\\\": \"\\\\\\\\\"}\n_HTML5_FORM_ENCODING_REPLACEMENTS.update(\n {chr(c): \"%{:02X}\".format(c) for c in range(0x1F + 1) if c != 0x1B}\n)\n_HTML5_FORM_ENCODING_RE = re.compile(\n r\"|\".join([re.escape(c) for c in _HTML5_FORM_ENCODING_REPLACEMENTS.keys()])\n)\n\n\ndef normalize_header_key(\n value: typing.Union[str, bytes],\n lower: bool,\n encoding: typing.Optional[str] = None,\n) -> bytes:\n \"\"\"\n Coerce str/bytes into a strictly byte-wise HTTP header key.\n \"\"\"\n if isinstance(value, bytes):\n bytes_value = value\n else:\n bytes_value = value.encode(encoding or \"ascii\")\n\n return bytes_value.lower() if lower else bytes_value\n\n\ndef normalize_header_value(\n value: typing.Union[str, bytes], encoding: typing.Optional[str] = None\n) -> bytes:\n \"\"\"\n Coerce str/bytes into a strictly byte-wise HTTP header value.\n \"\"\"\n if isinstance(value, bytes):\n return value\n return value.encode(encoding or \"ascii\")\n\n\ndef primitive_value_to_str(value: \"PrimitiveData\") -> str:\n \"\"\"\n Coerce a primitive data type into a string value.\n\n Note that we prefer JSON-style 'true'/'false' for boolean values here.\n \"\"\"\n if value is True:\n return \"true\"\n elif value is False:\n return \"false\"\n elif value is None:\n return \"\"\n elif isinstance(value, (str, float, int)):\n return str(value)\n raise TypeError(\n f\"Expected str, int, float, bool, or None. Got {type(value).__name__!r}.\"\n )\n\n\ndef is_known_encoding(encoding: str) -> bool:\n \"\"\"\n Return `True` if `encoding` is a known codec.\n \"\"\"\n try:\n codecs.lookup(encoding)\n except LookupError:\n return False\n return True\n\n\ndef format_form_param(name: str, value: str) -> bytes:\n \"\"\"\n Encode a name/value pair within a multipart form.\n \"\"\"\n\n def replacer(match: typing.Match[str]) -> str:\n return _HTML5_FORM_ENCODING_REPLACEMENTS[match.group(0)]\n\n value = _HTML5_FORM_ENCODING_RE.sub(replacer, value)\n return f'{name}=\"{value}\"'.encode()\n\n\n# Null bytes; no need to recreate these on each call to guess_json_utf\n_null = b\"\\x00\"\n_null2 = _null * 2\n_null3 = _null * 3\n\n\ndef guess_json_utf(data: bytes) -> typing.Optional[str]:\n # JSON always starts with two ASCII characters, so detection is as\n # easy as counting the nulls and from their location and count\n # determine the encoding. Also detect a BOM, if present.\n sample = data[:4]\n if sample in (codecs.BOM_UTF32_LE, codecs.BOM_UTF32_BE):\n return \"utf-32\" # BOM included\n if sample[:3] == codecs.BOM_UTF8:\n return \"utf-8-sig\" # BOM included, MS style (discouraged)\n if sample[:2] in (codecs.BOM_UTF16_LE, codecs.BOM_UTF16_BE):\n return \"utf-16\" # BOM included\n nullcount = sample.count(_null)\n if nullcount == 0:\n return \"utf-8\"\n if nullcount == 2:\n if sample[::2] == _null2: # 1st and 3rd are null\n return \"utf-16-be\"\n if sample[1::2] == _null2: # 2nd and 4th are null\n return \"utf-16-le\"\n # Did not detect 2 valid UTF-16 ascii-range characters\n if nullcount == 3:\n if sample[:3] == _null3:\n return \"utf-32-be\"\n if sample[1:] == _null3:\n return \"utf-32-le\"\n # Did not detect a valid UTF-32 ascii-range character\n return None\n\n\nclass NetRCInfo:\n def __init__(self, files: typing.Optional[typing.List[str]] = None) -> None:\n if files is None:\n files = [os.getenv(\"NETRC\", \"\"), \"~/.netrc\", \"~/_netrc\"]\n self.netrc_files = files\n\n @property\n def netrc_info(self) -> typing.Optional[netrc.netrc]:\n if not hasattr(self, \"_netrc_info\"):\n self._netrc_info = None\n for file_path in self.netrc_files:\n expanded_path = Path(file_path).expanduser()\n try:\n if expanded_path.is_file():\n self._netrc_info = netrc.netrc(str(expanded_path))\n break\n except (netrc.NetrcParseError, IOError): # pragma: no cover\n # Issue while reading the netrc file, ignore...\n pass\n return self._netrc_info\n\n def get_credentials(self, host: str) -> typing.Optional[typing.Tuple[str, str]]:\n if self.netrc_info is None:\n return None\n\n auth_info = self.netrc_info.authenticators(host)\n if auth_info is None or auth_info[2] is None:\n return None\n return (auth_info[0], auth_info[2])\n\n\ndef get_ca_bundle_from_env() -> typing.Optional[str]:\n if \"SSL_CERT_FILE\" in os.environ:\n ssl_file = Path(os.environ[\"SSL_CERT_FILE\"])\n if ssl_file.is_file():\n return str(ssl_file)\n if \"SSL_CERT_DIR\" in os.environ:\n ssl_path = Path(os.environ[\"SSL_CERT_DIR\"])\n if ssl_path.is_dir():\n return str(ssl_path)\n return None\n\n\ndef parse_header_links(value: str) -> typing.List[typing.Dict[str, str]]:\n \"\"\"\n Returns a list of parsed link headers, for more info see:\n https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link\n The generic syntax of those is:\n Link: < uri-reference >; param1=value1; param2=\"value2\"\n So for instance:\n Link; '<http:/.../front.jpeg>; type=\"image/jpeg\",<http://.../back.jpeg>;'\n would return\n [\n {\"url\": \"http:/.../front.jpeg\", \"type\": \"image/jpeg\"},\n {\"url\": \"http://.../back.jpeg\"},\n ]\n :param value: HTTP Link entity-header field\n :return: list of parsed link headers\n \"\"\"\n links: typing.List[typing.Dict[str, str]] = []\n replace_chars = \" '\\\"\"\n value = value.strip(replace_chars)\n if not value:\n return links\n for val in re.split(\", *<\", value):\n try:\n url, params = val.split(\";\", 1)\n except ValueError:\n url, params = val, \"\"\n link = {\"url\": url.strip(\"<> '\\\"\")}\n for param in params.split(\";\"):\n try:\n key, value = param.split(\"=\")\n except ValueError:\n break\n link[key.strip(replace_chars)] = value.strip(replace_chars)\n links.append(link)\n return links\n\n\ndef parse_content_type_charset(content_type: str) -> typing.Optional[str]:\n # We used to use `cgi.parse_header()` here, but `cgi` became a dead battery.\n # See: https://peps.python.org/pep-0594/#cgi\n msg = email.message.Message()\n msg[\"content-type\"] = content_type\n return msg.get_content_charset(failobj=None)\n\n\nSENSITIVE_HEADERS = {\"authorization\", \"proxy-authorization\"}\n\n\ndef obfuscate_sensitive_headers(\n items: typing.Iterable[typing.Tuple[typing.AnyStr, typing.AnyStr]]\n) -> typing.Iterator[typing.Tuple[typing.AnyStr, typing.AnyStr]]:\n for k, v in items:\n if to_str(k.lower()) in SENSITIVE_HEADERS:\n v = to_bytes_or_str(\"[secure]\", match_type_of=v)\n yield k, v\n\n\n_LOGGER_INITIALIZED = False\nTRACE_LOG_LEVEL = 5\n\n\nclass Logger(logging.Logger):\n # Stub for type checkers.\n def trace(self, message: str, *args: typing.Any, **kwargs: typing.Any) -> None:\n ... # pragma: no cover\n\n\ndef get_logger(name: str) -> Logger:\n \"\"\"\n Get a `logging.Logger` instance, and optionally\n set up debug logging based on the HTTPX_LOG_LEVEL environment variable.\n \"\"\"\n global _LOGGER_INITIALIZED\n\n if not _LOGGER_INITIALIZED:\n _LOGGER_INITIALIZED = True\n logging.addLevelName(TRACE_LOG_LEVEL, \"TRACE\")\n\n log_level = os.environ.get(\"HTTPX_LOG_LEVEL\", \"\").upper()\n if log_level in (\"DEBUG\", \"TRACE\"):\n logger = logging.getLogger(\"httpx\")\n logger.setLevel(logging.DEBUG if log_level == \"DEBUG\" else TRACE_LOG_LEVEL)\n handler = logging.StreamHandler(sys.stderr)\n handler.setFormatter(\n logging.Formatter(\n fmt=\"%(levelname)s [%(asctime)s] %(name)s - %(message)s\",\n datefmt=\"%Y-%m-%d %H:%M:%S\",\n )\n )\n logger.addHandler(handler)\n\n logger = logging.getLogger(name)\n\n def trace(message: str, *args: typing.Any, **kwargs: typing.Any) -> None:\n logger.log(TRACE_LOG_LEVEL, message, *args, **kwargs)\n\n logger.trace = trace # type: ignore\n\n return typing.cast(Logger, logger)\n\n\ndef port_or_default(url: \"URL\") -> typing.Optional[int]:\n if url.port is not None:\n return url.port\n return {\"http\": 80, \"https\": 443}.get(url.scheme)\n\n\ndef same_origin(url: \"URL\", other: \"URL\") -> bool:\n \"\"\"\n Return 'True' if the given URLs share the same origin.\n \"\"\"\n return (\n url.scheme == other.scheme\n and url.host == other.host\n and port_or_default(url) == port_or_default(other)\n )\n\n\ndef is_https_redirect(url: \"URL\", location: \"URL\") -> bool:\n \"\"\"\n Return 'True' if 'location' is a HTTPS upgrade of 'url'\n \"\"\"\n if url.host != location.host:\n return False\n\n return (\n url.scheme == \"http\"\n and port_or_default(url) == 80\n and location.scheme == \"https\"\n and port_or_default(location) == 443\n )\n\n\ndef get_environment_proxies() -> typing.Dict[str, typing.Optional[str]]:\n \"\"\"Gets proxy information from the environment\"\"\"\n\n # urllib.request.getproxies() falls back on System\n # Registry and Config for proxies on Windows and macOS.\n # We don't want to propagate non-HTTP proxies into\n # our configuration such as 'TRAVIS_APT_PROXY'.\n proxy_info = getproxies()\n mounts: typing.Dict[str, typing.Optional[str]] = {}\n\n for scheme in (\"http\", \"https\", \"all\"):\n if proxy_info.get(scheme):\n hostname = proxy_info[scheme]\n mounts[f\"{scheme}://\"] = (\n hostname if \"://\" in hostname else f\"http://{hostname}\"\n )\n\n no_proxy_hosts = [host.strip() for host in proxy_info.get(\"no\", \"\").split(\",\")]\n for hostname in no_proxy_hosts:\n # See https://curl.haxx.se/libcurl/c/CURLOPT_NOPROXY.html for details\n # on how names in `NO_PROXY` are handled.\n if hostname == \"*\":\n # If NO_PROXY=* is used or if \"*\" occurs as any one of the comma\n # separated hostnames, then we should just bypass any information\n # from HTTP_PROXY, HTTPS_PROXY, ALL_PROXY, and always ignore\n # proxies.\n return {}\n elif hostname:\n # NO_PROXY=.google.com is marked as \"all://*.google.com,\n # which disables \"www.google.com\" but not \"google.com\"\n # NO_PROXY=google.com is marked as \"all://*google.com,\n # which disables \"www.google.com\" and \"google.com\".\n # (But not \"wwwgoogle.com\")\n mounts[f\"all://*{hostname}\"] = None\n\n return mounts\n\n\ndef to_bytes(value: typing.Union[str, bytes], encoding: str = \"utf-8\") -> bytes:\n return value.encode(encoding) if isinstance(value, str) else value\n\n\ndef to_str(value: typing.Union[str, bytes], encoding: str = \"utf-8\") -> str:\n return value if isinstance(value, str) else value.decode(encoding)\n\n\ndef to_bytes_or_str(value: str, match_type_of: typing.AnyStr) -> typing.AnyStr:\n return value if isinstance(match_type_of, str) else value.encode()\n\n\ndef unquote(value: str) -> str:\n return value[1:-1] if value[0] == value[-1] == '\"' else value\n\n\ndef guess_content_type(filename: typing.Optional[str]) -> typing.Optional[str]:\n if filename:\n return mimetypes.guess_type(filename)[0] or \"application/octet-stream\"\n return None\n\n\ndef peek_filelike_length(stream: typing.Any) -> typing.Optional[int]:\n \"\"\"\n Given a file-like stream object, return its length in number of bytes\n without reading it into memory.\n \"\"\"\n try:\n # Is it an actual file?\n fd = stream.fileno()\n # Yup, seems to be an actual file.\n length = os.fstat(fd).st_size\n except (AttributeError, OSError):\n # No... Maybe it's something that supports random access, like `io.BytesIO`?\n try:\n # Assuming so, go to end of stream to figure out its length,\n # then put it back in place.\n offset = stream.tell()\n length = stream.seek(0, os.SEEK_END)\n stream.seek(offset)\n except (AttributeError, OSError):\n # Not even that? Sorry, we're doomed...\n return None\n\n return length\n\n\nclass Timer:\n async def _get_time(self) -> float:\n library = sniffio.current_async_library()\n if library == \"trio\":\n import trio\n\n return trio.current_time()\n elif library == \"curio\": # pragma: no cover\n import curio\n\n return typing.cast(float, await curio.clock())\n\n import asyncio\n\n return asyncio.get_event_loop().time()\n\n def sync_start(self) -> None:\n self.started = time.perf_counter()\n\n async def async_start(self) -> None:\n self.started = await self._get_time()\n\n def sync_elapsed(self) -> float:\n now = time.perf_counter()\n return now - self.started\n\n async def async_elapsed(self) -> float:\n now = await self._get_time()\n return now - self.started\n\n\nclass URLPattern:\n \"\"\"\n A utility class currently used for making lookups against proxy keys...\n\n # Wildcard matching...\n >>> pattern = URLPattern(\"all\")\n >>> pattern.matches(httpx.URL(\"http://example.com\"))\n True\n\n # Witch scheme matching...\n >>> pattern = URLPattern(\"https\")\n >>> pattern.matches(httpx.URL(\"https://example.com\"))\n True\n >>> pattern.matches(httpx.URL(\"http://example.com\"))\n False\n\n # With domain matching...\n >>> pattern = URLPattern(\"https://example.com\")\n >>> pattern.matches(httpx.URL(\"https://example.com\"))\n True\n >>> pattern.matches(httpx.URL(\"http://example.com\"))\n False\n >>> pattern.matches(httpx.URL(\"https://other.com\"))\n False\n\n # Wildcard scheme, with domain matching...\n >>> pattern = URLPattern(\"all://example.com\")\n >>> pattern.matches(httpx.URL(\"https://example.com\"))\n True\n >>> pattern.matches(httpx.URL(\"http://example.com\"))\n True\n >>> pattern.matches(httpx.URL(\"https://other.com\"))\n False\n\n # With port matching...\n >>> pattern = URLPattern(\"https://example.com:1234\")\n >>> pattern.matches(httpx.URL(\"https://example.com:1234\"))\n True\n >>> pattern.matches(httpx.URL(\"https://example.com\"))\n False\n \"\"\"\n\n def __init__(self, pattern: str) -> None:\n from ._urls import URL\n\n if pattern and \":\" not in pattern:\n raise ValueError(\n f\"Proxy keys should use proper URL forms rather \"\n f\"than plain scheme strings. \"\n f'Instead of \"{pattern}\", use \"{pattern}://\"'\n )\n\n url = URL(pattern)\n self.pattern = pattern\n self.scheme = \"\" if url.scheme == \"all\" else url.scheme\n self.host = \"\" if url.host == \"*\" else url.host\n self.port = url.port\n if not url.host or url.host == \"*\":\n self.host_regex: typing.Optional[typing.Pattern[str]] = None\n elif url.host.startswith(\"*.\"):\n # *.example.com should match \"www.example.com\", but not \"example.com\"\n domain = re.escape(url.host[2:])\n self.host_regex = re.compile(f\"^.+\\\\.{domain}$\")\n elif url.host.startswith(\"*\"):\n # *example.com should match \"www.example.com\" and \"example.com\"\n domain = re.escape(url.host[1:])\n self.host_regex = re.compile(f\"^(.+\\\\.)?{domain}$\")\n else:\n # example.com should match \"example.com\" but not \"www.example.com\"\n domain = re.escape(url.host)\n self.host_regex = re.compile(f\"^{domain}$\")\n\n def matches(self, other: \"URL\") -> bool:\n if self.scheme and self.scheme != other.scheme:\n return False\n if (\n self.host\n and self.host_regex is not None\n and not self.host_regex.match(other.host)\n ):\n return False\n if self.port is not None and self.port != other.port:\n return False\n return True\n\n @property\n def priority(self) -> typing.Tuple[int, int, int]:\n \"\"\"\n The priority allows URLPattern instances to be sortable, so that\n we can match from most specific to least specific.\n \"\"\"\n # URLs with a port should take priority over URLs without a port.\n port_priority = 0 if self.port is not None else 1\n # Longer hostnames should match first.\n host_priority = -len(self.host)\n # Longer schemes should match first.\n scheme_priority = -len(self.scheme)\n return (port_priority, host_priority, scheme_priority)\n\n def __hash__(self) -> int:\n return hash(self.pattern)\n\n def __lt__(self, other: \"URLPattern\") -> bool:\n return self.priority < other.priority\n\n def __eq__(self, other: typing.Any) -> bool:\n return isinstance(other, URLPattern) and self.pattern == other.pattern\n","path":"httpx/_utils.py"}],"string":"[\n {\n \"content\": \"import codecs\\nimport email.message\\nimport logging\\nimport mimetypes\\nimport netrc\\nimport os\\nimport re\\nimport sys\\nimport time\\nimport typing\\nfrom pathlib import Path\\nfrom urllib.request import getproxies\\n\\nimport sniffio\\n\\nfrom ._types import PrimitiveData\\n\\nif typing.TYPE_CHECKING: # pragma: no cover\\n from ._urls import URL\\n\\n\\n_HTML5_FORM_ENCODING_REPLACEMENTS = {'\\\"': \\\"%22\\\", \\\"\\\\\\\\\\\": \\\"\\\\\\\\\\\\\\\\\\\"}\\n_HTML5_FORM_ENCODING_REPLACEMENTS.update(\\n {chr(c): \\\"%{:02X}\\\".format(c) for c in range(0x1F + 1) if c != 0x1B}\\n)\\n_HTML5_FORM_ENCODING_RE = re.compile(\\n r\\\"|\\\".join([re.escape(c) for c in _HTML5_FORM_ENCODING_REPLACEMENTS.keys()])\\n)\\n\\n\\ndef normalize_header_key(\\n value: typing.Union[str, bytes],\\n lower: bool,\\n encoding: typing.Optional[str] = None,\\n) -> bytes:\\n \\\"\\\"\\\"\\n Coerce str/bytes into a strictly byte-wise HTTP header key.\\n \\\"\\\"\\\"\\n if isinstance(value, bytes):\\n bytes_value = value\\n else:\\n bytes_value = value.encode(encoding or \\\"ascii\\\")\\n\\n return bytes_value.lower() if lower else bytes_value\\n\\n\\ndef normalize_header_value(\\n value: typing.Union[str, bytes], encoding: typing.Optional[str] = None\\n) -> bytes:\\n \\\"\\\"\\\"\\n Coerce str/bytes into a strictly byte-wise HTTP header value.\\n \\\"\\\"\\\"\\n if isinstance(value, bytes):\\n return value\\n return value.encode(encoding or \\\"ascii\\\")\\n\\n\\ndef primitive_value_to_str(value: \\\"PrimitiveData\\\") -> str:\\n \\\"\\\"\\\"\\n Coerce a primitive data type into a string value.\\n\\n Note that we prefer JSON-style 'true'/'false' for boolean values here.\\n \\\"\\\"\\\"\\n if value is True:\\n return \\\"true\\\"\\n elif value is False:\\n return \\\"false\\\"\\n elif value is None:\\n return \\\"\\\"\\n elif isinstance(value, (str, float, int)):\\n return str(value)\\n raise TypeError(\\n f\\\"Expected str, int, float, bool, or None. Got {type(value).__name__!r}.\\\"\\n )\\n\\n\\ndef is_known_encoding(encoding: str) -> bool:\\n \\\"\\\"\\\"\\n Return `True` if `encoding` is a known codec.\\n \\\"\\\"\\\"\\n try:\\n codecs.lookup(encoding)\\n except LookupError:\\n return False\\n return True\\n\\n\\ndef format_form_param(name: str, value: str) -> bytes:\\n \\\"\\\"\\\"\\n Encode a name/value pair within a multipart form.\\n \\\"\\\"\\\"\\n\\n def replacer(match: typing.Match[str]) -> str:\\n return _HTML5_FORM_ENCODING_REPLACEMENTS[match.group(0)]\\n\\n value = _HTML5_FORM_ENCODING_RE.sub(replacer, value)\\n return f'{name}=\\\"{value}\\\"'.encode()\\n\\n\\n# Null bytes; no need to recreate these on each call to guess_json_utf\\n_null = b\\\"\\\\x00\\\"\\n_null2 = _null * 2\\n_null3 = _null * 3\\n\\n\\ndef guess_json_utf(data: bytes) -> typing.Optional[str]:\\n # JSON always starts with two ASCII characters, so detection is as\\n # easy as counting the nulls and from their location and count\\n # determine the encoding. Also detect a BOM, if present.\\n sample = data[:4]\\n if sample in (codecs.BOM_UTF32_LE, codecs.BOM_UTF32_BE):\\n return \\\"utf-32\\\" # BOM included\\n if sample[:3] == codecs.BOM_UTF8:\\n return \\\"utf-8-sig\\\" # BOM included, MS style (discouraged)\\n if sample[:2] in (codecs.BOM_UTF16_LE, codecs.BOM_UTF16_BE):\\n return \\\"utf-16\\\" # BOM included\\n nullcount = sample.count(_null)\\n if nullcount == 0:\\n return \\\"utf-8\\\"\\n if nullcount == 2:\\n if sample[::2] == _null2: # 1st and 3rd are null\\n return \\\"utf-16-be\\\"\\n if sample[1::2] == _null2: # 2nd and 4th are null\\n return \\\"utf-16-le\\\"\\n # Did not detect 2 valid UTF-16 ascii-range characters\\n if nullcount == 3:\\n if sample[:3] == _null3:\\n return \\\"utf-32-be\\\"\\n if sample[1:] == _null3:\\n return \\\"utf-32-le\\\"\\n # Did not detect a valid UTF-32 ascii-range character\\n return None\\n\\n\\nclass NetRCInfo:\\n def __init__(self, files: typing.Optional[typing.List[str]] = None) -> None:\\n if files is None:\\n files = [os.getenv(\\\"NETRC\\\", \\\"\\\"), \\\"~/.netrc\\\", \\\"~/_netrc\\\"]\\n self.netrc_files = files\\n\\n @property\\n def netrc_info(self) -> typing.Optional[netrc.netrc]:\\n if not hasattr(self, \\\"_netrc_info\\\"):\\n self._netrc_info = None\\n for file_path in self.netrc_files:\\n expanded_path = Path(file_path).expanduser()\\n try:\\n if expanded_path.is_file():\\n self._netrc_info = netrc.netrc(str(expanded_path))\\n break\\n except (netrc.NetrcParseError, IOError): # pragma: no cover\\n # Issue while reading the netrc file, ignore...\\n pass\\n return self._netrc_info\\n\\n def get_credentials(self, host: str) -> typing.Optional[typing.Tuple[str, str]]:\\n if self.netrc_info is None:\\n return None\\n\\n auth_info = self.netrc_info.authenticators(host)\\n if auth_info is None or auth_info[2] is None:\\n return None\\n return (auth_info[0], auth_info[2])\\n\\n\\ndef get_ca_bundle_from_env() -> typing.Optional[str]:\\n if \\\"SSL_CERT_FILE\\\" in os.environ:\\n ssl_file = Path(os.environ[\\\"SSL_CERT_FILE\\\"])\\n if ssl_file.is_file():\\n return str(ssl_file)\\n if \\\"SSL_CERT_DIR\\\" in os.environ:\\n ssl_path = Path(os.environ[\\\"SSL_CERT_DIR\\\"])\\n if ssl_path.is_dir():\\n return str(ssl_path)\\n return None\\n\\n\\ndef parse_header_links(value: str) -> typing.List[typing.Dict[str, str]]:\\n \\\"\\\"\\\"\\n Returns a list of parsed link headers, for more info see:\\n https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link\\n The generic syntax of those is:\\n Link: < uri-reference >; param1=value1; param2=\\\"value2\\\"\\n So for instance:\\n Link; '<http:/.../front.jpeg>; type=\\\"image/jpeg\\\",<http://.../back.jpeg>;'\\n would return\\n [\\n {\\\"url\\\": \\\"http:/.../front.jpeg\\\", \\\"type\\\": \\\"image/jpeg\\\"},\\n {\\\"url\\\": \\\"http://.../back.jpeg\\\"},\\n ]\\n :param value: HTTP Link entity-header field\\n :return: list of parsed link headers\\n \\\"\\\"\\\"\\n links: typing.List[typing.Dict[str, str]] = []\\n replace_chars = \\\" '\\\\\\\"\\\"\\n value = value.strip(replace_chars)\\n if not value:\\n return links\\n for val in re.split(\\\", *<\\\", value):\\n try:\\n url, params = val.split(\\\";\\\", 1)\\n except ValueError:\\n url, params = val, \\\"\\\"\\n link = {\\\"url\\\": url.strip(\\\"<> '\\\\\\\"\\\")}\\n for param in params.split(\\\";\\\"):\\n try:\\n key, value = param.split(\\\"=\\\")\\n except ValueError:\\n break\\n link[key.strip(replace_chars)] = value.strip(replace_chars)\\n links.append(link)\\n return links\\n\\n\\ndef parse_content_type_charset(content_type: str) -> typing.Optional[str]:\\n # We used to use `cgi.parse_header()` here, but `cgi` became a dead battery.\\n # See: https://peps.python.org/pep-0594/#cgi\\n msg = email.message.Message()\\n msg[\\\"content-type\\\"] = content_type\\n return msg.get_content_charset(failobj=None)\\n\\n\\nSENSITIVE_HEADERS = {\\\"authorization\\\", \\\"proxy-authorization\\\"}\\n\\n\\ndef obfuscate_sensitive_headers(\\n items: typing.Iterable[typing.Tuple[typing.AnyStr, typing.AnyStr]]\\n) -> typing.Iterator[typing.Tuple[typing.AnyStr, typing.AnyStr]]:\\n for k, v in items:\\n if to_str(k.lower()) in SENSITIVE_HEADERS:\\n v = to_bytes_or_str(\\\"[secure]\\\", match_type_of=v)\\n yield k, v\\n\\n\\n_LOGGER_INITIALIZED = False\\nTRACE_LOG_LEVEL = 5\\n\\n\\nclass Logger(logging.Logger):\\n # Stub for type checkers.\\n def trace(self, message: str, *args: typing.Any, **kwargs: typing.Any) -> None:\\n ... # pragma: no cover\\n\\n\\ndef get_logger(name: str) -> Logger:\\n \\\"\\\"\\\"\\n Get a `logging.Logger` instance, and optionally\\n set up debug logging based on the HTTPX_LOG_LEVEL environment variable.\\n \\\"\\\"\\\"\\n global _LOGGER_INITIALIZED\\n\\n if not _LOGGER_INITIALIZED:\\n _LOGGER_INITIALIZED = True\\n logging.addLevelName(TRACE_LOG_LEVEL, \\\"TRACE\\\")\\n\\n log_level = os.environ.get(\\\"HTTPX_LOG_LEVEL\\\", \\\"\\\").upper()\\n if log_level in (\\\"DEBUG\\\", \\\"TRACE\\\"):\\n logger = logging.getLogger(\\\"httpx\\\")\\n logger.setLevel(logging.DEBUG if log_level == \\\"DEBUG\\\" else TRACE_LOG_LEVEL)\\n handler = logging.StreamHandler(sys.stderr)\\n handler.setFormatter(\\n logging.Formatter(\\n fmt=\\\"%(levelname)s [%(asctime)s] %(name)s - %(message)s\\\",\\n datefmt=\\\"%Y-%m-%d %H:%M:%S\\\",\\n )\\n )\\n logger.addHandler(handler)\\n\\n logger = logging.getLogger(name)\\n\\n def trace(message: str, *args: typing.Any, **kwargs: typing.Any) -> None:\\n logger.log(TRACE_LOG_LEVEL, message, *args, **kwargs)\\n\\n logger.trace = trace # type: ignore\\n\\n return typing.cast(Logger, logger)\\n\\n\\ndef port_or_default(url: \\\"URL\\\") -> typing.Optional[int]:\\n if url.port is not None:\\n return url.port\\n return {\\\"http\\\": 80, \\\"https\\\": 443}.get(url.scheme)\\n\\n\\ndef same_origin(url: \\\"URL\\\", other: \\\"URL\\\") -> bool:\\n \\\"\\\"\\\"\\n Return 'True' if the given URLs share the same origin.\\n \\\"\\\"\\\"\\n return (\\n url.scheme == other.scheme\\n and url.host == other.host\\n and port_or_default(url) == port_or_default(other)\\n )\\n\\n\\ndef is_https_redirect(url: \\\"URL\\\", location: \\\"URL\\\") -> bool:\\n \\\"\\\"\\\"\\n Return 'True' if 'location' is a HTTPS upgrade of 'url'\\n \\\"\\\"\\\"\\n if url.host != location.host:\\n return False\\n\\n return (\\n url.scheme == \\\"http\\\"\\n and port_or_default(url) == 80\\n and location.scheme == \\\"https\\\"\\n and port_or_default(location) == 443\\n )\\n\\n\\ndef get_environment_proxies() -> typing.Dict[str, typing.Optional[str]]:\\n \\\"\\\"\\\"Gets proxy information from the environment\\\"\\\"\\\"\\n\\n # urllib.request.getproxies() falls back on System\\n # Registry and Config for proxies on Windows and macOS.\\n # We don't want to propagate non-HTTP proxies into\\n # our configuration such as 'TRAVIS_APT_PROXY'.\\n proxy_info = getproxies()\\n mounts: typing.Dict[str, typing.Optional[str]] = {}\\n\\n for scheme in (\\\"http\\\", \\\"https\\\", \\\"all\\\"):\\n if proxy_info.get(scheme):\\n hostname = proxy_info[scheme]\\n mounts[f\\\"{scheme}://\\\"] = (\\n hostname if \\\"://\\\" in hostname else f\\\"http://{hostname}\\\"\\n )\\n\\n no_proxy_hosts = [host.strip() for host in proxy_info.get(\\\"no\\\", \\\"\\\").split(\\\",\\\")]\\n for hostname in no_proxy_hosts:\\n # See https://curl.haxx.se/libcurl/c/CURLOPT_NOPROXY.html for details\\n # on how names in `NO_PROXY` are handled.\\n if hostname == \\\"*\\\":\\n # If NO_PROXY=* is used or if \\\"*\\\" occurs as any one of the comma\\n # separated hostnames, then we should just bypass any information\\n # from HTTP_PROXY, HTTPS_PROXY, ALL_PROXY, and always ignore\\n # proxies.\\n return {}\\n elif hostname:\\n # NO_PROXY=.google.com is marked as \\\"all://*.google.com,\\n # which disables \\\"www.google.com\\\" but not \\\"google.com\\\"\\n # NO_PROXY=google.com is marked as \\\"all://*google.com,\\n # which disables \\\"www.google.com\\\" and \\\"google.com\\\".\\n # (But not \\\"wwwgoogle.com\\\")\\n mounts[f\\\"all://*{hostname}\\\"] = None\\n\\n return mounts\\n\\n\\ndef to_bytes(value: typing.Union[str, bytes], encoding: str = \\\"utf-8\\\") -> bytes:\\n return value.encode(encoding) if isinstance(value, str) else value\\n\\n\\ndef to_str(value: typing.Union[str, bytes], encoding: str = \\\"utf-8\\\") -> str:\\n return value if isinstance(value, str) else value.decode(encoding)\\n\\n\\ndef to_bytes_or_str(value: str, match_type_of: typing.AnyStr) -> typing.AnyStr:\\n return value if isinstance(match_type_of, str) else value.encode()\\n\\n\\ndef unquote(value: str) -> str:\\n return value[1:-1] if value[0] == value[-1] == '\\\"' else value\\n\\n\\ndef guess_content_type(filename: typing.Optional[str]) -> typing.Optional[str]:\\n if filename:\\n return mimetypes.guess_type(filename)[0] or \\\"application/octet-stream\\\"\\n return None\\n\\n\\ndef peek_filelike_length(stream: typing.Any) -> typing.Optional[int]:\\n \\\"\\\"\\\"\\n Given a file-like stream object, return its length in number of bytes\\n without reading it into memory.\\n \\\"\\\"\\\"\\n try:\\n # Is it an actual file?\\n fd = stream.fileno()\\n # Yup, seems to be an actual file.\\n length = os.fstat(fd).st_size\\n except (AttributeError, OSError):\\n # No... Maybe it's something that supports random access, like `io.BytesIO`?\\n try:\\n # Assuming so, go to end of stream to figure out its length,\\n # then put it back in place.\\n offset = stream.tell()\\n length = stream.seek(0, os.SEEK_END)\\n stream.seek(offset)\\n except (AttributeError, OSError):\\n # Not even that? Sorry, we're doomed...\\n return None\\n\\n return length\\n\\n\\nclass Timer:\\n async def _get_time(self) -> float:\\n library = sniffio.current_async_library()\\n if library == \\\"trio\\\":\\n import trio\\n\\n return trio.current_time()\\n elif library == \\\"curio\\\": # pragma: no cover\\n import curio\\n\\n return typing.cast(float, await curio.clock())\\n\\n import asyncio\\n\\n return asyncio.get_event_loop().time()\\n\\n def sync_start(self) -> None:\\n self.started = time.perf_counter()\\n\\n async def async_start(self) -> None:\\n self.started = await self._get_time()\\n\\n def sync_elapsed(self) -> float:\\n now = time.perf_counter()\\n return now - self.started\\n\\n async def async_elapsed(self) -> float:\\n now = await self._get_time()\\n return now - self.started\\n\\n\\nclass URLPattern:\\n \\\"\\\"\\\"\\n A utility class currently used for making lookups against proxy keys...\\n\\n # Wildcard matching...\\n >>> pattern = URLPattern(\\\"all\\\")\\n >>> pattern.matches(httpx.URL(\\\"http://example.com\\\"))\\n True\\n\\n # Witch scheme matching...\\n >>> pattern = URLPattern(\\\"https\\\")\\n >>> pattern.matches(httpx.URL(\\\"https://example.com\\\"))\\n True\\n >>> pattern.matches(httpx.URL(\\\"http://example.com\\\"))\\n False\\n\\n # With domain matching...\\n >>> pattern = URLPattern(\\\"https://example.com\\\")\\n >>> pattern.matches(httpx.URL(\\\"https://example.com\\\"))\\n True\\n >>> pattern.matches(httpx.URL(\\\"http://example.com\\\"))\\n False\\n >>> pattern.matches(httpx.URL(\\\"https://other.com\\\"))\\n False\\n\\n # Wildcard scheme, with domain matching...\\n >>> pattern = URLPattern(\\\"all://example.com\\\")\\n >>> pattern.matches(httpx.URL(\\\"https://example.com\\\"))\\n True\\n >>> pattern.matches(httpx.URL(\\\"http://example.com\\\"))\\n True\\n >>> pattern.matches(httpx.URL(\\\"https://other.com\\\"))\\n False\\n\\n # With port matching...\\n >>> pattern = URLPattern(\\\"https://example.com:1234\\\")\\n >>> pattern.matches(httpx.URL(\\\"https://example.com:1234\\\"))\\n True\\n >>> pattern.matches(httpx.URL(\\\"https://example.com\\\"))\\n False\\n \\\"\\\"\\\"\\n\\n def __init__(self, pattern: str) -> None:\\n from ._urls import URL\\n\\n if pattern and \\\":\\\" not in pattern:\\n raise ValueError(\\n f\\\"Proxy keys should use proper URL forms rather \\\"\\n f\\\"than plain scheme strings. \\\"\\n f'Instead of \\\"{pattern}\\\", use \\\"{pattern}://\\\"'\\n )\\n\\n url = URL(pattern)\\n self.pattern = pattern\\n self.scheme = \\\"\\\" if url.scheme == \\\"all\\\" else url.scheme\\n self.host = \\\"\\\" if url.host == \\\"*\\\" else url.host\\n self.port = url.port\\n if not url.host or url.host == \\\"*\\\":\\n self.host_regex: typing.Optional[typing.Pattern[str]] = None\\n elif url.host.startswith(\\\"*.\\\"):\\n # *.example.com should match \\\"www.example.com\\\", but not \\\"example.com\\\"\\n domain = re.escape(url.host[2:])\\n self.host_regex = re.compile(f\\\"^.+\\\\\\\\.{domain}$\\\")\\n elif url.host.startswith(\\\"*\\\"):\\n # *example.com should match \\\"www.example.com\\\" and \\\"example.com\\\"\\n domain = re.escape(url.host[1:])\\n self.host_regex = re.compile(f\\\"^(.+\\\\\\\\.)?{domain}$\\\")\\n else:\\n # example.com should match \\\"example.com\\\" but not \\\"www.example.com\\\"\\n domain = re.escape(url.host)\\n self.host_regex = re.compile(f\\\"^{domain}$\\\")\\n\\n def matches(self, other: \\\"URL\\\") -> bool:\\n if self.scheme and self.scheme != other.scheme:\\n return False\\n if (\\n self.host\\n and self.host_regex is not None\\n and not self.host_regex.match(other.host)\\n ):\\n return False\\n if self.port is not None and self.port != other.port:\\n return False\\n return True\\n\\n @property\\n def priority(self) -> typing.Tuple[int, int, int]:\\n \\\"\\\"\\\"\\n The priority allows URLPattern instances to be sortable, so that\\n we can match from most specific to least specific.\\n \\\"\\\"\\\"\\n # URLs with a port should take priority over URLs without a port.\\n port_priority = 0 if self.port is not None else 1\\n # Longer hostnames should match first.\\n host_priority = -len(self.host)\\n # Longer schemes should match first.\\n scheme_priority = -len(self.scheme)\\n return (port_priority, host_priority, scheme_priority)\\n\\n def __hash__(self) -> int:\\n return hash(self.pattern)\\n\\n def __lt__(self, other: \\\"URLPattern\\\") -> bool:\\n return self.priority < other.priority\\n\\n def __eq__(self, other: typing.Any) -> bool:\\n return isinstance(other, URLPattern) and self.pattern == other.pattern\\n\",\n \"path\": \"httpx/_utils.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/httpx/_utils.py b/httpx/_utils.py\nindex 1f64deedcd..1e1570ee7f 100644\n--- a/httpx/_utils.py\n+++ b/httpx/_utils.py\n@@ -67,7 +67,11 @@ def primitive_value_to_str(value: \"PrimitiveData\") -> str:\n return \"false\"\n elif value is None:\n return \"\"\n- return str(value)\n+ elif isinstance(value, (str, float, int)):\n+ return str(value)\n+ raise TypeError(\n+ f\"Expected str, int, float, bool, or None. Got {type(value).__name__!r}.\"\n+ )\n \n \n def is_known_encoding(encoding: str) -> bool:\ndiff --git a/tests/models/test_queryparams.py b/tests/models/test_queryparams.py\nindex 29b2ca634d..cbb487bbc6 100644\n--- a/tests/models/test_queryparams.py\n+++ b/tests/models/test_queryparams.py\n@@ -87,6 +87,13 @@ def test_empty_query_params():\n assert str(q) == \"a=\"\n \n \n+def test_invalid_query_params():\n+ with pytest.raises(\n+ TypeError, match=r\"Expected str, int, float, bool, or None. Got 'bytes'.\"\n+ ):\n+ httpx.QueryParams({\"a\": b\"bytes\"})\n+\n+\n def test_queryparam_update_is_hard_deprecated():\n q = httpx.QueryParams(\"a=123\")\n with pytest.raises(RuntimeError):\n"}}},{"rowIdx":2684,"cells":{"in_source_id":{"kind":"string","value":"scikit-image__scikit-image-6839"},"issue":{"kind":"string","value":"`segmentation.watershed` returns wrong data type\n### Description:\n\nThe documentation of `segmentation.watershed` says that:\r\n\r\n> ### Returns\r\n> **out**: ndarray\r\n> A labeled matrix of the same type and shape as markers\r\n\r\n[[0.18.x]](https://scikit-image.org/docs/0.18.x/api/skimage.segmentation.html#skimage.segmentation.watershed) [[0.19.x]](https://scikit-image.org/docs/0.19.x/api/skimage.segmentation.html#skimage.segmentation.watershed)\r\n\r\nI have tested this with 0.18.1:\r\n\r\n```python\r\nimport skimage.segmentation\r\nimport numpy as np\r\nprint(skimage.segmentation.watershed(np.zeros((100, 100)), np.zeros((100, 100), np.uint16)).dtype)\r\n```\r\n\r\nGives `int32` but `uint16` is expected.\n\n### Way to reproduce:\n\n```Python\nimport skimage.segmentation\r\nimport numpy as np\r\nprint(skimage.segmentation.watershed(np.zeros((100, 100)), np.zeros((100, 100), np.uint16)).dtype)\n```\n\n\n### Traceback or output:\n\n```Shell\nint32\n```\n\n\n### Version information:\n\n```Shell\n3.8.5 (default, Sep 4 2020, 07:30:14) \r\n[GCC 7.3.0]\r\nLinux-5.8.0-36-generic-x86_64-with-glibc2.10\r\nscikit-image version: 0.18.1\r\nnumpy version: 1.20.3\n```\n\n"},"before_files":{"kind":"list like","value":[{"content":"\"\"\"watershed.py - watershed algorithm\n\nThis module implements a watershed algorithm that apportions pixels into\nmarked basins. The algorithm uses a priority queue to hold the pixels\nwith the metric for the priority queue being pixel value, then the time\nof entry into the queue - this settles ties in favor of the closest marker.\n\nSome ideas taken from\nSoille, \"Automated Basin Delineation from Digital Elevation Models Using\nMathematical Morphology\", Signal Processing 20 (1990) 171-182.\n\nThe most important insight in the paper is that entry time onto the queue\nsolves two problems: a pixel should be assigned to the neighbor with the\nlargest gradient or, if there is no gradient, pixels on a plateau should\nbe split between markers on opposite sides.\n\"\"\"\n\nimport numpy as np\nfrom scipy import ndimage as ndi\n\nfrom . import _watershed_cy\nfrom ..morphology.extrema import local_minima\nfrom ..morphology._util import (_validate_connectivity,\n _offsets_to_raveled_neighbors)\nfrom ..util import crop, regular_seeds\n\n\ndef _validate_inputs(image, markers, mask, connectivity):\n \"\"\"Ensure that all inputs to watershed have matching shapes and types.\n\n Parameters\n ----------\n image : array\n The input image.\n markers : int or array of int\n The marker image.\n mask : array, or None\n A boolean mask, True where we want to compute the watershed.\n connectivity : int in {1, ..., image.ndim}\n The connectivity of the neighborhood of a pixel.\n\n Returns\n -------\n image, markers, mask : arrays\n The validated and formatted arrays. Image will have dtype float64,\n markers int32, and mask int8. If ``None`` was given for the mask,\n it is a volume of all 1s.\n\n Raises\n ------\n ValueError\n If the shapes of the given arrays don't match.\n \"\"\"\n n_pixels = image.size\n if mask is None:\n # Use a complete `True` mask if none is provided\n mask = np.ones(image.shape, bool)\n else:\n mask = np.asanyarray(mask, dtype=bool)\n n_pixels = np.sum(mask)\n if mask.shape != image.shape:\n message = (f'`mask` (shape {mask.shape}) must have same shape '\n f'as `image` (shape {image.shape})')\n raise ValueError(message)\n if markers is None:\n markers_bool = local_minima(image, connectivity=connectivity) * mask\n footprint = ndi.generate_binary_structure(markers_bool.ndim, connectivity)\n markers = ndi.label(markers_bool, structure=footprint)[0]\n elif not isinstance(markers, (np.ndarray, list, tuple)):\n # not array-like, assume int\n # given int, assume that number of markers *within mask*.\n markers = regular_seeds(image.shape,\n int(markers / (n_pixels / image.size)))\n markers *= mask\n else:\n markers = np.asanyarray(markers) * mask\n if markers.shape != image.shape:\n message = (f'`markers` (shape {markers.shape}) must have same '\n f'shape as `image` (shape {image.shape})')\n raise ValueError(message)\n return (image.astype(np.float64),\n markers.astype(np.int32),\n mask.astype(np.int8))\n\n\ndef watershed(image, markers=None, connectivity=1, offset=None, mask=None,\n compactness=0, watershed_line=False):\n \"\"\"Find watershed basins in `image` flooded from given `markers`.\n\n Parameters\n ----------\n image : ndarray (2-D, 3-D, ...)\n Data array where the lowest value points are labeled first.\n markers : int, or ndarray of int, same shape as `image`, optional\n The desired number of markers, or an array marking the basins with the\n values to be assigned in the label matrix. Zero means not a marker. If\n ``None`` (no markers given), the local minima of the image are used as\n markers.\n connectivity : ndarray, optional\n An array with the same number of dimensions as `image` whose\n non-zero elements indicate neighbors for connection.\n Following the scipy convention, default is a one-connected array of\n the dimension of the image.\n offset : array_like of shape image.ndim, optional\n offset of the connectivity (one offset per dimension)\n mask : ndarray of bools or 0s and 1s, optional\n Array of same shape as `image`. Only points at which mask == True\n will be labeled.\n compactness : float, optional\n Use compact watershed [3]_ with given compactness parameter.\n Higher values result in more regularly-shaped watershed basins.\n watershed_line : bool, optional\n If watershed_line is True, a one-pixel wide line separates the regions\n obtained by the watershed algorithm. The line has the label 0.\n Note that the method used for adding this line expects that\n marker regions are not adjacent; the watershed line may not catch\n borders between adjacent marker regions.\n\n Returns\n -------\n out : ndarray\n A labeled matrix of the same type and shape as markers\n\n See Also\n --------\n skimage.segmentation.random_walker : random walker segmentation\n A segmentation algorithm based on anisotropic diffusion, usually\n slower than the watershed but with good results on noisy data and\n boundaries with holes.\n\n Notes\n -----\n This function implements a watershed algorithm [1]_ [2]_ that apportions\n pixels into marked basins. The algorithm uses a priority queue to hold\n the pixels with the metric for the priority queue being pixel value, then\n the time of entry into the queue - this settles ties in favor of the\n closest marker.\n\n Some ideas taken from\n Soille, \"Automated Basin Delineation from Digital Elevation Models Using\n Mathematical Morphology\", Signal Processing 20 (1990) 171-182\n\n The most important insight in the paper is that entry time onto the queue\n solves two problems: a pixel should be assigned to the neighbor with the\n largest gradient or, if there is no gradient, pixels on a plateau should\n be split between markers on opposite sides.\n\n This implementation converts all arguments to specific, lowest common\n denominator types, then passes these to a C algorithm.\n\n Markers can be determined manually, or automatically using for example\n the local minima of the gradient of the image, or the local maxima of the\n distance function to the background for separating overlapping objects\n (see example).\n\n References\n ----------\n .. [1] https://en.wikipedia.org/wiki/Watershed_%28image_processing%29\n\n .. [2] http://cmm.ensmp.fr/~beucher/wtshed.html\n\n .. [3] Peer Neubert & Peter Protzel (2014). Compact Watershed and\n Preemptive SLIC: On Improving Trade-offs of Superpixel Segmentation\n Algorithms. ICPR 2014, pp 996-1001. :DOI:`10.1109/ICPR.2014.181`\n https://www.tu-chemnitz.de/etit/proaut/publications/cws_pSLIC_ICPR.pdf\n\n Examples\n --------\n The watershed algorithm is useful to separate overlapping objects.\n\n We first generate an initial image with two overlapping circles:\n\n >>> x, y = np.indices((80, 80))\n >>> x1, y1, x2, y2 = 28, 28, 44, 52\n >>> r1, r2 = 16, 20\n >>> mask_circle1 = (x - x1)**2 + (y - y1)**2 < r1**2\n >>> mask_circle2 = (x - x2)**2 + (y - y2)**2 < r2**2\n >>> image = np.logical_or(mask_circle1, mask_circle2)\n\n Next, we want to separate the two circles. We generate markers at the\n maxima of the distance to the background:\n\n >>> from scipy import ndimage as ndi\n >>> distance = ndi.distance_transform_edt(image)\n >>> from skimage.feature import peak_local_max\n >>> max_coords = peak_local_max(distance, labels=image,\n ... footprint=np.ones((3, 3)))\n >>> local_maxima = np.zeros_like(image, dtype=bool)\n >>> local_maxima[tuple(max_coords.T)] = True\n >>> markers = ndi.label(local_maxima)[0]\n\n Finally, we run the watershed on the image and markers:\n\n >>> labels = watershed(-distance, markers, mask=image)\n\n The algorithm works also for 3-D images, and can be used for example to\n separate overlapping spheres.\n \"\"\"\n image, markers, mask = _validate_inputs(image, markers, mask, connectivity)\n connectivity, offset = _validate_connectivity(image.ndim, connectivity,\n offset)\n\n # pad the image, markers, and mask so that we can use the mask to\n # keep from running off the edges\n pad_width = [(p, p) for p in offset]\n image = np.pad(image, pad_width, mode='constant')\n mask = np.pad(mask, pad_width, mode='constant').ravel()\n output = np.pad(markers, pad_width, mode='constant')\n\n flat_neighborhood = _offsets_to_raveled_neighbors(\n image.shape, connectivity, center=offset)\n marker_locations = np.flatnonzero(output)\n image_strides = np.array(image.strides, dtype=np.intp) // image.itemsize\n\n _watershed_cy.watershed_raveled(image.ravel(),\n marker_locations, flat_neighborhood,\n mask, image_strides, compactness,\n output.ravel(),\n watershed_line)\n\n output = crop(output, pad_width, copy=True)\n\n return output\n","path":"skimage/segmentation/_watershed.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"watershed.py - watershed algorithm\\n\\nThis module implements a watershed algorithm that apportions pixels into\\nmarked basins. The algorithm uses a priority queue to hold the pixels\\nwith the metric for the priority queue being pixel value, then the time\\nof entry into the queue - this settles ties in favor of the closest marker.\\n\\nSome ideas taken from\\nSoille, \\\"Automated Basin Delineation from Digital Elevation Models Using\\nMathematical Morphology\\\", Signal Processing 20 (1990) 171-182.\\n\\nThe most important insight in the paper is that entry time onto the queue\\nsolves two problems: a pixel should be assigned to the neighbor with the\\nlargest gradient or, if there is no gradient, pixels on a plateau should\\nbe split between markers on opposite sides.\\n\\\"\\\"\\\"\\n\\nimport numpy as np\\nfrom scipy import ndimage as ndi\\n\\nfrom . import _watershed_cy\\nfrom ..morphology.extrema import local_minima\\nfrom ..morphology._util import (_validate_connectivity,\\n _offsets_to_raveled_neighbors)\\nfrom ..util import crop, regular_seeds\\n\\n\\ndef _validate_inputs(image, markers, mask, connectivity):\\n \\\"\\\"\\\"Ensure that all inputs to watershed have matching shapes and types.\\n\\n Parameters\\n ----------\\n image : array\\n The input image.\\n markers : int or array of int\\n The marker image.\\n mask : array, or None\\n A boolean mask, True where we want to compute the watershed.\\n connectivity : int in {1, ..., image.ndim}\\n The connectivity of the neighborhood of a pixel.\\n\\n Returns\\n -------\\n image, markers, mask : arrays\\n The validated and formatted arrays. Image will have dtype float64,\\n markers int32, and mask int8. If ``None`` was given for the mask,\\n it is a volume of all 1s.\\n\\n Raises\\n ------\\n ValueError\\n If the shapes of the given arrays don't match.\\n \\\"\\\"\\\"\\n n_pixels = image.size\\n if mask is None:\\n # Use a complete `True` mask if none is provided\\n mask = np.ones(image.shape, bool)\\n else:\\n mask = np.asanyarray(mask, dtype=bool)\\n n_pixels = np.sum(mask)\\n if mask.shape != image.shape:\\n message = (f'`mask` (shape {mask.shape}) must have same shape '\\n f'as `image` (shape {image.shape})')\\n raise ValueError(message)\\n if markers is None:\\n markers_bool = local_minima(image, connectivity=connectivity) * mask\\n footprint = ndi.generate_binary_structure(markers_bool.ndim, connectivity)\\n markers = ndi.label(markers_bool, structure=footprint)[0]\\n elif not isinstance(markers, (np.ndarray, list, tuple)):\\n # not array-like, assume int\\n # given int, assume that number of markers *within mask*.\\n markers = regular_seeds(image.shape,\\n int(markers / (n_pixels / image.size)))\\n markers *= mask\\n else:\\n markers = np.asanyarray(markers) * mask\\n if markers.shape != image.shape:\\n message = (f'`markers` (shape {markers.shape}) must have same '\\n f'shape as `image` (shape {image.shape})')\\n raise ValueError(message)\\n return (image.astype(np.float64),\\n markers.astype(np.int32),\\n mask.astype(np.int8))\\n\\n\\ndef watershed(image, markers=None, connectivity=1, offset=None, mask=None,\\n compactness=0, watershed_line=False):\\n \\\"\\\"\\\"Find watershed basins in `image` flooded from given `markers`.\\n\\n Parameters\\n ----------\\n image : ndarray (2-D, 3-D, ...)\\n Data array where the lowest value points are labeled first.\\n markers : int, or ndarray of int, same shape as `image`, optional\\n The desired number of markers, or an array marking the basins with the\\n values to be assigned in the label matrix. Zero means not a marker. If\\n ``None`` (no markers given), the local minima of the image are used as\\n markers.\\n connectivity : ndarray, optional\\n An array with the same number of dimensions as `image` whose\\n non-zero elements indicate neighbors for connection.\\n Following the scipy convention, default is a one-connected array of\\n the dimension of the image.\\n offset : array_like of shape image.ndim, optional\\n offset of the connectivity (one offset per dimension)\\n mask : ndarray of bools or 0s and 1s, optional\\n Array of same shape as `image`. Only points at which mask == True\\n will be labeled.\\n compactness : float, optional\\n Use compact watershed [3]_ with given compactness parameter.\\n Higher values result in more regularly-shaped watershed basins.\\n watershed_line : bool, optional\\n If watershed_line is True, a one-pixel wide line separates the regions\\n obtained by the watershed algorithm. The line has the label 0.\\n Note that the method used for adding this line expects that\\n marker regions are not adjacent; the watershed line may not catch\\n borders between adjacent marker regions.\\n\\n Returns\\n -------\\n out : ndarray\\n A labeled matrix of the same type and shape as markers\\n\\n See Also\\n --------\\n skimage.segmentation.random_walker : random walker segmentation\\n A segmentation algorithm based on anisotropic diffusion, usually\\n slower than the watershed but with good results on noisy data and\\n boundaries with holes.\\n\\n Notes\\n -----\\n This function implements a watershed algorithm [1]_ [2]_ that apportions\\n pixels into marked basins. The algorithm uses a priority queue to hold\\n the pixels with the metric for the priority queue being pixel value, then\\n the time of entry into the queue - this settles ties in favor of the\\n closest marker.\\n\\n Some ideas taken from\\n Soille, \\\"Automated Basin Delineation from Digital Elevation Models Using\\n Mathematical Morphology\\\", Signal Processing 20 (1990) 171-182\\n\\n The most important insight in the paper is that entry time onto the queue\\n solves two problems: a pixel should be assigned to the neighbor with the\\n largest gradient or, if there is no gradient, pixels on a plateau should\\n be split between markers on opposite sides.\\n\\n This implementation converts all arguments to specific, lowest common\\n denominator types, then passes these to a C algorithm.\\n\\n Markers can be determined manually, or automatically using for example\\n the local minima of the gradient of the image, or the local maxima of the\\n distance function to the background for separating overlapping objects\\n (see example).\\n\\n References\\n ----------\\n .. [1] https://en.wikipedia.org/wiki/Watershed_%28image_processing%29\\n\\n .. [2] http://cmm.ensmp.fr/~beucher/wtshed.html\\n\\n .. [3] Peer Neubert & Peter Protzel (2014). Compact Watershed and\\n Preemptive SLIC: On Improving Trade-offs of Superpixel Segmentation\\n Algorithms. ICPR 2014, pp 996-1001. :DOI:`10.1109/ICPR.2014.181`\\n https://www.tu-chemnitz.de/etit/proaut/publications/cws_pSLIC_ICPR.pdf\\n\\n Examples\\n --------\\n The watershed algorithm is useful to separate overlapping objects.\\n\\n We first generate an initial image with two overlapping circles:\\n\\n >>> x, y = np.indices((80, 80))\\n >>> x1, y1, x2, y2 = 28, 28, 44, 52\\n >>> r1, r2 = 16, 20\\n >>> mask_circle1 = (x - x1)**2 + (y - y1)**2 < r1**2\\n >>> mask_circle2 = (x - x2)**2 + (y - y2)**2 < r2**2\\n >>> image = np.logical_or(mask_circle1, mask_circle2)\\n\\n Next, we want to separate the two circles. We generate markers at the\\n maxima of the distance to the background:\\n\\n >>> from scipy import ndimage as ndi\\n >>> distance = ndi.distance_transform_edt(image)\\n >>> from skimage.feature import peak_local_max\\n >>> max_coords = peak_local_max(distance, labels=image,\\n ... footprint=np.ones((3, 3)))\\n >>> local_maxima = np.zeros_like(image, dtype=bool)\\n >>> local_maxima[tuple(max_coords.T)] = True\\n >>> markers = ndi.label(local_maxima)[0]\\n\\n Finally, we run the watershed on the image and markers:\\n\\n >>> labels = watershed(-distance, markers, mask=image)\\n\\n The algorithm works also for 3-D images, and can be used for example to\\n separate overlapping spheres.\\n \\\"\\\"\\\"\\n image, markers, mask = _validate_inputs(image, markers, mask, connectivity)\\n connectivity, offset = _validate_connectivity(image.ndim, connectivity,\\n offset)\\n\\n # pad the image, markers, and mask so that we can use the mask to\\n # keep from running off the edges\\n pad_width = [(p, p) for p in offset]\\n image = np.pad(image, pad_width, mode='constant')\\n mask = np.pad(mask, pad_width, mode='constant').ravel()\\n output = np.pad(markers, pad_width, mode='constant')\\n\\n flat_neighborhood = _offsets_to_raveled_neighbors(\\n image.shape, connectivity, center=offset)\\n marker_locations = np.flatnonzero(output)\\n image_strides = np.array(image.strides, dtype=np.intp) // image.itemsize\\n\\n _watershed_cy.watershed_raveled(image.ravel(),\\n marker_locations, flat_neighborhood,\\n mask, image_strides, compactness,\\n output.ravel(),\\n watershed_line)\\n\\n output = crop(output, pad_width, copy=True)\\n\\n return output\\n\",\n \"path\": \"skimage/segmentation/_watershed.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"\"\"\"watershed.py - watershed algorithm\n\nThis module implements a watershed algorithm that apportions pixels into\nmarked basins. The algorithm uses a priority queue to hold the pixels\nwith the metric for the priority queue being pixel value, then the time\nof entry into the queue - this settles ties in favor of the closest marker.\n\nSome ideas taken from\nSoille, \"Automated Basin Delineation from Digital Elevation Models Using\nMathematical Morphology\", Signal Processing 20 (1990) 171-182.\n\nThe most important insight in the paper is that entry time onto the queue\nsolves two problems: a pixel should be assigned to the neighbor with the\nlargest gradient or, if there is no gradient, pixels on a plateau should\nbe split between markers on opposite sides.\n\"\"\"\n\nimport numpy as np\nfrom scipy import ndimage as ndi\n\nfrom . import _watershed_cy\nfrom ..morphology.extrema import local_minima\nfrom ..morphology._util import (_validate_connectivity,\n _offsets_to_raveled_neighbors)\nfrom ..util import crop, regular_seeds\n\n\ndef _validate_inputs(image, markers, mask, connectivity):\n \"\"\"Ensure that all inputs to watershed have matching shapes and types.\n\n Parameters\n ----------\n image : array\n The input image.\n markers : int or array of int\n The marker image.\n mask : array, or None\n A boolean mask, True where we want to compute the watershed.\n connectivity : int in {1, ..., image.ndim}\n The connectivity of the neighborhood of a pixel.\n\n Returns\n -------\n image, markers, mask : arrays\n The validated and formatted arrays. Image will have dtype float64,\n markers int32, and mask int8. If ``None`` was given for the mask,\n it is a volume of all 1s.\n\n Raises\n ------\n ValueError\n If the shapes of the given arrays don't match.\n \"\"\"\n n_pixels = image.size\n if mask is None:\n # Use a complete `True` mask if none is provided\n mask = np.ones(image.shape, bool)\n else:\n mask = np.asanyarray(mask, dtype=bool)\n n_pixels = np.sum(mask)\n if mask.shape != image.shape:\n message = (f'`mask` (shape {mask.shape}) must have same shape '\n f'as `image` (shape {image.shape})')\n raise ValueError(message)\n if markers is None:\n markers_bool = local_minima(image, connectivity=connectivity) * mask\n footprint = ndi.generate_binary_structure(markers_bool.ndim, connectivity)\n markers = ndi.label(markers_bool, structure=footprint)[0]\n elif not isinstance(markers, (np.ndarray, list, tuple)):\n # not array-like, assume int\n # given int, assume that number of markers *within mask*.\n markers = regular_seeds(image.shape,\n int(markers / (n_pixels / image.size)))\n markers *= mask\n else:\n markers = np.asanyarray(markers) * mask\n if markers.shape != image.shape:\n message = (f'`markers` (shape {markers.shape}) must have same '\n f'shape as `image` (shape {image.shape})')\n raise ValueError(message)\n return (image.astype(np.float64),\n markers,\n mask.astype(np.int8))\n\n\ndef watershed(image, markers=None, connectivity=1, offset=None, mask=None,\n compactness=0, watershed_line=False):\n \"\"\"Find watershed basins in `image` flooded from given `markers`.\n\n Parameters\n ----------\n image : ndarray (2-D, 3-D, ...)\n Data array where the lowest value points are labeled first.\n markers : int, or ndarray of int, same shape as `image`, optional\n The desired number of markers, or an array marking the basins with the\n values to be assigned in the label matrix. Zero means not a marker. If\n ``None`` (no markers given), the local minima of the image are used as\n markers.\n connectivity : ndarray, optional\n An array with the same number of dimensions as `image` whose\n non-zero elements indicate neighbors for connection.\n Following the scipy convention, default is a one-connected array of\n the dimension of the image.\n offset : array_like of shape image.ndim, optional\n offset of the connectivity (one offset per dimension)\n mask : ndarray of bools or 0s and 1s, optional\n Array of same shape as `image`. Only points at which mask == True\n will be labeled.\n compactness : float, optional\n Use compact watershed [3]_ with given compactness parameter.\n Higher values result in more regularly-shaped watershed basins.\n watershed_line : bool, optional\n If watershed_line is True, a one-pixel wide line separates the regions\n obtained by the watershed algorithm. The line has the label 0.\n Note that the method used for adding this line expects that\n marker regions are not adjacent; the watershed line may not catch\n borders between adjacent marker regions.\n\n Returns\n -------\n out : ndarray\n A labeled matrix of the same type and shape as markers\n\n See Also\n --------\n skimage.segmentation.random_walker : random walker segmentation\n A segmentation algorithm based on anisotropic diffusion, usually\n slower than the watershed but with good results on noisy data and\n boundaries with holes.\n\n Notes\n -----\n This function implements a watershed algorithm [1]_ [2]_ that apportions\n pixels into marked basins. The algorithm uses a priority queue to hold\n the pixels with the metric for the priority queue being pixel value, then\n the time of entry into the queue - this settles ties in favor of the\n closest marker.\n\n Some ideas taken from\n Soille, \"Automated Basin Delineation from Digital Elevation Models Using\n Mathematical Morphology\", Signal Processing 20 (1990) 171-182\n\n The most important insight in the paper is that entry time onto the queue\n solves two problems: a pixel should be assigned to the neighbor with the\n largest gradient or, if there is no gradient, pixels on a plateau should\n be split between markers on opposite sides.\n\n This implementation converts all arguments to specific, lowest common\n denominator types, then passes these to a C algorithm.\n\n Markers can be determined manually, or automatically using for example\n the local minima of the gradient of the image, or the local maxima of the\n distance function to the background for separating overlapping objects\n (see example).\n\n References\n ----------\n .. [1] https://en.wikipedia.org/wiki/Watershed_%28image_processing%29\n\n .. [2] http://cmm.ensmp.fr/~beucher/wtshed.html\n\n .. [3] Peer Neubert & Peter Protzel (2014). Compact Watershed and\n Preemptive SLIC: On Improving Trade-offs of Superpixel Segmentation\n Algorithms. ICPR 2014, pp 996-1001. :DOI:`10.1109/ICPR.2014.181`\n https://www.tu-chemnitz.de/etit/proaut/publications/cws_pSLIC_ICPR.pdf\n\n Examples\n --------\n The watershed algorithm is useful to separate overlapping objects.\n\n We first generate an initial image with two overlapping circles:\n\n >>> x, y = np.indices((80, 80))\n >>> x1, y1, x2, y2 = 28, 28, 44, 52\n >>> r1, r2 = 16, 20\n >>> mask_circle1 = (x - x1)**2 + (y - y1)**2 < r1**2\n >>> mask_circle2 = (x - x2)**2 + (y - y2)**2 < r2**2\n >>> image = np.logical_or(mask_circle1, mask_circle2)\n\n Next, we want to separate the two circles. We generate markers at the\n maxima of the distance to the background:\n\n >>> from scipy import ndimage as ndi\n >>> distance = ndi.distance_transform_edt(image)\n >>> from skimage.feature import peak_local_max\n >>> max_coords = peak_local_max(distance, labels=image,\n ... footprint=np.ones((3, 3)))\n >>> local_maxima = np.zeros_like(image, dtype=bool)\n >>> local_maxima[tuple(max_coords.T)] = True\n >>> markers = ndi.label(local_maxima)[0]\n\n Finally, we run the watershed on the image and markers:\n\n >>> labels = watershed(-distance, markers, mask=image)\n\n The algorithm works also for 3-D images, and can be used for example to\n separate overlapping spheres.\n \"\"\"\n image, markers, mask = _validate_inputs(image, markers, mask, connectivity)\n connectivity, offset = _validate_connectivity(image.ndim, connectivity,\n offset)\n\n # pad the image, markers, and mask so that we can use the mask to\n # keep from running off the edges\n pad_width = [(p, p) for p in offset]\n image = np.pad(image, pad_width, mode='constant')\n mask = np.pad(mask, pad_width, mode='constant').ravel()\n output = np.pad(markers, pad_width, mode='constant')\n\n flat_neighborhood = _offsets_to_raveled_neighbors(\n image.shape, connectivity, center=offset)\n marker_locations = np.flatnonzero(output)\n image_strides = np.array(image.strides, dtype=np.intp) // image.itemsize\n\n _watershed_cy.watershed_raveled(image.ravel(),\n marker_locations, flat_neighborhood,\n mask, image_strides, compactness,\n output.ravel(),\n watershed_line)\n\n output = crop(output, pad_width, copy=True)\n\n return output\n","path":"skimage/segmentation/_watershed.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"watershed.py - watershed algorithm\\n\\nThis module implements a watershed algorithm that apportions pixels into\\nmarked basins. The algorithm uses a priority queue to hold the pixels\\nwith the metric for the priority queue being pixel value, then the time\\nof entry into the queue - this settles ties in favor of the closest marker.\\n\\nSome ideas taken from\\nSoille, \\\"Automated Basin Delineation from Digital Elevation Models Using\\nMathematical Morphology\\\", Signal Processing 20 (1990) 171-182.\\n\\nThe most important insight in the paper is that entry time onto the queue\\nsolves two problems: a pixel should be assigned to the neighbor with the\\nlargest gradient or, if there is no gradient, pixels on a plateau should\\nbe split between markers on opposite sides.\\n\\\"\\\"\\\"\\n\\nimport numpy as np\\nfrom scipy import ndimage as ndi\\n\\nfrom . import _watershed_cy\\nfrom ..morphology.extrema import local_minima\\nfrom ..morphology._util import (_validate_connectivity,\\n _offsets_to_raveled_neighbors)\\nfrom ..util import crop, regular_seeds\\n\\n\\ndef _validate_inputs(image, markers, mask, connectivity):\\n \\\"\\\"\\\"Ensure that all inputs to watershed have matching shapes and types.\\n\\n Parameters\\n ----------\\n image : array\\n The input image.\\n markers : int or array of int\\n The marker image.\\n mask : array, or None\\n A boolean mask, True where we want to compute the watershed.\\n connectivity : int in {1, ..., image.ndim}\\n The connectivity of the neighborhood of a pixel.\\n\\n Returns\\n -------\\n image, markers, mask : arrays\\n The validated and formatted arrays. Image will have dtype float64,\\n markers int32, and mask int8. If ``None`` was given for the mask,\\n it is a volume of all 1s.\\n\\n Raises\\n ------\\n ValueError\\n If the shapes of the given arrays don't match.\\n \\\"\\\"\\\"\\n n_pixels = image.size\\n if mask is None:\\n # Use a complete `True` mask if none is provided\\n mask = np.ones(image.shape, bool)\\n else:\\n mask = np.asanyarray(mask, dtype=bool)\\n n_pixels = np.sum(mask)\\n if mask.shape != image.shape:\\n message = (f'`mask` (shape {mask.shape}) must have same shape '\\n f'as `image` (shape {image.shape})')\\n raise ValueError(message)\\n if markers is None:\\n markers_bool = local_minima(image, connectivity=connectivity) * mask\\n footprint = ndi.generate_binary_structure(markers_bool.ndim, connectivity)\\n markers = ndi.label(markers_bool, structure=footprint)[0]\\n elif not isinstance(markers, (np.ndarray, list, tuple)):\\n # not array-like, assume int\\n # given int, assume that number of markers *within mask*.\\n markers = regular_seeds(image.shape,\\n int(markers / (n_pixels / image.size)))\\n markers *= mask\\n else:\\n markers = np.asanyarray(markers) * mask\\n if markers.shape != image.shape:\\n message = (f'`markers` (shape {markers.shape}) must have same '\\n f'shape as `image` (shape {image.shape})')\\n raise ValueError(message)\\n return (image.astype(np.float64),\\n markers,\\n mask.astype(np.int8))\\n\\n\\ndef watershed(image, markers=None, connectivity=1, offset=None, mask=None,\\n compactness=0, watershed_line=False):\\n \\\"\\\"\\\"Find watershed basins in `image` flooded from given `markers`.\\n\\n Parameters\\n ----------\\n image : ndarray (2-D, 3-D, ...)\\n Data array where the lowest value points are labeled first.\\n markers : int, or ndarray of int, same shape as `image`, optional\\n The desired number of markers, or an array marking the basins with the\\n values to be assigned in the label matrix. Zero means not a marker. If\\n ``None`` (no markers given), the local minima of the image are used as\\n markers.\\n connectivity : ndarray, optional\\n An array with the same number of dimensions as `image` whose\\n non-zero elements indicate neighbors for connection.\\n Following the scipy convention, default is a one-connected array of\\n the dimension of the image.\\n offset : array_like of shape image.ndim, optional\\n offset of the connectivity (one offset per dimension)\\n mask : ndarray of bools or 0s and 1s, optional\\n Array of same shape as `image`. Only points at which mask == True\\n will be labeled.\\n compactness : float, optional\\n Use compact watershed [3]_ with given compactness parameter.\\n Higher values result in more regularly-shaped watershed basins.\\n watershed_line : bool, optional\\n If watershed_line is True, a one-pixel wide line separates the regions\\n obtained by the watershed algorithm. The line has the label 0.\\n Note that the method used for adding this line expects that\\n marker regions are not adjacent; the watershed line may not catch\\n borders between adjacent marker regions.\\n\\n Returns\\n -------\\n out : ndarray\\n A labeled matrix of the same type and shape as markers\\n\\n See Also\\n --------\\n skimage.segmentation.random_walker : random walker segmentation\\n A segmentation algorithm based on anisotropic diffusion, usually\\n slower than the watershed but with good results on noisy data and\\n boundaries with holes.\\n\\n Notes\\n -----\\n This function implements a watershed algorithm [1]_ [2]_ that apportions\\n pixels into marked basins. The algorithm uses a priority queue to hold\\n the pixels with the metric for the priority queue being pixel value, then\\n the time of entry into the queue - this settles ties in favor of the\\n closest marker.\\n\\n Some ideas taken from\\n Soille, \\\"Automated Basin Delineation from Digital Elevation Models Using\\n Mathematical Morphology\\\", Signal Processing 20 (1990) 171-182\\n\\n The most important insight in the paper is that entry time onto the queue\\n solves two problems: a pixel should be assigned to the neighbor with the\\n largest gradient or, if there is no gradient, pixels on a plateau should\\n be split between markers on opposite sides.\\n\\n This implementation converts all arguments to specific, lowest common\\n denominator types, then passes these to a C algorithm.\\n\\n Markers can be determined manually, or automatically using for example\\n the local minima of the gradient of the image, or the local maxima of the\\n distance function to the background for separating overlapping objects\\n (see example).\\n\\n References\\n ----------\\n .. [1] https://en.wikipedia.org/wiki/Watershed_%28image_processing%29\\n\\n .. [2] http://cmm.ensmp.fr/~beucher/wtshed.html\\n\\n .. [3] Peer Neubert & Peter Protzel (2014). Compact Watershed and\\n Preemptive SLIC: On Improving Trade-offs of Superpixel Segmentation\\n Algorithms. ICPR 2014, pp 996-1001. :DOI:`10.1109/ICPR.2014.181`\\n https://www.tu-chemnitz.de/etit/proaut/publications/cws_pSLIC_ICPR.pdf\\n\\n Examples\\n --------\\n The watershed algorithm is useful to separate overlapping objects.\\n\\n We first generate an initial image with two overlapping circles:\\n\\n >>> x, y = np.indices((80, 80))\\n >>> x1, y1, x2, y2 = 28, 28, 44, 52\\n >>> r1, r2 = 16, 20\\n >>> mask_circle1 = (x - x1)**2 + (y - y1)**2 < r1**2\\n >>> mask_circle2 = (x - x2)**2 + (y - y2)**2 < r2**2\\n >>> image = np.logical_or(mask_circle1, mask_circle2)\\n\\n Next, we want to separate the two circles. We generate markers at the\\n maxima of the distance to the background:\\n\\n >>> from scipy import ndimage as ndi\\n >>> distance = ndi.distance_transform_edt(image)\\n >>> from skimage.feature import peak_local_max\\n >>> max_coords = peak_local_max(distance, labels=image,\\n ... footprint=np.ones((3, 3)))\\n >>> local_maxima = np.zeros_like(image, dtype=bool)\\n >>> local_maxima[tuple(max_coords.T)] = True\\n >>> markers = ndi.label(local_maxima)[0]\\n\\n Finally, we run the watershed on the image and markers:\\n\\n >>> labels = watershed(-distance, markers, mask=image)\\n\\n The algorithm works also for 3-D images, and can be used for example to\\n separate overlapping spheres.\\n \\\"\\\"\\\"\\n image, markers, mask = _validate_inputs(image, markers, mask, connectivity)\\n connectivity, offset = _validate_connectivity(image.ndim, connectivity,\\n offset)\\n\\n # pad the image, markers, and mask so that we can use the mask to\\n # keep from running off the edges\\n pad_width = [(p, p) for p in offset]\\n image = np.pad(image, pad_width, mode='constant')\\n mask = np.pad(mask, pad_width, mode='constant').ravel()\\n output = np.pad(markers, pad_width, mode='constant')\\n\\n flat_neighborhood = _offsets_to_raveled_neighbors(\\n image.shape, connectivity, center=offset)\\n marker_locations = np.flatnonzero(output)\\n image_strides = np.array(image.strides, dtype=np.intp) // image.itemsize\\n\\n _watershed_cy.watershed_raveled(image.ravel(),\\n marker_locations, flat_neighborhood,\\n mask, image_strides, compactness,\\n output.ravel(),\\n watershed_line)\\n\\n output = crop(output, pad_width, copy=True)\\n\\n return output\\n\",\n \"path\": \"skimage/segmentation/_watershed.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/skimage/segmentation/_watershed.py b/skimage/segmentation/_watershed.py\nindex 244f7a3462d..9b47b8f1688 100644\n--- a/skimage/segmentation/_watershed.py\n+++ b/skimage/segmentation/_watershed.py\n@@ -79,7 +79,7 @@ def _validate_inputs(image, markers, mask, connectivity):\n f'shape as `image` (shape {image.shape})')\n raise ValueError(message)\n return (image.astype(np.float64),\n- markers.astype(np.int32),\n+ markers,\n mask.astype(np.int8))\n \n \ndiff --git a/skimage/segmentation/_watershed_cy.pyx b/skimage/segmentation/_watershed_cy.pyx\nindex f3bc851694a..bdfff5ba070 100644\n--- a/skimage/segmentation/_watershed_cy.pyx\n+++ b/skimage/segmentation/_watershed_cy.pyx\n@@ -1,12 +1,12 @@\n \"\"\"watershed.pyx - cython implementation of guts of watershed\n \"\"\"\n from libc.math cimport sqrt\n+from .._shared.fused_numerics cimport np_anyint\n \n cimport numpy as cnp\n cimport cython\n cnp.import_array()\n \n-ctypedef cnp.int32_t DTYPE_INT32_t\n ctypedef cnp.int8_t DTYPE_BOOL_t\n \n \n@@ -35,7 +35,7 @@ cdef inline cnp.float64_t _euclid_dist(Py_ssize_t pt0, Py_ssize_t pt1,\n @cython.boundscheck(False)\n @cython.cdivision(True)\n @cython.unraisable_tracebacks(False)\n-cdef inline DTYPE_BOOL_t _diff_neighbors(DTYPE_INT32_t[::1] output,\n+cdef inline DTYPE_BOOL_t _diff_neighbors(np_anyint[::1] output,\n cnp.intp_t[::1] structure,\n DTYPE_BOOL_t[::1] mask,\n Py_ssize_t index) nogil:\n@@ -46,7 +46,7 @@ cdef inline DTYPE_BOOL_t _diff_neighbors(DTYPE_INT32_t[::1] output,\n \"\"\"\n cdef:\n Py_ssize_t i, neighbor_index\n- DTYPE_INT32_t neighbor_label0, neighbor_label1\n+ np_anyint neighbor_label0, neighbor_label1\n Py_ssize_t nneighbors = structure.shape[0]\n \n if not mask[index]:\n@@ -73,7 +73,7 @@ def watershed_raveled(cnp.float64_t[::1] image,\n DTYPE_BOOL_t[::1] mask,\n cnp.intp_t[::1] strides,\n cnp.float64_t compactness,\n- DTYPE_INT32_t[::1] output,\n+ np_anyint[::1] output,\n DTYPE_BOOL_t wsl):\n \"\"\"Perform watershed algorithm using a raveled image and neighborhood.\n \ndiff --git a/skimage/segmentation/tests/test_watershed.py b/skimage/segmentation/tests/test_watershed.py\nindex cc281b399e6..0459a22435d 100644\n--- a/skimage/segmentation/tests/test_watershed.py\n+++ b/skimage/segmentation/tests/test_watershed.py\n@@ -392,6 +392,15 @@ def test_watershed12(self):\n for lab, area in zip(range(4), [34,74,74,74]):\n self.assertTrue(np.sum(ws == lab) == area)\n \n+ def test_watershed_input_not_modified(self):\n+ \"\"\"Test to ensure input markers are not modified.\"\"\"\n+ image = np.random.default_rng().random(size=(21, 21))\n+ markers = np.zeros((21, 21), dtype=np.uint8)\n+ markers[[5, 5, 15, 15], [5, 15, 5, 15]] = [1, 2, 3, 4]\n+ original_markers = np.copy(markers)\n+ result = watershed(image, markers)\n+ np.testing.assert_equal(original_markers, markers)\n+ assert not np.all(result == markers)\n \n \n def test_compact_watershed():\n@@ -426,6 +435,17 @@ def test_numeric_seed_watershed():\n np.testing.assert_equal(compact, expected)\n \n \n+@pytest.mark.parametrize(\n+ 'dtype', [np.uint8, np.int8, np.uint16, np.int16,\n+ np.uint32, np.int32, np.uint64, np.int64]\n+)\n+def test_watershed_output_dtype(dtype):\n+ image = np.zeros((100, 100))\n+ markers = np.zeros((100, 100), dtype)\n+ out = watershed(image, markers)\n+ assert out.dtype == markers.dtype\n+\n+\n def test_incorrect_markers_shape():\n image = np.ones((5, 6))\n markers = np.ones((5, 7))\n"}}},{"rowIdx":2685,"cells":{"in_source_id":{"kind":"string","value":"hylang__hy-2454"},"issue":{"kind":"string","value":"`(hy.models.Symbol \"#foo\")` should be an error\nfor the same reason as `(hy.models.Symbol \"5\")`: `#foo` doesn't parse as a symbol. It parses as a reader-macro call.\n"},"before_files":{"kind":"list like","value":[{"content":"\"Character reader for parsing Hy source.\"\n\nfrom itertools import islice\n\nimport hy\nfrom hy.models import (\n Bytes,\n Complex,\n Dict,\n Expression,\n FComponent,\n Float,\n FString,\n Integer,\n Keyword,\n List,\n Set,\n String,\n Symbol,\n Tuple,\n as_model,\n)\n\nfrom .exceptions import LexException, PrematureEndOfInput\nfrom .mangling import mangle\nfrom .reader import Reader, isnormalizedspace\n\n\ndef sym(name):\n return Symbol(name, from_parser=True)\n\n\n# Note: This is subtly different from\n# the `mkexpr` in hy/compiler.py !\ndef mkexpr(root, *args):\n return Expression((sym(root) if isinstance(root, str) else root, *args))\n\n\ndef as_identifier(ident, reader=None):\n \"\"\"Generate a Hy model from an identifier.\n\n Also verifies the syntax of dot notation and validity of symbol names.\n\n Parameters\n ----------\n ident : str\n Text to convert.\n\n reader : Reader, optional\n The reader to use, if any; used for generating position data for errors.\n\n Returns\n -------\n out : a hy.models.Object subtype corresponding to the parsed text.\n \"\"\"\n try:\n return Integer(ident)\n except ValueError:\n pass\n try:\n return Float(ident)\n except ValueError:\n pass\n if ident not in (\"j\", \"J\"):\n try:\n return Complex(ident)\n except ValueError:\n pass\n\n if \".\" in ident:\n if not ident.strip(\".\"):\n # It's all dots. Return it as a symbol.\n return sym(ident)\n\n def err(msg):\n raise (\n ValueError(msg)\n if reader is None\n else LexException.from_reader(msg, reader)\n )\n\n if ident.lstrip(\".\").find(\"..\") > 0:\n err(\n \"In a dotted identifier, multiple dots in a row are only allowed at the start\"\n )\n if ident.endswith(\".\"):\n err(\"A dotted identifier can't end with a dot\")\n head = \".\" * (len(ident) - len(ident.lstrip(\".\")))\n args = [as_identifier(a, reader=reader) for a in ident.lstrip(\".\").split(\".\")]\n if any(not isinstance(a, Symbol) for a in args):\n err(\"The parts of a dotted identifier must be symbols\")\n return (\n mkexpr(sym(\".\"), *args)\n if head == \"\"\n else mkexpr(head, Symbol(\"None\"), *args)\n )\n\n if reader is None:\n if (\n not ident\n or ident[:1] == \":\"\n or any(isnormalizedspace(c) for c in ident)\n or HyReader.NON_IDENT.intersection(ident)\n ):\n raise ValueError(f\"Syntactically illegal symbol: {ident!r}\")\n\n return sym(ident)\n\n\nclass HyReader(Reader):\n \"\"\"A modular reader for Hy source.\"\"\"\n\n ###\n # Components necessary for Reader implementation\n ###\n\n NON_IDENT = set(\"()[]{};\\\"'`~\")\n\n def __init__(self):\n super().__init__()\n\n # move any reader macros declared using\n # `reader_for(\"#...\")` to the macro table\n self.reader_macros = {}\n for tag in list(self.reader_table.keys()):\n if tag[0] == '#' and tag[1:]:\n self.reader_macros[tag[1:]] = self.reader_table.pop(tag)\n\n\n def fill_pos(self, model, start):\n \"\"\"Attach line/col information to a model.\n\n Sets the end location of `model` to the current cursor position.\n\n Args:\n model (hy.models.Object): model to set line/col info for.\n start (tuple[int, int]): (line, column) tuple indicating the start\n location to assign to `model`.\n \"\"\"\n model.start_line, model.start_column = start\n model.end_line, model.end_column = self.pos\n return model.replace(model)\n # `replace` will recurse into submodels and set any model\n # positions that are still unset the same way.\n\n def read_default(self, key):\n \"\"\"Default reader handler when nothing in the table matches.\n\n Try to read an identifier. If there's a double-quote immediately\n following, then instead parse it as a string with the given prefix (e.g.,\n `r\"...\"`).\n \"\"\"\n ident = key + self.read_ident()\n if self.peek_and_getc('\"'):\n return self.prefixed_string('\"', ident)\n return as_identifier(ident, reader=self)\n\n def parse(self, stream, filename=None, skip_shebang=False):\n \"\"\"Yields all `hy.models.Object`'s in `source`\n\n Additionally exposes `self` as ``hy.&reader`` during read/compile time.\n\n Args:\n source:\n Hy source to be parsed.\n filename (str | None):\n Filename to use for error messages. If `None` then previously\n set filename is used.\n skip_shebang:\n Whether to detect a skip a shebang line at the start.\n \"\"\"\n self._set_source(stream, filename)\n\n if skip_shebang and \"\".join(\n islice(self.peeking(eof_ok = True), len(\"#!\"))) == \"#!\":\n for c in self.chars():\n if c == \"\\n\":\n break\n\n rname = mangle(\"&reader\")\n old_reader = getattr(hy, rname, None)\n setattr(hy, rname, self)\n\n try:\n yield from self.parse_forms_until(\"\")\n finally:\n if old_reader is None:\n delattr(hy, rname)\n else:\n setattr(hy, rname, old_reader)\n\n ###\n # Reading forms\n ###\n\n def try_parse_one_form(self):\n \"\"\"Attempt to parse a single Hy form.\n\n Read one (non-space) character from the stream, then call the\n corresponding handler.\n\n Returns:\n hy.models.Object | None:\n Model optionally returned by the called handler. Handlers may\n return `None` to signify no parsed form (e.g., for comments).\n\n Raises:\n PrematureEndOfInput: If the reader hits the end of the file before\n fully parsing a form.\n LexException: If there is an error during form parsing.\n \"\"\"\n try:\n self.slurp_space()\n c = self.getc()\n start = self._pos\n if not c:\n raise PrematureEndOfInput.from_reader(\n \"Premature end of input while attempting to parse one form\", self\n )\n handler = self.reader_table.get(c)\n model = handler(self, c) if handler else self.read_default(c)\n return self.fill_pos(model, start) if model is not None else None\n except LexException:\n raise\n except Exception as e:\n raise LexException.from_reader(\n str(e) or \"Exception thrown attempting to parse one form\", self\n )\n\n def parse_one_form(self):\n \"\"\"Read from the stream until a form is parsed.\n\n Guaranteed to return a model (i.e., skips over comments).\n\n Returns:\n hy.models.Object\n \"\"\"\n model = None\n while model is None:\n model = self.try_parse_one_form()\n return model\n\n def parse_forms_until(self, closer):\n \"\"\"Yields `hy.models.Object`'s until character `closer` is seen.\n\n Useful for reading a sequence such as s-exprs or lists.\n \"\"\"\n while True:\n self.slurp_space()\n if self.peek_and_getc(closer):\n break\n model = self.try_parse_one_form()\n if model is not None:\n yield model\n\n ###\n # Basic atoms\n ###\n\n @reader_for(\")\")\n @reader_for(\"]\")\n @reader_for(\"}\")\n def INVALID(self, key):\n raise LexException.from_reader(\n f\"Ran into a '{key}' where it wasn't expected.\", self\n )\n\n @reader_for(\";\")\n def line_comment(self, _):\n any(c == \"\\n\" for c in self.chars(eof_ok=True))\n return None\n\n @reader_for(\":\")\n def keyword(self, _):\n ident = self.read_ident()\n if \".\" in ident:\n raise LexException.from_reader(\n \"Cannot access attribute on anything other\"\n \" than a name (in order to get attributes of expressions,\"\n \" use `(. <expression> <attr>)` or `(.<attr> <expression>)`)\",\n self,\n )\n return Keyword(ident, from_parser=True)\n\n @reader_for('\"')\n def prefixed_string(self, _, prefix=\"\"):\n prefix_chars = set(prefix)\n if (\n len(prefix_chars) != len(prefix)\n or prefix_chars - set(\"bfr\")\n or set(\"bf\") <= prefix_chars\n ):\n raise LexException.from_reader(f\"invalid string prefix {prefix!r}\", self)\n\n escaping = False\n\n def quote_closing(c):\n nonlocal escaping\n if c == \"\\\\\":\n escaping = not escaping\n return 0\n if c == '\"' and not escaping:\n return 1\n if (\n escaping\n and \"r\" not in prefix\n and\n # https://docs.python.org/3/reference/lexical_analysis.html#string-and-bytes-literals\n c\n not in (\"\\n\\r\\\\'\\\"abfnrtv01234567x\" + (\"\" if \"b\" in prefix else \"NuU\"))\n ):\n raise LexException.from_reader(\"invalid escape sequence \\\\\" + c, self)\n escaping = False\n return 0\n\n return self.read_string_until(quote_closing, prefix, \"f\" in prefix.lower())\n\n ###\n # Special annotations\n ###\n\n @reader_for(\"'\", (\"quote\",))\n @reader_for(\"`\", (\"quasiquote\",))\n def tag_as(root):\n return lambda self, _: mkexpr(root, self.parse_one_form())\n\n @reader_for(\"~\")\n def unquote(self, key):\n return mkexpr(\n \"unquote\" + (\"-splice\" if self.peek_and_getc(\"@\") else \"\"),\n self.parse_one_form(),\n )\n\n ###\n # Sequences\n ###\n\n @reader_for(\"(\", (Expression, \")\"))\n @reader_for(\"[\", (List, \"]\"))\n @reader_for(\"{\", (Dict, \"}\"))\n @reader_for(\"#{\", (Set, \"}\"))\n @reader_for(\"#(\", (Tuple, \")\"))\n def sequence(seq_type, closer):\n return lambda self, _: seq_type(self.parse_forms_until(closer))\n\n ###\n # Reader tag-macros\n ###\n\n @reader_for(\"#\")\n def tag_dispatch(self, key):\n \"\"\"General handler for reader macros (and tag macros).\n\n Reads a full identifier after the `#` and calls the corresponding handler\n (this allows, e.g., `#reads-multiple-forms foo bar baz`).\n \"\"\"\n\n if not self.peekc().strip():\n raise PrematureEndOfInput.from_reader(\n \"Premature end of input while attempting dispatch\", self\n )\n\n # try dispatching tagged ident\n ident = self.read_ident() or self.getc()\n if ident in self.reader_macros:\n tree = self.reader_macros[ident](self, ident)\n return as_model(tree) if tree is not None else None\n\n raise LexException.from_reader(\n f\"reader macro '{key + ident}' is not defined\", self\n )\n\n @reader_for(\"#_\")\n def discard(self, _):\n \"\"\"Discards the next parsed form.\"\"\"\n self.parse_one_form()\n return None\n\n @reader_for(\"#*\")\n @reader_for(\"#**\")\n def hash_star(self, stars):\n \"\"\"Unpacking forms `#*` and `#**`, corresponding to `*` and `**` in Python.\"\"\"\n return mkexpr(\n \"unpack-\" + {\"*\": \"iterable\", \"**\": \"mapping\"}[stars],\n self.parse_one_form(),\n )\n\n @reader_for(\"#^\")\n def annotate(self, _):\n \"\"\"Annotate a symbol, usually with a type.\"\"\"\n typ = self.parse_one_form()\n target = self.parse_one_form()\n return mkexpr(\"annotate\", target, typ)\n\n ###\n # Strings\n # (these are more complicated because f-strings\n # form their own sublanguage)\n ###\n\n @reader_for(\"#[\")\n def bracketed_string(self, _):\n \"\"\"Bracketed strings. See the Hy docs for full details.\"\"\"\n delim = []\n for c in self.chars():\n if c == \"[\":\n break\n elif c == \"]\":\n raise LexException.from_reader(\n \"Ran into a ']' where it wasn't expected.\", self\n )\n delim.append(c)\n delim = \"\".join(delim)\n is_fstring = delim == \"f\" or delim.startswith(\"f-\")\n\n # discard single initial newline, if any, accounting for all\n # three styles of newline\n self.peek_and_getc(\"\\x0d\")\n self.peek_and_getc(\"\\x0a\")\n\n index = -1\n\n def delim_closing(c):\n nonlocal index\n if c == \"]\":\n if index == len(delim):\n # this is the second bracket at the end of the delim\n return len(delim) + 2\n else:\n # reset state, this may be the first bracket of closing delim\n index = 0\n elif 0 <= index <= len(delim):\n # we're inside a possible closing delim\n if index < len(delim) and c == delim[index]:\n index += 1\n else:\n # failed delim, reset state\n index = -1\n return 0\n\n return self.read_string_until(delim_closing, \"fr\" if is_fstring else None, is_fstring, brackets=delim)\n\n def read_string_until(self, closing, prefix, is_fstring, **kwargs):\n if is_fstring:\n components = self.read_fcomponents_until(closing, prefix)\n return FString(components, **kwargs)\n s = self.read_chars_until(closing, prefix, is_fstring=False)\n return (Bytes if isinstance(s, bytes) else String)(s, **kwargs)\n\n def read_chars_until(self, closing, prefix, is_fstring):\n s = []\n for c in self.chars():\n s.append(c)\n # check if c is closing\n n_closing_chars = closing(c)\n if n_closing_chars:\n # string has ended\n s = s[:-n_closing_chars]\n break\n # check if c is start of component\n if is_fstring and c == \"{\" and s[-3:] != [\"\\\\\", \"N\", \"{\"]:\n # check and handle \"{{\"\n if self.peek_and_getc(\"{\"):\n s.append(\"{\")\n else:\n # remove \"{\" from end of string component\n s.pop()\n break\n res = \"\".join(s).replace(\"\\x0d\\x0a\", \"\\x0a\").replace(\"\\x0d\", \"\\x0a\")\n\n if prefix is not None:\n res = eval(f'{prefix}\"\"\"{res}\"\"\"')\n if is_fstring:\n return res, n_closing_chars\n return res\n\n def read_fcomponents_until(self, closing, prefix):\n components = []\n start = self.pos\n while True:\n s, closed = self.read_chars_until(closing, prefix, is_fstring=True)\n if s:\n components.append(self.fill_pos(String(s), start))\n if closed:\n break\n components.extend(self.read_fcomponent(prefix))\n return components\n\n def read_fcomponent(self, prefix):\n \"\"\"May return one or two components, since the `=` debugging syntax\n will create a String component.\"\"\"\n start = self.pos\n values = []\n conversion = None\n has_debug = False\n\n # read the expression, saving the text verbatim\n # in case we encounter debug `=`\n space_before = self.slurp_space()\n with self.saving_chars() as form_text:\n model = self.parse_one_form()\n space_between = self.slurp_space()\n\n # check for and handle debug syntax:\n # we emt the verbatim text before we emit the value\n if self.peek_and_getc(\"=\"):\n has_debug = True\n space_after = self.slurp_space()\n dbg_prefix = (\n space_before + \"\".join(form_text) + space_between + \"=\" + space_after\n )\n values.append(self.fill_pos(String(dbg_prefix), start))\n\n # handle conversion code\n if self.peek_and_getc(\"!\"):\n conversion = self.getc()\n self.slurp_space()\n\n def component_closing(c):\n if c == \"}\":\n return 1\n return 0\n\n # handle formatting options\n format_components = []\n if self.peek_and_getc(\":\"):\n format_components = self.read_fcomponents_until(component_closing, prefix)\n else:\n if has_debug and conversion is None:\n conversion = \"r\"\n if not self.getc() == \"}\":\n raise LexException.from_reader(\"f-string: trailing junk in field\", self)\n return values + [\n self.fill_pos(FComponent((model, *format_components), conversion), start)\n ]\n","path":"hy/reader/hy_reader.py"}],"string":"[\n {\n \"content\": \"\\\"Character reader for parsing Hy source.\\\"\\n\\nfrom itertools import islice\\n\\nimport hy\\nfrom hy.models import (\\n Bytes,\\n Complex,\\n Dict,\\n Expression,\\n FComponent,\\n Float,\\n FString,\\n Integer,\\n Keyword,\\n List,\\n Set,\\n String,\\n Symbol,\\n Tuple,\\n as_model,\\n)\\n\\nfrom .exceptions import LexException, PrematureEndOfInput\\nfrom .mangling import mangle\\nfrom .reader import Reader, isnormalizedspace\\n\\n\\ndef sym(name):\\n return Symbol(name, from_parser=True)\\n\\n\\n# Note: This is subtly different from\\n# the `mkexpr` in hy/compiler.py !\\ndef mkexpr(root, *args):\\n return Expression((sym(root) if isinstance(root, str) else root, *args))\\n\\n\\ndef as_identifier(ident, reader=None):\\n \\\"\\\"\\\"Generate a Hy model from an identifier.\\n\\n Also verifies the syntax of dot notation and validity of symbol names.\\n\\n Parameters\\n ----------\\n ident : str\\n Text to convert.\\n\\n reader : Reader, optional\\n The reader to use, if any; used for generating position data for errors.\\n\\n Returns\\n -------\\n out : a hy.models.Object subtype corresponding to the parsed text.\\n \\\"\\\"\\\"\\n try:\\n return Integer(ident)\\n except ValueError:\\n pass\\n try:\\n return Float(ident)\\n except ValueError:\\n pass\\n if ident not in (\\\"j\\\", \\\"J\\\"):\\n try:\\n return Complex(ident)\\n except ValueError:\\n pass\\n\\n if \\\".\\\" in ident:\\n if not ident.strip(\\\".\\\"):\\n # It's all dots. Return it as a symbol.\\n return sym(ident)\\n\\n def err(msg):\\n raise (\\n ValueError(msg)\\n if reader is None\\n else LexException.from_reader(msg, reader)\\n )\\n\\n if ident.lstrip(\\\".\\\").find(\\\"..\\\") > 0:\\n err(\\n \\\"In a dotted identifier, multiple dots in a row are only allowed at the start\\\"\\n )\\n if ident.endswith(\\\".\\\"):\\n err(\\\"A dotted identifier can't end with a dot\\\")\\n head = \\\".\\\" * (len(ident) - len(ident.lstrip(\\\".\\\")))\\n args = [as_identifier(a, reader=reader) for a in ident.lstrip(\\\".\\\").split(\\\".\\\")]\\n if any(not isinstance(a, Symbol) for a in args):\\n err(\\\"The parts of a dotted identifier must be symbols\\\")\\n return (\\n mkexpr(sym(\\\".\\\"), *args)\\n if head == \\\"\\\"\\n else mkexpr(head, Symbol(\\\"None\\\"), *args)\\n )\\n\\n if reader is None:\\n if (\\n not ident\\n or ident[:1] == \\\":\\\"\\n or any(isnormalizedspace(c) for c in ident)\\n or HyReader.NON_IDENT.intersection(ident)\\n ):\\n raise ValueError(f\\\"Syntactically illegal symbol: {ident!r}\\\")\\n\\n return sym(ident)\\n\\n\\nclass HyReader(Reader):\\n \\\"\\\"\\\"A modular reader for Hy source.\\\"\\\"\\\"\\n\\n ###\\n # Components necessary for Reader implementation\\n ###\\n\\n NON_IDENT = set(\\\"()[]{};\\\\\\\"'`~\\\")\\n\\n def __init__(self):\\n super().__init__()\\n\\n # move any reader macros declared using\\n # `reader_for(\\\"#...\\\")` to the macro table\\n self.reader_macros = {}\\n for tag in list(self.reader_table.keys()):\\n if tag[0] == '#' and tag[1:]:\\n self.reader_macros[tag[1:]] = self.reader_table.pop(tag)\\n\\n\\n def fill_pos(self, model, start):\\n \\\"\\\"\\\"Attach line/col information to a model.\\n\\n Sets the end location of `model` to the current cursor position.\\n\\n Args:\\n model (hy.models.Object): model to set line/col info for.\\n start (tuple[int, int]): (line, column) tuple indicating the start\\n location to assign to `model`.\\n \\\"\\\"\\\"\\n model.start_line, model.start_column = start\\n model.end_line, model.end_column = self.pos\\n return model.replace(model)\\n # `replace` will recurse into submodels and set any model\\n # positions that are still unset the same way.\\n\\n def read_default(self, key):\\n \\\"\\\"\\\"Default reader handler when nothing in the table matches.\\n\\n Try to read an identifier. If there's a double-quote immediately\\n following, then instead parse it as a string with the given prefix (e.g.,\\n `r\\\"...\\\"`).\\n \\\"\\\"\\\"\\n ident = key + self.read_ident()\\n if self.peek_and_getc('\\\"'):\\n return self.prefixed_string('\\\"', ident)\\n return as_identifier(ident, reader=self)\\n\\n def parse(self, stream, filename=None, skip_shebang=False):\\n \\\"\\\"\\\"Yields all `hy.models.Object`'s in `source`\\n\\n Additionally exposes `self` as ``hy.&reader`` during read/compile time.\\n\\n Args:\\n source:\\n Hy source to be parsed.\\n filename (str | None):\\n Filename to use for error messages. If `None` then previously\\n set filename is used.\\n skip_shebang:\\n Whether to detect a skip a shebang line at the start.\\n \\\"\\\"\\\"\\n self._set_source(stream, filename)\\n\\n if skip_shebang and \\\"\\\".join(\\n islice(self.peeking(eof_ok = True), len(\\\"#!\\\"))) == \\\"#!\\\":\\n for c in self.chars():\\n if c == \\\"\\\\n\\\":\\n break\\n\\n rname = mangle(\\\"&reader\\\")\\n old_reader = getattr(hy, rname, None)\\n setattr(hy, rname, self)\\n\\n try:\\n yield from self.parse_forms_until(\\\"\\\")\\n finally:\\n if old_reader is None:\\n delattr(hy, rname)\\n else:\\n setattr(hy, rname, old_reader)\\n\\n ###\\n # Reading forms\\n ###\\n\\n def try_parse_one_form(self):\\n \\\"\\\"\\\"Attempt to parse a single Hy form.\\n\\n Read one (non-space) character from the stream, then call the\\n corresponding handler.\\n\\n Returns:\\n hy.models.Object | None:\\n Model optionally returned by the called handler. Handlers may\\n return `None` to signify no parsed form (e.g., for comments).\\n\\n Raises:\\n PrematureEndOfInput: If the reader hits the end of the file before\\n fully parsing a form.\\n LexException: If there is an error during form parsing.\\n \\\"\\\"\\\"\\n try:\\n self.slurp_space()\\n c = self.getc()\\n start = self._pos\\n if not c:\\n raise PrematureEndOfInput.from_reader(\\n \\\"Premature end of input while attempting to parse one form\\\", self\\n )\\n handler = self.reader_table.get(c)\\n model = handler(self, c) if handler else self.read_default(c)\\n return self.fill_pos(model, start) if model is not None else None\\n except LexException:\\n raise\\n except Exception as e:\\n raise LexException.from_reader(\\n str(e) or \\\"Exception thrown attempting to parse one form\\\", self\\n )\\n\\n def parse_one_form(self):\\n \\\"\\\"\\\"Read from the stream until a form is parsed.\\n\\n Guaranteed to return a model (i.e., skips over comments).\\n\\n Returns:\\n hy.models.Object\\n \\\"\\\"\\\"\\n model = None\\n while model is None:\\n model = self.try_parse_one_form()\\n return model\\n\\n def parse_forms_until(self, closer):\\n \\\"\\\"\\\"Yields `hy.models.Object`'s until character `closer` is seen.\\n\\n Useful for reading a sequence such as s-exprs or lists.\\n \\\"\\\"\\\"\\n while True:\\n self.slurp_space()\\n if self.peek_and_getc(closer):\\n break\\n model = self.try_parse_one_form()\\n if model is not None:\\n yield model\\n\\n ###\\n # Basic atoms\\n ###\\n\\n @reader_for(\\\")\\\")\\n @reader_for(\\\"]\\\")\\n @reader_for(\\\"}\\\")\\n def INVALID(self, key):\\n raise LexException.from_reader(\\n f\\\"Ran into a '{key}' where it wasn't expected.\\\", self\\n )\\n\\n @reader_for(\\\";\\\")\\n def line_comment(self, _):\\n any(c == \\\"\\\\n\\\" for c in self.chars(eof_ok=True))\\n return None\\n\\n @reader_for(\\\":\\\")\\n def keyword(self, _):\\n ident = self.read_ident()\\n if \\\".\\\" in ident:\\n raise LexException.from_reader(\\n \\\"Cannot access attribute on anything other\\\"\\n \\\" than a name (in order to get attributes of expressions,\\\"\\n \\\" use `(. <expression> <attr>)` or `(.<attr> <expression>)`)\\\",\\n self,\\n )\\n return Keyword(ident, from_parser=True)\\n\\n @reader_for('\\\"')\\n def prefixed_string(self, _, prefix=\\\"\\\"):\\n prefix_chars = set(prefix)\\n if (\\n len(prefix_chars) != len(prefix)\\n or prefix_chars - set(\\\"bfr\\\")\\n or set(\\\"bf\\\") <= prefix_chars\\n ):\\n raise LexException.from_reader(f\\\"invalid string prefix {prefix!r}\\\", self)\\n\\n escaping = False\\n\\n def quote_closing(c):\\n nonlocal escaping\\n if c == \\\"\\\\\\\\\\\":\\n escaping = not escaping\\n return 0\\n if c == '\\\"' and not escaping:\\n return 1\\n if (\\n escaping\\n and \\\"r\\\" not in prefix\\n and\\n # https://docs.python.org/3/reference/lexical_analysis.html#string-and-bytes-literals\\n c\\n not in (\\\"\\\\n\\\\r\\\\\\\\'\\\\\\\"abfnrtv01234567x\\\" + (\\\"\\\" if \\\"b\\\" in prefix else \\\"NuU\\\"))\\n ):\\n raise LexException.from_reader(\\\"invalid escape sequence \\\\\\\\\\\" + c, self)\\n escaping = False\\n return 0\\n\\n return self.read_string_until(quote_closing, prefix, \\\"f\\\" in prefix.lower())\\n\\n ###\\n # Special annotations\\n ###\\n\\n @reader_for(\\\"'\\\", (\\\"quote\\\",))\\n @reader_for(\\\"`\\\", (\\\"quasiquote\\\",))\\n def tag_as(root):\\n return lambda self, _: mkexpr(root, self.parse_one_form())\\n\\n @reader_for(\\\"~\\\")\\n def unquote(self, key):\\n return mkexpr(\\n \\\"unquote\\\" + (\\\"-splice\\\" if self.peek_and_getc(\\\"@\\\") else \\\"\\\"),\\n self.parse_one_form(),\\n )\\n\\n ###\\n # Sequences\\n ###\\n\\n @reader_for(\\\"(\\\", (Expression, \\\")\\\"))\\n @reader_for(\\\"[\\\", (List, \\\"]\\\"))\\n @reader_for(\\\"{\\\", (Dict, \\\"}\\\"))\\n @reader_for(\\\"#{\\\", (Set, \\\"}\\\"))\\n @reader_for(\\\"#(\\\", (Tuple, \\\")\\\"))\\n def sequence(seq_type, closer):\\n return lambda self, _: seq_type(self.parse_forms_until(closer))\\n\\n ###\\n # Reader tag-macros\\n ###\\n\\n @reader_for(\\\"#\\\")\\n def tag_dispatch(self, key):\\n \\\"\\\"\\\"General handler for reader macros (and tag macros).\\n\\n Reads a full identifier after the `#` and calls the corresponding handler\\n (this allows, e.g., `#reads-multiple-forms foo bar baz`).\\n \\\"\\\"\\\"\\n\\n if not self.peekc().strip():\\n raise PrematureEndOfInput.from_reader(\\n \\\"Premature end of input while attempting dispatch\\\", self\\n )\\n\\n # try dispatching tagged ident\\n ident = self.read_ident() or self.getc()\\n if ident in self.reader_macros:\\n tree = self.reader_macros[ident](self, ident)\\n return as_model(tree) if tree is not None else None\\n\\n raise LexException.from_reader(\\n f\\\"reader macro '{key + ident}' is not defined\\\", self\\n )\\n\\n @reader_for(\\\"#_\\\")\\n def discard(self, _):\\n \\\"\\\"\\\"Discards the next parsed form.\\\"\\\"\\\"\\n self.parse_one_form()\\n return None\\n\\n @reader_for(\\\"#*\\\")\\n @reader_for(\\\"#**\\\")\\n def hash_star(self, stars):\\n \\\"\\\"\\\"Unpacking forms `#*` and `#**`, corresponding to `*` and `**` in Python.\\\"\\\"\\\"\\n return mkexpr(\\n \\\"unpack-\\\" + {\\\"*\\\": \\\"iterable\\\", \\\"**\\\": \\\"mapping\\\"}[stars],\\n self.parse_one_form(),\\n )\\n\\n @reader_for(\\\"#^\\\")\\n def annotate(self, _):\\n \\\"\\\"\\\"Annotate a symbol, usually with a type.\\\"\\\"\\\"\\n typ = self.parse_one_form()\\n target = self.parse_one_form()\\n return mkexpr(\\\"annotate\\\", target, typ)\\n\\n ###\\n # Strings\\n # (these are more complicated because f-strings\\n # form their own sublanguage)\\n ###\\n\\n @reader_for(\\\"#[\\\")\\n def bracketed_string(self, _):\\n \\\"\\\"\\\"Bracketed strings. See the Hy docs for full details.\\\"\\\"\\\"\\n delim = []\\n for c in self.chars():\\n if c == \\\"[\\\":\\n break\\n elif c == \\\"]\\\":\\n raise LexException.from_reader(\\n \\\"Ran into a ']' where it wasn't expected.\\\", self\\n )\\n delim.append(c)\\n delim = \\\"\\\".join(delim)\\n is_fstring = delim == \\\"f\\\" or delim.startswith(\\\"f-\\\")\\n\\n # discard single initial newline, if any, accounting for all\\n # three styles of newline\\n self.peek_and_getc(\\\"\\\\x0d\\\")\\n self.peek_and_getc(\\\"\\\\x0a\\\")\\n\\n index = -1\\n\\n def delim_closing(c):\\n nonlocal index\\n if c == \\\"]\\\":\\n if index == len(delim):\\n # this is the second bracket at the end of the delim\\n return len(delim) + 2\\n else:\\n # reset state, this may be the first bracket of closing delim\\n index = 0\\n elif 0 <= index <= len(delim):\\n # we're inside a possible closing delim\\n if index < len(delim) and c == delim[index]:\\n index += 1\\n else:\\n # failed delim, reset state\\n index = -1\\n return 0\\n\\n return self.read_string_until(delim_closing, \\\"fr\\\" if is_fstring else None, is_fstring, brackets=delim)\\n\\n def read_string_until(self, closing, prefix, is_fstring, **kwargs):\\n if is_fstring:\\n components = self.read_fcomponents_until(closing, prefix)\\n return FString(components, **kwargs)\\n s = self.read_chars_until(closing, prefix, is_fstring=False)\\n return (Bytes if isinstance(s, bytes) else String)(s, **kwargs)\\n\\n def read_chars_until(self, closing, prefix, is_fstring):\\n s = []\\n for c in self.chars():\\n s.append(c)\\n # check if c is closing\\n n_closing_chars = closing(c)\\n if n_closing_chars:\\n # string has ended\\n s = s[:-n_closing_chars]\\n break\\n # check if c is start of component\\n if is_fstring and c == \\\"{\\\" and s[-3:] != [\\\"\\\\\\\\\\\", \\\"N\\\", \\\"{\\\"]:\\n # check and handle \\\"{{\\\"\\n if self.peek_and_getc(\\\"{\\\"):\\n s.append(\\\"{\\\")\\n else:\\n # remove \\\"{\\\" from end of string component\\n s.pop()\\n break\\n res = \\\"\\\".join(s).replace(\\\"\\\\x0d\\\\x0a\\\", \\\"\\\\x0a\\\").replace(\\\"\\\\x0d\\\", \\\"\\\\x0a\\\")\\n\\n if prefix is not None:\\n res = eval(f'{prefix}\\\"\\\"\\\"{res}\\\"\\\"\\\"')\\n if is_fstring:\\n return res, n_closing_chars\\n return res\\n\\n def read_fcomponents_until(self, closing, prefix):\\n components = []\\n start = self.pos\\n while True:\\n s, closed = self.read_chars_until(closing, prefix, is_fstring=True)\\n if s:\\n components.append(self.fill_pos(String(s), start))\\n if closed:\\n break\\n components.extend(self.read_fcomponent(prefix))\\n return components\\n\\n def read_fcomponent(self, prefix):\\n \\\"\\\"\\\"May return one or two components, since the `=` debugging syntax\\n will create a String component.\\\"\\\"\\\"\\n start = self.pos\\n values = []\\n conversion = None\\n has_debug = False\\n\\n # read the expression, saving the text verbatim\\n # in case we encounter debug `=`\\n space_before = self.slurp_space()\\n with self.saving_chars() as form_text:\\n model = self.parse_one_form()\\n space_between = self.slurp_space()\\n\\n # check for and handle debug syntax:\\n # we emt the verbatim text before we emit the value\\n if self.peek_and_getc(\\\"=\\\"):\\n has_debug = True\\n space_after = self.slurp_space()\\n dbg_prefix = (\\n space_before + \\\"\\\".join(form_text) + space_between + \\\"=\\\" + space_after\\n )\\n values.append(self.fill_pos(String(dbg_prefix), start))\\n\\n # handle conversion code\\n if self.peek_and_getc(\\\"!\\\"):\\n conversion = self.getc()\\n self.slurp_space()\\n\\n def component_closing(c):\\n if c == \\\"}\\\":\\n return 1\\n return 0\\n\\n # handle formatting options\\n format_components = []\\n if self.peek_and_getc(\\\":\\\"):\\n format_components = self.read_fcomponents_until(component_closing, prefix)\\n else:\\n if has_debug and conversion is None:\\n conversion = \\\"r\\\"\\n if not self.getc() == \\\"}\\\":\\n raise LexException.from_reader(\\\"f-string: trailing junk in field\\\", self)\\n return values + [\\n self.fill_pos(FComponent((model, *format_components), conversion), start)\\n ]\\n\",\n \"path\": \"hy/reader/hy_reader.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"\"Character reader for parsing Hy source.\"\n\nfrom itertools import islice\n\nimport hy\nfrom hy.models import (\n Bytes,\n Complex,\n Dict,\n Expression,\n FComponent,\n Float,\n FString,\n Integer,\n Keyword,\n List,\n Set,\n String,\n Symbol,\n Tuple,\n as_model,\n)\n\nfrom .exceptions import LexException, PrematureEndOfInput\nfrom .mangling import mangle\nfrom .reader import Reader, isnormalizedspace\n\n\ndef sym(name):\n return Symbol(name, from_parser=True)\n\n\n# Note: This is subtly different from\n# the `mkexpr` in hy/compiler.py !\ndef mkexpr(root, *args):\n return Expression((sym(root) if isinstance(root, str) else root, *args))\n\n\ndef as_identifier(ident, reader=None):\n \"\"\"Generate a Hy model from an identifier.\n\n Also verifies the syntax of dot notation and validity of symbol names.\n\n Parameters\n ----------\n ident : str\n Text to convert.\n\n reader : Reader, optional\n The reader to use, if any; used for generating position data for errors.\n\n Returns\n -------\n out : a hy.models.Object subtype corresponding to the parsed text.\n \"\"\"\n try:\n return Integer(ident)\n except ValueError:\n pass\n try:\n return Float(ident)\n except ValueError:\n pass\n if ident not in (\"j\", \"J\"):\n try:\n return Complex(ident)\n except ValueError:\n pass\n\n if \".\" in ident:\n if not ident.strip(\".\"):\n # It's all dots. Return it as a symbol.\n return sym(ident)\n\n def err(msg):\n raise (\n ValueError(msg)\n if reader is None\n else LexException.from_reader(msg, reader)\n )\n\n if ident.lstrip(\".\").find(\"..\") > 0:\n err(\n \"In a dotted identifier, multiple dots in a row are only allowed at the start\"\n )\n if ident.endswith(\".\"):\n err(\"A dotted identifier can't end with a dot\")\n head = \".\" * (len(ident) - len(ident.lstrip(\".\")))\n args = [as_identifier(a, reader=reader) for a in ident.lstrip(\".\").split(\".\")]\n if any(not isinstance(a, Symbol) for a in args):\n err(\"The parts of a dotted identifier must be symbols\")\n return (\n mkexpr(sym(\".\"), *args)\n if head == \"\"\n else mkexpr(head, Symbol(\"None\"), *args)\n )\n\n if reader is None:\n if (\n not ident\n or ident[0] in \":#\"\n or any(isnormalizedspace(c) for c in ident)\n or HyReader.NON_IDENT.intersection(ident)\n ):\n raise ValueError(f\"Syntactically illegal symbol: {ident!r}\")\n\n return sym(ident)\n\n\nclass HyReader(Reader):\n \"\"\"A modular reader for Hy source.\"\"\"\n\n ###\n # Components necessary for Reader implementation\n ###\n\n NON_IDENT = set(\"()[]{};\\\"'`~\")\n\n def __init__(self):\n super().__init__()\n\n # move any reader macros declared using\n # `reader_for(\"#...\")` to the macro table\n self.reader_macros = {}\n for tag in list(self.reader_table.keys()):\n if tag[0] == '#' and tag[1:]:\n self.reader_macros[tag[1:]] = self.reader_table.pop(tag)\n\n\n def fill_pos(self, model, start):\n \"\"\"Attach line/col information to a model.\n\n Sets the end location of `model` to the current cursor position.\n\n Args:\n model (hy.models.Object): model to set line/col info for.\n start (tuple[int, int]): (line, column) tuple indicating the start\n location to assign to `model`.\n \"\"\"\n model.start_line, model.start_column = start\n model.end_line, model.end_column = self.pos\n return model.replace(model)\n # `replace` will recurse into submodels and set any model\n # positions that are still unset the same way.\n\n def read_default(self, key):\n \"\"\"Default reader handler when nothing in the table matches.\n\n Try to read an identifier. If there's a double-quote immediately\n following, then instead parse it as a string with the given prefix (e.g.,\n `r\"...\"`).\n \"\"\"\n ident = key + self.read_ident()\n if self.peek_and_getc('\"'):\n return self.prefixed_string('\"', ident)\n return as_identifier(ident, reader=self)\n\n def parse(self, stream, filename=None, skip_shebang=False):\n \"\"\"Yields all `hy.models.Object`'s in `source`\n\n Additionally exposes `self` as ``hy.&reader`` during read/compile time.\n\n Args:\n source:\n Hy source to be parsed.\n filename (str | None):\n Filename to use for error messages. If `None` then previously\n set filename is used.\n skip_shebang:\n Whether to detect a skip a shebang line at the start.\n \"\"\"\n self._set_source(stream, filename)\n\n if skip_shebang and \"\".join(\n islice(self.peeking(eof_ok = True), len(\"#!\"))) == \"#!\":\n for c in self.chars():\n if c == \"\\n\":\n break\n\n rname = mangle(\"&reader\")\n old_reader = getattr(hy, rname, None)\n setattr(hy, rname, self)\n\n try:\n yield from self.parse_forms_until(\"\")\n finally:\n if old_reader is None:\n delattr(hy, rname)\n else:\n setattr(hy, rname, old_reader)\n\n ###\n # Reading forms\n ###\n\n def try_parse_one_form(self):\n \"\"\"Attempt to parse a single Hy form.\n\n Read one (non-space) character from the stream, then call the\n corresponding handler.\n\n Returns:\n hy.models.Object | None:\n Model optionally returned by the called handler. Handlers may\n return `None` to signify no parsed form (e.g., for comments).\n\n Raises:\n PrematureEndOfInput: If the reader hits the end of the file before\n fully parsing a form.\n LexException: If there is an error during form parsing.\n \"\"\"\n try:\n self.slurp_space()\n c = self.getc()\n start = self._pos\n if not c:\n raise PrematureEndOfInput.from_reader(\n \"Premature end of input while attempting to parse one form\", self\n )\n handler = self.reader_table.get(c)\n model = handler(self, c) if handler else self.read_default(c)\n return self.fill_pos(model, start) if model is not None else None\n except LexException:\n raise\n except Exception as e:\n raise LexException.from_reader(\n str(e) or \"Exception thrown attempting to parse one form\", self\n )\n\n def parse_one_form(self):\n \"\"\"Read from the stream until a form is parsed.\n\n Guaranteed to return a model (i.e., skips over comments).\n\n Returns:\n hy.models.Object\n \"\"\"\n model = None\n while model is None:\n model = self.try_parse_one_form()\n return model\n\n def parse_forms_until(self, closer):\n \"\"\"Yields `hy.models.Object`'s until character `closer` is seen.\n\n Useful for reading a sequence such as s-exprs or lists.\n \"\"\"\n while True:\n self.slurp_space()\n if self.peek_and_getc(closer):\n break\n model = self.try_parse_one_form()\n if model is not None:\n yield model\n\n ###\n # Basic atoms\n ###\n\n @reader_for(\")\")\n @reader_for(\"]\")\n @reader_for(\"}\")\n def INVALID(self, key):\n raise LexException.from_reader(\n f\"Ran into a '{key}' where it wasn't expected.\", self\n )\n\n @reader_for(\";\")\n def line_comment(self, _):\n any(c == \"\\n\" for c in self.chars(eof_ok=True))\n return None\n\n @reader_for(\":\")\n def keyword(self, _):\n ident = self.read_ident()\n if \".\" in ident:\n raise LexException.from_reader(\n \"Cannot access attribute on anything other\"\n \" than a name (in order to get attributes of expressions,\"\n \" use `(. <expression> <attr>)` or `(.<attr> <expression>)`)\",\n self,\n )\n return Keyword(ident, from_parser=True)\n\n @reader_for('\"')\n def prefixed_string(self, _, prefix=\"\"):\n prefix_chars = set(prefix)\n if (\n len(prefix_chars) != len(prefix)\n or prefix_chars - set(\"bfr\")\n or set(\"bf\") <= prefix_chars\n ):\n raise LexException.from_reader(f\"invalid string prefix {prefix!r}\", self)\n\n escaping = False\n\n def quote_closing(c):\n nonlocal escaping\n if c == \"\\\\\":\n escaping = not escaping\n return 0\n if c == '\"' and not escaping:\n return 1\n if (\n escaping\n and \"r\" not in prefix\n and\n # https://docs.python.org/3/reference/lexical_analysis.html#string-and-bytes-literals\n c\n not in (\"\\n\\r\\\\'\\\"abfnrtv01234567x\" + (\"\" if \"b\" in prefix else \"NuU\"))\n ):\n raise LexException.from_reader(\"invalid escape sequence \\\\\" + c, self)\n escaping = False\n return 0\n\n return self.read_string_until(quote_closing, prefix, \"f\" in prefix.lower())\n\n ###\n # Special annotations\n ###\n\n @reader_for(\"'\", (\"quote\",))\n @reader_for(\"`\", (\"quasiquote\",))\n def tag_as(root):\n return lambda self, _: mkexpr(root, self.parse_one_form())\n\n @reader_for(\"~\")\n def unquote(self, key):\n return mkexpr(\n \"unquote\" + (\"-splice\" if self.peek_and_getc(\"@\") else \"\"),\n self.parse_one_form(),\n )\n\n ###\n # Sequences\n ###\n\n @reader_for(\"(\", (Expression, \")\"))\n @reader_for(\"[\", (List, \"]\"))\n @reader_for(\"{\", (Dict, \"}\"))\n @reader_for(\"#{\", (Set, \"}\"))\n @reader_for(\"#(\", (Tuple, \")\"))\n def sequence(seq_type, closer):\n return lambda self, _: seq_type(self.parse_forms_until(closer))\n\n ###\n # Reader tag-macros\n ###\n\n @reader_for(\"#\")\n def tag_dispatch(self, key):\n \"\"\"General handler for reader macros (and tag macros).\n\n Reads a full identifier after the `#` and calls the corresponding handler\n (this allows, e.g., `#reads-multiple-forms foo bar baz`).\n \"\"\"\n\n if not self.peekc().strip():\n raise PrematureEndOfInput.from_reader(\n \"Premature end of input while attempting dispatch\", self\n )\n\n # try dispatching tagged ident\n ident = self.read_ident() or self.getc()\n if ident in self.reader_macros:\n tree = self.reader_macros[ident](self, ident)\n return as_model(tree) if tree is not None else None\n\n raise LexException.from_reader(\n f\"reader macro '{key + ident}' is not defined\", self\n )\n\n @reader_for(\"#_\")\n def discard(self, _):\n \"\"\"Discards the next parsed form.\"\"\"\n self.parse_one_form()\n return None\n\n @reader_for(\"#*\")\n @reader_for(\"#**\")\n def hash_star(self, stars):\n \"\"\"Unpacking forms `#*` and `#**`, corresponding to `*` and `**` in Python.\"\"\"\n return mkexpr(\n \"unpack-\" + {\"*\": \"iterable\", \"**\": \"mapping\"}[stars],\n self.parse_one_form(),\n )\n\n @reader_for(\"#^\")\n def annotate(self, _):\n \"\"\"Annotate a symbol, usually with a type.\"\"\"\n typ = self.parse_one_form()\n target = self.parse_one_form()\n return mkexpr(\"annotate\", target, typ)\n\n ###\n # Strings\n # (these are more complicated because f-strings\n # form their own sublanguage)\n ###\n\n @reader_for(\"#[\")\n def bracketed_string(self, _):\n \"\"\"Bracketed strings. See the Hy docs for full details.\"\"\"\n delim = []\n for c in self.chars():\n if c == \"[\":\n break\n elif c == \"]\":\n raise LexException.from_reader(\n \"Ran into a ']' where it wasn't expected.\", self\n )\n delim.append(c)\n delim = \"\".join(delim)\n is_fstring = delim == \"f\" or delim.startswith(\"f-\")\n\n # discard single initial newline, if any, accounting for all\n # three styles of newline\n self.peek_and_getc(\"\\x0d\")\n self.peek_and_getc(\"\\x0a\")\n\n index = -1\n\n def delim_closing(c):\n nonlocal index\n if c == \"]\":\n if index == len(delim):\n # this is the second bracket at the end of the delim\n return len(delim) + 2\n else:\n # reset state, this may be the first bracket of closing delim\n index = 0\n elif 0 <= index <= len(delim):\n # we're inside a possible closing delim\n if index < len(delim) and c == delim[index]:\n index += 1\n else:\n # failed delim, reset state\n index = -1\n return 0\n\n return self.read_string_until(delim_closing, \"fr\" if is_fstring else None, is_fstring, brackets=delim)\n\n def read_string_until(self, closing, prefix, is_fstring, **kwargs):\n if is_fstring:\n components = self.read_fcomponents_until(closing, prefix)\n return FString(components, **kwargs)\n s = self.read_chars_until(closing, prefix, is_fstring=False)\n return (Bytes if isinstance(s, bytes) else String)(s, **kwargs)\n\n def read_chars_until(self, closing, prefix, is_fstring):\n s = []\n for c in self.chars():\n s.append(c)\n # check if c is closing\n n_closing_chars = closing(c)\n if n_closing_chars:\n # string has ended\n s = s[:-n_closing_chars]\n break\n # check if c is start of component\n if is_fstring and c == \"{\" and s[-3:] != [\"\\\\\", \"N\", \"{\"]:\n # check and handle \"{{\"\n if self.peek_and_getc(\"{\"):\n s.append(\"{\")\n else:\n # remove \"{\" from end of string component\n s.pop()\n break\n res = \"\".join(s).replace(\"\\x0d\\x0a\", \"\\x0a\").replace(\"\\x0d\", \"\\x0a\")\n\n if prefix is not None:\n res = eval(f'{prefix}\"\"\"{res}\"\"\"')\n if is_fstring:\n return res, n_closing_chars\n return res\n\n def read_fcomponents_until(self, closing, prefix):\n components = []\n start = self.pos\n while True:\n s, closed = self.read_chars_until(closing, prefix, is_fstring=True)\n if s:\n components.append(self.fill_pos(String(s), start))\n if closed:\n break\n components.extend(self.read_fcomponent(prefix))\n return components\n\n def read_fcomponent(self, prefix):\n \"\"\"May return one or two components, since the `=` debugging syntax\n will create a String component.\"\"\"\n start = self.pos\n values = []\n conversion = None\n has_debug = False\n\n # read the expression, saving the text verbatim\n # in case we encounter debug `=`\n space_before = self.slurp_space()\n with self.saving_chars() as form_text:\n model = self.parse_one_form()\n space_between = self.slurp_space()\n\n # check for and handle debug syntax:\n # we emt the verbatim text before we emit the value\n if self.peek_and_getc(\"=\"):\n has_debug = True\n space_after = self.slurp_space()\n dbg_prefix = (\n space_before + \"\".join(form_text) + space_between + \"=\" + space_after\n )\n values.append(self.fill_pos(String(dbg_prefix), start))\n\n # handle conversion code\n if self.peek_and_getc(\"!\"):\n conversion = self.getc()\n self.slurp_space()\n\n def component_closing(c):\n if c == \"}\":\n return 1\n return 0\n\n # handle formatting options\n format_components = []\n if self.peek_and_getc(\":\"):\n format_components = self.read_fcomponents_until(component_closing, prefix)\n else:\n if has_debug and conversion is None:\n conversion = \"r\"\n if not self.getc() == \"}\":\n raise LexException.from_reader(\"f-string: trailing junk in field\", self)\n return values + [\n self.fill_pos(FComponent((model, *format_components), conversion), start)\n ]\n","path":"hy/reader/hy_reader.py"}],"string":"[\n {\n \"content\": \"\\\"Character reader for parsing Hy source.\\\"\\n\\nfrom itertools import islice\\n\\nimport hy\\nfrom hy.models import (\\n Bytes,\\n Complex,\\n Dict,\\n Expression,\\n FComponent,\\n Float,\\n FString,\\n Integer,\\n Keyword,\\n List,\\n Set,\\n String,\\n Symbol,\\n Tuple,\\n as_model,\\n)\\n\\nfrom .exceptions import LexException, PrematureEndOfInput\\nfrom .mangling import mangle\\nfrom .reader import Reader, isnormalizedspace\\n\\n\\ndef sym(name):\\n return Symbol(name, from_parser=True)\\n\\n\\n# Note: This is subtly different from\\n# the `mkexpr` in hy/compiler.py !\\ndef mkexpr(root, *args):\\n return Expression((sym(root) if isinstance(root, str) else root, *args))\\n\\n\\ndef as_identifier(ident, reader=None):\\n \\\"\\\"\\\"Generate a Hy model from an identifier.\\n\\n Also verifies the syntax of dot notation and validity of symbol names.\\n\\n Parameters\\n ----------\\n ident : str\\n Text to convert.\\n\\n reader : Reader, optional\\n The reader to use, if any; used for generating position data for errors.\\n\\n Returns\\n -------\\n out : a hy.models.Object subtype corresponding to the parsed text.\\n \\\"\\\"\\\"\\n try:\\n return Integer(ident)\\n except ValueError:\\n pass\\n try:\\n return Float(ident)\\n except ValueError:\\n pass\\n if ident not in (\\\"j\\\", \\\"J\\\"):\\n try:\\n return Complex(ident)\\n except ValueError:\\n pass\\n\\n if \\\".\\\" in ident:\\n if not ident.strip(\\\".\\\"):\\n # It's all dots. Return it as a symbol.\\n return sym(ident)\\n\\n def err(msg):\\n raise (\\n ValueError(msg)\\n if reader is None\\n else LexException.from_reader(msg, reader)\\n )\\n\\n if ident.lstrip(\\\".\\\").find(\\\"..\\\") > 0:\\n err(\\n \\\"In a dotted identifier, multiple dots in a row are only allowed at the start\\\"\\n )\\n if ident.endswith(\\\".\\\"):\\n err(\\\"A dotted identifier can't end with a dot\\\")\\n head = \\\".\\\" * (len(ident) - len(ident.lstrip(\\\".\\\")))\\n args = [as_identifier(a, reader=reader) for a in ident.lstrip(\\\".\\\").split(\\\".\\\")]\\n if any(not isinstance(a, Symbol) for a in args):\\n err(\\\"The parts of a dotted identifier must be symbols\\\")\\n return (\\n mkexpr(sym(\\\".\\\"), *args)\\n if head == \\\"\\\"\\n else mkexpr(head, Symbol(\\\"None\\\"), *args)\\n )\\n\\n if reader is None:\\n if (\\n not ident\\n or ident[0] in \\\":#\\\"\\n or any(isnormalizedspace(c) for c in ident)\\n or HyReader.NON_IDENT.intersection(ident)\\n ):\\n raise ValueError(f\\\"Syntactically illegal symbol: {ident!r}\\\")\\n\\n return sym(ident)\\n\\n\\nclass HyReader(Reader):\\n \\\"\\\"\\\"A modular reader for Hy source.\\\"\\\"\\\"\\n\\n ###\\n # Components necessary for Reader implementation\\n ###\\n\\n NON_IDENT = set(\\\"()[]{};\\\\\\\"'`~\\\")\\n\\n def __init__(self):\\n super().__init__()\\n\\n # move any reader macros declared using\\n # `reader_for(\\\"#...\\\")` to the macro table\\n self.reader_macros = {}\\n for tag in list(self.reader_table.keys()):\\n if tag[0] == '#' and tag[1:]:\\n self.reader_macros[tag[1:]] = self.reader_table.pop(tag)\\n\\n\\n def fill_pos(self, model, start):\\n \\\"\\\"\\\"Attach line/col information to a model.\\n\\n Sets the end location of `model` to the current cursor position.\\n\\n Args:\\n model (hy.models.Object): model to set line/col info for.\\n start (tuple[int, int]): (line, column) tuple indicating the start\\n location to assign to `model`.\\n \\\"\\\"\\\"\\n model.start_line, model.start_column = start\\n model.end_line, model.end_column = self.pos\\n return model.replace(model)\\n # `replace` will recurse into submodels and set any model\\n # positions that are still unset the same way.\\n\\n def read_default(self, key):\\n \\\"\\\"\\\"Default reader handler when nothing in the table matches.\\n\\n Try to read an identifier. If there's a double-quote immediately\\n following, then instead parse it as a string with the given prefix (e.g.,\\n `r\\\"...\\\"`).\\n \\\"\\\"\\\"\\n ident = key + self.read_ident()\\n if self.peek_and_getc('\\\"'):\\n return self.prefixed_string('\\\"', ident)\\n return as_identifier(ident, reader=self)\\n\\n def parse(self, stream, filename=None, skip_shebang=False):\\n \\\"\\\"\\\"Yields all `hy.models.Object`'s in `source`\\n\\n Additionally exposes `self` as ``hy.&reader`` during read/compile time.\\n\\n Args:\\n source:\\n Hy source to be parsed.\\n filename (str | None):\\n Filename to use for error messages. If `None` then previously\\n set filename is used.\\n skip_shebang:\\n Whether to detect a skip a shebang line at the start.\\n \\\"\\\"\\\"\\n self._set_source(stream, filename)\\n\\n if skip_shebang and \\\"\\\".join(\\n islice(self.peeking(eof_ok = True), len(\\\"#!\\\"))) == \\\"#!\\\":\\n for c in self.chars():\\n if c == \\\"\\\\n\\\":\\n break\\n\\n rname = mangle(\\\"&reader\\\")\\n old_reader = getattr(hy, rname, None)\\n setattr(hy, rname, self)\\n\\n try:\\n yield from self.parse_forms_until(\\\"\\\")\\n finally:\\n if old_reader is None:\\n delattr(hy, rname)\\n else:\\n setattr(hy, rname, old_reader)\\n\\n ###\\n # Reading forms\\n ###\\n\\n def try_parse_one_form(self):\\n \\\"\\\"\\\"Attempt to parse a single Hy form.\\n\\n Read one (non-space) character from the stream, then call the\\n corresponding handler.\\n\\n Returns:\\n hy.models.Object | None:\\n Model optionally returned by the called handler. Handlers may\\n return `None` to signify no parsed form (e.g., for comments).\\n\\n Raises:\\n PrematureEndOfInput: If the reader hits the end of the file before\\n fully parsing a form.\\n LexException: If there is an error during form parsing.\\n \\\"\\\"\\\"\\n try:\\n self.slurp_space()\\n c = self.getc()\\n start = self._pos\\n if not c:\\n raise PrematureEndOfInput.from_reader(\\n \\\"Premature end of input while attempting to parse one form\\\", self\\n )\\n handler = self.reader_table.get(c)\\n model = handler(self, c) if handler else self.read_default(c)\\n return self.fill_pos(model, start) if model is not None else None\\n except LexException:\\n raise\\n except Exception as e:\\n raise LexException.from_reader(\\n str(e) or \\\"Exception thrown attempting to parse one form\\\", self\\n )\\n\\n def parse_one_form(self):\\n \\\"\\\"\\\"Read from the stream until a form is parsed.\\n\\n Guaranteed to return a model (i.e., skips over comments).\\n\\n Returns:\\n hy.models.Object\\n \\\"\\\"\\\"\\n model = None\\n while model is None:\\n model = self.try_parse_one_form()\\n return model\\n\\n def parse_forms_until(self, closer):\\n \\\"\\\"\\\"Yields `hy.models.Object`'s until character `closer` is seen.\\n\\n Useful for reading a sequence such as s-exprs or lists.\\n \\\"\\\"\\\"\\n while True:\\n self.slurp_space()\\n if self.peek_and_getc(closer):\\n break\\n model = self.try_parse_one_form()\\n if model is not None:\\n yield model\\n\\n ###\\n # Basic atoms\\n ###\\n\\n @reader_for(\\\")\\\")\\n @reader_for(\\\"]\\\")\\n @reader_for(\\\"}\\\")\\n def INVALID(self, key):\\n raise LexException.from_reader(\\n f\\\"Ran into a '{key}' where it wasn't expected.\\\", self\\n )\\n\\n @reader_for(\\\";\\\")\\n def line_comment(self, _):\\n any(c == \\\"\\\\n\\\" for c in self.chars(eof_ok=True))\\n return None\\n\\n @reader_for(\\\":\\\")\\n def keyword(self, _):\\n ident = self.read_ident()\\n if \\\".\\\" in ident:\\n raise LexException.from_reader(\\n \\\"Cannot access attribute on anything other\\\"\\n \\\" than a name (in order to get attributes of expressions,\\\"\\n \\\" use `(. <expression> <attr>)` or `(.<attr> <expression>)`)\\\",\\n self,\\n )\\n return Keyword(ident, from_parser=True)\\n\\n @reader_for('\\\"')\\n def prefixed_string(self, _, prefix=\\\"\\\"):\\n prefix_chars = set(prefix)\\n if (\\n len(prefix_chars) != len(prefix)\\n or prefix_chars - set(\\\"bfr\\\")\\n or set(\\\"bf\\\") <= prefix_chars\\n ):\\n raise LexException.from_reader(f\\\"invalid string prefix {prefix!r}\\\", self)\\n\\n escaping = False\\n\\n def quote_closing(c):\\n nonlocal escaping\\n if c == \\\"\\\\\\\\\\\":\\n escaping = not escaping\\n return 0\\n if c == '\\\"' and not escaping:\\n return 1\\n if (\\n escaping\\n and \\\"r\\\" not in prefix\\n and\\n # https://docs.python.org/3/reference/lexical_analysis.html#string-and-bytes-literals\\n c\\n not in (\\\"\\\\n\\\\r\\\\\\\\'\\\\\\\"abfnrtv01234567x\\\" + (\\\"\\\" if \\\"b\\\" in prefix else \\\"NuU\\\"))\\n ):\\n raise LexException.from_reader(\\\"invalid escape sequence \\\\\\\\\\\" + c, self)\\n escaping = False\\n return 0\\n\\n return self.read_string_until(quote_closing, prefix, \\\"f\\\" in prefix.lower())\\n\\n ###\\n # Special annotations\\n ###\\n\\n @reader_for(\\\"'\\\", (\\\"quote\\\",))\\n @reader_for(\\\"`\\\", (\\\"quasiquote\\\",))\\n def tag_as(root):\\n return lambda self, _: mkexpr(root, self.parse_one_form())\\n\\n @reader_for(\\\"~\\\")\\n def unquote(self, key):\\n return mkexpr(\\n \\\"unquote\\\" + (\\\"-splice\\\" if self.peek_and_getc(\\\"@\\\") else \\\"\\\"),\\n self.parse_one_form(),\\n )\\n\\n ###\\n # Sequences\\n ###\\n\\n @reader_for(\\\"(\\\", (Expression, \\\")\\\"))\\n @reader_for(\\\"[\\\", (List, \\\"]\\\"))\\n @reader_for(\\\"{\\\", (Dict, \\\"}\\\"))\\n @reader_for(\\\"#{\\\", (Set, \\\"}\\\"))\\n @reader_for(\\\"#(\\\", (Tuple, \\\")\\\"))\\n def sequence(seq_type, closer):\\n return lambda self, _: seq_type(self.parse_forms_until(closer))\\n\\n ###\\n # Reader tag-macros\\n ###\\n\\n @reader_for(\\\"#\\\")\\n def tag_dispatch(self, key):\\n \\\"\\\"\\\"General handler for reader macros (and tag macros).\\n\\n Reads a full identifier after the `#` and calls the corresponding handler\\n (this allows, e.g., `#reads-multiple-forms foo bar baz`).\\n \\\"\\\"\\\"\\n\\n if not self.peekc().strip():\\n raise PrematureEndOfInput.from_reader(\\n \\\"Premature end of input while attempting dispatch\\\", self\\n )\\n\\n # try dispatching tagged ident\\n ident = self.read_ident() or self.getc()\\n if ident in self.reader_macros:\\n tree = self.reader_macros[ident](self, ident)\\n return as_model(tree) if tree is not None else None\\n\\n raise LexException.from_reader(\\n f\\\"reader macro '{key + ident}' is not defined\\\", self\\n )\\n\\n @reader_for(\\\"#_\\\")\\n def discard(self, _):\\n \\\"\\\"\\\"Discards the next parsed form.\\\"\\\"\\\"\\n self.parse_one_form()\\n return None\\n\\n @reader_for(\\\"#*\\\")\\n @reader_for(\\\"#**\\\")\\n def hash_star(self, stars):\\n \\\"\\\"\\\"Unpacking forms `#*` and `#**`, corresponding to `*` and `**` in Python.\\\"\\\"\\\"\\n return mkexpr(\\n \\\"unpack-\\\" + {\\\"*\\\": \\\"iterable\\\", \\\"**\\\": \\\"mapping\\\"}[stars],\\n self.parse_one_form(),\\n )\\n\\n @reader_for(\\\"#^\\\")\\n def annotate(self, _):\\n \\\"\\\"\\\"Annotate a symbol, usually with a type.\\\"\\\"\\\"\\n typ = self.parse_one_form()\\n target = self.parse_one_form()\\n return mkexpr(\\\"annotate\\\", target, typ)\\n\\n ###\\n # Strings\\n # (these are more complicated because f-strings\\n # form their own sublanguage)\\n ###\\n\\n @reader_for(\\\"#[\\\")\\n def bracketed_string(self, _):\\n \\\"\\\"\\\"Bracketed strings. See the Hy docs for full details.\\\"\\\"\\\"\\n delim = []\\n for c in self.chars():\\n if c == \\\"[\\\":\\n break\\n elif c == \\\"]\\\":\\n raise LexException.from_reader(\\n \\\"Ran into a ']' where it wasn't expected.\\\", self\\n )\\n delim.append(c)\\n delim = \\\"\\\".join(delim)\\n is_fstring = delim == \\\"f\\\" or delim.startswith(\\\"f-\\\")\\n\\n # discard single initial newline, if any, accounting for all\\n # three styles of newline\\n self.peek_and_getc(\\\"\\\\x0d\\\")\\n self.peek_and_getc(\\\"\\\\x0a\\\")\\n\\n index = -1\\n\\n def delim_closing(c):\\n nonlocal index\\n if c == \\\"]\\\":\\n if index == len(delim):\\n # this is the second bracket at the end of the delim\\n return len(delim) + 2\\n else:\\n # reset state, this may be the first bracket of closing delim\\n index = 0\\n elif 0 <= index <= len(delim):\\n # we're inside a possible closing delim\\n if index < len(delim) and c == delim[index]:\\n index += 1\\n else:\\n # failed delim, reset state\\n index = -1\\n return 0\\n\\n return self.read_string_until(delim_closing, \\\"fr\\\" if is_fstring else None, is_fstring, brackets=delim)\\n\\n def read_string_until(self, closing, prefix, is_fstring, **kwargs):\\n if is_fstring:\\n components = self.read_fcomponents_until(closing, prefix)\\n return FString(components, **kwargs)\\n s = self.read_chars_until(closing, prefix, is_fstring=False)\\n return (Bytes if isinstance(s, bytes) else String)(s, **kwargs)\\n\\n def read_chars_until(self, closing, prefix, is_fstring):\\n s = []\\n for c in self.chars():\\n s.append(c)\\n # check if c is closing\\n n_closing_chars = closing(c)\\n if n_closing_chars:\\n # string has ended\\n s = s[:-n_closing_chars]\\n break\\n # check if c is start of component\\n if is_fstring and c == \\\"{\\\" and s[-3:] != [\\\"\\\\\\\\\\\", \\\"N\\\", \\\"{\\\"]:\\n # check and handle \\\"{{\\\"\\n if self.peek_and_getc(\\\"{\\\"):\\n s.append(\\\"{\\\")\\n else:\\n # remove \\\"{\\\" from end of string component\\n s.pop()\\n break\\n res = \\\"\\\".join(s).replace(\\\"\\\\x0d\\\\x0a\\\", \\\"\\\\x0a\\\").replace(\\\"\\\\x0d\\\", \\\"\\\\x0a\\\")\\n\\n if prefix is not None:\\n res = eval(f'{prefix}\\\"\\\"\\\"{res}\\\"\\\"\\\"')\\n if is_fstring:\\n return res, n_closing_chars\\n return res\\n\\n def read_fcomponents_until(self, closing, prefix):\\n components = []\\n start = self.pos\\n while True:\\n s, closed = self.read_chars_until(closing, prefix, is_fstring=True)\\n if s:\\n components.append(self.fill_pos(String(s), start))\\n if closed:\\n break\\n components.extend(self.read_fcomponent(prefix))\\n return components\\n\\n def read_fcomponent(self, prefix):\\n \\\"\\\"\\\"May return one or two components, since the `=` debugging syntax\\n will create a String component.\\\"\\\"\\\"\\n start = self.pos\\n values = []\\n conversion = None\\n has_debug = False\\n\\n # read the expression, saving the text verbatim\\n # in case we encounter debug `=`\\n space_before = self.slurp_space()\\n with self.saving_chars() as form_text:\\n model = self.parse_one_form()\\n space_between = self.slurp_space()\\n\\n # check for and handle debug syntax:\\n # we emt the verbatim text before we emit the value\\n if self.peek_and_getc(\\\"=\\\"):\\n has_debug = True\\n space_after = self.slurp_space()\\n dbg_prefix = (\\n space_before + \\\"\\\".join(form_text) + space_between + \\\"=\\\" + space_after\\n )\\n values.append(self.fill_pos(String(dbg_prefix), start))\\n\\n # handle conversion code\\n if self.peek_and_getc(\\\"!\\\"):\\n conversion = self.getc()\\n self.slurp_space()\\n\\n def component_closing(c):\\n if c == \\\"}\\\":\\n return 1\\n return 0\\n\\n # handle formatting options\\n format_components = []\\n if self.peek_and_getc(\\\":\\\"):\\n format_components = self.read_fcomponents_until(component_closing, prefix)\\n else:\\n if has_debug and conversion is None:\\n conversion = \\\"r\\\"\\n if not self.getc() == \\\"}\\\":\\n raise LexException.from_reader(\\\"f-string: trailing junk in field\\\", self)\\n return values + [\\n self.fill_pos(FComponent((model, *format_components), conversion), start)\\n ]\\n\",\n \"path\": \"hy/reader/hy_reader.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/NEWS.rst b/NEWS.rst\nindex cbd903774..d4765e986 100644\n--- a/NEWS.rst\n+++ b/NEWS.rst\n@@ -29,6 +29,8 @@ Bug Fixes\n * The parser no longer looks for shebangs in the REPL or `hy -c`.\n * `require` with relative module names should now work correctly with\n `hy -m`, as well as `hy2py`'s recursive mode.\n+* `hy.models.Symbol` no longer allows constructing a symbol beginning\n+ with `#`.\n \n New Features\n ------------------------------\ndiff --git a/hy/reader/hy_reader.py b/hy/reader/hy_reader.py\nindex 016b94e50..923b820e2 100644\n--- a/hy/reader/hy_reader.py\n+++ b/hy/reader/hy_reader.py\n@@ -98,7 +98,7 @@ def err(msg):\n if reader is None:\n if (\n not ident\n- or ident[:1] == \":\"\n+ or ident[0] in \":#\"\n or any(isnormalizedspace(c) for c in ident)\n or HyReader.NON_IDENT.intersection(ident)\n ):\ndiff --git a/tests/macros/test_macro_processor.py b/tests/macros/test_macro_processor.py\nindex 5fb317911..464dcca81 100644\n--- a/tests/macros/test_macro_processor.py\n+++ b/tests/macros/test_macro_processor.py\n@@ -55,7 +55,7 @@ def test_macroexpand_nan():\n \n def test_macroexpand_source_data():\n # https://github.com/hylang/hy/issues/1944\n- ast = Expression([Symbol(\"#@\"), String(\"a\")])\n+ ast = Expression([Symbol(\"when\"), String(\"a\")])\n ast.start_line = 3\n ast.start_column = 5\n bad = macroexpand_1(ast, \"hy.core.macros\")\ndiff --git a/tests/test_models.py b/tests/test_models.py\nindex c000e8bd1..9ad851545 100644\n--- a/tests/test_models.py\n+++ b/tests/test_models.py\n@@ -28,7 +28,8 @@ def test_symbol_or_keyword():\n for x in (\"foo\", \"foo-bar\", \"foo_bar\", \"✈é😂⁂\"):\n assert str(Symbol(x)) == x\n assert Keyword(x).name == x\n- for x in (\"\", \":foo\", \"5\"):\n+ for x in (\"\", \":foo\", \"5\", \"#foo\"):\n+ # https://github.com/hylang/hy/issues/2383\n with pytest.raises(ValueError):\n Symbol(x)\n assert Keyword(x).name == x\n"}}},{"rowIdx":2686,"cells":{"in_source_id":{"kind":"string","value":"tobymao__sqlglot-1279"},"issue":{"kind":"string","value":"type `TIMESTAMPTZ` doesn't exist in sparksql\nsqlglot transpiles a trino type like `timestamp(6) with time zone` as the hive type `TIMESTAMPTZ` for spark, which isn't a spark type. I'd be happy to submit a PR if there's advice about how to address this.\r\n\r\n```\r\n>>> sqlglot.transpile('select cast(created as timestamp(6) with time zone) created from some_table', read=\"trino\", write=\"spark\")\r\n['SELECT CAST(created AS TIMESTAMPTZ) AS created FROM some_table']\r\n```\n"},"before_files":{"kind":"list like","value":[{"content":"from __future__ import annotations\n\nfrom sqlglot import exp, generator, parser, tokens, transforms\nfrom sqlglot.dialects.dialect import (\n Dialect,\n approx_count_distinct_sql,\n create_with_partitions_sql,\n format_time_lambda,\n if_sql,\n locate_to_strposition,\n min_or_least,\n no_ilike_sql,\n no_recursive_cte_sql,\n no_safe_divide_sql,\n no_trycast_sql,\n rename_func,\n strposition_to_locate_sql,\n struct_extract_sql,\n timestrtotime_sql,\n var_map_sql,\n)\nfrom sqlglot.helper import seq_get\nfrom sqlglot.parser import parse_var_map\nfrom sqlglot.tokens import TokenType\n\n# (FuncType, Multiplier)\nDATE_DELTA_INTERVAL = {\n \"YEAR\": (\"ADD_MONTHS\", 12),\n \"MONTH\": (\"ADD_MONTHS\", 1),\n \"QUARTER\": (\"ADD_MONTHS\", 3),\n \"WEEK\": (\"DATE_ADD\", 7),\n \"DAY\": (\"DATE_ADD\", 1),\n}\n\nDIFF_MONTH_SWITCH = (\"YEAR\", \"QUARTER\", \"MONTH\")\n\n\ndef _add_date_sql(self, expression):\n unit = expression.text(\"unit\").upper()\n func, multiplier = DATE_DELTA_INTERVAL.get(unit, (\"DATE_ADD\", 1))\n modified_increment = (\n int(expression.text(\"expression\")) * multiplier\n if expression.expression.is_number\n else expression.expression\n )\n modified_increment = exp.Literal.number(modified_increment)\n return self.func(func, expression.this, modified_increment.this)\n\n\ndef _date_diff_sql(self, expression):\n unit = expression.text(\"unit\").upper()\n sql_func = \"MONTHS_BETWEEN\" if unit in DIFF_MONTH_SWITCH else \"DATEDIFF\"\n _, multiplier = DATE_DELTA_INTERVAL.get(unit, (\"\", 1))\n multiplier_sql = f\" / {multiplier}\" if multiplier > 1 else \"\"\n diff_sql = f\"{sql_func}({self.format_args(expression.this, expression.expression)})\"\n return f\"{diff_sql}{multiplier_sql}\"\n\n\ndef _array_sort(self, expression):\n if expression.expression:\n self.unsupported(\"Hive SORT_ARRAY does not support a comparator\")\n return f\"SORT_ARRAY({self.sql(expression, 'this')})\"\n\n\ndef _property_sql(self, expression):\n return f\"'{expression.name}'={self.sql(expression, 'value')}\"\n\n\ndef _str_to_unix(self, expression):\n return self.func(\"UNIX_TIMESTAMP\", expression.this, _time_format(self, expression))\n\n\ndef _str_to_date(self, expression):\n this = self.sql(expression, \"this\")\n time_format = self.format_time(expression)\n if time_format not in (Hive.time_format, Hive.date_format):\n this = f\"FROM_UNIXTIME(UNIX_TIMESTAMP({this}, {time_format}))\"\n return f\"CAST({this} AS DATE)\"\n\n\ndef _str_to_time(self, expression):\n this = self.sql(expression, \"this\")\n time_format = self.format_time(expression)\n if time_format not in (Hive.time_format, Hive.date_format):\n this = f\"FROM_UNIXTIME(UNIX_TIMESTAMP({this}, {time_format}))\"\n return f\"CAST({this} AS TIMESTAMP)\"\n\n\ndef _time_format(self, expression):\n time_format = self.format_time(expression)\n if time_format == Hive.time_format:\n return None\n return time_format\n\n\ndef _time_to_str(self, expression):\n this = self.sql(expression, \"this\")\n time_format = self.format_time(expression)\n return f\"DATE_FORMAT({this}, {time_format})\"\n\n\ndef _to_date_sql(self, expression):\n this = self.sql(expression, \"this\")\n time_format = self.format_time(expression)\n if time_format and time_format not in (Hive.time_format, Hive.date_format):\n return f\"TO_DATE({this}, {time_format})\"\n return f\"TO_DATE({this})\"\n\n\ndef _unnest_to_explode_sql(self, expression):\n unnest = expression.this\n if isinstance(unnest, exp.Unnest):\n alias = unnest.args.get(\"alias\")\n udtf = exp.Posexplode if unnest.args.get(\"ordinality\") else exp.Explode\n return \"\".join(\n self.sql(\n exp.Lateral(\n this=udtf(this=expression),\n view=True,\n alias=exp.TableAlias(this=alias.this, columns=[column]),\n )\n )\n for expression, column in zip(unnest.expressions, alias.columns if alias else [])\n )\n return self.join_sql(expression)\n\n\ndef _index_sql(self, expression):\n this = self.sql(expression, \"this\")\n table = self.sql(expression, \"table\")\n columns = self.sql(expression, \"columns\")\n return f\"{this} ON TABLE {table} {columns}\"\n\n\nclass Hive(Dialect):\n alias_post_tablesample = True\n\n time_mapping = {\n \"y\": \"%Y\",\n \"Y\": \"%Y\",\n \"YYYY\": \"%Y\",\n \"yyyy\": \"%Y\",\n \"YY\": \"%y\",\n \"yy\": \"%y\",\n \"MMMM\": \"%B\",\n \"MMM\": \"%b\",\n \"MM\": \"%m\",\n \"M\": \"%-m\",\n \"dd\": \"%d\",\n \"d\": \"%-d\",\n \"HH\": \"%H\",\n \"H\": \"%-H\",\n \"hh\": \"%I\",\n \"h\": \"%-I\",\n \"mm\": \"%M\",\n \"m\": \"%-M\",\n \"ss\": \"%S\",\n \"s\": \"%-S\",\n \"SSSSSS\": \"%f\",\n \"a\": \"%p\",\n \"DD\": \"%j\",\n \"D\": \"%-j\",\n \"E\": \"%a\",\n \"EE\": \"%a\",\n \"EEE\": \"%a\",\n \"EEEE\": \"%A\",\n }\n\n date_format = \"'yyyy-MM-dd'\"\n dateint_format = \"'yyyyMMdd'\"\n time_format = \"'yyyy-MM-dd HH:mm:ss'\"\n\n class Tokenizer(tokens.Tokenizer):\n QUOTES = [\"'\", '\"']\n IDENTIFIERS = [\"`\"]\n STRING_ESCAPES = [\"\\\\\"]\n ENCODE = \"utf-8\"\n\n KEYWORDS = {\n **tokens.Tokenizer.KEYWORDS,\n \"ADD ARCHIVE\": TokenType.COMMAND,\n \"ADD ARCHIVES\": TokenType.COMMAND,\n \"ADD FILE\": TokenType.COMMAND,\n \"ADD FILES\": TokenType.COMMAND,\n \"ADD JAR\": TokenType.COMMAND,\n \"ADD JARS\": TokenType.COMMAND,\n \"MSCK REPAIR\": TokenType.COMMAND,\n \"WITH SERDEPROPERTIES\": TokenType.SERDE_PROPERTIES,\n }\n\n NUMERIC_LITERALS = {\n \"L\": \"BIGINT\",\n \"S\": \"SMALLINT\",\n \"Y\": \"TINYINT\",\n \"D\": \"DOUBLE\",\n \"F\": \"FLOAT\",\n \"BD\": \"DECIMAL\",\n }\n\n IDENTIFIER_CAN_START_WITH_DIGIT = True\n\n class Parser(parser.Parser):\n STRICT_CAST = False\n\n FUNCTIONS = {\n **parser.Parser.FUNCTIONS, # type: ignore\n \"APPROX_COUNT_DISTINCT\": exp.ApproxDistinct.from_arg_list,\n \"COLLECT_LIST\": exp.ArrayAgg.from_arg_list,\n \"DATE_ADD\": lambda args: exp.TsOrDsAdd(\n this=seq_get(args, 0),\n expression=seq_get(args, 1),\n unit=exp.Literal.string(\"DAY\"),\n ),\n \"DATEDIFF\": lambda args: exp.DateDiff(\n this=exp.TsOrDsToDate(this=seq_get(args, 0)),\n expression=exp.TsOrDsToDate(this=seq_get(args, 1)),\n ),\n \"DATE_SUB\": lambda args: exp.TsOrDsAdd(\n this=seq_get(args, 0),\n expression=exp.Mul(\n this=seq_get(args, 1),\n expression=exp.Literal.number(-1),\n ),\n unit=exp.Literal.string(\"DAY\"),\n ),\n \"DATE_FORMAT\": lambda args: format_time_lambda(exp.TimeToStr, \"hive\")(\n [\n exp.TimeStrToTime(this=seq_get(args, 0)),\n seq_get(args, 1),\n ]\n ),\n \"DAY\": lambda args: exp.Day(this=exp.TsOrDsToDate(this=seq_get(args, 0))),\n \"FROM_UNIXTIME\": format_time_lambda(exp.UnixToStr, \"hive\", True),\n \"GET_JSON_OBJECT\": exp.JSONExtractScalar.from_arg_list,\n \"LOCATE\": locate_to_strposition,\n \"LOG\": (\n lambda args: exp.Log.from_arg_list(args)\n if len(args) > 1\n else exp.Ln.from_arg_list(args)\n ),\n \"MAP\": parse_var_map,\n \"MONTH\": lambda args: exp.Month(this=exp.TsOrDsToDate.from_arg_list(args)),\n \"PERCENTILE\": exp.Quantile.from_arg_list,\n \"PERCENTILE_APPROX\": exp.ApproxQuantile.from_arg_list,\n \"COLLECT_SET\": exp.SetAgg.from_arg_list,\n \"SIZE\": exp.ArraySize.from_arg_list,\n \"SPLIT\": exp.RegexpSplit.from_arg_list,\n \"TO_DATE\": format_time_lambda(exp.TsOrDsToDate, \"hive\"),\n \"UNIX_TIMESTAMP\": format_time_lambda(exp.StrToUnix, \"hive\", True),\n \"YEAR\": lambda args: exp.Year(this=exp.TsOrDsToDate.from_arg_list(args)),\n }\n\n PROPERTY_PARSERS = {\n **parser.Parser.PROPERTY_PARSERS, # type: ignore\n \"WITH SERDEPROPERTIES\": lambda self: exp.SerdeProperties(\n expressions=self._parse_wrapped_csv(self._parse_property)\n ),\n }\n\n class Generator(generator.Generator):\n TYPE_MAPPING = {\n **generator.Generator.TYPE_MAPPING, # type: ignore\n exp.DataType.Type.TEXT: \"STRING\",\n exp.DataType.Type.DATETIME: \"TIMESTAMP\",\n exp.DataType.Type.VARBINARY: \"BINARY\",\n }\n\n TRANSFORMS = {\n **generator.Generator.TRANSFORMS, # type: ignore\n **transforms.UNALIAS_GROUP, # type: ignore\n exp.Property: _property_sql,\n exp.ApproxDistinct: approx_count_distinct_sql,\n exp.ArrayAgg: rename_func(\"COLLECT_LIST\"),\n exp.ArrayConcat: rename_func(\"CONCAT\"),\n exp.ArraySize: rename_func(\"SIZE\"),\n exp.ArraySort: _array_sort,\n exp.With: no_recursive_cte_sql,\n exp.DateAdd: _add_date_sql,\n exp.DateDiff: _date_diff_sql,\n exp.DateStrToDate: rename_func(\"TO_DATE\"),\n exp.DateToDi: lambda self, e: f\"CAST(DATE_FORMAT({self.sql(e, 'this')}, {Hive.dateint_format}) AS INT)\",\n exp.DiToDate: lambda self, e: f\"TO_DATE(CAST({self.sql(e, 'this')} AS STRING), {Hive.dateint_format})\",\n exp.FileFormatProperty: lambda self, e: f\"STORED AS {e.name.upper()}\",\n exp.If: if_sql,\n exp.Index: _index_sql,\n exp.ILike: no_ilike_sql,\n exp.Join: _unnest_to_explode_sql,\n exp.JSONExtract: rename_func(\"GET_JSON_OBJECT\"),\n exp.JSONExtractScalar: rename_func(\"GET_JSON_OBJECT\"),\n exp.Map: var_map_sql,\n exp.Min: min_or_least,\n exp.VarMap: var_map_sql,\n exp.Create: create_with_partitions_sql,\n exp.Quantile: rename_func(\"PERCENTILE\"),\n exp.ApproxQuantile: rename_func(\"PERCENTILE_APPROX\"),\n exp.RegexpLike: lambda self, e: self.binary(e, \"RLIKE\"),\n exp.RegexpSplit: rename_func(\"SPLIT\"),\n exp.SafeDivide: no_safe_divide_sql,\n exp.SchemaCommentProperty: lambda self, e: self.naked_property(e),\n exp.SetAgg: rename_func(\"COLLECT_SET\"),\n exp.Split: lambda self, e: f\"SPLIT({self.sql(e, 'this')}, CONCAT('\\\\\\\\Q', {self.sql(e, 'expression')}))\",\n exp.StrPosition: strposition_to_locate_sql,\n exp.StrToDate: _str_to_date,\n exp.StrToTime: _str_to_time,\n exp.StrToUnix: _str_to_unix,\n exp.StructExtract: struct_extract_sql,\n exp.TableFormatProperty: lambda self, e: f\"USING {self.sql(e, 'this')}\",\n exp.TimeStrToDate: rename_func(\"TO_DATE\"),\n exp.TimeStrToTime: timestrtotime_sql,\n exp.TimeStrToUnix: rename_func(\"UNIX_TIMESTAMP\"),\n exp.TimeToStr: _time_to_str,\n exp.TimeToUnix: rename_func(\"UNIX_TIMESTAMP\"),\n exp.TsOrDiToDi: lambda self, e: f\"CAST(SUBSTR(REPLACE(CAST({self.sql(e, 'this')} AS STRING), '-', ''), 1, 8) AS INT)\",\n exp.TsOrDsAdd: lambda self, e: f\"DATE_ADD({self.sql(e, 'this')}, {self.sql(e, 'expression')})\",\n exp.TsOrDsToDate: _to_date_sql,\n exp.TryCast: no_trycast_sql,\n exp.UnixToStr: lambda self, e: self.func(\n \"FROM_UNIXTIME\", e.this, _time_format(self, e)\n ),\n exp.UnixToTime: rename_func(\"FROM_UNIXTIME\"),\n exp.UnixToTimeStr: rename_func(\"FROM_UNIXTIME\"),\n exp.PartitionedByProperty: lambda self, e: f\"PARTITIONED BY {self.sql(e, 'this')}\",\n exp.RowFormatSerdeProperty: lambda self, e: f\"ROW FORMAT SERDE {self.sql(e, 'this')}\",\n exp.SerdeProperties: lambda self, e: self.properties(e, prefix=\"WITH SERDEPROPERTIES\"),\n exp.NumberToStr: rename_func(\"FORMAT_NUMBER\"),\n exp.LastDateOfMonth: rename_func(\"LAST_DAY\"),\n }\n\n PROPERTIES_LOCATION = {\n **generator.Generator.PROPERTIES_LOCATION, # type: ignore\n exp.FileFormatProperty: exp.Properties.Location.POST_SCHEMA,\n exp.PartitionedByProperty: exp.Properties.Location.POST_SCHEMA,\n exp.TableFormatProperty: exp.Properties.Location.POST_SCHEMA,\n }\n\n def with_properties(self, properties):\n return self.properties(\n properties,\n prefix=self.seg(\"TBLPROPERTIES\"),\n )\n\n def datatype_sql(self, expression):\n if (\n expression.this in (exp.DataType.Type.VARCHAR, exp.DataType.Type.NVARCHAR)\n and not expression.expressions\n ):\n expression = exp.DataType.build(\"text\")\n elif expression.this in exp.DataType.TEMPORAL_TYPES:\n expression = exp.DataType.build(expression.this)\n return super().datatype_sql(expression)\n","path":"sqlglot/dialects/hive.py"}],"string":"[\n {\n \"content\": \"from __future__ import annotations\\n\\nfrom sqlglot import exp, generator, parser, tokens, transforms\\nfrom sqlglot.dialects.dialect import (\\n Dialect,\\n approx_count_distinct_sql,\\n create_with_partitions_sql,\\n format_time_lambda,\\n if_sql,\\n locate_to_strposition,\\n min_or_least,\\n no_ilike_sql,\\n no_recursive_cte_sql,\\n no_safe_divide_sql,\\n no_trycast_sql,\\n rename_func,\\n strposition_to_locate_sql,\\n struct_extract_sql,\\n timestrtotime_sql,\\n var_map_sql,\\n)\\nfrom sqlglot.helper import seq_get\\nfrom sqlglot.parser import parse_var_map\\nfrom sqlglot.tokens import TokenType\\n\\n# (FuncType, Multiplier)\\nDATE_DELTA_INTERVAL = {\\n \\\"YEAR\\\": (\\\"ADD_MONTHS\\\", 12),\\n \\\"MONTH\\\": (\\\"ADD_MONTHS\\\", 1),\\n \\\"QUARTER\\\": (\\\"ADD_MONTHS\\\", 3),\\n \\\"WEEK\\\": (\\\"DATE_ADD\\\", 7),\\n \\\"DAY\\\": (\\\"DATE_ADD\\\", 1),\\n}\\n\\nDIFF_MONTH_SWITCH = (\\\"YEAR\\\", \\\"QUARTER\\\", \\\"MONTH\\\")\\n\\n\\ndef _add_date_sql(self, expression):\\n unit = expression.text(\\\"unit\\\").upper()\\n func, multiplier = DATE_DELTA_INTERVAL.get(unit, (\\\"DATE_ADD\\\", 1))\\n modified_increment = (\\n int(expression.text(\\\"expression\\\")) * multiplier\\n if expression.expression.is_number\\n else expression.expression\\n )\\n modified_increment = exp.Literal.number(modified_increment)\\n return self.func(func, expression.this, modified_increment.this)\\n\\n\\ndef _date_diff_sql(self, expression):\\n unit = expression.text(\\\"unit\\\").upper()\\n sql_func = \\\"MONTHS_BETWEEN\\\" if unit in DIFF_MONTH_SWITCH else \\\"DATEDIFF\\\"\\n _, multiplier = DATE_DELTA_INTERVAL.get(unit, (\\\"\\\", 1))\\n multiplier_sql = f\\\" / {multiplier}\\\" if multiplier > 1 else \\\"\\\"\\n diff_sql = f\\\"{sql_func}({self.format_args(expression.this, expression.expression)})\\\"\\n return f\\\"{diff_sql}{multiplier_sql}\\\"\\n\\n\\ndef _array_sort(self, expression):\\n if expression.expression:\\n self.unsupported(\\\"Hive SORT_ARRAY does not support a comparator\\\")\\n return f\\\"SORT_ARRAY({self.sql(expression, 'this')})\\\"\\n\\n\\ndef _property_sql(self, expression):\\n return f\\\"'{expression.name}'={self.sql(expression, 'value')}\\\"\\n\\n\\ndef _str_to_unix(self, expression):\\n return self.func(\\\"UNIX_TIMESTAMP\\\", expression.this, _time_format(self, expression))\\n\\n\\ndef _str_to_date(self, expression):\\n this = self.sql(expression, \\\"this\\\")\\n time_format = self.format_time(expression)\\n if time_format not in (Hive.time_format, Hive.date_format):\\n this = f\\\"FROM_UNIXTIME(UNIX_TIMESTAMP({this}, {time_format}))\\\"\\n return f\\\"CAST({this} AS DATE)\\\"\\n\\n\\ndef _str_to_time(self, expression):\\n this = self.sql(expression, \\\"this\\\")\\n time_format = self.format_time(expression)\\n if time_format not in (Hive.time_format, Hive.date_format):\\n this = f\\\"FROM_UNIXTIME(UNIX_TIMESTAMP({this}, {time_format}))\\\"\\n return f\\\"CAST({this} AS TIMESTAMP)\\\"\\n\\n\\ndef _time_format(self, expression):\\n time_format = self.format_time(expression)\\n if time_format == Hive.time_format:\\n return None\\n return time_format\\n\\n\\ndef _time_to_str(self, expression):\\n this = self.sql(expression, \\\"this\\\")\\n time_format = self.format_time(expression)\\n return f\\\"DATE_FORMAT({this}, {time_format})\\\"\\n\\n\\ndef _to_date_sql(self, expression):\\n this = self.sql(expression, \\\"this\\\")\\n time_format = self.format_time(expression)\\n if time_format and time_format not in (Hive.time_format, Hive.date_format):\\n return f\\\"TO_DATE({this}, {time_format})\\\"\\n return f\\\"TO_DATE({this})\\\"\\n\\n\\ndef _unnest_to_explode_sql(self, expression):\\n unnest = expression.this\\n if isinstance(unnest, exp.Unnest):\\n alias = unnest.args.get(\\\"alias\\\")\\n udtf = exp.Posexplode if unnest.args.get(\\\"ordinality\\\") else exp.Explode\\n return \\\"\\\".join(\\n self.sql(\\n exp.Lateral(\\n this=udtf(this=expression),\\n view=True,\\n alias=exp.TableAlias(this=alias.this, columns=[column]),\\n )\\n )\\n for expression, column in zip(unnest.expressions, alias.columns if alias else [])\\n )\\n return self.join_sql(expression)\\n\\n\\ndef _index_sql(self, expression):\\n this = self.sql(expression, \\\"this\\\")\\n table = self.sql(expression, \\\"table\\\")\\n columns = self.sql(expression, \\\"columns\\\")\\n return f\\\"{this} ON TABLE {table} {columns}\\\"\\n\\n\\nclass Hive(Dialect):\\n alias_post_tablesample = True\\n\\n time_mapping = {\\n \\\"y\\\": \\\"%Y\\\",\\n \\\"Y\\\": \\\"%Y\\\",\\n \\\"YYYY\\\": \\\"%Y\\\",\\n \\\"yyyy\\\": \\\"%Y\\\",\\n \\\"YY\\\": \\\"%y\\\",\\n \\\"yy\\\": \\\"%y\\\",\\n \\\"MMMM\\\": \\\"%B\\\",\\n \\\"MMM\\\": \\\"%b\\\",\\n \\\"MM\\\": \\\"%m\\\",\\n \\\"M\\\": \\\"%-m\\\",\\n \\\"dd\\\": \\\"%d\\\",\\n \\\"d\\\": \\\"%-d\\\",\\n \\\"HH\\\": \\\"%H\\\",\\n \\\"H\\\": \\\"%-H\\\",\\n \\\"hh\\\": \\\"%I\\\",\\n \\\"h\\\": \\\"%-I\\\",\\n \\\"mm\\\": \\\"%M\\\",\\n \\\"m\\\": \\\"%-M\\\",\\n \\\"ss\\\": \\\"%S\\\",\\n \\\"s\\\": \\\"%-S\\\",\\n \\\"SSSSSS\\\": \\\"%f\\\",\\n \\\"a\\\": \\\"%p\\\",\\n \\\"DD\\\": \\\"%j\\\",\\n \\\"D\\\": \\\"%-j\\\",\\n \\\"E\\\": \\\"%a\\\",\\n \\\"EE\\\": \\\"%a\\\",\\n \\\"EEE\\\": \\\"%a\\\",\\n \\\"EEEE\\\": \\\"%A\\\",\\n }\\n\\n date_format = \\\"'yyyy-MM-dd'\\\"\\n dateint_format = \\\"'yyyyMMdd'\\\"\\n time_format = \\\"'yyyy-MM-dd HH:mm:ss'\\\"\\n\\n class Tokenizer(tokens.Tokenizer):\\n QUOTES = [\\\"'\\\", '\\\"']\\n IDENTIFIERS = [\\\"`\\\"]\\n STRING_ESCAPES = [\\\"\\\\\\\\\\\"]\\n ENCODE = \\\"utf-8\\\"\\n\\n KEYWORDS = {\\n **tokens.Tokenizer.KEYWORDS,\\n \\\"ADD ARCHIVE\\\": TokenType.COMMAND,\\n \\\"ADD ARCHIVES\\\": TokenType.COMMAND,\\n \\\"ADD FILE\\\": TokenType.COMMAND,\\n \\\"ADD FILES\\\": TokenType.COMMAND,\\n \\\"ADD JAR\\\": TokenType.COMMAND,\\n \\\"ADD JARS\\\": TokenType.COMMAND,\\n \\\"MSCK REPAIR\\\": TokenType.COMMAND,\\n \\\"WITH SERDEPROPERTIES\\\": TokenType.SERDE_PROPERTIES,\\n }\\n\\n NUMERIC_LITERALS = {\\n \\\"L\\\": \\\"BIGINT\\\",\\n \\\"S\\\": \\\"SMALLINT\\\",\\n \\\"Y\\\": \\\"TINYINT\\\",\\n \\\"D\\\": \\\"DOUBLE\\\",\\n \\\"F\\\": \\\"FLOAT\\\",\\n \\\"BD\\\": \\\"DECIMAL\\\",\\n }\\n\\n IDENTIFIER_CAN_START_WITH_DIGIT = True\\n\\n class Parser(parser.Parser):\\n STRICT_CAST = False\\n\\n FUNCTIONS = {\\n **parser.Parser.FUNCTIONS, # type: ignore\\n \\\"APPROX_COUNT_DISTINCT\\\": exp.ApproxDistinct.from_arg_list,\\n \\\"COLLECT_LIST\\\": exp.ArrayAgg.from_arg_list,\\n \\\"DATE_ADD\\\": lambda args: exp.TsOrDsAdd(\\n this=seq_get(args, 0),\\n expression=seq_get(args, 1),\\n unit=exp.Literal.string(\\\"DAY\\\"),\\n ),\\n \\\"DATEDIFF\\\": lambda args: exp.DateDiff(\\n this=exp.TsOrDsToDate(this=seq_get(args, 0)),\\n expression=exp.TsOrDsToDate(this=seq_get(args, 1)),\\n ),\\n \\\"DATE_SUB\\\": lambda args: exp.TsOrDsAdd(\\n this=seq_get(args, 0),\\n expression=exp.Mul(\\n this=seq_get(args, 1),\\n expression=exp.Literal.number(-1),\\n ),\\n unit=exp.Literal.string(\\\"DAY\\\"),\\n ),\\n \\\"DATE_FORMAT\\\": lambda args: format_time_lambda(exp.TimeToStr, \\\"hive\\\")(\\n [\\n exp.TimeStrToTime(this=seq_get(args, 0)),\\n seq_get(args, 1),\\n ]\\n ),\\n \\\"DAY\\\": lambda args: exp.Day(this=exp.TsOrDsToDate(this=seq_get(args, 0))),\\n \\\"FROM_UNIXTIME\\\": format_time_lambda(exp.UnixToStr, \\\"hive\\\", True),\\n \\\"GET_JSON_OBJECT\\\": exp.JSONExtractScalar.from_arg_list,\\n \\\"LOCATE\\\": locate_to_strposition,\\n \\\"LOG\\\": (\\n lambda args: exp.Log.from_arg_list(args)\\n if len(args) > 1\\n else exp.Ln.from_arg_list(args)\\n ),\\n \\\"MAP\\\": parse_var_map,\\n \\\"MONTH\\\": lambda args: exp.Month(this=exp.TsOrDsToDate.from_arg_list(args)),\\n \\\"PERCENTILE\\\": exp.Quantile.from_arg_list,\\n \\\"PERCENTILE_APPROX\\\": exp.ApproxQuantile.from_arg_list,\\n \\\"COLLECT_SET\\\": exp.SetAgg.from_arg_list,\\n \\\"SIZE\\\": exp.ArraySize.from_arg_list,\\n \\\"SPLIT\\\": exp.RegexpSplit.from_arg_list,\\n \\\"TO_DATE\\\": format_time_lambda(exp.TsOrDsToDate, \\\"hive\\\"),\\n \\\"UNIX_TIMESTAMP\\\": format_time_lambda(exp.StrToUnix, \\\"hive\\\", True),\\n \\\"YEAR\\\": lambda args: exp.Year(this=exp.TsOrDsToDate.from_arg_list(args)),\\n }\\n\\n PROPERTY_PARSERS = {\\n **parser.Parser.PROPERTY_PARSERS, # type: ignore\\n \\\"WITH SERDEPROPERTIES\\\": lambda self: exp.SerdeProperties(\\n expressions=self._parse_wrapped_csv(self._parse_property)\\n ),\\n }\\n\\n class Generator(generator.Generator):\\n TYPE_MAPPING = {\\n **generator.Generator.TYPE_MAPPING, # type: ignore\\n exp.DataType.Type.TEXT: \\\"STRING\\\",\\n exp.DataType.Type.DATETIME: \\\"TIMESTAMP\\\",\\n exp.DataType.Type.VARBINARY: \\\"BINARY\\\",\\n }\\n\\n TRANSFORMS = {\\n **generator.Generator.TRANSFORMS, # type: ignore\\n **transforms.UNALIAS_GROUP, # type: ignore\\n exp.Property: _property_sql,\\n exp.ApproxDistinct: approx_count_distinct_sql,\\n exp.ArrayAgg: rename_func(\\\"COLLECT_LIST\\\"),\\n exp.ArrayConcat: rename_func(\\\"CONCAT\\\"),\\n exp.ArraySize: rename_func(\\\"SIZE\\\"),\\n exp.ArraySort: _array_sort,\\n exp.With: no_recursive_cte_sql,\\n exp.DateAdd: _add_date_sql,\\n exp.DateDiff: _date_diff_sql,\\n exp.DateStrToDate: rename_func(\\\"TO_DATE\\\"),\\n exp.DateToDi: lambda self, e: f\\\"CAST(DATE_FORMAT({self.sql(e, 'this')}, {Hive.dateint_format}) AS INT)\\\",\\n exp.DiToDate: lambda self, e: f\\\"TO_DATE(CAST({self.sql(e, 'this')} AS STRING), {Hive.dateint_format})\\\",\\n exp.FileFormatProperty: lambda self, e: f\\\"STORED AS {e.name.upper()}\\\",\\n exp.If: if_sql,\\n exp.Index: _index_sql,\\n exp.ILike: no_ilike_sql,\\n exp.Join: _unnest_to_explode_sql,\\n exp.JSONExtract: rename_func(\\\"GET_JSON_OBJECT\\\"),\\n exp.JSONExtractScalar: rename_func(\\\"GET_JSON_OBJECT\\\"),\\n exp.Map: var_map_sql,\\n exp.Min: min_or_least,\\n exp.VarMap: var_map_sql,\\n exp.Create: create_with_partitions_sql,\\n exp.Quantile: rename_func(\\\"PERCENTILE\\\"),\\n exp.ApproxQuantile: rename_func(\\\"PERCENTILE_APPROX\\\"),\\n exp.RegexpLike: lambda self, e: self.binary(e, \\\"RLIKE\\\"),\\n exp.RegexpSplit: rename_func(\\\"SPLIT\\\"),\\n exp.SafeDivide: no_safe_divide_sql,\\n exp.SchemaCommentProperty: lambda self, e: self.naked_property(e),\\n exp.SetAgg: rename_func(\\\"COLLECT_SET\\\"),\\n exp.Split: lambda self, e: f\\\"SPLIT({self.sql(e, 'this')}, CONCAT('\\\\\\\\\\\\\\\\Q', {self.sql(e, 'expression')}))\\\",\\n exp.StrPosition: strposition_to_locate_sql,\\n exp.StrToDate: _str_to_date,\\n exp.StrToTime: _str_to_time,\\n exp.StrToUnix: _str_to_unix,\\n exp.StructExtract: struct_extract_sql,\\n exp.TableFormatProperty: lambda self, e: f\\\"USING {self.sql(e, 'this')}\\\",\\n exp.TimeStrToDate: rename_func(\\\"TO_DATE\\\"),\\n exp.TimeStrToTime: timestrtotime_sql,\\n exp.TimeStrToUnix: rename_func(\\\"UNIX_TIMESTAMP\\\"),\\n exp.TimeToStr: _time_to_str,\\n exp.TimeToUnix: rename_func(\\\"UNIX_TIMESTAMP\\\"),\\n exp.TsOrDiToDi: lambda self, e: f\\\"CAST(SUBSTR(REPLACE(CAST({self.sql(e, 'this')} AS STRING), '-', ''), 1, 8) AS INT)\\\",\\n exp.TsOrDsAdd: lambda self, e: f\\\"DATE_ADD({self.sql(e, 'this')}, {self.sql(e, 'expression')})\\\",\\n exp.TsOrDsToDate: _to_date_sql,\\n exp.TryCast: no_trycast_sql,\\n exp.UnixToStr: lambda self, e: self.func(\\n \\\"FROM_UNIXTIME\\\", e.this, _time_format(self, e)\\n ),\\n exp.UnixToTime: rename_func(\\\"FROM_UNIXTIME\\\"),\\n exp.UnixToTimeStr: rename_func(\\\"FROM_UNIXTIME\\\"),\\n exp.PartitionedByProperty: lambda self, e: f\\\"PARTITIONED BY {self.sql(e, 'this')}\\\",\\n exp.RowFormatSerdeProperty: lambda self, e: f\\\"ROW FORMAT SERDE {self.sql(e, 'this')}\\\",\\n exp.SerdeProperties: lambda self, e: self.properties(e, prefix=\\\"WITH SERDEPROPERTIES\\\"),\\n exp.NumberToStr: rename_func(\\\"FORMAT_NUMBER\\\"),\\n exp.LastDateOfMonth: rename_func(\\\"LAST_DAY\\\"),\\n }\\n\\n PROPERTIES_LOCATION = {\\n **generator.Generator.PROPERTIES_LOCATION, # type: ignore\\n exp.FileFormatProperty: exp.Properties.Location.POST_SCHEMA,\\n exp.PartitionedByProperty: exp.Properties.Location.POST_SCHEMA,\\n exp.TableFormatProperty: exp.Properties.Location.POST_SCHEMA,\\n }\\n\\n def with_properties(self, properties):\\n return self.properties(\\n properties,\\n prefix=self.seg(\\\"TBLPROPERTIES\\\"),\\n )\\n\\n def datatype_sql(self, expression):\\n if (\\n expression.this in (exp.DataType.Type.VARCHAR, exp.DataType.Type.NVARCHAR)\\n and not expression.expressions\\n ):\\n expression = exp.DataType.build(\\\"text\\\")\\n elif expression.this in exp.DataType.TEMPORAL_TYPES:\\n expression = exp.DataType.build(expression.this)\\n return super().datatype_sql(expression)\\n\",\n \"path\": \"sqlglot/dialects/hive.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"from __future__ import annotations\n\nfrom sqlglot import exp, generator, parser, tokens, transforms\nfrom sqlglot.dialects.dialect import (\n Dialect,\n approx_count_distinct_sql,\n create_with_partitions_sql,\n format_time_lambda,\n if_sql,\n locate_to_strposition,\n min_or_least,\n no_ilike_sql,\n no_recursive_cte_sql,\n no_safe_divide_sql,\n no_trycast_sql,\n rename_func,\n strposition_to_locate_sql,\n struct_extract_sql,\n timestrtotime_sql,\n var_map_sql,\n)\nfrom sqlglot.helper import seq_get\nfrom sqlglot.parser import parse_var_map\nfrom sqlglot.tokens import TokenType\n\n# (FuncType, Multiplier)\nDATE_DELTA_INTERVAL = {\n \"YEAR\": (\"ADD_MONTHS\", 12),\n \"MONTH\": (\"ADD_MONTHS\", 1),\n \"QUARTER\": (\"ADD_MONTHS\", 3),\n \"WEEK\": (\"DATE_ADD\", 7),\n \"DAY\": (\"DATE_ADD\", 1),\n}\n\nDIFF_MONTH_SWITCH = (\"YEAR\", \"QUARTER\", \"MONTH\")\n\n\ndef _add_date_sql(self, expression):\n unit = expression.text(\"unit\").upper()\n func, multiplier = DATE_DELTA_INTERVAL.get(unit, (\"DATE_ADD\", 1))\n modified_increment = (\n int(expression.text(\"expression\")) * multiplier\n if expression.expression.is_number\n else expression.expression\n )\n modified_increment = exp.Literal.number(modified_increment)\n return self.func(func, expression.this, modified_increment.this)\n\n\ndef _date_diff_sql(self, expression):\n unit = expression.text(\"unit\").upper()\n sql_func = \"MONTHS_BETWEEN\" if unit in DIFF_MONTH_SWITCH else \"DATEDIFF\"\n _, multiplier = DATE_DELTA_INTERVAL.get(unit, (\"\", 1))\n multiplier_sql = f\" / {multiplier}\" if multiplier > 1 else \"\"\n diff_sql = f\"{sql_func}({self.format_args(expression.this, expression.expression)})\"\n return f\"{diff_sql}{multiplier_sql}\"\n\n\ndef _array_sort(self, expression):\n if expression.expression:\n self.unsupported(\"Hive SORT_ARRAY does not support a comparator\")\n return f\"SORT_ARRAY({self.sql(expression, 'this')})\"\n\n\ndef _property_sql(self, expression):\n return f\"'{expression.name}'={self.sql(expression, 'value')}\"\n\n\ndef _str_to_unix(self, expression):\n return self.func(\"UNIX_TIMESTAMP\", expression.this, _time_format(self, expression))\n\n\ndef _str_to_date(self, expression):\n this = self.sql(expression, \"this\")\n time_format = self.format_time(expression)\n if time_format not in (Hive.time_format, Hive.date_format):\n this = f\"FROM_UNIXTIME(UNIX_TIMESTAMP({this}, {time_format}))\"\n return f\"CAST({this} AS DATE)\"\n\n\ndef _str_to_time(self, expression):\n this = self.sql(expression, \"this\")\n time_format = self.format_time(expression)\n if time_format not in (Hive.time_format, Hive.date_format):\n this = f\"FROM_UNIXTIME(UNIX_TIMESTAMP({this}, {time_format}))\"\n return f\"CAST({this} AS TIMESTAMP)\"\n\n\ndef _time_format(self, expression):\n time_format = self.format_time(expression)\n if time_format == Hive.time_format:\n return None\n return time_format\n\n\ndef _time_to_str(self, expression):\n this = self.sql(expression, \"this\")\n time_format = self.format_time(expression)\n return f\"DATE_FORMAT({this}, {time_format})\"\n\n\ndef _to_date_sql(self, expression):\n this = self.sql(expression, \"this\")\n time_format = self.format_time(expression)\n if time_format and time_format not in (Hive.time_format, Hive.date_format):\n return f\"TO_DATE({this}, {time_format})\"\n return f\"TO_DATE({this})\"\n\n\ndef _unnest_to_explode_sql(self, expression):\n unnest = expression.this\n if isinstance(unnest, exp.Unnest):\n alias = unnest.args.get(\"alias\")\n udtf = exp.Posexplode if unnest.args.get(\"ordinality\") else exp.Explode\n return \"\".join(\n self.sql(\n exp.Lateral(\n this=udtf(this=expression),\n view=True,\n alias=exp.TableAlias(this=alias.this, columns=[column]),\n )\n )\n for expression, column in zip(unnest.expressions, alias.columns if alias else [])\n )\n return self.join_sql(expression)\n\n\ndef _index_sql(self, expression):\n this = self.sql(expression, \"this\")\n table = self.sql(expression, \"table\")\n columns = self.sql(expression, \"columns\")\n return f\"{this} ON TABLE {table} {columns}\"\n\n\nclass Hive(Dialect):\n alias_post_tablesample = True\n\n time_mapping = {\n \"y\": \"%Y\",\n \"Y\": \"%Y\",\n \"YYYY\": \"%Y\",\n \"yyyy\": \"%Y\",\n \"YY\": \"%y\",\n \"yy\": \"%y\",\n \"MMMM\": \"%B\",\n \"MMM\": \"%b\",\n \"MM\": \"%m\",\n \"M\": \"%-m\",\n \"dd\": \"%d\",\n \"d\": \"%-d\",\n \"HH\": \"%H\",\n \"H\": \"%-H\",\n \"hh\": \"%I\",\n \"h\": \"%-I\",\n \"mm\": \"%M\",\n \"m\": \"%-M\",\n \"ss\": \"%S\",\n \"s\": \"%-S\",\n \"SSSSSS\": \"%f\",\n \"a\": \"%p\",\n \"DD\": \"%j\",\n \"D\": \"%-j\",\n \"E\": \"%a\",\n \"EE\": \"%a\",\n \"EEE\": \"%a\",\n \"EEEE\": \"%A\",\n }\n\n date_format = \"'yyyy-MM-dd'\"\n dateint_format = \"'yyyyMMdd'\"\n time_format = \"'yyyy-MM-dd HH:mm:ss'\"\n\n class Tokenizer(tokens.Tokenizer):\n QUOTES = [\"'\", '\"']\n IDENTIFIERS = [\"`\"]\n STRING_ESCAPES = [\"\\\\\"]\n ENCODE = \"utf-8\"\n\n KEYWORDS = {\n **tokens.Tokenizer.KEYWORDS,\n \"ADD ARCHIVE\": TokenType.COMMAND,\n \"ADD ARCHIVES\": TokenType.COMMAND,\n \"ADD FILE\": TokenType.COMMAND,\n \"ADD FILES\": TokenType.COMMAND,\n \"ADD JAR\": TokenType.COMMAND,\n \"ADD JARS\": TokenType.COMMAND,\n \"MSCK REPAIR\": TokenType.COMMAND,\n \"WITH SERDEPROPERTIES\": TokenType.SERDE_PROPERTIES,\n }\n\n NUMERIC_LITERALS = {\n \"L\": \"BIGINT\",\n \"S\": \"SMALLINT\",\n \"Y\": \"TINYINT\",\n \"D\": \"DOUBLE\",\n \"F\": \"FLOAT\",\n \"BD\": \"DECIMAL\",\n }\n\n IDENTIFIER_CAN_START_WITH_DIGIT = True\n\n class Parser(parser.Parser):\n STRICT_CAST = False\n\n FUNCTIONS = {\n **parser.Parser.FUNCTIONS, # type: ignore\n \"APPROX_COUNT_DISTINCT\": exp.ApproxDistinct.from_arg_list,\n \"COLLECT_LIST\": exp.ArrayAgg.from_arg_list,\n \"DATE_ADD\": lambda args: exp.TsOrDsAdd(\n this=seq_get(args, 0),\n expression=seq_get(args, 1),\n unit=exp.Literal.string(\"DAY\"),\n ),\n \"DATEDIFF\": lambda args: exp.DateDiff(\n this=exp.TsOrDsToDate(this=seq_get(args, 0)),\n expression=exp.TsOrDsToDate(this=seq_get(args, 1)),\n ),\n \"DATE_SUB\": lambda args: exp.TsOrDsAdd(\n this=seq_get(args, 0),\n expression=exp.Mul(\n this=seq_get(args, 1),\n expression=exp.Literal.number(-1),\n ),\n unit=exp.Literal.string(\"DAY\"),\n ),\n \"DATE_FORMAT\": lambda args: format_time_lambda(exp.TimeToStr, \"hive\")(\n [\n exp.TimeStrToTime(this=seq_get(args, 0)),\n seq_get(args, 1),\n ]\n ),\n \"DAY\": lambda args: exp.Day(this=exp.TsOrDsToDate(this=seq_get(args, 0))),\n \"FROM_UNIXTIME\": format_time_lambda(exp.UnixToStr, \"hive\", True),\n \"GET_JSON_OBJECT\": exp.JSONExtractScalar.from_arg_list,\n \"LOCATE\": locate_to_strposition,\n \"LOG\": (\n lambda args: exp.Log.from_arg_list(args)\n if len(args) > 1\n else exp.Ln.from_arg_list(args)\n ),\n \"MAP\": parse_var_map,\n \"MONTH\": lambda args: exp.Month(this=exp.TsOrDsToDate.from_arg_list(args)),\n \"PERCENTILE\": exp.Quantile.from_arg_list,\n \"PERCENTILE_APPROX\": exp.ApproxQuantile.from_arg_list,\n \"COLLECT_SET\": exp.SetAgg.from_arg_list,\n \"SIZE\": exp.ArraySize.from_arg_list,\n \"SPLIT\": exp.RegexpSplit.from_arg_list,\n \"TO_DATE\": format_time_lambda(exp.TsOrDsToDate, \"hive\"),\n \"UNIX_TIMESTAMP\": format_time_lambda(exp.StrToUnix, \"hive\", True),\n \"YEAR\": lambda args: exp.Year(this=exp.TsOrDsToDate.from_arg_list(args)),\n }\n\n PROPERTY_PARSERS = {\n **parser.Parser.PROPERTY_PARSERS, # type: ignore\n \"WITH SERDEPROPERTIES\": lambda self: exp.SerdeProperties(\n expressions=self._parse_wrapped_csv(self._parse_property)\n ),\n }\n\n class Generator(generator.Generator):\n TYPE_MAPPING = {\n **generator.Generator.TYPE_MAPPING, # type: ignore\n exp.DataType.Type.TEXT: \"STRING\",\n exp.DataType.Type.DATETIME: \"TIMESTAMP\",\n exp.DataType.Type.VARBINARY: \"BINARY\",\n exp.DataType.Type.TIMESTAMPTZ: \"TIMESTAMP\",\n }\n\n TRANSFORMS = {\n **generator.Generator.TRANSFORMS, # type: ignore\n **transforms.UNALIAS_GROUP, # type: ignore\n exp.Property: _property_sql,\n exp.ApproxDistinct: approx_count_distinct_sql,\n exp.ArrayAgg: rename_func(\"COLLECT_LIST\"),\n exp.ArrayConcat: rename_func(\"CONCAT\"),\n exp.ArraySize: rename_func(\"SIZE\"),\n exp.ArraySort: _array_sort,\n exp.With: no_recursive_cte_sql,\n exp.DateAdd: _add_date_sql,\n exp.DateDiff: _date_diff_sql,\n exp.DateStrToDate: rename_func(\"TO_DATE\"),\n exp.DateToDi: lambda self, e: f\"CAST(DATE_FORMAT({self.sql(e, 'this')}, {Hive.dateint_format}) AS INT)\",\n exp.DiToDate: lambda self, e: f\"TO_DATE(CAST({self.sql(e, 'this')} AS STRING), {Hive.dateint_format})\",\n exp.FileFormatProperty: lambda self, e: f\"STORED AS {e.name.upper()}\",\n exp.If: if_sql,\n exp.Index: _index_sql,\n exp.ILike: no_ilike_sql,\n exp.Join: _unnest_to_explode_sql,\n exp.JSONExtract: rename_func(\"GET_JSON_OBJECT\"),\n exp.JSONExtractScalar: rename_func(\"GET_JSON_OBJECT\"),\n exp.Map: var_map_sql,\n exp.Min: min_or_least,\n exp.VarMap: var_map_sql,\n exp.Create: create_with_partitions_sql,\n exp.Quantile: rename_func(\"PERCENTILE\"),\n exp.ApproxQuantile: rename_func(\"PERCENTILE_APPROX\"),\n exp.RegexpLike: lambda self, e: self.binary(e, \"RLIKE\"),\n exp.RegexpSplit: rename_func(\"SPLIT\"),\n exp.SafeDivide: no_safe_divide_sql,\n exp.SchemaCommentProperty: lambda self, e: self.naked_property(e),\n exp.SetAgg: rename_func(\"COLLECT_SET\"),\n exp.Split: lambda self, e: f\"SPLIT({self.sql(e, 'this')}, CONCAT('\\\\\\\\Q', {self.sql(e, 'expression')}))\",\n exp.StrPosition: strposition_to_locate_sql,\n exp.StrToDate: _str_to_date,\n exp.StrToTime: _str_to_time,\n exp.StrToUnix: _str_to_unix,\n exp.StructExtract: struct_extract_sql,\n exp.TableFormatProperty: lambda self, e: f\"USING {self.sql(e, 'this')}\",\n exp.TimeStrToDate: rename_func(\"TO_DATE\"),\n exp.TimeStrToTime: timestrtotime_sql,\n exp.TimeStrToUnix: rename_func(\"UNIX_TIMESTAMP\"),\n exp.TimeToStr: _time_to_str,\n exp.TimeToUnix: rename_func(\"UNIX_TIMESTAMP\"),\n exp.TsOrDiToDi: lambda self, e: f\"CAST(SUBSTR(REPLACE(CAST({self.sql(e, 'this')} AS STRING), '-', ''), 1, 8) AS INT)\",\n exp.TsOrDsAdd: lambda self, e: f\"DATE_ADD({self.sql(e, 'this')}, {self.sql(e, 'expression')})\",\n exp.TsOrDsToDate: _to_date_sql,\n exp.TryCast: no_trycast_sql,\n exp.UnixToStr: lambda self, e: self.func(\n \"FROM_UNIXTIME\", e.this, _time_format(self, e)\n ),\n exp.UnixToTime: rename_func(\"FROM_UNIXTIME\"),\n exp.UnixToTimeStr: rename_func(\"FROM_UNIXTIME\"),\n exp.PartitionedByProperty: lambda self, e: f\"PARTITIONED BY {self.sql(e, 'this')}\",\n exp.RowFormatSerdeProperty: lambda self, e: f\"ROW FORMAT SERDE {self.sql(e, 'this')}\",\n exp.SerdeProperties: lambda self, e: self.properties(e, prefix=\"WITH SERDEPROPERTIES\"),\n exp.NumberToStr: rename_func(\"FORMAT_NUMBER\"),\n exp.LastDateOfMonth: rename_func(\"LAST_DAY\"),\n }\n\n PROPERTIES_LOCATION = {\n **generator.Generator.PROPERTIES_LOCATION, # type: ignore\n exp.FileFormatProperty: exp.Properties.Location.POST_SCHEMA,\n exp.PartitionedByProperty: exp.Properties.Location.POST_SCHEMA,\n exp.TableFormatProperty: exp.Properties.Location.POST_SCHEMA,\n }\n\n def with_properties(self, properties):\n return self.properties(\n properties,\n prefix=self.seg(\"TBLPROPERTIES\"),\n )\n\n def datatype_sql(self, expression):\n if (\n expression.this in (exp.DataType.Type.VARCHAR, exp.DataType.Type.NVARCHAR)\n and not expression.expressions\n ):\n expression = exp.DataType.build(\"text\")\n elif expression.this in exp.DataType.TEMPORAL_TYPES:\n expression = exp.DataType.build(expression.this)\n return super().datatype_sql(expression)\n","path":"sqlglot/dialects/hive.py"}],"string":"[\n {\n \"content\": \"from __future__ import annotations\\n\\nfrom sqlglot import exp, generator, parser, tokens, transforms\\nfrom sqlglot.dialects.dialect import (\\n Dialect,\\n approx_count_distinct_sql,\\n create_with_partitions_sql,\\n format_time_lambda,\\n if_sql,\\n locate_to_strposition,\\n min_or_least,\\n no_ilike_sql,\\n no_recursive_cte_sql,\\n no_safe_divide_sql,\\n no_trycast_sql,\\n rename_func,\\n strposition_to_locate_sql,\\n struct_extract_sql,\\n timestrtotime_sql,\\n var_map_sql,\\n)\\nfrom sqlglot.helper import seq_get\\nfrom sqlglot.parser import parse_var_map\\nfrom sqlglot.tokens import TokenType\\n\\n# (FuncType, Multiplier)\\nDATE_DELTA_INTERVAL = {\\n \\\"YEAR\\\": (\\\"ADD_MONTHS\\\", 12),\\n \\\"MONTH\\\": (\\\"ADD_MONTHS\\\", 1),\\n \\\"QUARTER\\\": (\\\"ADD_MONTHS\\\", 3),\\n \\\"WEEK\\\": (\\\"DATE_ADD\\\", 7),\\n \\\"DAY\\\": (\\\"DATE_ADD\\\", 1),\\n}\\n\\nDIFF_MONTH_SWITCH = (\\\"YEAR\\\", \\\"QUARTER\\\", \\\"MONTH\\\")\\n\\n\\ndef _add_date_sql(self, expression):\\n unit = expression.text(\\\"unit\\\").upper()\\n func, multiplier = DATE_DELTA_INTERVAL.get(unit, (\\\"DATE_ADD\\\", 1))\\n modified_increment = (\\n int(expression.text(\\\"expression\\\")) * multiplier\\n if expression.expression.is_number\\n else expression.expression\\n )\\n modified_increment = exp.Literal.number(modified_increment)\\n return self.func(func, expression.this, modified_increment.this)\\n\\n\\ndef _date_diff_sql(self, expression):\\n unit = expression.text(\\\"unit\\\").upper()\\n sql_func = \\\"MONTHS_BETWEEN\\\" if unit in DIFF_MONTH_SWITCH else \\\"DATEDIFF\\\"\\n _, multiplier = DATE_DELTA_INTERVAL.get(unit, (\\\"\\\", 1))\\n multiplier_sql = f\\\" / {multiplier}\\\" if multiplier > 1 else \\\"\\\"\\n diff_sql = f\\\"{sql_func}({self.format_args(expression.this, expression.expression)})\\\"\\n return f\\\"{diff_sql}{multiplier_sql}\\\"\\n\\n\\ndef _array_sort(self, expression):\\n if expression.expression:\\n self.unsupported(\\\"Hive SORT_ARRAY does not support a comparator\\\")\\n return f\\\"SORT_ARRAY({self.sql(expression, 'this')})\\\"\\n\\n\\ndef _property_sql(self, expression):\\n return f\\\"'{expression.name}'={self.sql(expression, 'value')}\\\"\\n\\n\\ndef _str_to_unix(self, expression):\\n return self.func(\\\"UNIX_TIMESTAMP\\\", expression.this, _time_format(self, expression))\\n\\n\\ndef _str_to_date(self, expression):\\n this = self.sql(expression, \\\"this\\\")\\n time_format = self.format_time(expression)\\n if time_format not in (Hive.time_format, Hive.date_format):\\n this = f\\\"FROM_UNIXTIME(UNIX_TIMESTAMP({this}, {time_format}))\\\"\\n return f\\\"CAST({this} AS DATE)\\\"\\n\\n\\ndef _str_to_time(self, expression):\\n this = self.sql(expression, \\\"this\\\")\\n time_format = self.format_time(expression)\\n if time_format not in (Hive.time_format, Hive.date_format):\\n this = f\\\"FROM_UNIXTIME(UNIX_TIMESTAMP({this}, {time_format}))\\\"\\n return f\\\"CAST({this} AS TIMESTAMP)\\\"\\n\\n\\ndef _time_format(self, expression):\\n time_format = self.format_time(expression)\\n if time_format == Hive.time_format:\\n return None\\n return time_format\\n\\n\\ndef _time_to_str(self, expression):\\n this = self.sql(expression, \\\"this\\\")\\n time_format = self.format_time(expression)\\n return f\\\"DATE_FORMAT({this}, {time_format})\\\"\\n\\n\\ndef _to_date_sql(self, expression):\\n this = self.sql(expression, \\\"this\\\")\\n time_format = self.format_time(expression)\\n if time_format and time_format not in (Hive.time_format, Hive.date_format):\\n return f\\\"TO_DATE({this}, {time_format})\\\"\\n return f\\\"TO_DATE({this})\\\"\\n\\n\\ndef _unnest_to_explode_sql(self, expression):\\n unnest = expression.this\\n if isinstance(unnest, exp.Unnest):\\n alias = unnest.args.get(\\\"alias\\\")\\n udtf = exp.Posexplode if unnest.args.get(\\\"ordinality\\\") else exp.Explode\\n return \\\"\\\".join(\\n self.sql(\\n exp.Lateral(\\n this=udtf(this=expression),\\n view=True,\\n alias=exp.TableAlias(this=alias.this, columns=[column]),\\n )\\n )\\n for expression, column in zip(unnest.expressions, alias.columns if alias else [])\\n )\\n return self.join_sql(expression)\\n\\n\\ndef _index_sql(self, expression):\\n this = self.sql(expression, \\\"this\\\")\\n table = self.sql(expression, \\\"table\\\")\\n columns = self.sql(expression, \\\"columns\\\")\\n return f\\\"{this} ON TABLE {table} {columns}\\\"\\n\\n\\nclass Hive(Dialect):\\n alias_post_tablesample = True\\n\\n time_mapping = {\\n \\\"y\\\": \\\"%Y\\\",\\n \\\"Y\\\": \\\"%Y\\\",\\n \\\"YYYY\\\": \\\"%Y\\\",\\n \\\"yyyy\\\": \\\"%Y\\\",\\n \\\"YY\\\": \\\"%y\\\",\\n \\\"yy\\\": \\\"%y\\\",\\n \\\"MMMM\\\": \\\"%B\\\",\\n \\\"MMM\\\": \\\"%b\\\",\\n \\\"MM\\\": \\\"%m\\\",\\n \\\"M\\\": \\\"%-m\\\",\\n \\\"dd\\\": \\\"%d\\\",\\n \\\"d\\\": \\\"%-d\\\",\\n \\\"HH\\\": \\\"%H\\\",\\n \\\"H\\\": \\\"%-H\\\",\\n \\\"hh\\\": \\\"%I\\\",\\n \\\"h\\\": \\\"%-I\\\",\\n \\\"mm\\\": \\\"%M\\\",\\n \\\"m\\\": \\\"%-M\\\",\\n \\\"ss\\\": \\\"%S\\\",\\n \\\"s\\\": \\\"%-S\\\",\\n \\\"SSSSSS\\\": \\\"%f\\\",\\n \\\"a\\\": \\\"%p\\\",\\n \\\"DD\\\": \\\"%j\\\",\\n \\\"D\\\": \\\"%-j\\\",\\n \\\"E\\\": \\\"%a\\\",\\n \\\"EE\\\": \\\"%a\\\",\\n \\\"EEE\\\": \\\"%a\\\",\\n \\\"EEEE\\\": \\\"%A\\\",\\n }\\n\\n date_format = \\\"'yyyy-MM-dd'\\\"\\n dateint_format = \\\"'yyyyMMdd'\\\"\\n time_format = \\\"'yyyy-MM-dd HH:mm:ss'\\\"\\n\\n class Tokenizer(tokens.Tokenizer):\\n QUOTES = [\\\"'\\\", '\\\"']\\n IDENTIFIERS = [\\\"`\\\"]\\n STRING_ESCAPES = [\\\"\\\\\\\\\\\"]\\n ENCODE = \\\"utf-8\\\"\\n\\n KEYWORDS = {\\n **tokens.Tokenizer.KEYWORDS,\\n \\\"ADD ARCHIVE\\\": TokenType.COMMAND,\\n \\\"ADD ARCHIVES\\\": TokenType.COMMAND,\\n \\\"ADD FILE\\\": TokenType.COMMAND,\\n \\\"ADD FILES\\\": TokenType.COMMAND,\\n \\\"ADD JAR\\\": TokenType.COMMAND,\\n \\\"ADD JARS\\\": TokenType.COMMAND,\\n \\\"MSCK REPAIR\\\": TokenType.COMMAND,\\n \\\"WITH SERDEPROPERTIES\\\": TokenType.SERDE_PROPERTIES,\\n }\\n\\n NUMERIC_LITERALS = {\\n \\\"L\\\": \\\"BIGINT\\\",\\n \\\"S\\\": \\\"SMALLINT\\\",\\n \\\"Y\\\": \\\"TINYINT\\\",\\n \\\"D\\\": \\\"DOUBLE\\\",\\n \\\"F\\\": \\\"FLOAT\\\",\\n \\\"BD\\\": \\\"DECIMAL\\\",\\n }\\n\\n IDENTIFIER_CAN_START_WITH_DIGIT = True\\n\\n class Parser(parser.Parser):\\n STRICT_CAST = False\\n\\n FUNCTIONS = {\\n **parser.Parser.FUNCTIONS, # type: ignore\\n \\\"APPROX_COUNT_DISTINCT\\\": exp.ApproxDistinct.from_arg_list,\\n \\\"COLLECT_LIST\\\": exp.ArrayAgg.from_arg_list,\\n \\\"DATE_ADD\\\": lambda args: exp.TsOrDsAdd(\\n this=seq_get(args, 0),\\n expression=seq_get(args, 1),\\n unit=exp.Literal.string(\\\"DAY\\\"),\\n ),\\n \\\"DATEDIFF\\\": lambda args: exp.DateDiff(\\n this=exp.TsOrDsToDate(this=seq_get(args, 0)),\\n expression=exp.TsOrDsToDate(this=seq_get(args, 1)),\\n ),\\n \\\"DATE_SUB\\\": lambda args: exp.TsOrDsAdd(\\n this=seq_get(args, 0),\\n expression=exp.Mul(\\n this=seq_get(args, 1),\\n expression=exp.Literal.number(-1),\\n ),\\n unit=exp.Literal.string(\\\"DAY\\\"),\\n ),\\n \\\"DATE_FORMAT\\\": lambda args: format_time_lambda(exp.TimeToStr, \\\"hive\\\")(\\n [\\n exp.TimeStrToTime(this=seq_get(args, 0)),\\n seq_get(args, 1),\\n ]\\n ),\\n \\\"DAY\\\": lambda args: exp.Day(this=exp.TsOrDsToDate(this=seq_get(args, 0))),\\n \\\"FROM_UNIXTIME\\\": format_time_lambda(exp.UnixToStr, \\\"hive\\\", True),\\n \\\"GET_JSON_OBJECT\\\": exp.JSONExtractScalar.from_arg_list,\\n \\\"LOCATE\\\": locate_to_strposition,\\n \\\"LOG\\\": (\\n lambda args: exp.Log.from_arg_list(args)\\n if len(args) > 1\\n else exp.Ln.from_arg_list(args)\\n ),\\n \\\"MAP\\\": parse_var_map,\\n \\\"MONTH\\\": lambda args: exp.Month(this=exp.TsOrDsToDate.from_arg_list(args)),\\n \\\"PERCENTILE\\\": exp.Quantile.from_arg_list,\\n \\\"PERCENTILE_APPROX\\\": exp.ApproxQuantile.from_arg_list,\\n \\\"COLLECT_SET\\\": exp.SetAgg.from_arg_list,\\n \\\"SIZE\\\": exp.ArraySize.from_arg_list,\\n \\\"SPLIT\\\": exp.RegexpSplit.from_arg_list,\\n \\\"TO_DATE\\\": format_time_lambda(exp.TsOrDsToDate, \\\"hive\\\"),\\n \\\"UNIX_TIMESTAMP\\\": format_time_lambda(exp.StrToUnix, \\\"hive\\\", True),\\n \\\"YEAR\\\": lambda args: exp.Year(this=exp.TsOrDsToDate.from_arg_list(args)),\\n }\\n\\n PROPERTY_PARSERS = {\\n **parser.Parser.PROPERTY_PARSERS, # type: ignore\\n \\\"WITH SERDEPROPERTIES\\\": lambda self: exp.SerdeProperties(\\n expressions=self._parse_wrapped_csv(self._parse_property)\\n ),\\n }\\n\\n class Generator(generator.Generator):\\n TYPE_MAPPING = {\\n **generator.Generator.TYPE_MAPPING, # type: ignore\\n exp.DataType.Type.TEXT: \\\"STRING\\\",\\n exp.DataType.Type.DATETIME: \\\"TIMESTAMP\\\",\\n exp.DataType.Type.VARBINARY: \\\"BINARY\\\",\\n exp.DataType.Type.TIMESTAMPTZ: \\\"TIMESTAMP\\\",\\n }\\n\\n TRANSFORMS = {\\n **generator.Generator.TRANSFORMS, # type: ignore\\n **transforms.UNALIAS_GROUP, # type: ignore\\n exp.Property: _property_sql,\\n exp.ApproxDistinct: approx_count_distinct_sql,\\n exp.ArrayAgg: rename_func(\\\"COLLECT_LIST\\\"),\\n exp.ArrayConcat: rename_func(\\\"CONCAT\\\"),\\n exp.ArraySize: rename_func(\\\"SIZE\\\"),\\n exp.ArraySort: _array_sort,\\n exp.With: no_recursive_cte_sql,\\n exp.DateAdd: _add_date_sql,\\n exp.DateDiff: _date_diff_sql,\\n exp.DateStrToDate: rename_func(\\\"TO_DATE\\\"),\\n exp.DateToDi: lambda self, e: f\\\"CAST(DATE_FORMAT({self.sql(e, 'this')}, {Hive.dateint_format}) AS INT)\\\",\\n exp.DiToDate: lambda self, e: f\\\"TO_DATE(CAST({self.sql(e, 'this')} AS STRING), {Hive.dateint_format})\\\",\\n exp.FileFormatProperty: lambda self, e: f\\\"STORED AS {e.name.upper()}\\\",\\n exp.If: if_sql,\\n exp.Index: _index_sql,\\n exp.ILike: no_ilike_sql,\\n exp.Join: _unnest_to_explode_sql,\\n exp.JSONExtract: rename_func(\\\"GET_JSON_OBJECT\\\"),\\n exp.JSONExtractScalar: rename_func(\\\"GET_JSON_OBJECT\\\"),\\n exp.Map: var_map_sql,\\n exp.Min: min_or_least,\\n exp.VarMap: var_map_sql,\\n exp.Create: create_with_partitions_sql,\\n exp.Quantile: rename_func(\\\"PERCENTILE\\\"),\\n exp.ApproxQuantile: rename_func(\\\"PERCENTILE_APPROX\\\"),\\n exp.RegexpLike: lambda self, e: self.binary(e, \\\"RLIKE\\\"),\\n exp.RegexpSplit: rename_func(\\\"SPLIT\\\"),\\n exp.SafeDivide: no_safe_divide_sql,\\n exp.SchemaCommentProperty: lambda self, e: self.naked_property(e),\\n exp.SetAgg: rename_func(\\\"COLLECT_SET\\\"),\\n exp.Split: lambda self, e: f\\\"SPLIT({self.sql(e, 'this')}, CONCAT('\\\\\\\\\\\\\\\\Q', {self.sql(e, 'expression')}))\\\",\\n exp.StrPosition: strposition_to_locate_sql,\\n exp.StrToDate: _str_to_date,\\n exp.StrToTime: _str_to_time,\\n exp.StrToUnix: _str_to_unix,\\n exp.StructExtract: struct_extract_sql,\\n exp.TableFormatProperty: lambda self, e: f\\\"USING {self.sql(e, 'this')}\\\",\\n exp.TimeStrToDate: rename_func(\\\"TO_DATE\\\"),\\n exp.TimeStrToTime: timestrtotime_sql,\\n exp.TimeStrToUnix: rename_func(\\\"UNIX_TIMESTAMP\\\"),\\n exp.TimeToStr: _time_to_str,\\n exp.TimeToUnix: rename_func(\\\"UNIX_TIMESTAMP\\\"),\\n exp.TsOrDiToDi: lambda self, e: f\\\"CAST(SUBSTR(REPLACE(CAST({self.sql(e, 'this')} AS STRING), '-', ''), 1, 8) AS INT)\\\",\\n exp.TsOrDsAdd: lambda self, e: f\\\"DATE_ADD({self.sql(e, 'this')}, {self.sql(e, 'expression')})\\\",\\n exp.TsOrDsToDate: _to_date_sql,\\n exp.TryCast: no_trycast_sql,\\n exp.UnixToStr: lambda self, e: self.func(\\n \\\"FROM_UNIXTIME\\\", e.this, _time_format(self, e)\\n ),\\n exp.UnixToTime: rename_func(\\\"FROM_UNIXTIME\\\"),\\n exp.UnixToTimeStr: rename_func(\\\"FROM_UNIXTIME\\\"),\\n exp.PartitionedByProperty: lambda self, e: f\\\"PARTITIONED BY {self.sql(e, 'this')}\\\",\\n exp.RowFormatSerdeProperty: lambda self, e: f\\\"ROW FORMAT SERDE {self.sql(e, 'this')}\\\",\\n exp.SerdeProperties: lambda self, e: self.properties(e, prefix=\\\"WITH SERDEPROPERTIES\\\"),\\n exp.NumberToStr: rename_func(\\\"FORMAT_NUMBER\\\"),\\n exp.LastDateOfMonth: rename_func(\\\"LAST_DAY\\\"),\\n }\\n\\n PROPERTIES_LOCATION = {\\n **generator.Generator.PROPERTIES_LOCATION, # type: ignore\\n exp.FileFormatProperty: exp.Properties.Location.POST_SCHEMA,\\n exp.PartitionedByProperty: exp.Properties.Location.POST_SCHEMA,\\n exp.TableFormatProperty: exp.Properties.Location.POST_SCHEMA,\\n }\\n\\n def with_properties(self, properties):\\n return self.properties(\\n properties,\\n prefix=self.seg(\\\"TBLPROPERTIES\\\"),\\n )\\n\\n def datatype_sql(self, expression):\\n if (\\n expression.this in (exp.DataType.Type.VARCHAR, exp.DataType.Type.NVARCHAR)\\n and not expression.expressions\\n ):\\n expression = exp.DataType.build(\\\"text\\\")\\n elif expression.this in exp.DataType.TEMPORAL_TYPES:\\n expression = exp.DataType.build(expression.this)\\n return super().datatype_sql(expression)\\n\",\n \"path\": \"sqlglot/dialects/hive.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/sqlglot/dialects/hive.py b/sqlglot/dialects/hive.py\nindex c4b8fa9ce5..9f72347bcc 100644\n--- a/sqlglot/dialects/hive.py\n+++ b/sqlglot/dialects/hive.py\n@@ -263,6 +263,7 @@ class Generator(generator.Generator):\n exp.DataType.Type.TEXT: \"STRING\",\n exp.DataType.Type.DATETIME: \"TIMESTAMP\",\n exp.DataType.Type.VARBINARY: \"BINARY\",\n+ exp.DataType.Type.TIMESTAMPTZ: \"TIMESTAMP\",\n }\n \n TRANSFORMS = {\ndiff --git a/tests/dialects/test_presto.py b/tests/dialects/test_presto.py\nindex bf22652e72..ec4cfce111 100644\n--- a/tests/dialects/test_presto.py\n+++ b/tests/dialects/test_presto.py\n@@ -63,8 +63,8 @@ def test_cast(self):\n \"bigquery\": \"CAST(x AS TIMESTAMPTZ)\",\n \"duckdb\": \"CAST(x AS TIMESTAMPTZ(9))\",\n \"presto\": \"CAST(x AS TIMESTAMP(9) WITH TIME ZONE)\",\n- \"hive\": \"CAST(x AS TIMESTAMPTZ)\",\n- \"spark\": \"CAST(x AS TIMESTAMPTZ)\",\n+ \"hive\": \"CAST(x AS TIMESTAMP)\",\n+ \"spark\": \"CAST(x AS TIMESTAMP)\",\n },\n )\n \ndiff --git a/tests/dialects/test_spark.py b/tests/dialects/test_spark.py\nindex 9328eaac97..5b213496a2 100644\n--- a/tests/dialects/test_spark.py\n+++ b/tests/dialects/test_spark.py\n@@ -213,6 +213,9 @@ def test_spark(self):\n self.validate_identity(\"TRIM(LEADING 'SL' FROM 'SSparkSQLS')\")\n self.validate_identity(\"TRIM(TRAILING 'SL' FROM 'SSparkSQLS')\")\n \n+ self.validate_all(\n+ \"CAST(x AS TIMESTAMP)\", read={\"trino\": \"CAST(x AS TIMESTAMP(6) WITH TIME ZONE)\"}\n+ )\n self.validate_all(\n \"SELECT DATE_ADD(my_date_column, 1)\",\n write={\n"}}},{"rowIdx":2687,"cells":{"in_source_id":{"kind":"string","value":"interlegis__sapl-2981"},"issue":{"kind":"string","value":"Retirar a OBRIGATORIEDADE na pesquisar para adicionar várias matérias na ordem do dia\n<!--- Forneça um resumo geral da _issue_ no título acima -->\r\n\r\n## Comportamento Esperado\r\n<!--- Se você está descrevendo um _bug_, conte-nos o que deveria acontecer. -->\r\n<!--- Se você está sugerindo uma mudança/melhoria, conte-nos como deve funcionar. -->\r\nAo adicionar várias matérias na ordem do dia, na aba de várias matérias, gostaria de poder por exemplo digita apenas o TIPO DE MATÉRIA , e depois escolher as matérias para adicionar, sem que o usuário FOSSE OBRIGADO A SABER O STATUS da matéria, além disso por exemplo REQUERIMENTOS é uma especia de matéria que não tramita na CASA, ele fica sem STATUS, impossibilitando a inclusão na ordem do dia pela aba várias matérias. \r\n\r\n## Comportamento Atual\r\n<!--- Se está descrevendo um bug, conte-nos o que acontece em vez do comportamento esperado. -->\r\n<!--- Se está sugerindo uma mudança/melhoria, explique a diferença com o comportamento atual. -->\r\nO usuário tem que saber o status da matéria para poder pesquisar, essa pesquisa poderia ficar sem campos obrigatórios\r\n\r\n## Possível Solução\r\n<!--- Não é obrigatório, mas sugira uma possível correção/razão para o bug -->\r\n<!--- ou ideias de como implementar a adição/mudança. -->\r\nApenas retirar a OBRIGATORIEDADE DA PESQUISA , No caso o campo STATUS\r\n\r\n## Passos para Reproduzir (para bugs)\r\n<!--- Forneça um link para um exemplo, ou um conjunto de passos inequívocos -->\r\n<!--- para reproduzir esse bug. Inclua código para reproduzir, se relevante. -->\r\n1.\r\n2.\r\n3.\r\n4.\r\n\r\n## Contexto\r\n<!--- Como esse problema o afeta? O que você está tentando realizar? -->\r\n<!--- Fornecer o contexto nos ajuda a encontrar uma solução que seja mais útil no mundo real -->\r\n\r\n## Imagens do Ocorrido\r\n<!--- Representação visual em vídeo ou imagem do ocorrido -->\r\n<!--- Se está descrevendo um bug poste imagens ou vídeos na repordução do bug citado, caso se aplique -->\r\n\r\n\r\n## Seu Ambiente\r\n<!--- Inclua detalhes relevantes sobre o ambiente em que você presenciou/experienciou o bug. -->\r\n* Versão usada (_Release_):\r\n* Nome e versão do navegador:\r\n* Nome e versão do Sistema Operacional (desktop ou mobile):\r\n* Link para o seu projeto (Caso de fork deste projeto):\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"from datetime import datetime\n\nfrom crispy_forms.layout import HTML, Button, Fieldset, Layout\nfrom django import forms\nfrom django.contrib.contenttypes.models import ContentType\nfrom django.core.exceptions import ObjectDoesNotExist, ValidationError\nfrom django.db import transaction\nfrom django.db.models import Q\nfrom django.forms import ModelForm\nfrom django.forms.widgets import CheckboxSelectMultiple\nfrom django.utils.translation import ugettext_lazy as _\nimport django_filters\n\nfrom sapl.settings import MAX_DOC_UPLOAD_SIZE\nfrom sapl.base.models import Autor, TipoAutor\nfrom sapl.crispy_layout_mixin import SaplFormHelper\nfrom sapl.crispy_layout_mixin import form_actions, to_row, SaplFormLayout\nfrom sapl.materia.forms import MateriaLegislativaFilterSet\nfrom sapl.materia.models import (MateriaLegislativa, StatusTramitacao,\n TipoMateriaLegislativa)\nfrom sapl.parlamentares.models import Parlamentar, Mandato\nfrom sapl.utils import (RANGE_DIAS_MES, RANGE_MESES,\n MateriaPesquisaOrderingFilter, autor_label,\n autor_modal, timezone, choice_anos_com_sessaoplenaria,\n FileFieldCheckMixin)\n\nfrom .models import (Bancada, ExpedienteMateria, JustificativaAusencia,\n Orador, OradorExpediente, OrdemDia, PresencaOrdemDia, SessaoPlenaria,\n SessaoPlenariaPresenca, TipoResultadoVotacao,\n OcorrenciaSessao, RetiradaPauta, TipoRetiradaPauta, OradorOrdemDia, ORDENACAO_RESUMO,\n ResumoOrdenacao)\n\n\nMES_CHOICES = RANGE_MESES\nDIA_CHOICES = RANGE_DIAS_MES\n\n\nclass SessaoPlenariaForm(FileFieldCheckMixin, ModelForm):\n\n class Meta:\n model = SessaoPlenaria\n exclude = ['cod_andamento_sessao']\n\n def clean(self):\n super(SessaoPlenariaForm, self).clean()\n\n if not self.is_valid():\n return self.cleaned_data\n\n instance = self.instance\n\n num = self.cleaned_data['numero']\n sl = self.cleaned_data['sessao_legislativa']\n leg = self.cleaned_data['legislatura']\n tipo = self.cleaned_data['tipo']\n abertura = self.cleaned_data['data_inicio']\n encerramento = self.cleaned_data['data_fim']\n\n error = ValidationError(\n \"Número de Sessão Plenária já existente \"\n \"para a Legislatura, Sessão Legislativa e Tipo informados. \"\n \"Favor escolher um número distinto.\")\n\n qs = tipo.queryset_tipo_numeracao(leg, sl, abertura)\n qs &= Q(numero=num)\n\n if SessaoPlenaria.objects.filter(qs).exclude(pk=instance.pk).exists():\n raise error\n\n # Condições da verificação\n abertura_entre_leg = leg.data_inicio <= abertura <= leg.data_fim\n abertura_entre_sl = sl.data_inicio <= abertura <= sl.data_fim\n if encerramento is not None:\n encerramento_entre_leg = leg.data_inicio <= encerramento <= leg.data_fim\n encerramento_entre_sl = sl.data_inicio <= encerramento <= sl.data_fim\n # Verificação das datas de abertura e encerramento da Sessão\n # Verificações com a data de encerramento preenchidas\n if encerramento is not None:\n # Verifica se a data de encerramento é anterior a data de abertura\n if encerramento < abertura:\n raise ValidationError(\"A data de encerramento não pode ser \"\n \"anterior a data de abertura.\")\n # Verifica se a data de abertura está entre a data de início e fim\n # da legislatura\n if abertura_entre_leg and encerramento_entre_leg:\n if abertura_entre_sl and encerramento_entre_sl:\n pass\n elif abertura_entre_sl and not encerramento_entre_sl:\n raise ValidationError(\"A data de encerramento deve estar entre \"\n \"as datas de início e fim da Sessão Legislativa.\")\n elif not abertura_entre_sl and encerramento_entre_sl:\n raise ValidationError(\"A data de abertura deve estar entre as \"\n \"datas de início e fim da Sessão Legislativa.\")\n elif not abertura_entre_sl and not encerramento_entre_sl:\n raise ValidationError(\"A data de abertura e de encerramento devem estar \"\n \"entre as datas de início e fim da Sessão Legislativa.\")\n elif abertura_entre_leg and not encerramento_entre_leg:\n if abertura_entre_sl and encerramento_entre_sl:\n raise ValidationError(\"A data de encerramento deve estar entre \"\n \"as datas de início e fim da Legislatura.\")\n elif abertura_entre_sl and not encerramento_entre_sl:\n raise ValidationError(\"A data de encerramento deve estar entre \"\n \"as datas de início e fim tanto da \"\n \"Legislatura quanto da Sessão Legislativa.\")\n elif not abertura_entre_sl and encerramento_entre_sl:\n raise ValidationError(\"As datas de abertura e encerramento devem \"\n \"estar entre as \"\n \"datas de início e fim tanto Legislatura \"\n \"quanto da Sessão Legislativa.\")\n elif not abertura_entre_sl and not encerramento_entre_sl:\n raise ValidationError(\"As datas de abertura e encerramento devem \"\n \"estar entre as \"\n \"datas de início e fim tanto Legislatura \"\n \"quanto da Sessão Legislativa.\")\n elif not abertura_entre_leg and not encerramento_entre_leg:\n if abertura_entre_sl and encerramento_entre_sl:\n raise ValidationError(\"As datas de abertura e encerramento devem \"\n \"estar entre as \"\n \"datas de início e fim da Legislatura.\")\n elif abertura_entre_sl and not encerramento_entre_sl:\n raise ValidationError(\"As datas de abertura e encerramento devem \"\n \"estar entre as \"\n \"datas de início e fim tanto Legislatura \"\n \"quanto da Sessão Legislativa.\")\n elif not abertura_entre_sl and encerramento_entre_sl:\n raise ValidationError(\"As datas de abertura e encerramento devem \"\n \"estar entre as \"\n \"datas de início e fim tanto Legislatura \"\n \"quanto da Sessão Legislativa.\")\n elif not abertura_entre_sl and not encerramento_entre_sl:\n raise ValidationError(\"As datas de abertura e encerramento devem \"\n \"estar entre as \"\n \"datas de início e fim tanto Legislatura \"\n \"quanto da Sessão Legislativa.\")\n\n # Verificações com a data de encerramento vazia\n else:\n if abertura_entre_leg:\n if abertura_entre_sl:\n pass\n else:\n raise ValidationError(\"A data de abertura da sessão deve estar \"\n \"entre a data de início e fim da Sessão Legislativa.\")\n else:\n if abertura_entre_sl:\n raise ValidationError(\"A data de abertura da sessão deve estar \"\n \"entre a data de início e fim da Legislatura.\")\n else:\n raise ValidationError(\"A data de abertura da sessão deve estar \"\n \"entre a data de início e fim tanto da \"\n \"Legislatura quanto da Sessão Legislativa.\")\n\n\n upload_pauta = self.cleaned_data.get('upload_pauta', False)\n upload_ata = self.cleaned_data.get('upload_ata', False)\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\n\n if upload_pauta and upload_pauta.size > MAX_DOC_UPLOAD_SIZE:\n raise ValidationError(\"O arquivo Pauta da Sessão deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\" \\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_pauta.size/1024)/1024))\n \n if upload_ata and upload_ata.size > MAX_DOC_UPLOAD_SIZE:\n raise ValidationError(\"O arquivo Ata da Sessão deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\" \\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_ata.size/1024)/1024))\n \n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\n raise ValidationError(\"O arquivo Anexo da Sessão deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\" \\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\n \n\n return self.cleaned_data\n\n\nclass RetiradaPautaForm(ModelForm):\n\n tipo_de_retirada = forms.ModelChoiceField(required=True,\n empty_label='------------',\n queryset=TipoRetiradaPauta.objects.all())\n expediente = forms.ModelChoiceField(required=False,\n label='Matéria do Expediente',\n queryset=ExpedienteMateria.objects.all())\n ordem = forms.ModelChoiceField(required=False,\n label='Matéria da Ordem do Dia',\n queryset=OrdemDia.objects.all())\n materia = forms.ModelChoiceField(required=False,\n widget=forms.HiddenInput(),\n queryset=MateriaLegislativa.objects.all())\n\n class Meta:\n model = RetiradaPauta\n fields = ['ordem',\n 'expediente',\n 'parlamentar',\n 'tipo_de_retirada',\n 'data',\n 'observacao',\n 'materia']\n\n def __init__(self, *args, **kwargs):\n\n row1 = to_row([('tipo_de_retirada', 5),\n ('parlamentar', 4),\n ('data', 3)])\n row2 = to_row([('ordem', 6),\n ('expediente', 6)])\n row3 = to_row([('observacao', 12)])\n\n self.helper = SaplFormHelper()\n self.helper.layout = SaplFormLayout(\n Fieldset(_('Retirada de Pauta'),\n row1, row2, row3))\n\n q = Q(sessao_plenaria=kwargs['initial']['sessao_plenaria'])\n ordens = OrdemDia.objects.filter(q)\n expedientes = ExpedienteMateria.objects.filter(q)\n retiradas_ordem = [\n r.ordem for r in RetiradaPauta.objects.filter(q, ordem__in=ordens)]\n retiradas_expediente = [r.expediente for r in RetiradaPauta.objects.filter(\n q, expediente__in=expedientes)]\n setOrdem = set(ordens) - set(retiradas_ordem)\n setExpediente = set(expedientes) - set(retiradas_expediente)\n\n super(RetiradaPautaForm, self).__init__(\n *args, **kwargs)\n\n if self.instance.pk:\n setOrdem = set(ordens)\n setExpediente = set(expedientes)\n\n presencas = SessaoPlenariaPresenca.objects.filter(\n q).order_by('parlamentar__nome_parlamentar')\n presentes = [p.parlamentar for p in presencas]\n\n self.fields['expediente'].choices = [\n (None, \"------------\")] + [(e.id, e.materia) for e in setExpediente]\n self.fields['ordem'].choices = [\n (None, \"------------\")] + [(o.id, o.materia) for o in setOrdem]\n self.fields['parlamentar'].choices = [\n (None, \"------------\")] + [(p.id, p) for p in presentes]\n\n def clean(self):\n\n super(RetiradaPautaForm, self).clean()\n\n if not self.is_valid():\n return self.cleaned_data\n\n sessao_plenaria = self.instance.sessao_plenaria\n if self.cleaned_data['data'] < sessao_plenaria.data_inicio:\n raise ValidationError(\n _(\"Data de retirada de pauta anterior à abertura da Sessão.\"))\n if sessao_plenaria.data_fim and self.cleaned_data['data'] > sessao_plenaria.data_fim:\n raise ValidationError(\n _(\"Data de retirada de pauta posterior ao encerramento da Sessão.\"))\n\n if self.cleaned_data['ordem'] and self.cleaned_data['ordem'].registrovotacao_set.exists():\n raise ValidationError(\n _(\"Essa matéria já foi votada, portanto não pode ser retirada de pauta.\"))\n elif self.cleaned_data['expediente'] and self.cleaned_data['expediente'].registrovotacao_set.exists():\n raise ValidationError(\n _(\"Essa matéria já foi votada, portanto não pode ser retirada de pauta.\"))\n\n return self.cleaned_data\n\n def save(self, commit=False):\n retirada = super(RetiradaPautaForm, self).save(commit=commit)\n if retirada.ordem:\n ordem = retirada.ordem\n retirada.materia = ordem.materia\n ordem.votacao_aberta = False\n ordem.save()\n elif retirada.expediente:\n expediente = retirada.expediente\n retirada.materia = expediente.materia\n expediente.votacao_aberta = False\n expediente.save()\n retirada.save()\n return retirada\n\n\nclass BancadaForm(ModelForm):\n\n class Meta:\n model = Bancada\n fields = ['legislatura', 'nome', 'partido', 'data_criacao',\n 'data_extincao', 'descricao']\n\n def clean(self):\n super(BancadaForm, self).clean()\n\n if not self.is_valid():\n return self.cleaned_data\n\n data = self.cleaned_data\n\n legislatura = data['legislatura']\n\n data_criacao = data['data_criacao']\n if data_criacao:\n if (data_criacao < legislatura.data_inicio or\n data_criacao > legislatura.data_fim):\n raise ValidationError(_(\"Data de criação da bancada fora do intervalo\"\n \" de legislatura informada\"))\n\n data_extincao = data['data_extincao']\n if data_extincao:\n if (data_extincao < legislatura.data_inicio or\n data_extincao > legislatura.data_fim):\n raise ValidationError(_(\"Data fim da bancada fora do intervalo de\"\n \" legislatura informada\"))\n\n if self.cleaned_data['data_extincao']:\n if (self.cleaned_data['data_extincao'] <\n self.cleaned_data['data_criacao']):\n msg = _('Data de extinção não pode ser menor que a de criação')\n raise ValidationError(msg)\n return self.cleaned_data\n\n @transaction.atomic\n def save(self, commit=True):\n bancada = super(BancadaForm, self).save(commit)\n content_type = ContentType.objects.get_for_model(Bancada)\n object_id = bancada.pk\n tipo = TipoAutor.objects.get(content_type=content_type)\n Autor.objects.create(\n content_type=content_type,\n object_id=object_id,\n tipo=tipo,\n nome=bancada.nome\n )\n return bancada\n\n\nclass ExpedienteMateriaForm(ModelForm):\n\n _model = ExpedienteMateria\n data_atual = timezone.now()\n\n tipo_materia = forms.ModelChoiceField(\n label=_('Tipo Matéria'),\n required=True,\n queryset=TipoMateriaLegislativa.objects.all(),\n empty_label='Selecione',\n widget=forms.Select(attrs={'autocomplete': 'off'}))\n\n numero_materia = forms.CharField(\n label='Número Matéria', required=True,\n widget=forms.TextInput(attrs={'autocomplete': 'off'}))\n\n ano_materia = forms.CharField(\n label='Ano Matéria',\n initial=int(data_atual.year),\n required=True,\n widget=forms.TextInput(attrs={'autocomplete': 'off'}))\n\n data_ordem = forms.CharField(\n label='Data Sessão',\n initial=datetime.strftime(timezone.now(), '%d/%m/%Y'),\n widget=forms.TextInput(attrs={'readonly': 'readonly'}))\n\n class Meta:\n model = ExpedienteMateria\n fields = ['data_ordem', 'numero_ordem', 'tipo_materia', 'observacao',\n 'numero_materia', 'ano_materia', 'tipo_votacao']\n\n def clean_numero_ordem(self):\n sessao = self.instance.sessao_plenaria\n\n numero_ordem_exists = ExpedienteMateria.objects.filter(\n sessao_plenaria=sessao,\n numero_ordem=self.cleaned_data['numero_ordem']).exists()\n\n if numero_ordem_exists and not self.instance.pk:\n msg = _('Esse número de ordem já existe.')\n raise ValidationError(msg)\n\n return self.cleaned_data['numero_ordem']\n\n def clean_data_ordem(self):\n return self.instance.sessao_plenaria.data_inicio\n\n def clean(self):\n cleaned_data = super(ExpedienteMateriaForm, self).clean()\n if not self.is_valid():\n return cleaned_data\n\n sessao = self.instance.sessao_plenaria\n\n try:\n materia = MateriaLegislativa.objects.get(\n numero=self.cleaned_data['numero_materia'],\n ano=self.cleaned_data['ano_materia'],\n tipo=self.cleaned_data['tipo_materia'])\n except ObjectDoesNotExist:\n msg = _('A matéria a ser inclusa não existe no cadastro'\n ' de matérias legislativas.')\n raise ValidationError(msg)\n else:\n cleaned_data['materia'] = materia\n\n exists = self._model.objects.filter(\n sessao_plenaria=sessao,\n materia=materia).exists()\n\n if exists and not self.instance.pk:\n msg = _('Essa matéria já foi cadastrada.')\n raise ValidationError(msg)\n\n return cleaned_data\n\n def save(self, commit=False):\n expediente = super(ExpedienteMateriaForm, self).save(commit)\n expediente.materia = self.cleaned_data['materia']\n expediente.save()\n return expediente\n\n\nclass OrdemDiaForm(ExpedienteMateriaForm):\n\n _model = OrdemDia\n\n class Meta:\n model = OrdemDia\n fields = ['data_ordem', 'numero_ordem', 'tipo_materia', 'observacao',\n 'numero_materia', 'ano_materia', 'tipo_votacao']\n\n def clean_data_ordem(self):\n return self.instance.sessao_plenaria.data_inicio\n\n def clean_numero_ordem(self):\n sessao = self.instance.sessao_plenaria\n\n numero_ordem_exists = OrdemDia.objects.filter(\n sessao_plenaria=sessao,\n numero_ordem=self.cleaned_data['numero_ordem']).exists()\n\n if numero_ordem_exists and not self.instance.pk:\n msg = _('Esse número de ordem já existe.')\n raise ValidationError(msg)\n\n return self.cleaned_data['numero_ordem']\n\n def clean(self):\n cleaned_data = super(OrdemDiaForm, self).clean()\n if not self.is_valid():\n return cleaned_data\n return self.cleaned_data\n\n def save(self, commit=False):\n ordem = super(OrdemDiaForm, self).save(commit)\n ordem.materia = self.cleaned_data['materia']\n ordem.save()\n return ordem\n\n\nclass PresencaForm(forms.Form):\n presenca = forms.CharField(required=False, initial=False)\n parlamentar = forms.CharField(required=False, max_length=20)\n\n\nclass ListMateriaForm(forms.Form):\n error_message = forms.CharField(required=False, label='votacao_aberta')\n\n\nclass MesaForm(forms.Form):\n parlamentar = forms.IntegerField(required=True)\n cargo = forms.IntegerField(required=True)\n\n\nclass ExpedienteForm(forms.Form):\n conteudo = forms.CharField(required=False, widget=forms.Textarea)\n\n\nclass OcorrenciaSessaoForm(ModelForm):\n class Meta:\n model = OcorrenciaSessao\n fields = ['conteudo']\n\n\nclass VotacaoForm(forms.Form):\n votos_sim = forms.IntegerField(label='Sim')\n votos_nao = forms.IntegerField(label='Não')\n abstencoes = forms.IntegerField(label='Abstenções')\n total_presentes = forms.IntegerField(\n required=False, widget=forms.HiddenInput())\n total_votantes = forms.IntegerField(\n required=False, widget=forms.HiddenInput()\n )\n voto_presidente = forms.IntegerField(\n label='A totalização inclui o voto do Presidente?')\n total_votos = forms.IntegerField(required=False, label='total')\n observacao = forms.CharField(required=False, label='Observação')\n resultado_votacao = forms.CharField(label='Resultado da Votação')\n\n def clean(self):\n cleaned_data = super(VotacaoForm, self).clean()\n if not self.is_valid():\n return cleaned_data\n\n votos_sim = cleaned_data['votos_sim']\n votos_nao = cleaned_data['votos_nao']\n abstencoes = cleaned_data['abstencoes']\n qtde_presentes = cleaned_data['total_presentes']\n qtde_votantes = cleaned_data['total_votantes']\n qtde_votos = votos_sim + votos_nao + abstencoes\n voto_presidente = cleaned_data['voto_presidente']\n\n if qtde_votantes and not voto_presidente:\n qtde_votantes -= 1\n\n if qtde_votantes and qtde_votos != qtde_votantes:\n raise ValidationError(\n 'O total de votos não corresponde com a quantidade de votantes!')\n\n return cleaned_data\n\n # def save(self, commit=False):\n # #TODO Verificar se esse códido é utilizado\n\n # votacao = super(VotacaoForm, self).save(commit)\n # votacao.materia = self.cleaned_data['materia']\n # votacao.save()\n # return votacao\n\n\nclass VotacaoNominalForm(forms.Form):\n resultado_votacao = forms.ModelChoiceField(label='Resultado da Votação',\n required=False,\n queryset=TipoResultadoVotacao.objects.all())\n\n\nclass VotacaoEditForm(forms.Form):\n pass\n\n\nclass SessaoPlenariaFilterSet(django_filters.FilterSet):\n\n data_inicio__year = django_filters.ChoiceFilter(\n required=False,\n label='Ano',\n choices=choice_anos_com_sessaoplenaria\n )\n data_inicio__month = django_filters.ChoiceFilter(required=False,\n label='Mês',\n choices=MES_CHOICES)\n data_inicio__day = django_filters.ChoiceFilter(required=False,\n label='Dia',\n choices=DIA_CHOICES)\n titulo = _('Pesquisa de Sessão Plenária')\n\n class Meta:\n model = SessaoPlenaria\n fields = ['tipo']\n\n def __init__(self, *args, **kwargs):\n super(SessaoPlenariaFilterSet, self).__init__(*args, **kwargs)\n\n # pré-popula o campo do formulário com o ano corrente\n self.form.fields['data_inicio__year'].initial = timezone.now().year\n\n row1 = to_row(\n [('data_inicio__year', 3),\n ('data_inicio__month', 3),\n ('data_inicio__day', 3),\n ('tipo', 3)])\n\n self.form.helper = SaplFormHelper()\n self.form.helper.form_method = 'GET'\n self.form.helper.layout = Layout(\n Fieldset(self.titulo,\n row1,\n form_actions(label='Pesquisar'))\n )\n\n\nclass AdicionarVariasMateriasFilterSet(MateriaLegislativaFilterSet):\n\n o = MateriaPesquisaOrderingFilter()\n tramitacao__status = django_filters.ModelChoiceFilter(\n required=True,\n queryset=StatusTramitacao.objects.all(),\n label=_('Status da Matéria'))\n\n class Meta:\n model = MateriaLegislativa\n fields = ['tramitacao__status',\n 'numero',\n 'numero_protocolo',\n 'ano',\n 'tipo',\n 'data_apresentacao',\n 'data_publicacao',\n 'autoria__autor__tipo',\n # FIXME 'autoria__autor__partido',\n 'relatoria__parlamentar_id',\n 'local_origem_externa',\n 'em_tramitacao',\n ]\n\n def __init__(self, *args, **kwargs):\n super(MateriaLegislativaFilterSet, self).__init__(*args, **kwargs)\n\n self.filters['tipo'].label = 'Tipo de Matéria'\n self.filters['autoria__autor__tipo'].label = 'Tipo de Autor'\n # self.filters['autoria__autor__partido'].label = 'Partido do Autor'\n self.filters['relatoria__parlamentar_id'].label = 'Relatoria'\n\n row1 = to_row(\n [('tramitacao__status', 12)])\n row2 = to_row(\n [('tipo', 12)])\n row3 = to_row(\n [('numero', 4),\n ('ano', 4),\n ('numero_protocolo', 4)])\n row4 = to_row(\n [('data_apresentacao', 6),\n ('data_publicacao', 6)])\n row5 = to_row(\n [('autoria__autor', 0),\n (Button('pesquisar',\n 'Pesquisar Autor',\n css_class='btn btn-primary btn-sm'), 2),\n (Button('limpar',\n 'limpar Autor',\n css_class='btn btn-primary btn-sm'), 10)])\n row6 = to_row(\n [('autoria__autor__tipo', 6),\n # ('autoria__autor__partido', 6)\n ])\n row7 = to_row(\n [('relatoria__parlamentar_id', 6),\n ('local_origem_externa', 6)])\n row8 = to_row(\n [('em_tramitacao', 6),\n ('o', 6)])\n row9 = to_row(\n [('ementa', 12)])\n\n self.form.helper = SaplFormHelper()\n self.form.helper.form_method = 'GET'\n self.form.helper.layout = Layout(\n Fieldset(_('Pesquisa de Matéria'),\n row1, row2, row3,\n HTML(autor_label),\n HTML(autor_modal),\n row4, row5, row6, row7, row8, row9,\n form_actions(label='Pesquisar'))\n )\n\n\nclass OradorForm(ModelForm):\n def __init__(self, *args, **kwargs):\n super().__init__(*args, **kwargs)\n self.fields['parlamentar'].queryset = \\\n Parlamentar.objects.filter(ativo=True).order_by('nome_parlamentar')\n\n def clean(self):\n super(OradorForm, self).clean()\n cleaned_data = self.cleaned_data\n\n if not self.is_valid():\n return self.cleaned_data\n\n sessao_id = self.initial['id_sessao']\n numero = self.initial.get('numero')\n numero_ordem = cleaned_data['numero_ordem']\n ordem = Orador.objects.filter(\n sessao_plenaria_id=sessao_id,\n numero_ordem=numero_ordem\n ).exists()\n\n if ordem and numero_ordem != numero:\n raise ValidationError(_(\n \"Já existe orador nesta posição de ordem de pronunciamento\"\n ))\n\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\n\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\n raise ValidationError(\"O arquivo Anexo do Orador deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\" \\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\n\n return self.cleaned_data\n\n class Meta:\n model = Orador\n exclude = ['sessao_plenaria']\n\n\nclass OradorExpedienteForm(ModelForm):\n def __init__(self, *args, **kwargs):\n super().__init__(*args, **kwargs)\n id_sessao = int(self.initial['id_sessao'])\n sessao = SessaoPlenaria.objects.get(id=id_sessao)\n legislatura_vigente = sessao.legislatura\n self.fields['parlamentar'].queryset = \\\n Parlamentar.objects.filter(mandato__legislatura=legislatura_vigente,\n ativo=True).order_by('nome_parlamentar')\n\n def clean(self):\n super(OradorExpedienteForm, self).clean()\n cleaned_data = self.cleaned_data\n\n if not self.is_valid():\n return self.cleaned_data\n\n sessao_id = self.initial['id_sessao']\n numero = self.initial.get('numero', None)\n ordem = OradorExpediente.objects.filter(\n sessao_plenaria_id=sessao_id,\n numero_ordem=cleaned_data['numero_ordem']\n ).exists()\n\n if ordem and (cleaned_data['numero_ordem'] != numero):\n raise ValidationError(_(\n 'Já existe orador nesta posição da ordem de pronunciamento'))\n\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\n\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\n raise ValidationError(\"O arquivo Anexo do Orador deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\" \\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\n\n return self.cleaned_data\n\n class Meta:\n model = OradorExpediente\n exclude = ['sessao_plenaria']\n\n\nclass OradorOrdemDiaForm(ModelForm):\n def __init__(self, *args, **kwargs):\n super().__init__(*args, **kwargs)\n id_sessao = int(self.initial['id_sessao'])\n sessao = SessaoPlenaria.objects.get(id=id_sessao)\n legislatura_vigente = sessao.legislatura\n self.fields['parlamentar'].queryset = \\\n Parlamentar.objects.filter(mandato__legislatura=legislatura_vigente,\n ativo=True).order_by('nome_parlamentar')\n\n def clean(self):\n super(OradorOrdemDiaForm, self).clean()\n cleaned_data = self.cleaned_data\n\n if not self.is_valid():\n return self.cleaned_data\n\n sessao_id = self.initial['id_sessao']\n numero = self.initial.get('numero')\n numero_ordem = cleaned_data['numero_ordem']\n ordem = OradorOrdemDia.objects.filter(\n sessao_plenaria_id=sessao_id,\n numero_ordem=numero_ordem\n ).exists()\n\n if ordem and numero_ordem != numero:\n raise ValidationError(_(\n \"Já existe orador nesta posição de ordem de pronunciamento\"\n ))\n\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\n\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\n raise ValidationError(\"O arquivo Anexo do Orador deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\" \\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\n\n return self.cleaned_data\n\n class Meta:\n model = OradorOrdemDia\n exclude = ['sessao_plenaria']\n\n\nclass PautaSessaoFilterSet(SessaoPlenariaFilterSet):\n titulo = _('Pesquisa de Pauta de Sessão')\n\n\nclass ResumoOrdenacaoForm(forms.Form):\n primeiro = forms.ChoiceField(\n label='1°',\n choices=ORDENACAO_RESUMO\n )\n segundo = forms.ChoiceField(\n label='2°',\n choices=ORDENACAO_RESUMO\n )\n terceiro = forms.ChoiceField(\n label='3°',\n choices=ORDENACAO_RESUMO\n )\n quarto = forms.ChoiceField(\n label='4°',\n choices=ORDENACAO_RESUMO\n )\n quinto = forms.ChoiceField(\n label='5°',\n choices=ORDENACAO_RESUMO\n )\n sexto = forms.ChoiceField(\n label='6°',\n choices=ORDENACAO_RESUMO\n )\n setimo = forms.ChoiceField(\n label='7°',\n choices=ORDENACAO_RESUMO\n )\n oitavo = forms.ChoiceField(\n label='8°',\n choices=ORDENACAO_RESUMO\n )\n nono = forms.ChoiceField(\n label='9°',\n choices=ORDENACAO_RESUMO\n )\n decimo = forms.ChoiceField(\n label='10°',\n choices=ORDENACAO_RESUMO\n )\n decimo_primeiro = forms.ChoiceField(\n label='11°',\n choices=ORDENACAO_RESUMO\n )\n decimo_segundo = forms.ChoiceField(\n label='12°',\n choices=ORDENACAO_RESUMO\n )\n decimo_terceiro = forms.ChoiceField(\n label='13°',\n choices=ORDENACAO_RESUMO\n )\n decimo_quarto = forms.ChoiceField(\n label='14°',\n choices=ORDENACAO_RESUMO\n )\n\n def __init__(self, *args, **kwargs):\n row1 = to_row(\n [('primeiro', 12)])\n row2 = to_row(\n [('segundo', 12)])\n row3 = to_row(\n [('terceiro', 12)])\n row4 = to_row(\n [('quarto', 12)])\n row5 = to_row(\n [('quinto', 12)])\n row6 = to_row(\n [('sexto', 12)])\n row7 = to_row(\n [('setimo', 12)])\n row8 = to_row(\n [('oitavo', 12)])\n row9 = to_row(\n [('nono', 12)])\n row10 = to_row(\n [('decimo', 12)])\n row11 = to_row(\n [('decimo_primeiro', 12)])\n row12 = to_row(\n [('decimo_segundo', 12)])\n row13 = to_row(\n [('decimo_terceiro', 12)])\n row14 = to_row(\n [('decimo_quarto', 12)]\n )\n\n self.helper = SaplFormHelper()\n self.helper.layout = Layout(\n Fieldset(_(''),\n row1, row2, row3, row4, row5,\n row6, row7, row8, row9, row10,\n row11, row12, row13, row14,\n form_actions(label='Atualizar'))\n )\n\n super().__init__(*args, **kwargs)\n\n def clean(self):\n super(ResumoOrdenacaoForm, self).clean()\n\n if not self.is_valid():\n return self.cleaned_data\n\n cleaned_data = self.cleaned_data\n\n for c1 in cleaned_data:\n i = 0\n for c2 in cleaned_data:\n if cleaned_data[str(c1)] == cleaned_data[str(c2)]:\n i = i + 1\n if i > 1:\n raise ValidationError(_(\n 'Não é possível ter campos repetidos'))\n return self.cleaned_data\n\n def save(self):\n ordenacao = ResumoOrdenacao.objects.get()\n cleaned_data = self.cleaned_data\n\n ordenacao.primeiro = cleaned_data['primeiro']\n ordenacao.segundo = cleaned_data['segundo']\n ordenacao.terceiro = cleaned_data['terceiro']\n ordenacao.quarto = cleaned_data['quarto']\n ordenacao.quinto = cleaned_data['quinto']\n ordenacao.sexto = cleaned_data['sexto']\n ordenacao.setimo = cleaned_data['setimo']\n ordenacao.oitavo = cleaned_data['oitavo']\n ordenacao.nono = cleaned_data['nono']\n ordenacao.decimo = cleaned_data['decimo']\n ordenacao.decimo_primeiro = cleaned_data['decimo_primeiro']\n ordenacao.decimo_segundo = cleaned_data['decimo_segundo']\n ordenacao.decimo_terceiro = cleaned_data['decimo_terceiro']\n ordenacao.decimo_quarto = cleaned_data['decimo_quarto']\n\n ordenacao.save()\n\n\nclass JustificativaAusenciaForm(ModelForm):\n\n class Meta:\n model = JustificativaAusencia\n fields = ['parlamentar',\n 'hora',\n 'data',\n 'upload_anexo',\n 'tipo_ausencia',\n 'ausencia',\n 'materias_do_expediente',\n 'materias_da_ordem_do_dia',\n 'observacao'\n ]\n\n widgets = {\n 'materias_do_expediente': CheckboxSelectMultiple(),\n 'materias_da_ordem_do_dia': CheckboxSelectMultiple()}\n\n def __init__(self, *args, **kwargs):\n\n row1 = to_row(\n [('parlamentar', 12)])\n row2 = to_row(\n [('data', 6),\n ('hora', 6)])\n row3 = to_row(\n [('upload_anexo', 6)])\n row4 = to_row(\n [('tipo_ausencia', 12)])\n row5 = to_row(\n [('ausencia', 12)])\n row6 = to_row(\n [('materias_do_expediente', 12)])\n row7 = to_row(\n [('materias_da_ordem_do_dia', 12)])\n row8 = to_row(\n [('observacao', 12)])\n\n self.helper = SaplFormHelper()\n self.helper.layout = SaplFormLayout(\n Fieldset(_('Justificativa de Ausência'),\n row1, row2, row3,\n row4, row5,\n row6,\n row7,\n row8)\n )\n q = Q(sessao_plenaria=kwargs['initial']['sessao_plenaria'])\n ordens = OrdemDia.objects.filter(q)\n expedientes = ExpedienteMateria.objects.filter(q)\n legislatura = kwargs['initial']['sessao_plenaria'].legislatura\n mandato = Mandato.objects.filter(\n legislatura=legislatura).order_by('parlamentar__nome_parlamentar')\n parlamentares = [m.parlamentar for m in mandato]\n\n super(JustificativaAusenciaForm, self).__init__(\n *args, **kwargs)\n\n presencas = SessaoPlenariaPresenca.objects.filter(\n q).order_by('parlamentar__nome_parlamentar')\n presencas_ordem = PresencaOrdemDia.objects.filter(\n q).order_by('parlamentar__nome_parlamentar')\n\n presentes = [p.parlamentar for p in presencas]\n presentes_ordem = [p.parlamentar for p in presencas_ordem]\n\n presentes_ambos = set(presentes).intersection(set(presentes_ordem))\n setFinal = set(parlamentares) - presentes_ambos\n\n self.fields['materias_do_expediente'].choices = [\n (e.id, e.materia) for e in expedientes]\n\n self.fields['materias_da_ordem_do_dia'].choices = [\n (o.id, o.materia) for o in ordens]\n\n self.fields['parlamentar'].choices = [\n (\"0\", \"------------\")] + [(p.id, p) for p in setFinal]\n\n def clean(self):\n super(JustificativaAusenciaForm, self).clean()\n\n if not self.is_valid():\n return self.cleaned_data\n\n sessao_plenaria = self.instance.sessao_plenaria\n\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\n\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\n raise ValidationError(\"O arquivo Anexo de Justificativa deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\" \\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\n\n if not sessao_plenaria.finalizada or sessao_plenaria.finalizada is None:\n raise ValidationError(\n \"A sessão deve estar finalizada para registrar uma Ausência\")\n else:\n return self.cleaned_data\n\n def save(self):\n\n justificativa = super().save(True)\n\n if justificativa.ausencia == 2:\n justificativa.materias_do_expediente.clear()\n justificativa.materias_da_ordem_do_dia.clear()\n return justificativa\n","path":"sapl/sessao/forms.py"}],"string":"[\n {\n \"content\": \"from datetime import datetime\\n\\nfrom crispy_forms.layout import HTML, Button, Fieldset, Layout\\nfrom django import forms\\nfrom django.contrib.contenttypes.models import ContentType\\nfrom django.core.exceptions import ObjectDoesNotExist, ValidationError\\nfrom django.db import transaction\\nfrom django.db.models import Q\\nfrom django.forms import ModelForm\\nfrom django.forms.widgets import CheckboxSelectMultiple\\nfrom django.utils.translation import ugettext_lazy as _\\nimport django_filters\\n\\nfrom sapl.settings import MAX_DOC_UPLOAD_SIZE\\nfrom sapl.base.models import Autor, TipoAutor\\nfrom sapl.crispy_layout_mixin import SaplFormHelper\\nfrom sapl.crispy_layout_mixin import form_actions, to_row, SaplFormLayout\\nfrom sapl.materia.forms import MateriaLegislativaFilterSet\\nfrom sapl.materia.models import (MateriaLegislativa, StatusTramitacao,\\n TipoMateriaLegislativa)\\nfrom sapl.parlamentares.models import Parlamentar, Mandato\\nfrom sapl.utils import (RANGE_DIAS_MES, RANGE_MESES,\\n MateriaPesquisaOrderingFilter, autor_label,\\n autor_modal, timezone, choice_anos_com_sessaoplenaria,\\n FileFieldCheckMixin)\\n\\nfrom .models import (Bancada, ExpedienteMateria, JustificativaAusencia,\\n Orador, OradorExpediente, OrdemDia, PresencaOrdemDia, SessaoPlenaria,\\n SessaoPlenariaPresenca, TipoResultadoVotacao,\\n OcorrenciaSessao, RetiradaPauta, TipoRetiradaPauta, OradorOrdemDia, ORDENACAO_RESUMO,\\n ResumoOrdenacao)\\n\\n\\nMES_CHOICES = RANGE_MESES\\nDIA_CHOICES = RANGE_DIAS_MES\\n\\n\\nclass SessaoPlenariaForm(FileFieldCheckMixin, ModelForm):\\n\\n class Meta:\\n model = SessaoPlenaria\\n exclude = ['cod_andamento_sessao']\\n\\n def clean(self):\\n super(SessaoPlenariaForm, self).clean()\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n instance = self.instance\\n\\n num = self.cleaned_data['numero']\\n sl = self.cleaned_data['sessao_legislativa']\\n leg = self.cleaned_data['legislatura']\\n tipo = self.cleaned_data['tipo']\\n abertura = self.cleaned_data['data_inicio']\\n encerramento = self.cleaned_data['data_fim']\\n\\n error = ValidationError(\\n \\\"Número de Sessão Plenária já existente \\\"\\n \\\"para a Legislatura, Sessão Legislativa e Tipo informados. \\\"\\n \\\"Favor escolher um número distinto.\\\")\\n\\n qs = tipo.queryset_tipo_numeracao(leg, sl, abertura)\\n qs &= Q(numero=num)\\n\\n if SessaoPlenaria.objects.filter(qs).exclude(pk=instance.pk).exists():\\n raise error\\n\\n # Condições da verificação\\n abertura_entre_leg = leg.data_inicio <= abertura <= leg.data_fim\\n abertura_entre_sl = sl.data_inicio <= abertura <= sl.data_fim\\n if encerramento is not None:\\n encerramento_entre_leg = leg.data_inicio <= encerramento <= leg.data_fim\\n encerramento_entre_sl = sl.data_inicio <= encerramento <= sl.data_fim\\n # Verificação das datas de abertura e encerramento da Sessão\\n # Verificações com a data de encerramento preenchidas\\n if encerramento is not None:\\n # Verifica se a data de encerramento é anterior a data de abertura\\n if encerramento < abertura:\\n raise ValidationError(\\\"A data de encerramento não pode ser \\\"\\n \\\"anterior a data de abertura.\\\")\\n # Verifica se a data de abertura está entre a data de início e fim\\n # da legislatura\\n if abertura_entre_leg and encerramento_entre_leg:\\n if abertura_entre_sl and encerramento_entre_sl:\\n pass\\n elif abertura_entre_sl and not encerramento_entre_sl:\\n raise ValidationError(\\\"A data de encerramento deve estar entre \\\"\\n \\\"as datas de início e fim da Sessão Legislativa.\\\")\\n elif not abertura_entre_sl and encerramento_entre_sl:\\n raise ValidationError(\\\"A data de abertura deve estar entre as \\\"\\n \\\"datas de início e fim da Sessão Legislativa.\\\")\\n elif not abertura_entre_sl and not encerramento_entre_sl:\\n raise ValidationError(\\\"A data de abertura e de encerramento devem estar \\\"\\n \\\"entre as datas de início e fim da Sessão Legislativa.\\\")\\n elif abertura_entre_leg and not encerramento_entre_leg:\\n if abertura_entre_sl and encerramento_entre_sl:\\n raise ValidationError(\\\"A data de encerramento deve estar entre \\\"\\n \\\"as datas de início e fim da Legislatura.\\\")\\n elif abertura_entre_sl and not encerramento_entre_sl:\\n raise ValidationError(\\\"A data de encerramento deve estar entre \\\"\\n \\\"as datas de início e fim tanto da \\\"\\n \\\"Legislatura quanto da Sessão Legislativa.\\\")\\n elif not abertura_entre_sl and encerramento_entre_sl:\\n raise ValidationError(\\\"As datas de abertura e encerramento devem \\\"\\n \\\"estar entre as \\\"\\n \\\"datas de início e fim tanto Legislatura \\\"\\n \\\"quanto da Sessão Legislativa.\\\")\\n elif not abertura_entre_sl and not encerramento_entre_sl:\\n raise ValidationError(\\\"As datas de abertura e encerramento devem \\\"\\n \\\"estar entre as \\\"\\n \\\"datas de início e fim tanto Legislatura \\\"\\n \\\"quanto da Sessão Legislativa.\\\")\\n elif not abertura_entre_leg and not encerramento_entre_leg:\\n if abertura_entre_sl and encerramento_entre_sl:\\n raise ValidationError(\\\"As datas de abertura e encerramento devem \\\"\\n \\\"estar entre as \\\"\\n \\\"datas de início e fim da Legislatura.\\\")\\n elif abertura_entre_sl and not encerramento_entre_sl:\\n raise ValidationError(\\\"As datas de abertura e encerramento devem \\\"\\n \\\"estar entre as \\\"\\n \\\"datas de início e fim tanto Legislatura \\\"\\n \\\"quanto da Sessão Legislativa.\\\")\\n elif not abertura_entre_sl and encerramento_entre_sl:\\n raise ValidationError(\\\"As datas de abertura e encerramento devem \\\"\\n \\\"estar entre as \\\"\\n \\\"datas de início e fim tanto Legislatura \\\"\\n \\\"quanto da Sessão Legislativa.\\\")\\n elif not abertura_entre_sl and not encerramento_entre_sl:\\n raise ValidationError(\\\"As datas de abertura e encerramento devem \\\"\\n \\\"estar entre as \\\"\\n \\\"datas de início e fim tanto Legislatura \\\"\\n \\\"quanto da Sessão Legislativa.\\\")\\n\\n # Verificações com a data de encerramento vazia\\n else:\\n if abertura_entre_leg:\\n if abertura_entre_sl:\\n pass\\n else:\\n raise ValidationError(\\\"A data de abertura da sessão deve estar \\\"\\n \\\"entre a data de início e fim da Sessão Legislativa.\\\")\\n else:\\n if abertura_entre_sl:\\n raise ValidationError(\\\"A data de abertura da sessão deve estar \\\"\\n \\\"entre a data de início e fim da Legislatura.\\\")\\n else:\\n raise ValidationError(\\\"A data de abertura da sessão deve estar \\\"\\n \\\"entre a data de início e fim tanto da \\\"\\n \\\"Legislatura quanto da Sessão Legislativa.\\\")\\n\\n\\n upload_pauta = self.cleaned_data.get('upload_pauta', False)\\n upload_ata = self.cleaned_data.get('upload_ata', False)\\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\\n\\n if upload_pauta and upload_pauta.size > MAX_DOC_UPLOAD_SIZE:\\n raise ValidationError(\\\"O arquivo Pauta da Sessão deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\\\" \\\\\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_pauta.size/1024)/1024))\\n \\n if upload_ata and upload_ata.size > MAX_DOC_UPLOAD_SIZE:\\n raise ValidationError(\\\"O arquivo Ata da Sessão deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\\\" \\\\\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_ata.size/1024)/1024))\\n \\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\\n raise ValidationError(\\\"O arquivo Anexo da Sessão deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\\\" \\\\\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\\n \\n\\n return self.cleaned_data\\n\\n\\nclass RetiradaPautaForm(ModelForm):\\n\\n tipo_de_retirada = forms.ModelChoiceField(required=True,\\n empty_label='------------',\\n queryset=TipoRetiradaPauta.objects.all())\\n expediente = forms.ModelChoiceField(required=False,\\n label='Matéria do Expediente',\\n queryset=ExpedienteMateria.objects.all())\\n ordem = forms.ModelChoiceField(required=False,\\n label='Matéria da Ordem do Dia',\\n queryset=OrdemDia.objects.all())\\n materia = forms.ModelChoiceField(required=False,\\n widget=forms.HiddenInput(),\\n queryset=MateriaLegislativa.objects.all())\\n\\n class Meta:\\n model = RetiradaPauta\\n fields = ['ordem',\\n 'expediente',\\n 'parlamentar',\\n 'tipo_de_retirada',\\n 'data',\\n 'observacao',\\n 'materia']\\n\\n def __init__(self, *args, **kwargs):\\n\\n row1 = to_row([('tipo_de_retirada', 5),\\n ('parlamentar', 4),\\n ('data', 3)])\\n row2 = to_row([('ordem', 6),\\n ('expediente', 6)])\\n row3 = to_row([('observacao', 12)])\\n\\n self.helper = SaplFormHelper()\\n self.helper.layout = SaplFormLayout(\\n Fieldset(_('Retirada de Pauta'),\\n row1, row2, row3))\\n\\n q = Q(sessao_plenaria=kwargs['initial']['sessao_plenaria'])\\n ordens = OrdemDia.objects.filter(q)\\n expedientes = ExpedienteMateria.objects.filter(q)\\n retiradas_ordem = [\\n r.ordem for r in RetiradaPauta.objects.filter(q, ordem__in=ordens)]\\n retiradas_expediente = [r.expediente for r in RetiradaPauta.objects.filter(\\n q, expediente__in=expedientes)]\\n setOrdem = set(ordens) - set(retiradas_ordem)\\n setExpediente = set(expedientes) - set(retiradas_expediente)\\n\\n super(RetiradaPautaForm, self).__init__(\\n *args, **kwargs)\\n\\n if self.instance.pk:\\n setOrdem = set(ordens)\\n setExpediente = set(expedientes)\\n\\n presencas = SessaoPlenariaPresenca.objects.filter(\\n q).order_by('parlamentar__nome_parlamentar')\\n presentes = [p.parlamentar for p in presencas]\\n\\n self.fields['expediente'].choices = [\\n (None, \\\"------------\\\")] + [(e.id, e.materia) for e in setExpediente]\\n self.fields['ordem'].choices = [\\n (None, \\\"------------\\\")] + [(o.id, o.materia) for o in setOrdem]\\n self.fields['parlamentar'].choices = [\\n (None, \\\"------------\\\")] + [(p.id, p) for p in presentes]\\n\\n def clean(self):\\n\\n super(RetiradaPautaForm, self).clean()\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n sessao_plenaria = self.instance.sessao_plenaria\\n if self.cleaned_data['data'] < sessao_plenaria.data_inicio:\\n raise ValidationError(\\n _(\\\"Data de retirada de pauta anterior à abertura da Sessão.\\\"))\\n if sessao_plenaria.data_fim and self.cleaned_data['data'] > sessao_plenaria.data_fim:\\n raise ValidationError(\\n _(\\\"Data de retirada de pauta posterior ao encerramento da Sessão.\\\"))\\n\\n if self.cleaned_data['ordem'] and self.cleaned_data['ordem'].registrovotacao_set.exists():\\n raise ValidationError(\\n _(\\\"Essa matéria já foi votada, portanto não pode ser retirada de pauta.\\\"))\\n elif self.cleaned_data['expediente'] and self.cleaned_data['expediente'].registrovotacao_set.exists():\\n raise ValidationError(\\n _(\\\"Essa matéria já foi votada, portanto não pode ser retirada de pauta.\\\"))\\n\\n return self.cleaned_data\\n\\n def save(self, commit=False):\\n retirada = super(RetiradaPautaForm, self).save(commit=commit)\\n if retirada.ordem:\\n ordem = retirada.ordem\\n retirada.materia = ordem.materia\\n ordem.votacao_aberta = False\\n ordem.save()\\n elif retirada.expediente:\\n expediente = retirada.expediente\\n retirada.materia = expediente.materia\\n expediente.votacao_aberta = False\\n expediente.save()\\n retirada.save()\\n return retirada\\n\\n\\nclass BancadaForm(ModelForm):\\n\\n class Meta:\\n model = Bancada\\n fields = ['legislatura', 'nome', 'partido', 'data_criacao',\\n 'data_extincao', 'descricao']\\n\\n def clean(self):\\n super(BancadaForm, self).clean()\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n data = self.cleaned_data\\n\\n legislatura = data['legislatura']\\n\\n data_criacao = data['data_criacao']\\n if data_criacao:\\n if (data_criacao < legislatura.data_inicio or\\n data_criacao > legislatura.data_fim):\\n raise ValidationError(_(\\\"Data de criação da bancada fora do intervalo\\\"\\n \\\" de legislatura informada\\\"))\\n\\n data_extincao = data['data_extincao']\\n if data_extincao:\\n if (data_extincao < legislatura.data_inicio or\\n data_extincao > legislatura.data_fim):\\n raise ValidationError(_(\\\"Data fim da bancada fora do intervalo de\\\"\\n \\\" legislatura informada\\\"))\\n\\n if self.cleaned_data['data_extincao']:\\n if (self.cleaned_data['data_extincao'] <\\n self.cleaned_data['data_criacao']):\\n msg = _('Data de extinção não pode ser menor que a de criação')\\n raise ValidationError(msg)\\n return self.cleaned_data\\n\\n @transaction.atomic\\n def save(self, commit=True):\\n bancada = super(BancadaForm, self).save(commit)\\n content_type = ContentType.objects.get_for_model(Bancada)\\n object_id = bancada.pk\\n tipo = TipoAutor.objects.get(content_type=content_type)\\n Autor.objects.create(\\n content_type=content_type,\\n object_id=object_id,\\n tipo=tipo,\\n nome=bancada.nome\\n )\\n return bancada\\n\\n\\nclass ExpedienteMateriaForm(ModelForm):\\n\\n _model = ExpedienteMateria\\n data_atual = timezone.now()\\n\\n tipo_materia = forms.ModelChoiceField(\\n label=_('Tipo Matéria'),\\n required=True,\\n queryset=TipoMateriaLegislativa.objects.all(),\\n empty_label='Selecione',\\n widget=forms.Select(attrs={'autocomplete': 'off'}))\\n\\n numero_materia = forms.CharField(\\n label='Número Matéria', required=True,\\n widget=forms.TextInput(attrs={'autocomplete': 'off'}))\\n\\n ano_materia = forms.CharField(\\n label='Ano Matéria',\\n initial=int(data_atual.year),\\n required=True,\\n widget=forms.TextInput(attrs={'autocomplete': 'off'}))\\n\\n data_ordem = forms.CharField(\\n label='Data Sessão',\\n initial=datetime.strftime(timezone.now(), '%d/%m/%Y'),\\n widget=forms.TextInput(attrs={'readonly': 'readonly'}))\\n\\n class Meta:\\n model = ExpedienteMateria\\n fields = ['data_ordem', 'numero_ordem', 'tipo_materia', 'observacao',\\n 'numero_materia', 'ano_materia', 'tipo_votacao']\\n\\n def clean_numero_ordem(self):\\n sessao = self.instance.sessao_plenaria\\n\\n numero_ordem_exists = ExpedienteMateria.objects.filter(\\n sessao_plenaria=sessao,\\n numero_ordem=self.cleaned_data['numero_ordem']).exists()\\n\\n if numero_ordem_exists and not self.instance.pk:\\n msg = _('Esse número de ordem já existe.')\\n raise ValidationError(msg)\\n\\n return self.cleaned_data['numero_ordem']\\n\\n def clean_data_ordem(self):\\n return self.instance.sessao_plenaria.data_inicio\\n\\n def clean(self):\\n cleaned_data = super(ExpedienteMateriaForm, self).clean()\\n if not self.is_valid():\\n return cleaned_data\\n\\n sessao = self.instance.sessao_plenaria\\n\\n try:\\n materia = MateriaLegislativa.objects.get(\\n numero=self.cleaned_data['numero_materia'],\\n ano=self.cleaned_data['ano_materia'],\\n tipo=self.cleaned_data['tipo_materia'])\\n except ObjectDoesNotExist:\\n msg = _('A matéria a ser inclusa não existe no cadastro'\\n ' de matérias legislativas.')\\n raise ValidationError(msg)\\n else:\\n cleaned_data['materia'] = materia\\n\\n exists = self._model.objects.filter(\\n sessao_plenaria=sessao,\\n materia=materia).exists()\\n\\n if exists and not self.instance.pk:\\n msg = _('Essa matéria já foi cadastrada.')\\n raise ValidationError(msg)\\n\\n return cleaned_data\\n\\n def save(self, commit=False):\\n expediente = super(ExpedienteMateriaForm, self).save(commit)\\n expediente.materia = self.cleaned_data['materia']\\n expediente.save()\\n return expediente\\n\\n\\nclass OrdemDiaForm(ExpedienteMateriaForm):\\n\\n _model = OrdemDia\\n\\n class Meta:\\n model = OrdemDia\\n fields = ['data_ordem', 'numero_ordem', 'tipo_materia', 'observacao',\\n 'numero_materia', 'ano_materia', 'tipo_votacao']\\n\\n def clean_data_ordem(self):\\n return self.instance.sessao_plenaria.data_inicio\\n\\n def clean_numero_ordem(self):\\n sessao = self.instance.sessao_plenaria\\n\\n numero_ordem_exists = OrdemDia.objects.filter(\\n sessao_plenaria=sessao,\\n numero_ordem=self.cleaned_data['numero_ordem']).exists()\\n\\n if numero_ordem_exists and not self.instance.pk:\\n msg = _('Esse número de ordem já existe.')\\n raise ValidationError(msg)\\n\\n return self.cleaned_data['numero_ordem']\\n\\n def clean(self):\\n cleaned_data = super(OrdemDiaForm, self).clean()\\n if not self.is_valid():\\n return cleaned_data\\n return self.cleaned_data\\n\\n def save(self, commit=False):\\n ordem = super(OrdemDiaForm, self).save(commit)\\n ordem.materia = self.cleaned_data['materia']\\n ordem.save()\\n return ordem\\n\\n\\nclass PresencaForm(forms.Form):\\n presenca = forms.CharField(required=False, initial=False)\\n parlamentar = forms.CharField(required=False, max_length=20)\\n\\n\\nclass ListMateriaForm(forms.Form):\\n error_message = forms.CharField(required=False, label='votacao_aberta')\\n\\n\\nclass MesaForm(forms.Form):\\n parlamentar = forms.IntegerField(required=True)\\n cargo = forms.IntegerField(required=True)\\n\\n\\nclass ExpedienteForm(forms.Form):\\n conteudo = forms.CharField(required=False, widget=forms.Textarea)\\n\\n\\nclass OcorrenciaSessaoForm(ModelForm):\\n class Meta:\\n model = OcorrenciaSessao\\n fields = ['conteudo']\\n\\n\\nclass VotacaoForm(forms.Form):\\n votos_sim = forms.IntegerField(label='Sim')\\n votos_nao = forms.IntegerField(label='Não')\\n abstencoes = forms.IntegerField(label='Abstenções')\\n total_presentes = forms.IntegerField(\\n required=False, widget=forms.HiddenInput())\\n total_votantes = forms.IntegerField(\\n required=False, widget=forms.HiddenInput()\\n )\\n voto_presidente = forms.IntegerField(\\n label='A totalização inclui o voto do Presidente?')\\n total_votos = forms.IntegerField(required=False, label='total')\\n observacao = forms.CharField(required=False, label='Observação')\\n resultado_votacao = forms.CharField(label='Resultado da Votação')\\n\\n def clean(self):\\n cleaned_data = super(VotacaoForm, self).clean()\\n if not self.is_valid():\\n return cleaned_data\\n\\n votos_sim = cleaned_data['votos_sim']\\n votos_nao = cleaned_data['votos_nao']\\n abstencoes = cleaned_data['abstencoes']\\n qtde_presentes = cleaned_data['total_presentes']\\n qtde_votantes = cleaned_data['total_votantes']\\n qtde_votos = votos_sim + votos_nao + abstencoes\\n voto_presidente = cleaned_data['voto_presidente']\\n\\n if qtde_votantes and not voto_presidente:\\n qtde_votantes -= 1\\n\\n if qtde_votantes and qtde_votos != qtde_votantes:\\n raise ValidationError(\\n 'O total de votos não corresponde com a quantidade de votantes!')\\n\\n return cleaned_data\\n\\n # def save(self, commit=False):\\n # #TODO Verificar se esse códido é utilizado\\n\\n # votacao = super(VotacaoForm, self).save(commit)\\n # votacao.materia = self.cleaned_data['materia']\\n # votacao.save()\\n # return votacao\\n\\n\\nclass VotacaoNominalForm(forms.Form):\\n resultado_votacao = forms.ModelChoiceField(label='Resultado da Votação',\\n required=False,\\n queryset=TipoResultadoVotacao.objects.all())\\n\\n\\nclass VotacaoEditForm(forms.Form):\\n pass\\n\\n\\nclass SessaoPlenariaFilterSet(django_filters.FilterSet):\\n\\n data_inicio__year = django_filters.ChoiceFilter(\\n required=False,\\n label='Ano',\\n choices=choice_anos_com_sessaoplenaria\\n )\\n data_inicio__month = django_filters.ChoiceFilter(required=False,\\n label='Mês',\\n choices=MES_CHOICES)\\n data_inicio__day = django_filters.ChoiceFilter(required=False,\\n label='Dia',\\n choices=DIA_CHOICES)\\n titulo = _('Pesquisa de Sessão Plenária')\\n\\n class Meta:\\n model = SessaoPlenaria\\n fields = ['tipo']\\n\\n def __init__(self, *args, **kwargs):\\n super(SessaoPlenariaFilterSet, self).__init__(*args, **kwargs)\\n\\n # pré-popula o campo do formulário com o ano corrente\\n self.form.fields['data_inicio__year'].initial = timezone.now().year\\n\\n row1 = to_row(\\n [('data_inicio__year', 3),\\n ('data_inicio__month', 3),\\n ('data_inicio__day', 3),\\n ('tipo', 3)])\\n\\n self.form.helper = SaplFormHelper()\\n self.form.helper.form_method = 'GET'\\n self.form.helper.layout = Layout(\\n Fieldset(self.titulo,\\n row1,\\n form_actions(label='Pesquisar'))\\n )\\n\\n\\nclass AdicionarVariasMateriasFilterSet(MateriaLegislativaFilterSet):\\n\\n o = MateriaPesquisaOrderingFilter()\\n tramitacao__status = django_filters.ModelChoiceFilter(\\n required=True,\\n queryset=StatusTramitacao.objects.all(),\\n label=_('Status da Matéria'))\\n\\n class Meta:\\n model = MateriaLegislativa\\n fields = ['tramitacao__status',\\n 'numero',\\n 'numero_protocolo',\\n 'ano',\\n 'tipo',\\n 'data_apresentacao',\\n 'data_publicacao',\\n 'autoria__autor__tipo',\\n # FIXME 'autoria__autor__partido',\\n 'relatoria__parlamentar_id',\\n 'local_origem_externa',\\n 'em_tramitacao',\\n ]\\n\\n def __init__(self, *args, **kwargs):\\n super(MateriaLegislativaFilterSet, self).__init__(*args, **kwargs)\\n\\n self.filters['tipo'].label = 'Tipo de Matéria'\\n self.filters['autoria__autor__tipo'].label = 'Tipo de Autor'\\n # self.filters['autoria__autor__partido'].label = 'Partido do Autor'\\n self.filters['relatoria__parlamentar_id'].label = 'Relatoria'\\n\\n row1 = to_row(\\n [('tramitacao__status', 12)])\\n row2 = to_row(\\n [('tipo', 12)])\\n row3 = to_row(\\n [('numero', 4),\\n ('ano', 4),\\n ('numero_protocolo', 4)])\\n row4 = to_row(\\n [('data_apresentacao', 6),\\n ('data_publicacao', 6)])\\n row5 = to_row(\\n [('autoria__autor', 0),\\n (Button('pesquisar',\\n 'Pesquisar Autor',\\n css_class='btn btn-primary btn-sm'), 2),\\n (Button('limpar',\\n 'limpar Autor',\\n css_class='btn btn-primary btn-sm'), 10)])\\n row6 = to_row(\\n [('autoria__autor__tipo', 6),\\n # ('autoria__autor__partido', 6)\\n ])\\n row7 = to_row(\\n [('relatoria__parlamentar_id', 6),\\n ('local_origem_externa', 6)])\\n row8 = to_row(\\n [('em_tramitacao', 6),\\n ('o', 6)])\\n row9 = to_row(\\n [('ementa', 12)])\\n\\n self.form.helper = SaplFormHelper()\\n self.form.helper.form_method = 'GET'\\n self.form.helper.layout = Layout(\\n Fieldset(_('Pesquisa de Matéria'),\\n row1, row2, row3,\\n HTML(autor_label),\\n HTML(autor_modal),\\n row4, row5, row6, row7, row8, row9,\\n form_actions(label='Pesquisar'))\\n )\\n\\n\\nclass OradorForm(ModelForm):\\n def __init__(self, *args, **kwargs):\\n super().__init__(*args, **kwargs)\\n self.fields['parlamentar'].queryset = \\\\\\n Parlamentar.objects.filter(ativo=True).order_by('nome_parlamentar')\\n\\n def clean(self):\\n super(OradorForm, self).clean()\\n cleaned_data = self.cleaned_data\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n sessao_id = self.initial['id_sessao']\\n numero = self.initial.get('numero')\\n numero_ordem = cleaned_data['numero_ordem']\\n ordem = Orador.objects.filter(\\n sessao_plenaria_id=sessao_id,\\n numero_ordem=numero_ordem\\n ).exists()\\n\\n if ordem and numero_ordem != numero:\\n raise ValidationError(_(\\n \\\"Já existe orador nesta posição de ordem de pronunciamento\\\"\\n ))\\n\\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\\n\\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\\n raise ValidationError(\\\"O arquivo Anexo do Orador deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\\\" \\\\\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\\n\\n return self.cleaned_data\\n\\n class Meta:\\n model = Orador\\n exclude = ['sessao_plenaria']\\n\\n\\nclass OradorExpedienteForm(ModelForm):\\n def __init__(self, *args, **kwargs):\\n super().__init__(*args, **kwargs)\\n id_sessao = int(self.initial['id_sessao'])\\n sessao = SessaoPlenaria.objects.get(id=id_sessao)\\n legislatura_vigente = sessao.legislatura\\n self.fields['parlamentar'].queryset = \\\\\\n Parlamentar.objects.filter(mandato__legislatura=legislatura_vigente,\\n ativo=True).order_by('nome_parlamentar')\\n\\n def clean(self):\\n super(OradorExpedienteForm, self).clean()\\n cleaned_data = self.cleaned_data\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n sessao_id = self.initial['id_sessao']\\n numero = self.initial.get('numero', None)\\n ordem = OradorExpediente.objects.filter(\\n sessao_plenaria_id=sessao_id,\\n numero_ordem=cleaned_data['numero_ordem']\\n ).exists()\\n\\n if ordem and (cleaned_data['numero_ordem'] != numero):\\n raise ValidationError(_(\\n 'Já existe orador nesta posição da ordem de pronunciamento'))\\n\\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\\n\\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\\n raise ValidationError(\\\"O arquivo Anexo do Orador deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\\\" \\\\\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\\n\\n return self.cleaned_data\\n\\n class Meta:\\n model = OradorExpediente\\n exclude = ['sessao_plenaria']\\n\\n\\nclass OradorOrdemDiaForm(ModelForm):\\n def __init__(self, *args, **kwargs):\\n super().__init__(*args, **kwargs)\\n id_sessao = int(self.initial['id_sessao'])\\n sessao = SessaoPlenaria.objects.get(id=id_sessao)\\n legislatura_vigente = sessao.legislatura\\n self.fields['parlamentar'].queryset = \\\\\\n Parlamentar.objects.filter(mandato__legislatura=legislatura_vigente,\\n ativo=True).order_by('nome_parlamentar')\\n\\n def clean(self):\\n super(OradorOrdemDiaForm, self).clean()\\n cleaned_data = self.cleaned_data\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n sessao_id = self.initial['id_sessao']\\n numero = self.initial.get('numero')\\n numero_ordem = cleaned_data['numero_ordem']\\n ordem = OradorOrdemDia.objects.filter(\\n sessao_plenaria_id=sessao_id,\\n numero_ordem=numero_ordem\\n ).exists()\\n\\n if ordem and numero_ordem != numero:\\n raise ValidationError(_(\\n \\\"Já existe orador nesta posição de ordem de pronunciamento\\\"\\n ))\\n\\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\\n\\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\\n raise ValidationError(\\\"O arquivo Anexo do Orador deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\\\" \\\\\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\\n\\n return self.cleaned_data\\n\\n class Meta:\\n model = OradorOrdemDia\\n exclude = ['sessao_plenaria']\\n\\n\\nclass PautaSessaoFilterSet(SessaoPlenariaFilterSet):\\n titulo = _('Pesquisa de Pauta de Sessão')\\n\\n\\nclass ResumoOrdenacaoForm(forms.Form):\\n primeiro = forms.ChoiceField(\\n label='1°',\\n choices=ORDENACAO_RESUMO\\n )\\n segundo = forms.ChoiceField(\\n label='2°',\\n choices=ORDENACAO_RESUMO\\n )\\n terceiro = forms.ChoiceField(\\n label='3°',\\n choices=ORDENACAO_RESUMO\\n )\\n quarto = forms.ChoiceField(\\n label='4°',\\n choices=ORDENACAO_RESUMO\\n )\\n quinto = forms.ChoiceField(\\n label='5°',\\n choices=ORDENACAO_RESUMO\\n )\\n sexto = forms.ChoiceField(\\n label='6°',\\n choices=ORDENACAO_RESUMO\\n )\\n setimo = forms.ChoiceField(\\n label='7°',\\n choices=ORDENACAO_RESUMO\\n )\\n oitavo = forms.ChoiceField(\\n label='8°',\\n choices=ORDENACAO_RESUMO\\n )\\n nono = forms.ChoiceField(\\n label='9°',\\n choices=ORDENACAO_RESUMO\\n )\\n decimo = forms.ChoiceField(\\n label='10°',\\n choices=ORDENACAO_RESUMO\\n )\\n decimo_primeiro = forms.ChoiceField(\\n label='11°',\\n choices=ORDENACAO_RESUMO\\n )\\n decimo_segundo = forms.ChoiceField(\\n label='12°',\\n choices=ORDENACAO_RESUMO\\n )\\n decimo_terceiro = forms.ChoiceField(\\n label='13°',\\n choices=ORDENACAO_RESUMO\\n )\\n decimo_quarto = forms.ChoiceField(\\n label='14°',\\n choices=ORDENACAO_RESUMO\\n )\\n\\n def __init__(self, *args, **kwargs):\\n row1 = to_row(\\n [('primeiro', 12)])\\n row2 = to_row(\\n [('segundo', 12)])\\n row3 = to_row(\\n [('terceiro', 12)])\\n row4 = to_row(\\n [('quarto', 12)])\\n row5 = to_row(\\n [('quinto', 12)])\\n row6 = to_row(\\n [('sexto', 12)])\\n row7 = to_row(\\n [('setimo', 12)])\\n row8 = to_row(\\n [('oitavo', 12)])\\n row9 = to_row(\\n [('nono', 12)])\\n row10 = to_row(\\n [('decimo', 12)])\\n row11 = to_row(\\n [('decimo_primeiro', 12)])\\n row12 = to_row(\\n [('decimo_segundo', 12)])\\n row13 = to_row(\\n [('decimo_terceiro', 12)])\\n row14 = to_row(\\n [('decimo_quarto', 12)]\\n )\\n\\n self.helper = SaplFormHelper()\\n self.helper.layout = Layout(\\n Fieldset(_(''),\\n row1, row2, row3, row4, row5,\\n row6, row7, row8, row9, row10,\\n row11, row12, row13, row14,\\n form_actions(label='Atualizar'))\\n )\\n\\n super().__init__(*args, **kwargs)\\n\\n def clean(self):\\n super(ResumoOrdenacaoForm, self).clean()\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n cleaned_data = self.cleaned_data\\n\\n for c1 in cleaned_data:\\n i = 0\\n for c2 in cleaned_data:\\n if cleaned_data[str(c1)] == cleaned_data[str(c2)]:\\n i = i + 1\\n if i > 1:\\n raise ValidationError(_(\\n 'Não é possível ter campos repetidos'))\\n return self.cleaned_data\\n\\n def save(self):\\n ordenacao = ResumoOrdenacao.objects.get()\\n cleaned_data = self.cleaned_data\\n\\n ordenacao.primeiro = cleaned_data['primeiro']\\n ordenacao.segundo = cleaned_data['segundo']\\n ordenacao.terceiro = cleaned_data['terceiro']\\n ordenacao.quarto = cleaned_data['quarto']\\n ordenacao.quinto = cleaned_data['quinto']\\n ordenacao.sexto = cleaned_data['sexto']\\n ordenacao.setimo = cleaned_data['setimo']\\n ordenacao.oitavo = cleaned_data['oitavo']\\n ordenacao.nono = cleaned_data['nono']\\n ordenacao.decimo = cleaned_data['decimo']\\n ordenacao.decimo_primeiro = cleaned_data['decimo_primeiro']\\n ordenacao.decimo_segundo = cleaned_data['decimo_segundo']\\n ordenacao.decimo_terceiro = cleaned_data['decimo_terceiro']\\n ordenacao.decimo_quarto = cleaned_data['decimo_quarto']\\n\\n ordenacao.save()\\n\\n\\nclass JustificativaAusenciaForm(ModelForm):\\n\\n class Meta:\\n model = JustificativaAusencia\\n fields = ['parlamentar',\\n 'hora',\\n 'data',\\n 'upload_anexo',\\n 'tipo_ausencia',\\n 'ausencia',\\n 'materias_do_expediente',\\n 'materias_da_ordem_do_dia',\\n 'observacao'\\n ]\\n\\n widgets = {\\n 'materias_do_expediente': CheckboxSelectMultiple(),\\n 'materias_da_ordem_do_dia': CheckboxSelectMultiple()}\\n\\n def __init__(self, *args, **kwargs):\\n\\n row1 = to_row(\\n [('parlamentar', 12)])\\n row2 = to_row(\\n [('data', 6),\\n ('hora', 6)])\\n row3 = to_row(\\n [('upload_anexo', 6)])\\n row4 = to_row(\\n [('tipo_ausencia', 12)])\\n row5 = to_row(\\n [('ausencia', 12)])\\n row6 = to_row(\\n [('materias_do_expediente', 12)])\\n row7 = to_row(\\n [('materias_da_ordem_do_dia', 12)])\\n row8 = to_row(\\n [('observacao', 12)])\\n\\n self.helper = SaplFormHelper()\\n self.helper.layout = SaplFormLayout(\\n Fieldset(_('Justificativa de Ausência'),\\n row1, row2, row3,\\n row4, row5,\\n row6,\\n row7,\\n row8)\\n )\\n q = Q(sessao_plenaria=kwargs['initial']['sessao_plenaria'])\\n ordens = OrdemDia.objects.filter(q)\\n expedientes = ExpedienteMateria.objects.filter(q)\\n legislatura = kwargs['initial']['sessao_plenaria'].legislatura\\n mandato = Mandato.objects.filter(\\n legislatura=legislatura).order_by('parlamentar__nome_parlamentar')\\n parlamentares = [m.parlamentar for m in mandato]\\n\\n super(JustificativaAusenciaForm, self).__init__(\\n *args, **kwargs)\\n\\n presencas = SessaoPlenariaPresenca.objects.filter(\\n q).order_by('parlamentar__nome_parlamentar')\\n presencas_ordem = PresencaOrdemDia.objects.filter(\\n q).order_by('parlamentar__nome_parlamentar')\\n\\n presentes = [p.parlamentar for p in presencas]\\n presentes_ordem = [p.parlamentar for p in presencas_ordem]\\n\\n presentes_ambos = set(presentes).intersection(set(presentes_ordem))\\n setFinal = set(parlamentares) - presentes_ambos\\n\\n self.fields['materias_do_expediente'].choices = [\\n (e.id, e.materia) for e in expedientes]\\n\\n self.fields['materias_da_ordem_do_dia'].choices = [\\n (o.id, o.materia) for o in ordens]\\n\\n self.fields['parlamentar'].choices = [\\n (\\\"0\\\", \\\"------------\\\")] + [(p.id, p) for p in setFinal]\\n\\n def clean(self):\\n super(JustificativaAusenciaForm, self).clean()\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n sessao_plenaria = self.instance.sessao_plenaria\\n\\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\\n\\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\\n raise ValidationError(\\\"O arquivo Anexo de Justificativa deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\\\" \\\\\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\\n\\n if not sessao_plenaria.finalizada or sessao_plenaria.finalizada is None:\\n raise ValidationError(\\n \\\"A sessão deve estar finalizada para registrar uma Ausência\\\")\\n else:\\n return self.cleaned_data\\n\\n def save(self):\\n\\n justificativa = super().save(True)\\n\\n if justificativa.ausencia == 2:\\n justificativa.materias_do_expediente.clear()\\n justificativa.materias_da_ordem_do_dia.clear()\\n return justificativa\\n\",\n \"path\": \"sapl/sessao/forms.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"from datetime import datetime\n\nfrom crispy_forms.layout import HTML, Button, Fieldset, Layout\nfrom django import forms\nfrom django.contrib.contenttypes.models import ContentType\nfrom django.core.exceptions import ObjectDoesNotExist, ValidationError\nfrom django.db import transaction\nfrom django.db.models import Q\nfrom django.forms import ModelForm\nfrom django.forms.widgets import CheckboxSelectMultiple\nfrom django.utils.translation import ugettext_lazy as _\nimport django_filters\n\nfrom sapl.settings import MAX_DOC_UPLOAD_SIZE\nfrom sapl.base.models import Autor, TipoAutor\nfrom sapl.crispy_layout_mixin import SaplFormHelper\nfrom sapl.crispy_layout_mixin import form_actions, to_row, SaplFormLayout\nfrom sapl.materia.forms import MateriaLegislativaFilterSet\nfrom sapl.materia.models import (MateriaLegislativa, StatusTramitacao,\n TipoMateriaLegislativa)\nfrom sapl.parlamentares.models import Parlamentar, Mandato\nfrom sapl.utils import (RANGE_DIAS_MES, RANGE_MESES,\n MateriaPesquisaOrderingFilter, autor_label,\n autor_modal, timezone, choice_anos_com_sessaoplenaria,\n FileFieldCheckMixin)\n\nfrom .models import (Bancada, ExpedienteMateria, JustificativaAusencia,\n Orador, OradorExpediente, OrdemDia, PresencaOrdemDia, SessaoPlenaria,\n SessaoPlenariaPresenca, TipoResultadoVotacao,\n OcorrenciaSessao, RetiradaPauta, TipoRetiradaPauta, OradorOrdemDia, ORDENACAO_RESUMO,\n ResumoOrdenacao)\n\n\nMES_CHOICES = RANGE_MESES\nDIA_CHOICES = RANGE_DIAS_MES\n\n\nclass SessaoPlenariaForm(FileFieldCheckMixin, ModelForm):\n\n class Meta:\n model = SessaoPlenaria\n exclude = ['cod_andamento_sessao']\n\n def clean(self):\n super(SessaoPlenariaForm, self).clean()\n\n if not self.is_valid():\n return self.cleaned_data\n\n instance = self.instance\n\n num = self.cleaned_data['numero']\n sl = self.cleaned_data['sessao_legislativa']\n leg = self.cleaned_data['legislatura']\n tipo = self.cleaned_data['tipo']\n abertura = self.cleaned_data['data_inicio']\n encerramento = self.cleaned_data['data_fim']\n\n error = ValidationError(\n \"Número de Sessão Plenária já existente \"\n \"para a Legislatura, Sessão Legislativa e Tipo informados. \"\n \"Favor escolher um número distinto.\")\n\n qs = tipo.queryset_tipo_numeracao(leg, sl, abertura)\n qs &= Q(numero=num)\n\n if SessaoPlenaria.objects.filter(qs).exclude(pk=instance.pk).exists():\n raise error\n\n # Condições da verificação\n abertura_entre_leg = leg.data_inicio <= abertura <= leg.data_fim\n abertura_entre_sl = sl.data_inicio <= abertura <= sl.data_fim\n if encerramento is not None:\n encerramento_entre_leg = leg.data_inicio <= encerramento <= leg.data_fim\n encerramento_entre_sl = sl.data_inicio <= encerramento <= sl.data_fim\n # Verificação das datas de abertura e encerramento da Sessão\n # Verificações com a data de encerramento preenchidas\n if encerramento is not None:\n # Verifica se a data de encerramento é anterior a data de abertura\n if encerramento < abertura:\n raise ValidationError(\"A data de encerramento não pode ser \"\n \"anterior a data de abertura.\")\n # Verifica se a data de abertura está entre a data de início e fim\n # da legislatura\n if abertura_entre_leg and encerramento_entre_leg:\n if abertura_entre_sl and encerramento_entre_sl:\n pass\n elif abertura_entre_sl and not encerramento_entre_sl:\n raise ValidationError(\"A data de encerramento deve estar entre \"\n \"as datas de início e fim da Sessão Legislativa.\")\n elif not abertura_entre_sl and encerramento_entre_sl:\n raise ValidationError(\"A data de abertura deve estar entre as \"\n \"datas de início e fim da Sessão Legislativa.\")\n elif not abertura_entre_sl and not encerramento_entre_sl:\n raise ValidationError(\"A data de abertura e de encerramento devem estar \"\n \"entre as datas de início e fim da Sessão Legislativa.\")\n elif abertura_entre_leg and not encerramento_entre_leg:\n if abertura_entre_sl and encerramento_entre_sl:\n raise ValidationError(\"A data de encerramento deve estar entre \"\n \"as datas de início e fim da Legislatura.\")\n elif abertura_entre_sl and not encerramento_entre_sl:\n raise ValidationError(\"A data de encerramento deve estar entre \"\n \"as datas de início e fim tanto da \"\n \"Legislatura quanto da Sessão Legislativa.\")\n elif not abertura_entre_sl and encerramento_entre_sl:\n raise ValidationError(\"As datas de abertura e encerramento devem \"\n \"estar entre as \"\n \"datas de início e fim tanto Legislatura \"\n \"quanto da Sessão Legislativa.\")\n elif not abertura_entre_sl and not encerramento_entre_sl:\n raise ValidationError(\"As datas de abertura e encerramento devem \"\n \"estar entre as \"\n \"datas de início e fim tanto Legislatura \"\n \"quanto da Sessão Legislativa.\")\n elif not abertura_entre_leg and not encerramento_entre_leg:\n if abertura_entre_sl and encerramento_entre_sl:\n raise ValidationError(\"As datas de abertura e encerramento devem \"\n \"estar entre as \"\n \"datas de início e fim da Legislatura.\")\n elif abertura_entre_sl and not encerramento_entre_sl:\n raise ValidationError(\"As datas de abertura e encerramento devem \"\n \"estar entre as \"\n \"datas de início e fim tanto Legislatura \"\n \"quanto da Sessão Legislativa.\")\n elif not abertura_entre_sl and encerramento_entre_sl:\n raise ValidationError(\"As datas de abertura e encerramento devem \"\n \"estar entre as \"\n \"datas de início e fim tanto Legislatura \"\n \"quanto da Sessão Legislativa.\")\n elif not abertura_entre_sl and not encerramento_entre_sl:\n raise ValidationError(\"As datas de abertura e encerramento devem \"\n \"estar entre as \"\n \"datas de início e fim tanto Legislatura \"\n \"quanto da Sessão Legislativa.\")\n\n # Verificações com a data de encerramento vazia\n else:\n if abertura_entre_leg:\n if abertura_entre_sl:\n pass\n else:\n raise ValidationError(\"A data de abertura da sessão deve estar \"\n \"entre a data de início e fim da Sessão Legislativa.\")\n else:\n if abertura_entre_sl:\n raise ValidationError(\"A data de abertura da sessão deve estar \"\n \"entre a data de início e fim da Legislatura.\")\n else:\n raise ValidationError(\"A data de abertura da sessão deve estar \"\n \"entre a data de início e fim tanto da \"\n \"Legislatura quanto da Sessão Legislativa.\")\n\n\n upload_pauta = self.cleaned_data.get('upload_pauta', False)\n upload_ata = self.cleaned_data.get('upload_ata', False)\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\n\n if upload_pauta and upload_pauta.size > MAX_DOC_UPLOAD_SIZE:\n raise ValidationError(\"O arquivo Pauta da Sessão deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\" \\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_pauta.size/1024)/1024))\n \n if upload_ata and upload_ata.size > MAX_DOC_UPLOAD_SIZE:\n raise ValidationError(\"O arquivo Ata da Sessão deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\" \\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_ata.size/1024)/1024))\n \n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\n raise ValidationError(\"O arquivo Anexo da Sessão deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\" \\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\n \n\n return self.cleaned_data\n\n\nclass RetiradaPautaForm(ModelForm):\n\n tipo_de_retirada = forms.ModelChoiceField(required=True,\n empty_label='------------',\n queryset=TipoRetiradaPauta.objects.all())\n expediente = forms.ModelChoiceField(required=False,\n label='Matéria do Expediente',\n queryset=ExpedienteMateria.objects.all())\n ordem = forms.ModelChoiceField(required=False,\n label='Matéria da Ordem do Dia',\n queryset=OrdemDia.objects.all())\n materia = forms.ModelChoiceField(required=False,\n widget=forms.HiddenInput(),\n queryset=MateriaLegislativa.objects.all())\n\n class Meta:\n model = RetiradaPauta\n fields = ['ordem',\n 'expediente',\n 'parlamentar',\n 'tipo_de_retirada',\n 'data',\n 'observacao',\n 'materia']\n\n def __init__(self, *args, **kwargs):\n\n row1 = to_row([('tipo_de_retirada', 5),\n ('parlamentar', 4),\n ('data', 3)])\n row2 = to_row([('ordem', 6),\n ('expediente', 6)])\n row3 = to_row([('observacao', 12)])\n\n self.helper = SaplFormHelper()\n self.helper.layout = SaplFormLayout(\n Fieldset(_('Retirada de Pauta'),\n row1, row2, row3))\n\n q = Q(sessao_plenaria=kwargs['initial']['sessao_plenaria'])\n ordens = OrdemDia.objects.filter(q)\n expedientes = ExpedienteMateria.objects.filter(q)\n retiradas_ordem = [\n r.ordem for r in RetiradaPauta.objects.filter(q, ordem__in=ordens)]\n retiradas_expediente = [r.expediente for r in RetiradaPauta.objects.filter(\n q, expediente__in=expedientes)]\n setOrdem = set(ordens) - set(retiradas_ordem)\n setExpediente = set(expedientes) - set(retiradas_expediente)\n\n super(RetiradaPautaForm, self).__init__(\n *args, **kwargs)\n\n if self.instance.pk:\n setOrdem = set(ordens)\n setExpediente = set(expedientes)\n\n presencas = SessaoPlenariaPresenca.objects.filter(\n q).order_by('parlamentar__nome_parlamentar')\n presentes = [p.parlamentar for p in presencas]\n\n self.fields['expediente'].choices = [\n (None, \"------------\")] + [(e.id, e.materia) for e in setExpediente]\n self.fields['ordem'].choices = [\n (None, \"------------\")] + [(o.id, o.materia) for o in setOrdem]\n self.fields['parlamentar'].choices = [\n (None, \"------------\")] + [(p.id, p) for p in presentes]\n\n def clean(self):\n\n super(RetiradaPautaForm, self).clean()\n\n if not self.is_valid():\n return self.cleaned_data\n\n sessao_plenaria = self.instance.sessao_plenaria\n if self.cleaned_data['data'] < sessao_plenaria.data_inicio:\n raise ValidationError(\n _(\"Data de retirada de pauta anterior à abertura da Sessão.\"))\n if sessao_plenaria.data_fim and self.cleaned_data['data'] > sessao_plenaria.data_fim:\n raise ValidationError(\n _(\"Data de retirada de pauta posterior ao encerramento da Sessão.\"))\n\n if self.cleaned_data['ordem'] and self.cleaned_data['ordem'].registrovotacao_set.exists():\n raise ValidationError(\n _(\"Essa matéria já foi votada, portanto não pode ser retirada de pauta.\"))\n elif self.cleaned_data['expediente'] and self.cleaned_data['expediente'].registrovotacao_set.exists():\n raise ValidationError(\n _(\"Essa matéria já foi votada, portanto não pode ser retirada de pauta.\"))\n\n return self.cleaned_data\n\n def save(self, commit=False):\n retirada = super(RetiradaPautaForm, self).save(commit=commit)\n if retirada.ordem:\n ordem = retirada.ordem\n retirada.materia = ordem.materia\n ordem.votacao_aberta = False\n ordem.save()\n elif retirada.expediente:\n expediente = retirada.expediente\n retirada.materia = expediente.materia\n expediente.votacao_aberta = False\n expediente.save()\n retirada.save()\n return retirada\n\n\nclass BancadaForm(ModelForm):\n\n class Meta:\n model = Bancada\n fields = ['legislatura', 'nome', 'partido', 'data_criacao',\n 'data_extincao', 'descricao']\n\n def clean(self):\n super(BancadaForm, self).clean()\n\n if not self.is_valid():\n return self.cleaned_data\n\n data = self.cleaned_data\n\n legislatura = data['legislatura']\n\n data_criacao = data['data_criacao']\n if data_criacao:\n if (data_criacao < legislatura.data_inicio or\n data_criacao > legislatura.data_fim):\n raise ValidationError(_(\"Data de criação da bancada fora do intervalo\"\n \" de legislatura informada\"))\n\n data_extincao = data['data_extincao']\n if data_extincao:\n if (data_extincao < legislatura.data_inicio or\n data_extincao > legislatura.data_fim):\n raise ValidationError(_(\"Data fim da bancada fora do intervalo de\"\n \" legislatura informada\"))\n\n if self.cleaned_data['data_extincao']:\n if (self.cleaned_data['data_extincao'] <\n self.cleaned_data['data_criacao']):\n msg = _('Data de extinção não pode ser menor que a de criação')\n raise ValidationError(msg)\n return self.cleaned_data\n\n @transaction.atomic\n def save(self, commit=True):\n bancada = super(BancadaForm, self).save(commit)\n content_type = ContentType.objects.get_for_model(Bancada)\n object_id = bancada.pk\n tipo = TipoAutor.objects.get(content_type=content_type)\n Autor.objects.create(\n content_type=content_type,\n object_id=object_id,\n tipo=tipo,\n nome=bancada.nome\n )\n return bancada\n\n\nclass ExpedienteMateriaForm(ModelForm):\n\n _model = ExpedienteMateria\n data_atual = timezone.now()\n\n tipo_materia = forms.ModelChoiceField(\n label=_('Tipo Matéria'),\n required=True,\n queryset=TipoMateriaLegislativa.objects.all(),\n empty_label='Selecione',\n widget=forms.Select(attrs={'autocomplete': 'off'}))\n\n numero_materia = forms.CharField(\n label='Número Matéria', required=True,\n widget=forms.TextInput(attrs={'autocomplete': 'off'}))\n\n ano_materia = forms.CharField(\n label='Ano Matéria',\n initial=int(data_atual.year),\n required=True,\n widget=forms.TextInput(attrs={'autocomplete': 'off'}))\n\n data_ordem = forms.CharField(\n label='Data Sessão',\n initial=datetime.strftime(timezone.now(), '%d/%m/%Y'),\n widget=forms.TextInput(attrs={'readonly': 'readonly'}))\n\n class Meta:\n model = ExpedienteMateria\n fields = ['data_ordem', 'numero_ordem', 'tipo_materia', 'observacao',\n 'numero_materia', 'ano_materia', 'tipo_votacao']\n\n def clean_numero_ordem(self):\n sessao = self.instance.sessao_plenaria\n\n numero_ordem_exists = ExpedienteMateria.objects.filter(\n sessao_plenaria=sessao,\n numero_ordem=self.cleaned_data['numero_ordem']).exists()\n\n if numero_ordem_exists and not self.instance.pk:\n msg = _('Esse número de ordem já existe.')\n raise ValidationError(msg)\n\n return self.cleaned_data['numero_ordem']\n\n def clean_data_ordem(self):\n return self.instance.sessao_plenaria.data_inicio\n\n def clean(self):\n cleaned_data = super(ExpedienteMateriaForm, self).clean()\n if not self.is_valid():\n return cleaned_data\n\n sessao = self.instance.sessao_plenaria\n\n try:\n materia = MateriaLegislativa.objects.get(\n numero=self.cleaned_data['numero_materia'],\n ano=self.cleaned_data['ano_materia'],\n tipo=self.cleaned_data['tipo_materia'])\n except ObjectDoesNotExist:\n msg = _('A matéria a ser inclusa não existe no cadastro'\n ' de matérias legislativas.')\n raise ValidationError(msg)\n else:\n cleaned_data['materia'] = materia\n\n exists = self._model.objects.filter(\n sessao_plenaria=sessao,\n materia=materia).exists()\n\n if exists and not self.instance.pk:\n msg = _('Essa matéria já foi cadastrada.')\n raise ValidationError(msg)\n\n return cleaned_data\n\n def save(self, commit=False):\n expediente = super(ExpedienteMateriaForm, self).save(commit)\n expediente.materia = self.cleaned_data['materia']\n expediente.save()\n return expediente\n\n\nclass OrdemDiaForm(ExpedienteMateriaForm):\n\n _model = OrdemDia\n\n class Meta:\n model = OrdemDia\n fields = ['data_ordem', 'numero_ordem', 'tipo_materia', 'observacao',\n 'numero_materia', 'ano_materia', 'tipo_votacao']\n\n def clean_data_ordem(self):\n return self.instance.sessao_plenaria.data_inicio\n\n def clean_numero_ordem(self):\n sessao = self.instance.sessao_plenaria\n\n numero_ordem_exists = OrdemDia.objects.filter(\n sessao_plenaria=sessao,\n numero_ordem=self.cleaned_data['numero_ordem']).exists()\n\n if numero_ordem_exists and not self.instance.pk:\n msg = _('Esse número de ordem já existe.')\n raise ValidationError(msg)\n\n return self.cleaned_data['numero_ordem']\n\n def clean(self):\n cleaned_data = super(OrdemDiaForm, self).clean()\n if not self.is_valid():\n return cleaned_data\n return self.cleaned_data\n\n def save(self, commit=False):\n ordem = super(OrdemDiaForm, self).save(commit)\n ordem.materia = self.cleaned_data['materia']\n ordem.save()\n return ordem\n\n\nclass PresencaForm(forms.Form):\n presenca = forms.CharField(required=False, initial=False)\n parlamentar = forms.CharField(required=False, max_length=20)\n\n\nclass ListMateriaForm(forms.Form):\n error_message = forms.CharField(required=False, label='votacao_aberta')\n\n\nclass MesaForm(forms.Form):\n parlamentar = forms.IntegerField(required=True)\n cargo = forms.IntegerField(required=True)\n\n\nclass ExpedienteForm(forms.Form):\n conteudo = forms.CharField(required=False, widget=forms.Textarea)\n\n\nclass OcorrenciaSessaoForm(ModelForm):\n class Meta:\n model = OcorrenciaSessao\n fields = ['conteudo']\n\n\nclass VotacaoForm(forms.Form):\n votos_sim = forms.IntegerField(label='Sim')\n votos_nao = forms.IntegerField(label='Não')\n abstencoes = forms.IntegerField(label='Abstenções')\n total_presentes = forms.IntegerField(\n required=False, widget=forms.HiddenInput())\n total_votantes = forms.IntegerField(\n required=False, widget=forms.HiddenInput()\n )\n voto_presidente = forms.IntegerField(\n label='A totalização inclui o voto do Presidente?')\n total_votos = forms.IntegerField(required=False, label='total')\n observacao = forms.CharField(required=False, label='Observação')\n resultado_votacao = forms.CharField(label='Resultado da Votação')\n\n def clean(self):\n cleaned_data = super(VotacaoForm, self).clean()\n if not self.is_valid():\n return cleaned_data\n\n votos_sim = cleaned_data['votos_sim']\n votos_nao = cleaned_data['votos_nao']\n abstencoes = cleaned_data['abstencoes']\n qtde_presentes = cleaned_data['total_presentes']\n qtde_votantes = cleaned_data['total_votantes']\n qtde_votos = votos_sim + votos_nao + abstencoes\n voto_presidente = cleaned_data['voto_presidente']\n\n if qtde_votantes and not voto_presidente:\n qtde_votantes -= 1\n\n if qtde_votantes and qtde_votos != qtde_votantes:\n raise ValidationError(\n 'O total de votos não corresponde com a quantidade de votantes!')\n\n return cleaned_data\n\n # def save(self, commit=False):\n # #TODO Verificar se esse códido é utilizado\n\n # votacao = super(VotacaoForm, self).save(commit)\n # votacao.materia = self.cleaned_data['materia']\n # votacao.save()\n # return votacao\n\n\nclass VotacaoNominalForm(forms.Form):\n resultado_votacao = forms.ModelChoiceField(label='Resultado da Votação',\n required=False,\n queryset=TipoResultadoVotacao.objects.all())\n\n\nclass VotacaoEditForm(forms.Form):\n pass\n\n\nclass SessaoPlenariaFilterSet(django_filters.FilterSet):\n\n data_inicio__year = django_filters.ChoiceFilter(\n required=False,\n label='Ano',\n choices=choice_anos_com_sessaoplenaria\n )\n data_inicio__month = django_filters.ChoiceFilter(required=False,\n label='Mês',\n choices=MES_CHOICES)\n data_inicio__day = django_filters.ChoiceFilter(required=False,\n label='Dia',\n choices=DIA_CHOICES)\n titulo = _('Pesquisa de Sessão Plenária')\n\n class Meta:\n model = SessaoPlenaria\n fields = ['tipo']\n\n def __init__(self, *args, **kwargs):\n super(SessaoPlenariaFilterSet, self).__init__(*args, **kwargs)\n\n # pré-popula o campo do formulário com o ano corrente\n self.form.fields['data_inicio__year'].initial = timezone.now().year\n\n row1 = to_row(\n [('data_inicio__year', 3),\n ('data_inicio__month', 3),\n ('data_inicio__day', 3),\n ('tipo', 3)])\n\n self.form.helper = SaplFormHelper()\n self.form.helper.form_method = 'GET'\n self.form.helper.layout = Layout(\n Fieldset(self.titulo,\n row1,\n form_actions(label='Pesquisar'))\n )\n\n\nclass AdicionarVariasMateriasFilterSet(MateriaLegislativaFilterSet):\n\n o = MateriaPesquisaOrderingFilter()\n tramitacao__status = django_filters.ModelChoiceFilter(\n required=False,\n queryset=StatusTramitacao.objects.all(),\n label=_('Status da Matéria'))\n\n class Meta:\n model = MateriaLegislativa\n fields = ['tramitacao__status',\n 'numero',\n 'numero_protocolo',\n 'ano',\n 'tipo',\n 'data_apresentacao',\n 'data_publicacao',\n 'autoria__autor__tipo',\n # FIXME 'autoria__autor__partido',\n 'relatoria__parlamentar_id',\n 'local_origem_externa',\n 'em_tramitacao',\n ]\n\n def __init__(self, *args, **kwargs):\n super(MateriaLegislativaFilterSet, self).__init__(*args, **kwargs)\n\n self.filters['tipo'].label = 'Tipo de Matéria'\n self.filters['autoria__autor__tipo'].label = 'Tipo de Autor'\n # self.filters['autoria__autor__partido'].label = 'Partido do Autor'\n self.filters['relatoria__parlamentar_id'].label = 'Relatoria'\n\n row1 = to_row(\n [('tramitacao__status', 12)])\n row2 = to_row(\n [('tipo', 12)])\n row3 = to_row(\n [('numero', 4),\n ('ano', 4),\n ('numero_protocolo', 4)])\n row4 = to_row(\n [('data_apresentacao', 6),\n ('data_publicacao', 6)])\n row5 = to_row(\n [('autoria__autor', 0),\n (Button('pesquisar',\n 'Pesquisar Autor',\n css_class='btn btn-primary btn-sm'), 2),\n (Button('limpar',\n 'limpar Autor',\n css_class='btn btn-primary btn-sm'), 10)])\n row6 = to_row(\n [('autoria__autor__tipo', 6),\n # ('autoria__autor__partido', 6)\n ])\n row7 = to_row(\n [('relatoria__parlamentar_id', 6),\n ('local_origem_externa', 6)])\n row8 = to_row(\n [('em_tramitacao', 6),\n ('o', 6)])\n row9 = to_row(\n [('ementa', 12)])\n\n self.form.helper = SaplFormHelper()\n self.form.helper.form_method = 'GET'\n self.form.helper.layout = Layout(\n Fieldset(_('Pesquisa de Matéria'),\n row1, row2, row3,\n HTML(autor_label),\n HTML(autor_modal),\n row4, row5, row6, row7, row8, row9,\n form_actions(label='Pesquisar'))\n )\n\n\nclass OradorForm(ModelForm):\n def __init__(self, *args, **kwargs):\n super().__init__(*args, **kwargs)\n self.fields['parlamentar'].queryset = \\\n Parlamentar.objects.filter(ativo=True).order_by('nome_parlamentar')\n\n def clean(self):\n super(OradorForm, self).clean()\n cleaned_data = self.cleaned_data\n\n if not self.is_valid():\n return self.cleaned_data\n\n sessao_id = self.initial['id_sessao']\n numero = self.initial.get('numero')\n numero_ordem = cleaned_data['numero_ordem']\n ordem = Orador.objects.filter(\n sessao_plenaria_id=sessao_id,\n numero_ordem=numero_ordem\n ).exists()\n\n if ordem and numero_ordem != numero:\n raise ValidationError(_(\n \"Já existe orador nesta posição de ordem de pronunciamento\"\n ))\n\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\n\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\n raise ValidationError(\"O arquivo Anexo do Orador deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\" \\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\n\n return self.cleaned_data\n\n class Meta:\n model = Orador\n exclude = ['sessao_plenaria']\n\n\nclass OradorExpedienteForm(ModelForm):\n def __init__(self, *args, **kwargs):\n super().__init__(*args, **kwargs)\n id_sessao = int(self.initial['id_sessao'])\n sessao = SessaoPlenaria.objects.get(id=id_sessao)\n legislatura_vigente = sessao.legislatura\n self.fields['parlamentar'].queryset = \\\n Parlamentar.objects.filter(mandato__legislatura=legislatura_vigente,\n ativo=True).order_by('nome_parlamentar')\n\n def clean(self):\n super(OradorExpedienteForm, self).clean()\n cleaned_data = self.cleaned_data\n\n if not self.is_valid():\n return self.cleaned_data\n\n sessao_id = self.initial['id_sessao']\n numero = self.initial.get('numero', None)\n ordem = OradorExpediente.objects.filter(\n sessao_plenaria_id=sessao_id,\n numero_ordem=cleaned_data['numero_ordem']\n ).exists()\n\n if ordem and (cleaned_data['numero_ordem'] != numero):\n raise ValidationError(_(\n 'Já existe orador nesta posição da ordem de pronunciamento'))\n\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\n\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\n raise ValidationError(\"O arquivo Anexo do Orador deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\" \\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\n\n return self.cleaned_data\n\n class Meta:\n model = OradorExpediente\n exclude = ['sessao_plenaria']\n\n\nclass OradorOrdemDiaForm(ModelForm):\n def __init__(self, *args, **kwargs):\n super().__init__(*args, **kwargs)\n id_sessao = int(self.initial['id_sessao'])\n sessao = SessaoPlenaria.objects.get(id=id_sessao)\n legislatura_vigente = sessao.legislatura\n self.fields['parlamentar'].queryset = \\\n Parlamentar.objects.filter(mandato__legislatura=legislatura_vigente,\n ativo=True).order_by('nome_parlamentar')\n\n def clean(self):\n super(OradorOrdemDiaForm, self).clean()\n cleaned_data = self.cleaned_data\n\n if not self.is_valid():\n return self.cleaned_data\n\n sessao_id = self.initial['id_sessao']\n numero = self.initial.get('numero')\n numero_ordem = cleaned_data['numero_ordem']\n ordem = OradorOrdemDia.objects.filter(\n sessao_plenaria_id=sessao_id,\n numero_ordem=numero_ordem\n ).exists()\n\n if ordem and numero_ordem != numero:\n raise ValidationError(_(\n \"Já existe orador nesta posição de ordem de pronunciamento\"\n ))\n\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\n\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\n raise ValidationError(\"O arquivo Anexo do Orador deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\" \\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\n\n return self.cleaned_data\n\n class Meta:\n model = OradorOrdemDia\n exclude = ['sessao_plenaria']\n\n\nclass PautaSessaoFilterSet(SessaoPlenariaFilterSet):\n titulo = _('Pesquisa de Pauta de Sessão')\n\n\nclass ResumoOrdenacaoForm(forms.Form):\n primeiro = forms.ChoiceField(\n label='1°',\n choices=ORDENACAO_RESUMO\n )\n segundo = forms.ChoiceField(\n label='2°',\n choices=ORDENACAO_RESUMO\n )\n terceiro = forms.ChoiceField(\n label='3°',\n choices=ORDENACAO_RESUMO\n )\n quarto = forms.ChoiceField(\n label='4°',\n choices=ORDENACAO_RESUMO\n )\n quinto = forms.ChoiceField(\n label='5°',\n choices=ORDENACAO_RESUMO\n )\n sexto = forms.ChoiceField(\n label='6°',\n choices=ORDENACAO_RESUMO\n )\n setimo = forms.ChoiceField(\n label='7°',\n choices=ORDENACAO_RESUMO\n )\n oitavo = forms.ChoiceField(\n label='8°',\n choices=ORDENACAO_RESUMO\n )\n nono = forms.ChoiceField(\n label='9°',\n choices=ORDENACAO_RESUMO\n )\n decimo = forms.ChoiceField(\n label='10°',\n choices=ORDENACAO_RESUMO\n )\n decimo_primeiro = forms.ChoiceField(\n label='11°',\n choices=ORDENACAO_RESUMO\n )\n decimo_segundo = forms.ChoiceField(\n label='12°',\n choices=ORDENACAO_RESUMO\n )\n decimo_terceiro = forms.ChoiceField(\n label='13°',\n choices=ORDENACAO_RESUMO\n )\n decimo_quarto = forms.ChoiceField(\n label='14°',\n choices=ORDENACAO_RESUMO\n )\n\n def __init__(self, *args, **kwargs):\n row1 = to_row(\n [('primeiro', 12)])\n row2 = to_row(\n [('segundo', 12)])\n row3 = to_row(\n [('terceiro', 12)])\n row4 = to_row(\n [('quarto', 12)])\n row5 = to_row(\n [('quinto', 12)])\n row6 = to_row(\n [('sexto', 12)])\n row7 = to_row(\n [('setimo', 12)])\n row8 = to_row(\n [('oitavo', 12)])\n row9 = to_row(\n [('nono', 12)])\n row10 = to_row(\n [('decimo', 12)])\n row11 = to_row(\n [('decimo_primeiro', 12)])\n row12 = to_row(\n [('decimo_segundo', 12)])\n row13 = to_row(\n [('decimo_terceiro', 12)])\n row14 = to_row(\n [('decimo_quarto', 12)]\n )\n\n self.helper = SaplFormHelper()\n self.helper.layout = Layout(\n Fieldset(_(''),\n row1, row2, row3, row4, row5,\n row6, row7, row8, row9, row10,\n row11, row12, row13, row14,\n form_actions(label='Atualizar'))\n )\n\n super().__init__(*args, **kwargs)\n\n def clean(self):\n super(ResumoOrdenacaoForm, self).clean()\n\n if not self.is_valid():\n return self.cleaned_data\n\n cleaned_data = self.cleaned_data\n\n for c1 in cleaned_data:\n i = 0\n for c2 in cleaned_data:\n if cleaned_data[str(c1)] == cleaned_data[str(c2)]:\n i = i + 1\n if i > 1:\n raise ValidationError(_(\n 'Não é possível ter campos repetidos'))\n return self.cleaned_data\n\n def save(self):\n ordenacao = ResumoOrdenacao.objects.get()\n cleaned_data = self.cleaned_data\n\n ordenacao.primeiro = cleaned_data['primeiro']\n ordenacao.segundo = cleaned_data['segundo']\n ordenacao.terceiro = cleaned_data['terceiro']\n ordenacao.quarto = cleaned_data['quarto']\n ordenacao.quinto = cleaned_data['quinto']\n ordenacao.sexto = cleaned_data['sexto']\n ordenacao.setimo = cleaned_data['setimo']\n ordenacao.oitavo = cleaned_data['oitavo']\n ordenacao.nono = cleaned_data['nono']\n ordenacao.decimo = cleaned_data['decimo']\n ordenacao.decimo_primeiro = cleaned_data['decimo_primeiro']\n ordenacao.decimo_segundo = cleaned_data['decimo_segundo']\n ordenacao.decimo_terceiro = cleaned_data['decimo_terceiro']\n ordenacao.decimo_quarto = cleaned_data['decimo_quarto']\n\n ordenacao.save()\n\n\nclass JustificativaAusenciaForm(ModelForm):\n\n class Meta:\n model = JustificativaAusencia\n fields = ['parlamentar',\n 'hora',\n 'data',\n 'upload_anexo',\n 'tipo_ausencia',\n 'ausencia',\n 'materias_do_expediente',\n 'materias_da_ordem_do_dia',\n 'observacao'\n ]\n\n widgets = {\n 'materias_do_expediente': CheckboxSelectMultiple(),\n 'materias_da_ordem_do_dia': CheckboxSelectMultiple()}\n\n def __init__(self, *args, **kwargs):\n\n row1 = to_row(\n [('parlamentar', 12)])\n row2 = to_row(\n [('data', 6),\n ('hora', 6)])\n row3 = to_row(\n [('upload_anexo', 6)])\n row4 = to_row(\n [('tipo_ausencia', 12)])\n row5 = to_row(\n [('ausencia', 12)])\n row6 = to_row(\n [('materias_do_expediente', 12)])\n row7 = to_row(\n [('materias_da_ordem_do_dia', 12)])\n row8 = to_row(\n [('observacao', 12)])\n\n self.helper = SaplFormHelper()\n self.helper.layout = SaplFormLayout(\n Fieldset(_('Justificativa de Ausência'),\n row1, row2, row3,\n row4, row5,\n row6,\n row7,\n row8)\n )\n q = Q(sessao_plenaria=kwargs['initial']['sessao_plenaria'])\n ordens = OrdemDia.objects.filter(q)\n expedientes = ExpedienteMateria.objects.filter(q)\n legislatura = kwargs['initial']['sessao_plenaria'].legislatura\n mandato = Mandato.objects.filter(\n legislatura=legislatura).order_by('parlamentar__nome_parlamentar')\n parlamentares = [m.parlamentar for m in mandato]\n\n super(JustificativaAusenciaForm, self).__init__(\n *args, **kwargs)\n\n presencas = SessaoPlenariaPresenca.objects.filter(\n q).order_by('parlamentar__nome_parlamentar')\n presencas_ordem = PresencaOrdemDia.objects.filter(\n q).order_by('parlamentar__nome_parlamentar')\n\n presentes = [p.parlamentar for p in presencas]\n presentes_ordem = [p.parlamentar for p in presencas_ordem]\n\n presentes_ambos = set(presentes).intersection(set(presentes_ordem))\n setFinal = set(parlamentares) - presentes_ambos\n\n self.fields['materias_do_expediente'].choices = [\n (e.id, e.materia) for e in expedientes]\n\n self.fields['materias_da_ordem_do_dia'].choices = [\n (o.id, o.materia) for o in ordens]\n\n self.fields['parlamentar'].choices = [\n (\"0\", \"------------\")] + [(p.id, p) for p in setFinal]\n\n def clean(self):\n super(JustificativaAusenciaForm, self).clean()\n\n if not self.is_valid():\n return self.cleaned_data\n\n sessao_plenaria = self.instance.sessao_plenaria\n\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\n\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\n raise ValidationError(\"O arquivo Anexo de Justificativa deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\" \\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\n\n if not sessao_plenaria.finalizada or sessao_plenaria.finalizada is None:\n raise ValidationError(\n \"A sessão deve estar finalizada para registrar uma Ausência\")\n else:\n return self.cleaned_data\n\n def save(self):\n\n justificativa = super().save(True)\n\n if justificativa.ausencia == 2:\n justificativa.materias_do_expediente.clear()\n justificativa.materias_da_ordem_do_dia.clear()\n return justificativa\n","path":"sapl/sessao/forms.py"}],"string":"[\n {\n \"content\": \"from datetime import datetime\\n\\nfrom crispy_forms.layout import HTML, Button, Fieldset, Layout\\nfrom django import forms\\nfrom django.contrib.contenttypes.models import ContentType\\nfrom django.core.exceptions import ObjectDoesNotExist, ValidationError\\nfrom django.db import transaction\\nfrom django.db.models import Q\\nfrom django.forms import ModelForm\\nfrom django.forms.widgets import CheckboxSelectMultiple\\nfrom django.utils.translation import ugettext_lazy as _\\nimport django_filters\\n\\nfrom sapl.settings import MAX_DOC_UPLOAD_SIZE\\nfrom sapl.base.models import Autor, TipoAutor\\nfrom sapl.crispy_layout_mixin import SaplFormHelper\\nfrom sapl.crispy_layout_mixin import form_actions, to_row, SaplFormLayout\\nfrom sapl.materia.forms import MateriaLegislativaFilterSet\\nfrom sapl.materia.models import (MateriaLegislativa, StatusTramitacao,\\n TipoMateriaLegislativa)\\nfrom sapl.parlamentares.models import Parlamentar, Mandato\\nfrom sapl.utils import (RANGE_DIAS_MES, RANGE_MESES,\\n MateriaPesquisaOrderingFilter, autor_label,\\n autor_modal, timezone, choice_anos_com_sessaoplenaria,\\n FileFieldCheckMixin)\\n\\nfrom .models import (Bancada, ExpedienteMateria, JustificativaAusencia,\\n Orador, OradorExpediente, OrdemDia, PresencaOrdemDia, SessaoPlenaria,\\n SessaoPlenariaPresenca, TipoResultadoVotacao,\\n OcorrenciaSessao, RetiradaPauta, TipoRetiradaPauta, OradorOrdemDia, ORDENACAO_RESUMO,\\n ResumoOrdenacao)\\n\\n\\nMES_CHOICES = RANGE_MESES\\nDIA_CHOICES = RANGE_DIAS_MES\\n\\n\\nclass SessaoPlenariaForm(FileFieldCheckMixin, ModelForm):\\n\\n class Meta:\\n model = SessaoPlenaria\\n exclude = ['cod_andamento_sessao']\\n\\n def clean(self):\\n super(SessaoPlenariaForm, self).clean()\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n instance = self.instance\\n\\n num = self.cleaned_data['numero']\\n sl = self.cleaned_data['sessao_legislativa']\\n leg = self.cleaned_data['legislatura']\\n tipo = self.cleaned_data['tipo']\\n abertura = self.cleaned_data['data_inicio']\\n encerramento = self.cleaned_data['data_fim']\\n\\n error = ValidationError(\\n \\\"Número de Sessão Plenária já existente \\\"\\n \\\"para a Legislatura, Sessão Legislativa e Tipo informados. \\\"\\n \\\"Favor escolher um número distinto.\\\")\\n\\n qs = tipo.queryset_tipo_numeracao(leg, sl, abertura)\\n qs &= Q(numero=num)\\n\\n if SessaoPlenaria.objects.filter(qs).exclude(pk=instance.pk).exists():\\n raise error\\n\\n # Condições da verificação\\n abertura_entre_leg = leg.data_inicio <= abertura <= leg.data_fim\\n abertura_entre_sl = sl.data_inicio <= abertura <= sl.data_fim\\n if encerramento is not None:\\n encerramento_entre_leg = leg.data_inicio <= encerramento <= leg.data_fim\\n encerramento_entre_sl = sl.data_inicio <= encerramento <= sl.data_fim\\n # Verificação das datas de abertura e encerramento da Sessão\\n # Verificações com a data de encerramento preenchidas\\n if encerramento is not None:\\n # Verifica se a data de encerramento é anterior a data de abertura\\n if encerramento < abertura:\\n raise ValidationError(\\\"A data de encerramento não pode ser \\\"\\n \\\"anterior a data de abertura.\\\")\\n # Verifica se a data de abertura está entre a data de início e fim\\n # da legislatura\\n if abertura_entre_leg and encerramento_entre_leg:\\n if abertura_entre_sl and encerramento_entre_sl:\\n pass\\n elif abertura_entre_sl and not encerramento_entre_sl:\\n raise ValidationError(\\\"A data de encerramento deve estar entre \\\"\\n \\\"as datas de início e fim da Sessão Legislativa.\\\")\\n elif not abertura_entre_sl and encerramento_entre_sl:\\n raise ValidationError(\\\"A data de abertura deve estar entre as \\\"\\n \\\"datas de início e fim da Sessão Legislativa.\\\")\\n elif not abertura_entre_sl and not encerramento_entre_sl:\\n raise ValidationError(\\\"A data de abertura e de encerramento devem estar \\\"\\n \\\"entre as datas de início e fim da Sessão Legislativa.\\\")\\n elif abertura_entre_leg and not encerramento_entre_leg:\\n if abertura_entre_sl and encerramento_entre_sl:\\n raise ValidationError(\\\"A data de encerramento deve estar entre \\\"\\n \\\"as datas de início e fim da Legislatura.\\\")\\n elif abertura_entre_sl and not encerramento_entre_sl:\\n raise ValidationError(\\\"A data de encerramento deve estar entre \\\"\\n \\\"as datas de início e fim tanto da \\\"\\n \\\"Legislatura quanto da Sessão Legislativa.\\\")\\n elif not abertura_entre_sl and encerramento_entre_sl:\\n raise ValidationError(\\\"As datas de abertura e encerramento devem \\\"\\n \\\"estar entre as \\\"\\n \\\"datas de início e fim tanto Legislatura \\\"\\n \\\"quanto da Sessão Legislativa.\\\")\\n elif not abertura_entre_sl and not encerramento_entre_sl:\\n raise ValidationError(\\\"As datas de abertura e encerramento devem \\\"\\n \\\"estar entre as \\\"\\n \\\"datas de início e fim tanto Legislatura \\\"\\n \\\"quanto da Sessão Legislativa.\\\")\\n elif not abertura_entre_leg and not encerramento_entre_leg:\\n if abertura_entre_sl and encerramento_entre_sl:\\n raise ValidationError(\\\"As datas de abertura e encerramento devem \\\"\\n \\\"estar entre as \\\"\\n \\\"datas de início e fim da Legislatura.\\\")\\n elif abertura_entre_sl and not encerramento_entre_sl:\\n raise ValidationError(\\\"As datas de abertura e encerramento devem \\\"\\n \\\"estar entre as \\\"\\n \\\"datas de início e fim tanto Legislatura \\\"\\n \\\"quanto da Sessão Legislativa.\\\")\\n elif not abertura_entre_sl and encerramento_entre_sl:\\n raise ValidationError(\\\"As datas de abertura e encerramento devem \\\"\\n \\\"estar entre as \\\"\\n \\\"datas de início e fim tanto Legislatura \\\"\\n \\\"quanto da Sessão Legislativa.\\\")\\n elif not abertura_entre_sl and not encerramento_entre_sl:\\n raise ValidationError(\\\"As datas de abertura e encerramento devem \\\"\\n \\\"estar entre as \\\"\\n \\\"datas de início e fim tanto Legislatura \\\"\\n \\\"quanto da Sessão Legislativa.\\\")\\n\\n # Verificações com a data de encerramento vazia\\n else:\\n if abertura_entre_leg:\\n if abertura_entre_sl:\\n pass\\n else:\\n raise ValidationError(\\\"A data de abertura da sessão deve estar \\\"\\n \\\"entre a data de início e fim da Sessão Legislativa.\\\")\\n else:\\n if abertura_entre_sl:\\n raise ValidationError(\\\"A data de abertura da sessão deve estar \\\"\\n \\\"entre a data de início e fim da Legislatura.\\\")\\n else:\\n raise ValidationError(\\\"A data de abertura da sessão deve estar \\\"\\n \\\"entre a data de início e fim tanto da \\\"\\n \\\"Legislatura quanto da Sessão Legislativa.\\\")\\n\\n\\n upload_pauta = self.cleaned_data.get('upload_pauta', False)\\n upload_ata = self.cleaned_data.get('upload_ata', False)\\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\\n\\n if upload_pauta and upload_pauta.size > MAX_DOC_UPLOAD_SIZE:\\n raise ValidationError(\\\"O arquivo Pauta da Sessão deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\\\" \\\\\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_pauta.size/1024)/1024))\\n \\n if upload_ata and upload_ata.size > MAX_DOC_UPLOAD_SIZE:\\n raise ValidationError(\\\"O arquivo Ata da Sessão deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\\\" \\\\\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_ata.size/1024)/1024))\\n \\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\\n raise ValidationError(\\\"O arquivo Anexo da Sessão deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\\\" \\\\\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\\n \\n\\n return self.cleaned_data\\n\\n\\nclass RetiradaPautaForm(ModelForm):\\n\\n tipo_de_retirada = forms.ModelChoiceField(required=True,\\n empty_label='------------',\\n queryset=TipoRetiradaPauta.objects.all())\\n expediente = forms.ModelChoiceField(required=False,\\n label='Matéria do Expediente',\\n queryset=ExpedienteMateria.objects.all())\\n ordem = forms.ModelChoiceField(required=False,\\n label='Matéria da Ordem do Dia',\\n queryset=OrdemDia.objects.all())\\n materia = forms.ModelChoiceField(required=False,\\n widget=forms.HiddenInput(),\\n queryset=MateriaLegislativa.objects.all())\\n\\n class Meta:\\n model = RetiradaPauta\\n fields = ['ordem',\\n 'expediente',\\n 'parlamentar',\\n 'tipo_de_retirada',\\n 'data',\\n 'observacao',\\n 'materia']\\n\\n def __init__(self, *args, **kwargs):\\n\\n row1 = to_row([('tipo_de_retirada', 5),\\n ('parlamentar', 4),\\n ('data', 3)])\\n row2 = to_row([('ordem', 6),\\n ('expediente', 6)])\\n row3 = to_row([('observacao', 12)])\\n\\n self.helper = SaplFormHelper()\\n self.helper.layout = SaplFormLayout(\\n Fieldset(_('Retirada de Pauta'),\\n row1, row2, row3))\\n\\n q = Q(sessao_plenaria=kwargs['initial']['sessao_plenaria'])\\n ordens = OrdemDia.objects.filter(q)\\n expedientes = ExpedienteMateria.objects.filter(q)\\n retiradas_ordem = [\\n r.ordem for r in RetiradaPauta.objects.filter(q, ordem__in=ordens)]\\n retiradas_expediente = [r.expediente for r in RetiradaPauta.objects.filter(\\n q, expediente__in=expedientes)]\\n setOrdem = set(ordens) - set(retiradas_ordem)\\n setExpediente = set(expedientes) - set(retiradas_expediente)\\n\\n super(RetiradaPautaForm, self).__init__(\\n *args, **kwargs)\\n\\n if self.instance.pk:\\n setOrdem = set(ordens)\\n setExpediente = set(expedientes)\\n\\n presencas = SessaoPlenariaPresenca.objects.filter(\\n q).order_by('parlamentar__nome_parlamentar')\\n presentes = [p.parlamentar for p in presencas]\\n\\n self.fields['expediente'].choices = [\\n (None, \\\"------------\\\")] + [(e.id, e.materia) for e in setExpediente]\\n self.fields['ordem'].choices = [\\n (None, \\\"------------\\\")] + [(o.id, o.materia) for o in setOrdem]\\n self.fields['parlamentar'].choices = [\\n (None, \\\"------------\\\")] + [(p.id, p) for p in presentes]\\n\\n def clean(self):\\n\\n super(RetiradaPautaForm, self).clean()\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n sessao_plenaria = self.instance.sessao_plenaria\\n if self.cleaned_data['data'] < sessao_plenaria.data_inicio:\\n raise ValidationError(\\n _(\\\"Data de retirada de pauta anterior à abertura da Sessão.\\\"))\\n if sessao_plenaria.data_fim and self.cleaned_data['data'] > sessao_plenaria.data_fim:\\n raise ValidationError(\\n _(\\\"Data de retirada de pauta posterior ao encerramento da Sessão.\\\"))\\n\\n if self.cleaned_data['ordem'] and self.cleaned_data['ordem'].registrovotacao_set.exists():\\n raise ValidationError(\\n _(\\\"Essa matéria já foi votada, portanto não pode ser retirada de pauta.\\\"))\\n elif self.cleaned_data['expediente'] and self.cleaned_data['expediente'].registrovotacao_set.exists():\\n raise ValidationError(\\n _(\\\"Essa matéria já foi votada, portanto não pode ser retirada de pauta.\\\"))\\n\\n return self.cleaned_data\\n\\n def save(self, commit=False):\\n retirada = super(RetiradaPautaForm, self).save(commit=commit)\\n if retirada.ordem:\\n ordem = retirada.ordem\\n retirada.materia = ordem.materia\\n ordem.votacao_aberta = False\\n ordem.save()\\n elif retirada.expediente:\\n expediente = retirada.expediente\\n retirada.materia = expediente.materia\\n expediente.votacao_aberta = False\\n expediente.save()\\n retirada.save()\\n return retirada\\n\\n\\nclass BancadaForm(ModelForm):\\n\\n class Meta:\\n model = Bancada\\n fields = ['legislatura', 'nome', 'partido', 'data_criacao',\\n 'data_extincao', 'descricao']\\n\\n def clean(self):\\n super(BancadaForm, self).clean()\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n data = self.cleaned_data\\n\\n legislatura = data['legislatura']\\n\\n data_criacao = data['data_criacao']\\n if data_criacao:\\n if (data_criacao < legislatura.data_inicio or\\n data_criacao > legislatura.data_fim):\\n raise ValidationError(_(\\\"Data de criação da bancada fora do intervalo\\\"\\n \\\" de legislatura informada\\\"))\\n\\n data_extincao = data['data_extincao']\\n if data_extincao:\\n if (data_extincao < legislatura.data_inicio or\\n data_extincao > legislatura.data_fim):\\n raise ValidationError(_(\\\"Data fim da bancada fora do intervalo de\\\"\\n \\\" legislatura informada\\\"))\\n\\n if self.cleaned_data['data_extincao']:\\n if (self.cleaned_data['data_extincao'] <\\n self.cleaned_data['data_criacao']):\\n msg = _('Data de extinção não pode ser menor que a de criação')\\n raise ValidationError(msg)\\n return self.cleaned_data\\n\\n @transaction.atomic\\n def save(self, commit=True):\\n bancada = super(BancadaForm, self).save(commit)\\n content_type = ContentType.objects.get_for_model(Bancada)\\n object_id = bancada.pk\\n tipo = TipoAutor.objects.get(content_type=content_type)\\n Autor.objects.create(\\n content_type=content_type,\\n object_id=object_id,\\n tipo=tipo,\\n nome=bancada.nome\\n )\\n return bancada\\n\\n\\nclass ExpedienteMateriaForm(ModelForm):\\n\\n _model = ExpedienteMateria\\n data_atual = timezone.now()\\n\\n tipo_materia = forms.ModelChoiceField(\\n label=_('Tipo Matéria'),\\n required=True,\\n queryset=TipoMateriaLegislativa.objects.all(),\\n empty_label='Selecione',\\n widget=forms.Select(attrs={'autocomplete': 'off'}))\\n\\n numero_materia = forms.CharField(\\n label='Número Matéria', required=True,\\n widget=forms.TextInput(attrs={'autocomplete': 'off'}))\\n\\n ano_materia = forms.CharField(\\n label='Ano Matéria',\\n initial=int(data_atual.year),\\n required=True,\\n widget=forms.TextInput(attrs={'autocomplete': 'off'}))\\n\\n data_ordem = forms.CharField(\\n label='Data Sessão',\\n initial=datetime.strftime(timezone.now(), '%d/%m/%Y'),\\n widget=forms.TextInput(attrs={'readonly': 'readonly'}))\\n\\n class Meta:\\n model = ExpedienteMateria\\n fields = ['data_ordem', 'numero_ordem', 'tipo_materia', 'observacao',\\n 'numero_materia', 'ano_materia', 'tipo_votacao']\\n\\n def clean_numero_ordem(self):\\n sessao = self.instance.sessao_plenaria\\n\\n numero_ordem_exists = ExpedienteMateria.objects.filter(\\n sessao_plenaria=sessao,\\n numero_ordem=self.cleaned_data['numero_ordem']).exists()\\n\\n if numero_ordem_exists and not self.instance.pk:\\n msg = _('Esse número de ordem já existe.')\\n raise ValidationError(msg)\\n\\n return self.cleaned_data['numero_ordem']\\n\\n def clean_data_ordem(self):\\n return self.instance.sessao_plenaria.data_inicio\\n\\n def clean(self):\\n cleaned_data = super(ExpedienteMateriaForm, self).clean()\\n if not self.is_valid():\\n return cleaned_data\\n\\n sessao = self.instance.sessao_plenaria\\n\\n try:\\n materia = MateriaLegislativa.objects.get(\\n numero=self.cleaned_data['numero_materia'],\\n ano=self.cleaned_data['ano_materia'],\\n tipo=self.cleaned_data['tipo_materia'])\\n except ObjectDoesNotExist:\\n msg = _('A matéria a ser inclusa não existe no cadastro'\\n ' de matérias legislativas.')\\n raise ValidationError(msg)\\n else:\\n cleaned_data['materia'] = materia\\n\\n exists = self._model.objects.filter(\\n sessao_plenaria=sessao,\\n materia=materia).exists()\\n\\n if exists and not self.instance.pk:\\n msg = _('Essa matéria já foi cadastrada.')\\n raise ValidationError(msg)\\n\\n return cleaned_data\\n\\n def save(self, commit=False):\\n expediente = super(ExpedienteMateriaForm, self).save(commit)\\n expediente.materia = self.cleaned_data['materia']\\n expediente.save()\\n return expediente\\n\\n\\nclass OrdemDiaForm(ExpedienteMateriaForm):\\n\\n _model = OrdemDia\\n\\n class Meta:\\n model = OrdemDia\\n fields = ['data_ordem', 'numero_ordem', 'tipo_materia', 'observacao',\\n 'numero_materia', 'ano_materia', 'tipo_votacao']\\n\\n def clean_data_ordem(self):\\n return self.instance.sessao_plenaria.data_inicio\\n\\n def clean_numero_ordem(self):\\n sessao = self.instance.sessao_plenaria\\n\\n numero_ordem_exists = OrdemDia.objects.filter(\\n sessao_plenaria=sessao,\\n numero_ordem=self.cleaned_data['numero_ordem']).exists()\\n\\n if numero_ordem_exists and not self.instance.pk:\\n msg = _('Esse número de ordem já existe.')\\n raise ValidationError(msg)\\n\\n return self.cleaned_data['numero_ordem']\\n\\n def clean(self):\\n cleaned_data = super(OrdemDiaForm, self).clean()\\n if not self.is_valid():\\n return cleaned_data\\n return self.cleaned_data\\n\\n def save(self, commit=False):\\n ordem = super(OrdemDiaForm, self).save(commit)\\n ordem.materia = self.cleaned_data['materia']\\n ordem.save()\\n return ordem\\n\\n\\nclass PresencaForm(forms.Form):\\n presenca = forms.CharField(required=False, initial=False)\\n parlamentar = forms.CharField(required=False, max_length=20)\\n\\n\\nclass ListMateriaForm(forms.Form):\\n error_message = forms.CharField(required=False, label='votacao_aberta')\\n\\n\\nclass MesaForm(forms.Form):\\n parlamentar = forms.IntegerField(required=True)\\n cargo = forms.IntegerField(required=True)\\n\\n\\nclass ExpedienteForm(forms.Form):\\n conteudo = forms.CharField(required=False, widget=forms.Textarea)\\n\\n\\nclass OcorrenciaSessaoForm(ModelForm):\\n class Meta:\\n model = OcorrenciaSessao\\n fields = ['conteudo']\\n\\n\\nclass VotacaoForm(forms.Form):\\n votos_sim = forms.IntegerField(label='Sim')\\n votos_nao = forms.IntegerField(label='Não')\\n abstencoes = forms.IntegerField(label='Abstenções')\\n total_presentes = forms.IntegerField(\\n required=False, widget=forms.HiddenInput())\\n total_votantes = forms.IntegerField(\\n required=False, widget=forms.HiddenInput()\\n )\\n voto_presidente = forms.IntegerField(\\n label='A totalização inclui o voto do Presidente?')\\n total_votos = forms.IntegerField(required=False, label='total')\\n observacao = forms.CharField(required=False, label='Observação')\\n resultado_votacao = forms.CharField(label='Resultado da Votação')\\n\\n def clean(self):\\n cleaned_data = super(VotacaoForm, self).clean()\\n if not self.is_valid():\\n return cleaned_data\\n\\n votos_sim = cleaned_data['votos_sim']\\n votos_nao = cleaned_data['votos_nao']\\n abstencoes = cleaned_data['abstencoes']\\n qtde_presentes = cleaned_data['total_presentes']\\n qtde_votantes = cleaned_data['total_votantes']\\n qtde_votos = votos_sim + votos_nao + abstencoes\\n voto_presidente = cleaned_data['voto_presidente']\\n\\n if qtde_votantes and not voto_presidente:\\n qtde_votantes -= 1\\n\\n if qtde_votantes and qtde_votos != qtde_votantes:\\n raise ValidationError(\\n 'O total de votos não corresponde com a quantidade de votantes!')\\n\\n return cleaned_data\\n\\n # def save(self, commit=False):\\n # #TODO Verificar se esse códido é utilizado\\n\\n # votacao = super(VotacaoForm, self).save(commit)\\n # votacao.materia = self.cleaned_data['materia']\\n # votacao.save()\\n # return votacao\\n\\n\\nclass VotacaoNominalForm(forms.Form):\\n resultado_votacao = forms.ModelChoiceField(label='Resultado da Votação',\\n required=False,\\n queryset=TipoResultadoVotacao.objects.all())\\n\\n\\nclass VotacaoEditForm(forms.Form):\\n pass\\n\\n\\nclass SessaoPlenariaFilterSet(django_filters.FilterSet):\\n\\n data_inicio__year = django_filters.ChoiceFilter(\\n required=False,\\n label='Ano',\\n choices=choice_anos_com_sessaoplenaria\\n )\\n data_inicio__month = django_filters.ChoiceFilter(required=False,\\n label='Mês',\\n choices=MES_CHOICES)\\n data_inicio__day = django_filters.ChoiceFilter(required=False,\\n label='Dia',\\n choices=DIA_CHOICES)\\n titulo = _('Pesquisa de Sessão Plenária')\\n\\n class Meta:\\n model = SessaoPlenaria\\n fields = ['tipo']\\n\\n def __init__(self, *args, **kwargs):\\n super(SessaoPlenariaFilterSet, self).__init__(*args, **kwargs)\\n\\n # pré-popula o campo do formulário com o ano corrente\\n self.form.fields['data_inicio__year'].initial = timezone.now().year\\n\\n row1 = to_row(\\n [('data_inicio__year', 3),\\n ('data_inicio__month', 3),\\n ('data_inicio__day', 3),\\n ('tipo', 3)])\\n\\n self.form.helper = SaplFormHelper()\\n self.form.helper.form_method = 'GET'\\n self.form.helper.layout = Layout(\\n Fieldset(self.titulo,\\n row1,\\n form_actions(label='Pesquisar'))\\n )\\n\\n\\nclass AdicionarVariasMateriasFilterSet(MateriaLegislativaFilterSet):\\n\\n o = MateriaPesquisaOrderingFilter()\\n tramitacao__status = django_filters.ModelChoiceFilter(\\n required=False,\\n queryset=StatusTramitacao.objects.all(),\\n label=_('Status da Matéria'))\\n\\n class Meta:\\n model = MateriaLegislativa\\n fields = ['tramitacao__status',\\n 'numero',\\n 'numero_protocolo',\\n 'ano',\\n 'tipo',\\n 'data_apresentacao',\\n 'data_publicacao',\\n 'autoria__autor__tipo',\\n # FIXME 'autoria__autor__partido',\\n 'relatoria__parlamentar_id',\\n 'local_origem_externa',\\n 'em_tramitacao',\\n ]\\n\\n def __init__(self, *args, **kwargs):\\n super(MateriaLegislativaFilterSet, self).__init__(*args, **kwargs)\\n\\n self.filters['tipo'].label = 'Tipo de Matéria'\\n self.filters['autoria__autor__tipo'].label = 'Tipo de Autor'\\n # self.filters['autoria__autor__partido'].label = 'Partido do Autor'\\n self.filters['relatoria__parlamentar_id'].label = 'Relatoria'\\n\\n row1 = to_row(\\n [('tramitacao__status', 12)])\\n row2 = to_row(\\n [('tipo', 12)])\\n row3 = to_row(\\n [('numero', 4),\\n ('ano', 4),\\n ('numero_protocolo', 4)])\\n row4 = to_row(\\n [('data_apresentacao', 6),\\n ('data_publicacao', 6)])\\n row5 = to_row(\\n [('autoria__autor', 0),\\n (Button('pesquisar',\\n 'Pesquisar Autor',\\n css_class='btn btn-primary btn-sm'), 2),\\n (Button('limpar',\\n 'limpar Autor',\\n css_class='btn btn-primary btn-sm'), 10)])\\n row6 = to_row(\\n [('autoria__autor__tipo', 6),\\n # ('autoria__autor__partido', 6)\\n ])\\n row7 = to_row(\\n [('relatoria__parlamentar_id', 6),\\n ('local_origem_externa', 6)])\\n row8 = to_row(\\n [('em_tramitacao', 6),\\n ('o', 6)])\\n row9 = to_row(\\n [('ementa', 12)])\\n\\n self.form.helper = SaplFormHelper()\\n self.form.helper.form_method = 'GET'\\n self.form.helper.layout = Layout(\\n Fieldset(_('Pesquisa de Matéria'),\\n row1, row2, row3,\\n HTML(autor_label),\\n HTML(autor_modal),\\n row4, row5, row6, row7, row8, row9,\\n form_actions(label='Pesquisar'))\\n )\\n\\n\\nclass OradorForm(ModelForm):\\n def __init__(self, *args, **kwargs):\\n super().__init__(*args, **kwargs)\\n self.fields['parlamentar'].queryset = \\\\\\n Parlamentar.objects.filter(ativo=True).order_by('nome_parlamentar')\\n\\n def clean(self):\\n super(OradorForm, self).clean()\\n cleaned_data = self.cleaned_data\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n sessao_id = self.initial['id_sessao']\\n numero = self.initial.get('numero')\\n numero_ordem = cleaned_data['numero_ordem']\\n ordem = Orador.objects.filter(\\n sessao_plenaria_id=sessao_id,\\n numero_ordem=numero_ordem\\n ).exists()\\n\\n if ordem and numero_ordem != numero:\\n raise ValidationError(_(\\n \\\"Já existe orador nesta posição de ordem de pronunciamento\\\"\\n ))\\n\\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\\n\\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\\n raise ValidationError(\\\"O arquivo Anexo do Orador deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\\\" \\\\\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\\n\\n return self.cleaned_data\\n\\n class Meta:\\n model = Orador\\n exclude = ['sessao_plenaria']\\n\\n\\nclass OradorExpedienteForm(ModelForm):\\n def __init__(self, *args, **kwargs):\\n super().__init__(*args, **kwargs)\\n id_sessao = int(self.initial['id_sessao'])\\n sessao = SessaoPlenaria.objects.get(id=id_sessao)\\n legislatura_vigente = sessao.legislatura\\n self.fields['parlamentar'].queryset = \\\\\\n Parlamentar.objects.filter(mandato__legislatura=legislatura_vigente,\\n ativo=True).order_by('nome_parlamentar')\\n\\n def clean(self):\\n super(OradorExpedienteForm, self).clean()\\n cleaned_data = self.cleaned_data\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n sessao_id = self.initial['id_sessao']\\n numero = self.initial.get('numero', None)\\n ordem = OradorExpediente.objects.filter(\\n sessao_plenaria_id=sessao_id,\\n numero_ordem=cleaned_data['numero_ordem']\\n ).exists()\\n\\n if ordem and (cleaned_data['numero_ordem'] != numero):\\n raise ValidationError(_(\\n 'Já existe orador nesta posição da ordem de pronunciamento'))\\n\\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\\n\\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\\n raise ValidationError(\\\"O arquivo Anexo do Orador deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\\\" \\\\\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\\n\\n return self.cleaned_data\\n\\n class Meta:\\n model = OradorExpediente\\n exclude = ['sessao_plenaria']\\n\\n\\nclass OradorOrdemDiaForm(ModelForm):\\n def __init__(self, *args, **kwargs):\\n super().__init__(*args, **kwargs)\\n id_sessao = int(self.initial['id_sessao'])\\n sessao = SessaoPlenaria.objects.get(id=id_sessao)\\n legislatura_vigente = sessao.legislatura\\n self.fields['parlamentar'].queryset = \\\\\\n Parlamentar.objects.filter(mandato__legislatura=legislatura_vigente,\\n ativo=True).order_by('nome_parlamentar')\\n\\n def clean(self):\\n super(OradorOrdemDiaForm, self).clean()\\n cleaned_data = self.cleaned_data\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n sessao_id = self.initial['id_sessao']\\n numero = self.initial.get('numero')\\n numero_ordem = cleaned_data['numero_ordem']\\n ordem = OradorOrdemDia.objects.filter(\\n sessao_plenaria_id=sessao_id,\\n numero_ordem=numero_ordem\\n ).exists()\\n\\n if ordem and numero_ordem != numero:\\n raise ValidationError(_(\\n \\\"Já existe orador nesta posição de ordem de pronunciamento\\\"\\n ))\\n\\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\\n\\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\\n raise ValidationError(\\\"O arquivo Anexo do Orador deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\\\" \\\\\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\\n\\n return self.cleaned_data\\n\\n class Meta:\\n model = OradorOrdemDia\\n exclude = ['sessao_plenaria']\\n\\n\\nclass PautaSessaoFilterSet(SessaoPlenariaFilterSet):\\n titulo = _('Pesquisa de Pauta de Sessão')\\n\\n\\nclass ResumoOrdenacaoForm(forms.Form):\\n primeiro = forms.ChoiceField(\\n label='1°',\\n choices=ORDENACAO_RESUMO\\n )\\n segundo = forms.ChoiceField(\\n label='2°',\\n choices=ORDENACAO_RESUMO\\n )\\n terceiro = forms.ChoiceField(\\n label='3°',\\n choices=ORDENACAO_RESUMO\\n )\\n quarto = forms.ChoiceField(\\n label='4°',\\n choices=ORDENACAO_RESUMO\\n )\\n quinto = forms.ChoiceField(\\n label='5°',\\n choices=ORDENACAO_RESUMO\\n )\\n sexto = forms.ChoiceField(\\n label='6°',\\n choices=ORDENACAO_RESUMO\\n )\\n setimo = forms.ChoiceField(\\n label='7°',\\n choices=ORDENACAO_RESUMO\\n )\\n oitavo = forms.ChoiceField(\\n label='8°',\\n choices=ORDENACAO_RESUMO\\n )\\n nono = forms.ChoiceField(\\n label='9°',\\n choices=ORDENACAO_RESUMO\\n )\\n decimo = forms.ChoiceField(\\n label='10°',\\n choices=ORDENACAO_RESUMO\\n )\\n decimo_primeiro = forms.ChoiceField(\\n label='11°',\\n choices=ORDENACAO_RESUMO\\n )\\n decimo_segundo = forms.ChoiceField(\\n label='12°',\\n choices=ORDENACAO_RESUMO\\n )\\n decimo_terceiro = forms.ChoiceField(\\n label='13°',\\n choices=ORDENACAO_RESUMO\\n )\\n decimo_quarto = forms.ChoiceField(\\n label='14°',\\n choices=ORDENACAO_RESUMO\\n )\\n\\n def __init__(self, *args, **kwargs):\\n row1 = to_row(\\n [('primeiro', 12)])\\n row2 = to_row(\\n [('segundo', 12)])\\n row3 = to_row(\\n [('terceiro', 12)])\\n row4 = to_row(\\n [('quarto', 12)])\\n row5 = to_row(\\n [('quinto', 12)])\\n row6 = to_row(\\n [('sexto', 12)])\\n row7 = to_row(\\n [('setimo', 12)])\\n row8 = to_row(\\n [('oitavo', 12)])\\n row9 = to_row(\\n [('nono', 12)])\\n row10 = to_row(\\n [('decimo', 12)])\\n row11 = to_row(\\n [('decimo_primeiro', 12)])\\n row12 = to_row(\\n [('decimo_segundo', 12)])\\n row13 = to_row(\\n [('decimo_terceiro', 12)])\\n row14 = to_row(\\n [('decimo_quarto', 12)]\\n )\\n\\n self.helper = SaplFormHelper()\\n self.helper.layout = Layout(\\n Fieldset(_(''),\\n row1, row2, row3, row4, row5,\\n row6, row7, row8, row9, row10,\\n row11, row12, row13, row14,\\n form_actions(label='Atualizar'))\\n )\\n\\n super().__init__(*args, **kwargs)\\n\\n def clean(self):\\n super(ResumoOrdenacaoForm, self).clean()\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n cleaned_data = self.cleaned_data\\n\\n for c1 in cleaned_data:\\n i = 0\\n for c2 in cleaned_data:\\n if cleaned_data[str(c1)] == cleaned_data[str(c2)]:\\n i = i + 1\\n if i > 1:\\n raise ValidationError(_(\\n 'Não é possível ter campos repetidos'))\\n return self.cleaned_data\\n\\n def save(self):\\n ordenacao = ResumoOrdenacao.objects.get()\\n cleaned_data = self.cleaned_data\\n\\n ordenacao.primeiro = cleaned_data['primeiro']\\n ordenacao.segundo = cleaned_data['segundo']\\n ordenacao.terceiro = cleaned_data['terceiro']\\n ordenacao.quarto = cleaned_data['quarto']\\n ordenacao.quinto = cleaned_data['quinto']\\n ordenacao.sexto = cleaned_data['sexto']\\n ordenacao.setimo = cleaned_data['setimo']\\n ordenacao.oitavo = cleaned_data['oitavo']\\n ordenacao.nono = cleaned_data['nono']\\n ordenacao.decimo = cleaned_data['decimo']\\n ordenacao.decimo_primeiro = cleaned_data['decimo_primeiro']\\n ordenacao.decimo_segundo = cleaned_data['decimo_segundo']\\n ordenacao.decimo_terceiro = cleaned_data['decimo_terceiro']\\n ordenacao.decimo_quarto = cleaned_data['decimo_quarto']\\n\\n ordenacao.save()\\n\\n\\nclass JustificativaAusenciaForm(ModelForm):\\n\\n class Meta:\\n model = JustificativaAusencia\\n fields = ['parlamentar',\\n 'hora',\\n 'data',\\n 'upload_anexo',\\n 'tipo_ausencia',\\n 'ausencia',\\n 'materias_do_expediente',\\n 'materias_da_ordem_do_dia',\\n 'observacao'\\n ]\\n\\n widgets = {\\n 'materias_do_expediente': CheckboxSelectMultiple(),\\n 'materias_da_ordem_do_dia': CheckboxSelectMultiple()}\\n\\n def __init__(self, *args, **kwargs):\\n\\n row1 = to_row(\\n [('parlamentar', 12)])\\n row2 = to_row(\\n [('data', 6),\\n ('hora', 6)])\\n row3 = to_row(\\n [('upload_anexo', 6)])\\n row4 = to_row(\\n [('tipo_ausencia', 12)])\\n row5 = to_row(\\n [('ausencia', 12)])\\n row6 = to_row(\\n [('materias_do_expediente', 12)])\\n row7 = to_row(\\n [('materias_da_ordem_do_dia', 12)])\\n row8 = to_row(\\n [('observacao', 12)])\\n\\n self.helper = SaplFormHelper()\\n self.helper.layout = SaplFormLayout(\\n Fieldset(_('Justificativa de Ausência'),\\n row1, row2, row3,\\n row4, row5,\\n row6,\\n row7,\\n row8)\\n )\\n q = Q(sessao_plenaria=kwargs['initial']['sessao_plenaria'])\\n ordens = OrdemDia.objects.filter(q)\\n expedientes = ExpedienteMateria.objects.filter(q)\\n legislatura = kwargs['initial']['sessao_plenaria'].legislatura\\n mandato = Mandato.objects.filter(\\n legislatura=legislatura).order_by('parlamentar__nome_parlamentar')\\n parlamentares = [m.parlamentar for m in mandato]\\n\\n super(JustificativaAusenciaForm, self).__init__(\\n *args, **kwargs)\\n\\n presencas = SessaoPlenariaPresenca.objects.filter(\\n q).order_by('parlamentar__nome_parlamentar')\\n presencas_ordem = PresencaOrdemDia.objects.filter(\\n q).order_by('parlamentar__nome_parlamentar')\\n\\n presentes = [p.parlamentar for p in presencas]\\n presentes_ordem = [p.parlamentar for p in presencas_ordem]\\n\\n presentes_ambos = set(presentes).intersection(set(presentes_ordem))\\n setFinal = set(parlamentares) - presentes_ambos\\n\\n self.fields['materias_do_expediente'].choices = [\\n (e.id, e.materia) for e in expedientes]\\n\\n self.fields['materias_da_ordem_do_dia'].choices = [\\n (o.id, o.materia) for o in ordens]\\n\\n self.fields['parlamentar'].choices = [\\n (\\\"0\\\", \\\"------------\\\")] + [(p.id, p) for p in setFinal]\\n\\n def clean(self):\\n super(JustificativaAusenciaForm, self).clean()\\n\\n if not self.is_valid():\\n return self.cleaned_data\\n\\n sessao_plenaria = self.instance.sessao_plenaria\\n\\n upload_anexo = self.cleaned_data.get('upload_anexo', False)\\n\\n if upload_anexo and upload_anexo.size > MAX_DOC_UPLOAD_SIZE:\\n raise ValidationError(\\\"O arquivo Anexo de Justificativa deve ser menor que {0:.1f} mb, o tamanho atual desse arquivo é {1:.1f} mb\\\" \\\\\\n .format((MAX_DOC_UPLOAD_SIZE/1024)/1024, (upload_anexo.size/1024)/1024))\\n\\n if not sessao_plenaria.finalizada or sessao_plenaria.finalizada is None:\\n raise ValidationError(\\n \\\"A sessão deve estar finalizada para registrar uma Ausência\\\")\\n else:\\n return self.cleaned_data\\n\\n def save(self):\\n\\n justificativa = super().save(True)\\n\\n if justificativa.ausencia == 2:\\n justificativa.materias_do_expediente.clear()\\n justificativa.materias_da_ordem_do_dia.clear()\\n return justificativa\\n\",\n \"path\": \"sapl/sessao/forms.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/sapl/sessao/forms.py b/sapl/sessao/forms.py\nindex 01f0c3636..4e2a0498f 100644\n--- a/sapl/sessao/forms.py\n+++ b/sapl/sessao/forms.py\n@@ -577,7 +577,7 @@ class AdicionarVariasMateriasFilterSet(MateriaLegislativaFilterSet):\n \n o = MateriaPesquisaOrderingFilter()\n tramitacao__status = django_filters.ModelChoiceFilter(\n- required=True,\n+ required=False,\n queryset=StatusTramitacao.objects.all(),\n label=_('Status da Matéria'))\n \n"}}},{"rowIdx":2688,"cells":{"in_source_id":{"kind":"string","value":"projectmesa__mesa-1256"},"issue":{"kind":"string","value":"CI: test flake: batch runner sometimes takes 6 hours then gets killed by GitHub Actions\nSee e.g. https://github.com/projectmesa/mesa/runs/5259005495?check_suite_focus=true.\r\n\r\nWe might want to add timeout to batch runner tests, with https://pypi.org/project/pytest-timeout/.\n"},"before_files":{"kind":"list like","value":[{"content":"\"\"\"\nBatchrunner\n===========\n\nA single class to manage a batch run or parameter sweep of a given model.\n\n\"\"\"\nimport copy\nimport itertools\nimport random\nfrom collections import OrderedDict\nfrom functools import partial\nfrom itertools import count, product\nfrom multiprocessing import Pool, cpu_count\nfrom warnings import warn\nfrom typing import (\n Any,\n Counter,\n Dict,\n Iterable,\n List,\n Mapping,\n Optional,\n Tuple,\n Type,\n Union,\n)\n\nimport pandas as pd\nfrom tqdm import tqdm\n\nfrom mesa.model import Model\n\n\ndef batch_run(\n model_cls: Type[Model],\n parameters: Mapping[str, Union[Any, Iterable[Any]]],\n number_processes: Optional[int] = None,\n iterations: int = 1,\n data_collection_period: int = -1,\n max_steps: int = 1000,\n display_progress: bool = True,\n) -> List[Dict[str, Any]]:\n \"\"\"Batch run a mesa model with a set of parameter values.\n\n Parameters\n ----------\n model_cls : Type[Model]\n The model class to batch-run\n parameters : Mapping[str, Union[Any, Iterable[Any]]],\n Dictionary with model parameters over which to run the model. You can either pass single values or iterables.\n number_processes : int, optional\n Number of processes used. Set to None (default) to use all available processors\n iterations : int, optional\n Number of iterations for each parameter combination, by default 1\n data_collection_period : int, optional\n Number of steps after which data gets collected, by default -1 (end of episode)\n max_steps : int, optional\n Maximum number of model steps after which the model halts, by default 1000\n display_progress : bool, optional\n Display batch run process, by default True\n\n Returns\n -------\n List[Dict[str, Any]]\n [description]\n \"\"\"\n\n kwargs_list = _make_model_kwargs(parameters) * iterations\n process_func = partial(\n _model_run_func,\n model_cls,\n max_steps=max_steps,\n data_collection_period=data_collection_period,\n )\n\n total_iterations = len(kwargs_list) * iterations\n run_counter = count()\n\n results: List[Dict[str, Any]] = []\n\n with tqdm(total_iterations, disable=not display_progress) as pbar:\n if number_processes == 1:\n for iteration in range(iterations):\n for kwargs in kwargs_list:\n _, rawdata = process_func(kwargs)\n run_id = next(run_counter)\n data = []\n for run_data in rawdata:\n out = {\"RunId\": run_id, \"iteration\": iteration - 1}\n out.update(run_data)\n data.append(out)\n results.extend(data)\n pbar.update()\n\n else:\n iteration_counter: Counter[Tuple[Any, ...]] = Counter()\n with Pool(number_processes) as p:\n for paramValues, rawdata in p.imap_unordered(process_func, kwargs_list):\n iteration_counter[paramValues] += 1\n iteration = iteration_counter[paramValues]\n run_id = next(run_counter)\n data = []\n for run_data in rawdata:\n out = {\"RunId\": run_id, \"iteration\": iteration - 1}\n out.update(run_data)\n data.append(out)\n results.extend(data)\n pbar.update()\n\n return results\n\n\ndef _make_model_kwargs(\n parameters: Mapping[str, Union[Any, Iterable[Any]]]\n) -> List[Dict[str, Any]]:\n \"\"\"Create model kwargs from parameters dictionary.\n\n Parameters\n ----------\n parameters : Mapping[str, Union[Any, Iterable[Any]]]\n Single or multiple values for each model parameter name\n\n Returns\n -------\n List[Dict[str, Any]]\n A list of all kwargs combinations.\n \"\"\"\n parameter_list = []\n for param, values in parameters.items():\n try:\n all_values = [(param, value) for value in values]\n except TypeError:\n all_values = [(param, values)]\n parameter_list.append(all_values)\n all_kwargs = itertools.product(*parameter_list)\n kwargs_list = [dict(kwargs) for kwargs in all_kwargs]\n return kwargs_list\n\n\ndef _model_run_func(\n model_cls: Type[Model],\n kwargs: Dict[str, Any],\n max_steps: int,\n data_collection_period: int,\n) -> Tuple[Tuple[Any, ...], List[Dict[str, Any]]]:\n \"\"\"Run a single model run and collect model and agent data.\n\n Parameters\n ----------\n model_cls : Type[Model]\n The model class to batch-run\n kwargs : Dict[str, Any]\n model kwargs used for this run\n max_steps : int\n Maximum number of model steps after which the model halts, by default 1000\n data_collection_period : int\n Number of steps after which data gets collected\n\n Returns\n -------\n Tuple[Tuple[Any, ...], List[Dict[str, Any]]]\n Return model_data, agent_data from the reporters\n \"\"\"\n model = model_cls(**kwargs)\n while model.running and model.schedule.steps <= max_steps:\n model.step()\n\n data = []\n\n steps = list(range(0, model.schedule.steps, data_collection_period))\n if not steps or steps[-1] != model.schedule.steps - 1:\n steps.append(model.schedule.steps - 1)\n\n for step in steps:\n model_data, all_agents_data = _collect_data(model, step)\n\n # If there are agent_reporters, then create an entry for each agent\n if all_agents_data:\n stepdata = [\n {**{\"Step\": step}, **kwargs, **model_data, **agent_data}\n for agent_data in all_agents_data\n ]\n # If there is only model data, then create a single entry for the step\n else:\n stepdata = [{**{\"Step\": step}, **kwargs, **model_data}]\n data.extend(stepdata)\n\n return tuple(kwargs.values()), data\n\n\ndef _collect_data(\n model: Model,\n step: int,\n) -> Tuple[Dict[str, Any], List[Dict[str, Any]]]:\n \"\"\"Collect model and agent data from a model using mesas datacollector.\"\"\"\n dc = model.datacollector\n\n model_data = {param: values[step] for param, values in dc.model_vars.items()}\n\n all_agents_data = []\n raw_agent_data = dc._agent_records.get(step, [])\n for data in raw_agent_data:\n agent_dict = {\"AgentID\": data[1]}\n agent_dict.update(zip(dc.agent_reporters, data[2:]))\n all_agents_data.append(agent_dict)\n return model_data, all_agents_data\n\n\nclass ParameterError(TypeError):\n MESSAGE = (\n \"Parameters must map a name to a value. \"\n \"These names did not match parameters: {}\"\n )\n\n def __init__(self, bad_names):\n self.bad_names = bad_names\n\n def __str__(self):\n return self.MESSAGE.format(self.bad_names)\n\n\nclass VariableParameterError(ParameterError):\n MESSAGE = (\n \"Variable_parameters must map a name to a sequence of values. \"\n \"These parameters were given with non-sequence values: {}\"\n )\n\n def __init__(self, bad_names):\n super().__init__(bad_names)\n\n\nclass FixedBatchRunner:\n \"\"\"This class is instantiated with a model class, and model parameters\n associated with one or more values. It is also instantiated with model and\n agent-level reporters, dictionaries mapping a variable name to a function\n which collects some data from the model or its agents at the end of the run\n and stores it.\n\n Note that by default, the reporters only collect data at the *end* of the\n run. To get step by step data, simply have a reporter store the model's\n entire DataCollector object.\n \"\"\"\n\n def __init__(\n self,\n model_cls,\n parameters_list=None,\n fixed_parameters=None,\n iterations=1,\n max_steps=1000,\n model_reporters=None,\n agent_reporters=None,\n display_progress=True,\n ):\n \"\"\"Create a new BatchRunner for a given model with the given\n parameters.\n\n Args:\n model_cls: The class of model to batch-run.\n parameters_list: A list of dictionaries of parameter sets.\n The model will be run with dictionary of parameters.\n For example, given parameters_list of\n [{\"homophily\": 3, \"density\": 0.8, \"minority_pc\": 0.2},\n {\"homophily\": 2, \"density\": 0.9, \"minority_pc\": 0.1},\n {\"homophily\": 4, \"density\": 0.6, \"minority_pc\": 0.5}]\n 3 models will be run, one for each provided set of parameters.\n fixed_parameters: Dictionary of parameters that stay same through\n all batch runs. For example, given fixed_parameters of\n {\"constant_parameter\": 3},\n every instantiated model will be passed constant_parameter=3\n as a kwarg.\n iterations: The total number of times to run the model for each set\n of parameters.\n max_steps: Upper limit of steps above which each run will be halted\n if it hasn't halted on its own.\n model_reporters: The dictionary of variables to collect on each run\n at the end, with variable names mapped to a function to collect\n them. For example:\n {\"agent_count\": lambda m: m.schedule.get_agent_count()}\n agent_reporters: Like model_reporters, but each variable is now\n collected at the level of each agent present in the model at\n the end of the run.\n display_progress: Display progress bar with time estimation?\n\n \"\"\"\n self.model_cls = model_cls\n if parameters_list is None:\n parameters_list = []\n self.parameters_list = list(parameters_list)\n self.fixed_parameters = fixed_parameters or {}\n self._include_fixed = len(self.fixed_parameters.keys()) > 0\n self.iterations = iterations\n self.max_steps = max_steps\n\n for params in self.parameters_list:\n if list(params) != list(self.parameters_list[0]):\n msg = \"parameter names in parameters_list are not equal across the list\"\n raise ValueError(msg)\n\n self.model_reporters = model_reporters\n self.agent_reporters = agent_reporters\n\n if self.model_reporters:\n self.model_vars = {}\n\n if self.agent_reporters:\n self.agent_vars = {}\n\n # Make Compatible with Python 3.5\n self.datacollector_model_reporters = OrderedDict()\n self.datacollector_agent_reporters = OrderedDict()\n\n self.display_progress = display_progress\n\n def _make_model_args(self):\n \"\"\"Prepare all combinations of parameter values for `run_all`\n\n Returns:\n Tuple with the form:\n (total_iterations, all_kwargs, all_param_values)\n \"\"\"\n total_iterations = self.iterations\n all_kwargs = []\n all_param_values = []\n\n count = len(self.parameters_list)\n if count:\n for params in self.parameters_list:\n kwargs = params.copy()\n kwargs.update(self.fixed_parameters)\n all_kwargs.append(kwargs)\n all_param_values.append(list(params.values()))\n\n elif len(self.fixed_parameters):\n count = 1\n kwargs = self.fixed_parameters.copy()\n all_kwargs.append(kwargs)\n all_param_values.append(list(kwargs.values()))\n\n total_iterations *= count\n\n return total_iterations, all_kwargs, all_param_values\n\n def run_all(self):\n \"\"\"Run the model at all parameter combinations and store results.\"\"\"\n run_count = count()\n total_iterations, all_kwargs, all_param_values = self._make_model_args()\n\n with tqdm(total_iterations, disable=not self.display_progress) as pbar:\n for i, kwargs in enumerate(all_kwargs):\n param_values = all_param_values[i]\n for _ in range(self.iterations):\n self.run_iteration(kwargs, param_values, next(run_count))\n pbar.update()\n\n def run_iteration(self, kwargs, param_values, run_count):\n model = self.model_cls(**kwargs)\n results = self.run_model(model)\n if param_values is not None:\n model_key = tuple(param_values) + (run_count,)\n else:\n model_key = (run_count,)\n\n if self.model_reporters:\n self.model_vars[model_key] = self.collect_model_vars(model)\n if self.agent_reporters:\n agent_vars = self.collect_agent_vars(model)\n for agent_id, reports in agent_vars.items():\n agent_key = model_key + (agent_id,)\n self.agent_vars[agent_key] = reports\n # Collects data from datacollector object in model\n if results is not None:\n if results.model_reporters is not None:\n self.datacollector_model_reporters[\n model_key\n ] = results.get_model_vars_dataframe()\n if results.agent_reporters is not None:\n self.datacollector_agent_reporters[\n model_key\n ] = results.get_agent_vars_dataframe()\n\n return (\n getattr(self, \"model_vars\", None),\n getattr(self, \"agent_vars\", None),\n getattr(self, \"datacollector_model_reporters\", None),\n getattr(self, \"datacollector_agent_reporters\", None),\n )\n\n def run_model(self, model):\n \"\"\"Run a model object to completion, or until reaching max steps.\n\n If your model runs in a non-standard way, this is the method to modify\n in your subclass.\n\n \"\"\"\n while model.running and model.schedule.steps < self.max_steps:\n model.step()\n\n if hasattr(model, \"datacollector\"):\n return model.datacollector\n else:\n return None\n\n def collect_model_vars(self, model):\n \"\"\"Run reporters and collect model-level variables.\"\"\"\n model_vars = OrderedDict()\n for var, reporter in self.model_reporters.items():\n model_vars[var] = reporter(model)\n\n return model_vars\n\n def collect_agent_vars(self, model):\n \"\"\"Run reporters and collect agent-level variables.\"\"\"\n agent_vars = OrderedDict()\n for agent in model.schedule._agents.values():\n agent_record = OrderedDict()\n for var, reporter in self.agent_reporters.items():\n agent_record[var] = getattr(agent, reporter)\n agent_vars[agent.unique_id] = agent_record\n return agent_vars\n\n def get_model_vars_dataframe(self):\n \"\"\"Generate a pandas DataFrame from the model-level variables\n collected.\n \"\"\"\n\n return self._prepare_report_table(self.model_vars)\n\n def get_agent_vars_dataframe(self):\n \"\"\"Generate a pandas DataFrame from the agent-level variables\n collected.\n \"\"\"\n\n return self._prepare_report_table(self.agent_vars, extra_cols=[\"AgentId\"])\n\n def get_collector_model(self):\n \"\"\"\n Passes pandas dataframes from datacollector module in dictionary format of model reporters\n :return: dict {(Param1, Param2,...,iteration): <DataCollector Pandas DataFrame>}\n \"\"\"\n\n return self.datacollector_model_reporters\n\n def get_collector_agents(self):\n \"\"\"\n Passes pandas dataframes from datacollector module in dictionary format of agent reporters\n :return: dict {(Param1, Param2,...,iteration): <DataCollector Pandas DataFrame>}\n \"\"\"\n return self.datacollector_agent_reporters\n\n def _prepare_report_table(self, vars_dict, extra_cols=None):\n \"\"\"\n Creates a dataframe from collected records and sorts it using 'Run'\n column as a key.\n \"\"\"\n extra_cols = [\"Run\"] + (extra_cols or [])\n index_cols = []\n if self.parameters_list:\n index_cols = list(self.parameters_list[0].keys())\n index_cols += extra_cols\n\n records = []\n for param_key, values in vars_dict.items():\n record = dict(zip(index_cols, param_key))\n record.update(values)\n records.append(record)\n\n df = pd.DataFrame(records)\n rest_cols = set(df.columns) - set(index_cols)\n ordered = df[index_cols + list(sorted(rest_cols))]\n ordered.sort_values(by=\"Run\", inplace=True)\n if self._include_fixed:\n for param in self.fixed_parameters.keys():\n val = self.fixed_parameters[param]\n\n # avoid error when val is an iterable\n vallist = [val for i in range(ordered.shape[0])]\n ordered[param] = vallist\n return ordered\n\n\nclass ParameterProduct:\n def __init__(self, variable_parameters):\n self.param_names, self.param_lists = zip(\n *(copy.deepcopy(variable_parameters)).items()\n )\n self._product = product(*self.param_lists)\n\n def __iter__(self):\n return self\n\n def __next__(self):\n return dict(zip(self.param_names, next(self._product)))\n\n\n# Roughly inspired by sklearn.model_selection.ParameterSampler. Does not handle\n# distributions, only lists.\nclass ParameterSampler:\n def __init__(self, parameter_lists, n, random_state=None):\n self.param_names, self.param_lists = zip(\n *(copy.deepcopy(parameter_lists)).items()\n )\n self.n = n\n if random_state is None:\n self.random_state = random.Random()\n elif isinstance(random_state, int):\n self.random_state = random.Random(random_state)\n else:\n self.random_state = random_state\n self.count = 0\n\n def __iter__(self):\n return self\n\n def __next__(self):\n self.count += 1\n if self.count <= self.n:\n return dict(\n zip(\n self.param_names,\n [self.random_state.choice(p_list) for p_list in self.param_lists],\n )\n )\n raise StopIteration()\n\n\nclass BatchRunner(FixedBatchRunner):\n \"\"\"DEPRECATION WARNING: BatchRunner Class has been replaced batch_run function\n This class is instantiated with a model class, and model parameters\n associated with one or more values. It is also instantiated with model and\n agent-level reporters, dictionaries mapping a variable name to a function\n which collects some data from the model or its agents at the end of the run\n and stores it.\n\n Note that by default, the reporters only collect data at the *end* of the\n run. To get step by step data, simply have a reporter store the model's\n entire DataCollector object.\n\n \"\"\"\n\n def __init__(\n self,\n model_cls,\n variable_parameters=None,\n fixed_parameters=None,\n iterations=1,\n max_steps=1000,\n model_reporters=None,\n agent_reporters=None,\n display_progress=True,\n ):\n \"\"\"Create a new BatchRunner for a given model with the given\n parameters.\n\n Args:\n model_cls: The class of model to batch-run.\n variable_parameters: Dictionary of parameters to lists of values.\n The model will be run with every combo of these parameters.\n For example, given variable_parameters of\n {\"param_1\": range(5),\n \"param_2\": [1, 5, 10]}\n models will be run with {param_1=1, param_2=1},\n {param_1=2, param_2=1}, ..., {param_1=4, param_2=10}.\n fixed_parameters: Dictionary of parameters that stay same through\n all batch runs. For example, given fixed_parameters of\n {\"constant_parameter\": 3},\n every instantiated model will be passed constant_parameter=3\n as a kwarg.\n iterations: The total number of times to run the model for each\n combination of parameters.\n max_steps: Upper limit of steps above which each run will be halted\n if it hasn't halted on its own.\n model_reporters: The dictionary of variables to collect on each run\n at the end, with variable names mapped to a function to collect\n them. For example:\n {\"agent_count\": lambda m: m.schedule.get_agent_count()}\n agent_reporters: Like model_reporters, but each variable is now\n collected at the level of each agent present in the model at\n the end of the run.\n display_progress: Display progress bar with time estimation?\n\n \"\"\"\n warn(\n \"BatchRunner class has been replaced by batch_run function. Please see documentation.\",\n DeprecationWarning,\n 2,\n )\n if variable_parameters is None:\n super().__init__(\n model_cls,\n variable_parameters,\n fixed_parameters,\n iterations,\n max_steps,\n model_reporters,\n agent_reporters,\n display_progress,\n )\n else:\n super().__init__(\n model_cls,\n ParameterProduct(variable_parameters),\n fixed_parameters,\n iterations,\n max_steps,\n model_reporters,\n agent_reporters,\n display_progress,\n )\n\n\nclass BatchRunnerMP(BatchRunner):\n \"\"\"DEPRECATION WARNING: BatchRunner class has been replaced by batch_run\n Child class of BatchRunner, extended with multiprocessing support.\"\"\"\n\n def __init__(self, model_cls, nr_processes=None, **kwargs):\n \"\"\"Create a new BatchRunnerMP for a given model with the given\n parameters.\n\n model_cls: The class of model to batch-run.\n nr_processes: int\n the number of separate processes the BatchRunner\n should start, all running in parallel.\n kwargs: the kwargs required for the parent BatchRunner class\n \"\"\"\n warn(\n \"BatchRunnerMP class has been replaced by batch_run function. Please see documentation.\",\n DeprecationWarning,\n 2,\n )\n if nr_processes is None:\n # identify the number of processors available on users machine\n available_processors = cpu_count()\n self.processes = available_processors\n print(f\"BatchRunner MP will use {self.processes} processors.\")\n else:\n self.processes = nr_processes\n\n super().__init__(model_cls, **kwargs)\n self.pool = Pool(self.processes)\n\n def _make_model_args_mp(self):\n \"\"\"Prepare all combinations of parameter values for `run_all`\n Due to multiprocessing requirements of @StaticMethod takes different input, hence the similar function\n Returns:\n List of list with the form:\n [[model_object, dictionary_of_kwargs, max_steps, iterations]]\n \"\"\"\n total_iterations = self.iterations\n all_kwargs = []\n\n count = len(self.parameters_list)\n if count:\n for params in self.parameters_list:\n kwargs = params.copy()\n kwargs.update(self.fixed_parameters)\n # run each iterations specific number of times\n for iter in range(self.iterations):\n kwargs_repeated = kwargs.copy()\n all_kwargs.append(\n [self.model_cls, kwargs_repeated, self.max_steps, iter]\n )\n\n elif len(self.fixed_parameters):\n count = 1\n kwargs = self.fixed_parameters.copy()\n all_kwargs.append(kwargs)\n\n total_iterations *= count\n\n return all_kwargs, total_iterations\n\n @staticmethod\n def _run_wrappermp(iter_args):\n \"\"\"\n Based on requirement of Python multiprocessing requires @staticmethod decorator;\n this is primarily to ensure functionality on Windows OS and does not impact MAC or Linux distros\n\n :param iter_args: List of arguments for model run\n iter_args[0] = model object\n iter_args[1] = key word arguments needed for model object\n iter_args[2] = maximum number of steps for model\n iter_args[3] = number of time to run model for stochastic/random variation with same parameters\n :return:\n tuple of param values which serves as a unique key for model results\n model object\n \"\"\"\n\n model_i = iter_args[0]\n kwargs = iter_args[1]\n max_steps = iter_args[2]\n iteration = iter_args[3]\n\n # instantiate version of model with correct parameters\n model = model_i(**kwargs)\n while model.running and model.schedule.steps < max_steps:\n model.step()\n\n # add iteration number to dictionary to make unique_key\n kwargs[\"iteration\"] = iteration\n\n # convert kwargs dict to tuple to make consistent\n param_values = tuple(kwargs.values())\n\n return param_values, model\n\n def _result_prep_mp(self, results):\n \"\"\"\n Helper Function\n :param results: Takes results dictionary from Processpool and single processor debug run and fixes format to\n make compatible with BatchRunner Output\n :updates model_vars and agents_vars so consistent across all batchrunner\n \"\"\"\n # Take results and convert to dictionary so dataframe can be called\n for model_key, model in results.items():\n if self.model_reporters:\n self.model_vars[model_key] = self.collect_model_vars(model)\n if self.agent_reporters:\n agent_vars = self.collect_agent_vars(model)\n for agent_id, reports in agent_vars.items():\n agent_key = model_key + (agent_id,)\n self.agent_vars[agent_key] = reports\n if hasattr(model, \"datacollector\"):\n if model.datacollector.model_reporters is not None:\n self.datacollector_model_reporters[\n model_key\n ] = model.datacollector.get_model_vars_dataframe()\n if model.datacollector.agent_reporters is not None:\n self.datacollector_agent_reporters[\n model_key\n ] = model.datacollector.get_agent_vars_dataframe()\n\n # Make results consistent\n if len(self.datacollector_model_reporters.keys()) == 0:\n self.datacollector_model_reporters = None\n if len(self.datacollector_agent_reporters.keys()) == 0:\n self.datacollector_agent_reporters = None\n\n def run_all(self):\n \"\"\"\n Run the model at all parameter combinations and store results,\n overrides run_all from BatchRunner.\n \"\"\"\n\n run_iter_args, total_iterations = self._make_model_args_mp()\n # register the process pool and init a queue\n # store results in ordered dictionary\n results = {}\n\n if self.processes > 1:\n with tqdm(total_iterations, disable=not self.display_progress) as pbar:\n for params, model in self.pool.imap_unordered(\n self._run_wrappermp, run_iter_args\n ):\n results[params] = model\n pbar.update()\n\n self._result_prep_mp(results)\n # For debugging model due to difficulty of getting errors during multiprocessing\n else:\n for run in run_iter_args:\n params, model_data = self._run_wrappermp(run)\n results[params] = model_data\n\n self._result_prep_mp(results)\n\n # Close multi-processing\n self.pool.close()\n\n return (\n getattr(self, \"model_vars\", None),\n getattr(self, \"agent_vars\", None),\n getattr(self, \"datacollector_model_reporters\", None),\n getattr(self, \"datacollector_agent_reporters\", None),\n )\n","path":"mesa/batchrunner.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"\\nBatchrunner\\n===========\\n\\nA single class to manage a batch run or parameter sweep of a given model.\\n\\n\\\"\\\"\\\"\\nimport copy\\nimport itertools\\nimport random\\nfrom collections import OrderedDict\\nfrom functools import partial\\nfrom itertools import count, product\\nfrom multiprocessing import Pool, cpu_count\\nfrom warnings import warn\\nfrom typing import (\\n Any,\\n Counter,\\n Dict,\\n Iterable,\\n List,\\n Mapping,\\n Optional,\\n Tuple,\\n Type,\\n Union,\\n)\\n\\nimport pandas as pd\\nfrom tqdm import tqdm\\n\\nfrom mesa.model import Model\\n\\n\\ndef batch_run(\\n model_cls: Type[Model],\\n parameters: Mapping[str, Union[Any, Iterable[Any]]],\\n number_processes: Optional[int] = None,\\n iterations: int = 1,\\n data_collection_period: int = -1,\\n max_steps: int = 1000,\\n display_progress: bool = True,\\n) -> List[Dict[str, Any]]:\\n \\\"\\\"\\\"Batch run a mesa model with a set of parameter values.\\n\\n Parameters\\n ----------\\n model_cls : Type[Model]\\n The model class to batch-run\\n parameters : Mapping[str, Union[Any, Iterable[Any]]],\\n Dictionary with model parameters over which to run the model. You can either pass single values or iterables.\\n number_processes : int, optional\\n Number of processes used. Set to None (default) to use all available processors\\n iterations : int, optional\\n Number of iterations for each parameter combination, by default 1\\n data_collection_period : int, optional\\n Number of steps after which data gets collected, by default -1 (end of episode)\\n max_steps : int, optional\\n Maximum number of model steps after which the model halts, by default 1000\\n display_progress : bool, optional\\n Display batch run process, by default True\\n\\n Returns\\n -------\\n List[Dict[str, Any]]\\n [description]\\n \\\"\\\"\\\"\\n\\n kwargs_list = _make_model_kwargs(parameters) * iterations\\n process_func = partial(\\n _model_run_func,\\n model_cls,\\n max_steps=max_steps,\\n data_collection_period=data_collection_period,\\n )\\n\\n total_iterations = len(kwargs_list) * iterations\\n run_counter = count()\\n\\n results: List[Dict[str, Any]] = []\\n\\n with tqdm(total_iterations, disable=not display_progress) as pbar:\\n if number_processes == 1:\\n for iteration in range(iterations):\\n for kwargs in kwargs_list:\\n _, rawdata = process_func(kwargs)\\n run_id = next(run_counter)\\n data = []\\n for run_data in rawdata:\\n out = {\\\"RunId\\\": run_id, \\\"iteration\\\": iteration - 1}\\n out.update(run_data)\\n data.append(out)\\n results.extend(data)\\n pbar.update()\\n\\n else:\\n iteration_counter: Counter[Tuple[Any, ...]] = Counter()\\n with Pool(number_processes) as p:\\n for paramValues, rawdata in p.imap_unordered(process_func, kwargs_list):\\n iteration_counter[paramValues] += 1\\n iteration = iteration_counter[paramValues]\\n run_id = next(run_counter)\\n data = []\\n for run_data in rawdata:\\n out = {\\\"RunId\\\": run_id, \\\"iteration\\\": iteration - 1}\\n out.update(run_data)\\n data.append(out)\\n results.extend(data)\\n pbar.update()\\n\\n return results\\n\\n\\ndef _make_model_kwargs(\\n parameters: Mapping[str, Union[Any, Iterable[Any]]]\\n) -> List[Dict[str, Any]]:\\n \\\"\\\"\\\"Create model kwargs from parameters dictionary.\\n\\n Parameters\\n ----------\\n parameters : Mapping[str, Union[Any, Iterable[Any]]]\\n Single or multiple values for each model parameter name\\n\\n Returns\\n -------\\n List[Dict[str, Any]]\\n A list of all kwargs combinations.\\n \\\"\\\"\\\"\\n parameter_list = []\\n for param, values in parameters.items():\\n try:\\n all_values = [(param, value) for value in values]\\n except TypeError:\\n all_values = [(param, values)]\\n parameter_list.append(all_values)\\n all_kwargs = itertools.product(*parameter_list)\\n kwargs_list = [dict(kwargs) for kwargs in all_kwargs]\\n return kwargs_list\\n\\n\\ndef _model_run_func(\\n model_cls: Type[Model],\\n kwargs: Dict[str, Any],\\n max_steps: int,\\n data_collection_period: int,\\n) -> Tuple[Tuple[Any, ...], List[Dict[str, Any]]]:\\n \\\"\\\"\\\"Run a single model run and collect model and agent data.\\n\\n Parameters\\n ----------\\n model_cls : Type[Model]\\n The model class to batch-run\\n kwargs : Dict[str, Any]\\n model kwargs used for this run\\n max_steps : int\\n Maximum number of model steps after which the model halts, by default 1000\\n data_collection_period : int\\n Number of steps after which data gets collected\\n\\n Returns\\n -------\\n Tuple[Tuple[Any, ...], List[Dict[str, Any]]]\\n Return model_data, agent_data from the reporters\\n \\\"\\\"\\\"\\n model = model_cls(**kwargs)\\n while model.running and model.schedule.steps <= max_steps:\\n model.step()\\n\\n data = []\\n\\n steps = list(range(0, model.schedule.steps, data_collection_period))\\n if not steps or steps[-1] != model.schedule.steps - 1:\\n steps.append(model.schedule.steps - 1)\\n\\n for step in steps:\\n model_data, all_agents_data = _collect_data(model, step)\\n\\n # If there are agent_reporters, then create an entry for each agent\\n if all_agents_data:\\n stepdata = [\\n {**{\\\"Step\\\": step}, **kwargs, **model_data, **agent_data}\\n for agent_data in all_agents_data\\n ]\\n # If there is only model data, then create a single entry for the step\\n else:\\n stepdata = [{**{\\\"Step\\\": step}, **kwargs, **model_data}]\\n data.extend(stepdata)\\n\\n return tuple(kwargs.values()), data\\n\\n\\ndef _collect_data(\\n model: Model,\\n step: int,\\n) -> Tuple[Dict[str, Any], List[Dict[str, Any]]]:\\n \\\"\\\"\\\"Collect model and agent data from a model using mesas datacollector.\\\"\\\"\\\"\\n dc = model.datacollector\\n\\n model_data = {param: values[step] for param, values in dc.model_vars.items()}\\n\\n all_agents_data = []\\n raw_agent_data = dc._agent_records.get(step, [])\\n for data in raw_agent_data:\\n agent_dict = {\\\"AgentID\\\": data[1]}\\n agent_dict.update(zip(dc.agent_reporters, data[2:]))\\n all_agents_data.append(agent_dict)\\n return model_data, all_agents_data\\n\\n\\nclass ParameterError(TypeError):\\n MESSAGE = (\\n \\\"Parameters must map a name to a value. \\\"\\n \\\"These names did not match parameters: {}\\\"\\n )\\n\\n def __init__(self, bad_names):\\n self.bad_names = bad_names\\n\\n def __str__(self):\\n return self.MESSAGE.format(self.bad_names)\\n\\n\\nclass VariableParameterError(ParameterError):\\n MESSAGE = (\\n \\\"Variable_parameters must map a name to a sequence of values. \\\"\\n \\\"These parameters were given with non-sequence values: {}\\\"\\n )\\n\\n def __init__(self, bad_names):\\n super().__init__(bad_names)\\n\\n\\nclass FixedBatchRunner:\\n \\\"\\\"\\\"This class is instantiated with a model class, and model parameters\\n associated with one or more values. It is also instantiated with model and\\n agent-level reporters, dictionaries mapping a variable name to a function\\n which collects some data from the model or its agents at the end of the run\\n and stores it.\\n\\n Note that by default, the reporters only collect data at the *end* of the\\n run. To get step by step data, simply have a reporter store the model's\\n entire DataCollector object.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n model_cls,\\n parameters_list=None,\\n fixed_parameters=None,\\n iterations=1,\\n max_steps=1000,\\n model_reporters=None,\\n agent_reporters=None,\\n display_progress=True,\\n ):\\n \\\"\\\"\\\"Create a new BatchRunner for a given model with the given\\n parameters.\\n\\n Args:\\n model_cls: The class of model to batch-run.\\n parameters_list: A list of dictionaries of parameter sets.\\n The model will be run with dictionary of parameters.\\n For example, given parameters_list of\\n [{\\\"homophily\\\": 3, \\\"density\\\": 0.8, \\\"minority_pc\\\": 0.2},\\n {\\\"homophily\\\": 2, \\\"density\\\": 0.9, \\\"minority_pc\\\": 0.1},\\n {\\\"homophily\\\": 4, \\\"density\\\": 0.6, \\\"minority_pc\\\": 0.5}]\\n 3 models will be run, one for each provided set of parameters.\\n fixed_parameters: Dictionary of parameters that stay same through\\n all batch runs. For example, given fixed_parameters of\\n {\\\"constant_parameter\\\": 3},\\n every instantiated model will be passed constant_parameter=3\\n as a kwarg.\\n iterations: The total number of times to run the model for each set\\n of parameters.\\n max_steps: Upper limit of steps above which each run will be halted\\n if it hasn't halted on its own.\\n model_reporters: The dictionary of variables to collect on each run\\n at the end, with variable names mapped to a function to collect\\n them. For example:\\n {\\\"agent_count\\\": lambda m: m.schedule.get_agent_count()}\\n agent_reporters: Like model_reporters, but each variable is now\\n collected at the level of each agent present in the model at\\n the end of the run.\\n display_progress: Display progress bar with time estimation?\\n\\n \\\"\\\"\\\"\\n self.model_cls = model_cls\\n if parameters_list is None:\\n parameters_list = []\\n self.parameters_list = list(parameters_list)\\n self.fixed_parameters = fixed_parameters or {}\\n self._include_fixed = len(self.fixed_parameters.keys()) > 0\\n self.iterations = iterations\\n self.max_steps = max_steps\\n\\n for params in self.parameters_list:\\n if list(params) != list(self.parameters_list[0]):\\n msg = \\\"parameter names in parameters_list are not equal across the list\\\"\\n raise ValueError(msg)\\n\\n self.model_reporters = model_reporters\\n self.agent_reporters = agent_reporters\\n\\n if self.model_reporters:\\n self.model_vars = {}\\n\\n if self.agent_reporters:\\n self.agent_vars = {}\\n\\n # Make Compatible with Python 3.5\\n self.datacollector_model_reporters = OrderedDict()\\n self.datacollector_agent_reporters = OrderedDict()\\n\\n self.display_progress = display_progress\\n\\n def _make_model_args(self):\\n \\\"\\\"\\\"Prepare all combinations of parameter values for `run_all`\\n\\n Returns:\\n Tuple with the form:\\n (total_iterations, all_kwargs, all_param_values)\\n \\\"\\\"\\\"\\n total_iterations = self.iterations\\n all_kwargs = []\\n all_param_values = []\\n\\n count = len(self.parameters_list)\\n if count:\\n for params in self.parameters_list:\\n kwargs = params.copy()\\n kwargs.update(self.fixed_parameters)\\n all_kwargs.append(kwargs)\\n all_param_values.append(list(params.values()))\\n\\n elif len(self.fixed_parameters):\\n count = 1\\n kwargs = self.fixed_parameters.copy()\\n all_kwargs.append(kwargs)\\n all_param_values.append(list(kwargs.values()))\\n\\n total_iterations *= count\\n\\n return total_iterations, all_kwargs, all_param_values\\n\\n def run_all(self):\\n \\\"\\\"\\\"Run the model at all parameter combinations and store results.\\\"\\\"\\\"\\n run_count = count()\\n total_iterations, all_kwargs, all_param_values = self._make_model_args()\\n\\n with tqdm(total_iterations, disable=not self.display_progress) as pbar:\\n for i, kwargs in enumerate(all_kwargs):\\n param_values = all_param_values[i]\\n for _ in range(self.iterations):\\n self.run_iteration(kwargs, param_values, next(run_count))\\n pbar.update()\\n\\n def run_iteration(self, kwargs, param_values, run_count):\\n model = self.model_cls(**kwargs)\\n results = self.run_model(model)\\n if param_values is not None:\\n model_key = tuple(param_values) + (run_count,)\\n else:\\n model_key = (run_count,)\\n\\n if self.model_reporters:\\n self.model_vars[model_key] = self.collect_model_vars(model)\\n if self.agent_reporters:\\n agent_vars = self.collect_agent_vars(model)\\n for agent_id, reports in agent_vars.items():\\n agent_key = model_key + (agent_id,)\\n self.agent_vars[agent_key] = reports\\n # Collects data from datacollector object in model\\n if results is not None:\\n if results.model_reporters is not None:\\n self.datacollector_model_reporters[\\n model_key\\n ] = results.get_model_vars_dataframe()\\n if results.agent_reporters is not None:\\n self.datacollector_agent_reporters[\\n model_key\\n ] = results.get_agent_vars_dataframe()\\n\\n return (\\n getattr(self, \\\"model_vars\\\", None),\\n getattr(self, \\\"agent_vars\\\", None),\\n getattr(self, \\\"datacollector_model_reporters\\\", None),\\n getattr(self, \\\"datacollector_agent_reporters\\\", None),\\n )\\n\\n def run_model(self, model):\\n \\\"\\\"\\\"Run a model object to completion, or until reaching max steps.\\n\\n If your model runs in a non-standard way, this is the method to modify\\n in your subclass.\\n\\n \\\"\\\"\\\"\\n while model.running and model.schedule.steps < self.max_steps:\\n model.step()\\n\\n if hasattr(model, \\\"datacollector\\\"):\\n return model.datacollector\\n else:\\n return None\\n\\n def collect_model_vars(self, model):\\n \\\"\\\"\\\"Run reporters and collect model-level variables.\\\"\\\"\\\"\\n model_vars = OrderedDict()\\n for var, reporter in self.model_reporters.items():\\n model_vars[var] = reporter(model)\\n\\n return model_vars\\n\\n def collect_agent_vars(self, model):\\n \\\"\\\"\\\"Run reporters and collect agent-level variables.\\\"\\\"\\\"\\n agent_vars = OrderedDict()\\n for agent in model.schedule._agents.values():\\n agent_record = OrderedDict()\\n for var, reporter in self.agent_reporters.items():\\n agent_record[var] = getattr(agent, reporter)\\n agent_vars[agent.unique_id] = agent_record\\n return agent_vars\\n\\n def get_model_vars_dataframe(self):\\n \\\"\\\"\\\"Generate a pandas DataFrame from the model-level variables\\n collected.\\n \\\"\\\"\\\"\\n\\n return self._prepare_report_table(self.model_vars)\\n\\n def get_agent_vars_dataframe(self):\\n \\\"\\\"\\\"Generate a pandas DataFrame from the agent-level variables\\n collected.\\n \\\"\\\"\\\"\\n\\n return self._prepare_report_table(self.agent_vars, extra_cols=[\\\"AgentId\\\"])\\n\\n def get_collector_model(self):\\n \\\"\\\"\\\"\\n Passes pandas dataframes from datacollector module in dictionary format of model reporters\\n :return: dict {(Param1, Param2,...,iteration): <DataCollector Pandas DataFrame>}\\n \\\"\\\"\\\"\\n\\n return self.datacollector_model_reporters\\n\\n def get_collector_agents(self):\\n \\\"\\\"\\\"\\n Passes pandas dataframes from datacollector module in dictionary format of agent reporters\\n :return: dict {(Param1, Param2,...,iteration): <DataCollector Pandas DataFrame>}\\n \\\"\\\"\\\"\\n return self.datacollector_agent_reporters\\n\\n def _prepare_report_table(self, vars_dict, extra_cols=None):\\n \\\"\\\"\\\"\\n Creates a dataframe from collected records and sorts it using 'Run'\\n column as a key.\\n \\\"\\\"\\\"\\n extra_cols = [\\\"Run\\\"] + (extra_cols or [])\\n index_cols = []\\n if self.parameters_list:\\n index_cols = list(self.parameters_list[0].keys())\\n index_cols += extra_cols\\n\\n records = []\\n for param_key, values in vars_dict.items():\\n record = dict(zip(index_cols, param_key))\\n record.update(values)\\n records.append(record)\\n\\n df = pd.DataFrame(records)\\n rest_cols = set(df.columns) - set(index_cols)\\n ordered = df[index_cols + list(sorted(rest_cols))]\\n ordered.sort_values(by=\\\"Run\\\", inplace=True)\\n if self._include_fixed:\\n for param in self.fixed_parameters.keys():\\n val = self.fixed_parameters[param]\\n\\n # avoid error when val is an iterable\\n vallist = [val for i in range(ordered.shape[0])]\\n ordered[param] = vallist\\n return ordered\\n\\n\\nclass ParameterProduct:\\n def __init__(self, variable_parameters):\\n self.param_names, self.param_lists = zip(\\n *(copy.deepcopy(variable_parameters)).items()\\n )\\n self._product = product(*self.param_lists)\\n\\n def __iter__(self):\\n return self\\n\\n def __next__(self):\\n return dict(zip(self.param_names, next(self._product)))\\n\\n\\n# Roughly inspired by sklearn.model_selection.ParameterSampler. Does not handle\\n# distributions, only lists.\\nclass ParameterSampler:\\n def __init__(self, parameter_lists, n, random_state=None):\\n self.param_names, self.param_lists = zip(\\n *(copy.deepcopy(parameter_lists)).items()\\n )\\n self.n = n\\n if random_state is None:\\n self.random_state = random.Random()\\n elif isinstance(random_state, int):\\n self.random_state = random.Random(random_state)\\n else:\\n self.random_state = random_state\\n self.count = 0\\n\\n def __iter__(self):\\n return self\\n\\n def __next__(self):\\n self.count += 1\\n if self.count <= self.n:\\n return dict(\\n zip(\\n self.param_names,\\n [self.random_state.choice(p_list) for p_list in self.param_lists],\\n )\\n )\\n raise StopIteration()\\n\\n\\nclass BatchRunner(FixedBatchRunner):\\n \\\"\\\"\\\"DEPRECATION WARNING: BatchRunner Class has been replaced batch_run function\\n This class is instantiated with a model class, and model parameters\\n associated with one or more values. It is also instantiated with model and\\n agent-level reporters, dictionaries mapping a variable name to a function\\n which collects some data from the model or its agents at the end of the run\\n and stores it.\\n\\n Note that by default, the reporters only collect data at the *end* of the\\n run. To get step by step data, simply have a reporter store the model's\\n entire DataCollector object.\\n\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n model_cls,\\n variable_parameters=None,\\n fixed_parameters=None,\\n iterations=1,\\n max_steps=1000,\\n model_reporters=None,\\n agent_reporters=None,\\n display_progress=True,\\n ):\\n \\\"\\\"\\\"Create a new BatchRunner for a given model with the given\\n parameters.\\n\\n Args:\\n model_cls: The class of model to batch-run.\\n variable_parameters: Dictionary of parameters to lists of values.\\n The model will be run with every combo of these parameters.\\n For example, given variable_parameters of\\n {\\\"param_1\\\": range(5),\\n \\\"param_2\\\": [1, 5, 10]}\\n models will be run with {param_1=1, param_2=1},\\n {param_1=2, param_2=1}, ..., {param_1=4, param_2=10}.\\n fixed_parameters: Dictionary of parameters that stay same through\\n all batch runs. For example, given fixed_parameters of\\n {\\\"constant_parameter\\\": 3},\\n every instantiated model will be passed constant_parameter=3\\n as a kwarg.\\n iterations: The total number of times to run the model for each\\n combination of parameters.\\n max_steps: Upper limit of steps above which each run will be halted\\n if it hasn't halted on its own.\\n model_reporters: The dictionary of variables to collect on each run\\n at the end, with variable names mapped to a function to collect\\n them. For example:\\n {\\\"agent_count\\\": lambda m: m.schedule.get_agent_count()}\\n agent_reporters: Like model_reporters, but each variable is now\\n collected at the level of each agent present in the model at\\n the end of the run.\\n display_progress: Display progress bar with time estimation?\\n\\n \\\"\\\"\\\"\\n warn(\\n \\\"BatchRunner class has been replaced by batch_run function. Please see documentation.\\\",\\n DeprecationWarning,\\n 2,\\n )\\n if variable_parameters is None:\\n super().__init__(\\n model_cls,\\n variable_parameters,\\n fixed_parameters,\\n iterations,\\n max_steps,\\n model_reporters,\\n agent_reporters,\\n display_progress,\\n )\\n else:\\n super().__init__(\\n model_cls,\\n ParameterProduct(variable_parameters),\\n fixed_parameters,\\n iterations,\\n max_steps,\\n model_reporters,\\n agent_reporters,\\n display_progress,\\n )\\n\\n\\nclass BatchRunnerMP(BatchRunner):\\n \\\"\\\"\\\"DEPRECATION WARNING: BatchRunner class has been replaced by batch_run\\n Child class of BatchRunner, extended with multiprocessing support.\\\"\\\"\\\"\\n\\n def __init__(self, model_cls, nr_processes=None, **kwargs):\\n \\\"\\\"\\\"Create a new BatchRunnerMP for a given model with the given\\n parameters.\\n\\n model_cls: The class of model to batch-run.\\n nr_processes: int\\n the number of separate processes the BatchRunner\\n should start, all running in parallel.\\n kwargs: the kwargs required for the parent BatchRunner class\\n \\\"\\\"\\\"\\n warn(\\n \\\"BatchRunnerMP class has been replaced by batch_run function. Please see documentation.\\\",\\n DeprecationWarning,\\n 2,\\n )\\n if nr_processes is None:\\n # identify the number of processors available on users machine\\n available_processors = cpu_count()\\n self.processes = available_processors\\n print(f\\\"BatchRunner MP will use {self.processes} processors.\\\")\\n else:\\n self.processes = nr_processes\\n\\n super().__init__(model_cls, **kwargs)\\n self.pool = Pool(self.processes)\\n\\n def _make_model_args_mp(self):\\n \\\"\\\"\\\"Prepare all combinations of parameter values for `run_all`\\n Due to multiprocessing requirements of @StaticMethod takes different input, hence the similar function\\n Returns:\\n List of list with the form:\\n [[model_object, dictionary_of_kwargs, max_steps, iterations]]\\n \\\"\\\"\\\"\\n total_iterations = self.iterations\\n all_kwargs = []\\n\\n count = len(self.parameters_list)\\n if count:\\n for params in self.parameters_list:\\n kwargs = params.copy()\\n kwargs.update(self.fixed_parameters)\\n # run each iterations specific number of times\\n for iter in range(self.iterations):\\n kwargs_repeated = kwargs.copy()\\n all_kwargs.append(\\n [self.model_cls, kwargs_repeated, self.max_steps, iter]\\n )\\n\\n elif len(self.fixed_parameters):\\n count = 1\\n kwargs = self.fixed_parameters.copy()\\n all_kwargs.append(kwargs)\\n\\n total_iterations *= count\\n\\n return all_kwargs, total_iterations\\n\\n @staticmethod\\n def _run_wrappermp(iter_args):\\n \\\"\\\"\\\"\\n Based on requirement of Python multiprocessing requires @staticmethod decorator;\\n this is primarily to ensure functionality on Windows OS and does not impact MAC or Linux distros\\n\\n :param iter_args: List of arguments for model run\\n iter_args[0] = model object\\n iter_args[1] = key word arguments needed for model object\\n iter_args[2] = maximum number of steps for model\\n iter_args[3] = number of time to run model for stochastic/random variation with same parameters\\n :return:\\n tuple of param values which serves as a unique key for model results\\n model object\\n \\\"\\\"\\\"\\n\\n model_i = iter_args[0]\\n kwargs = iter_args[1]\\n max_steps = iter_args[2]\\n iteration = iter_args[3]\\n\\n # instantiate version of model with correct parameters\\n model = model_i(**kwargs)\\n while model.running and model.schedule.steps < max_steps:\\n model.step()\\n\\n # add iteration number to dictionary to make unique_key\\n kwargs[\\\"iteration\\\"] = iteration\\n\\n # convert kwargs dict to tuple to make consistent\\n param_values = tuple(kwargs.values())\\n\\n return param_values, model\\n\\n def _result_prep_mp(self, results):\\n \\\"\\\"\\\"\\n Helper Function\\n :param results: Takes results dictionary from Processpool and single processor debug run and fixes format to\\n make compatible with BatchRunner Output\\n :updates model_vars and agents_vars so consistent across all batchrunner\\n \\\"\\\"\\\"\\n # Take results and convert to dictionary so dataframe can be called\\n for model_key, model in results.items():\\n if self.model_reporters:\\n self.model_vars[model_key] = self.collect_model_vars(model)\\n if self.agent_reporters:\\n agent_vars = self.collect_agent_vars(model)\\n for agent_id, reports in agent_vars.items():\\n agent_key = model_key + (agent_id,)\\n self.agent_vars[agent_key] = reports\\n if hasattr(model, \\\"datacollector\\\"):\\n if model.datacollector.model_reporters is not None:\\n self.datacollector_model_reporters[\\n model_key\\n ] = model.datacollector.get_model_vars_dataframe()\\n if model.datacollector.agent_reporters is not None:\\n self.datacollector_agent_reporters[\\n model_key\\n ] = model.datacollector.get_agent_vars_dataframe()\\n\\n # Make results consistent\\n if len(self.datacollector_model_reporters.keys()) == 0:\\n self.datacollector_model_reporters = None\\n if len(self.datacollector_agent_reporters.keys()) == 0:\\n self.datacollector_agent_reporters = None\\n\\n def run_all(self):\\n \\\"\\\"\\\"\\n Run the model at all parameter combinations and store results,\\n overrides run_all from BatchRunner.\\n \\\"\\\"\\\"\\n\\n run_iter_args, total_iterations = self._make_model_args_mp()\\n # register the process pool and init a queue\\n # store results in ordered dictionary\\n results = {}\\n\\n if self.processes > 1:\\n with tqdm(total_iterations, disable=not self.display_progress) as pbar:\\n for params, model in self.pool.imap_unordered(\\n self._run_wrappermp, run_iter_args\\n ):\\n results[params] = model\\n pbar.update()\\n\\n self._result_prep_mp(results)\\n # For debugging model due to difficulty of getting errors during multiprocessing\\n else:\\n for run in run_iter_args:\\n params, model_data = self._run_wrappermp(run)\\n results[params] = model_data\\n\\n self._result_prep_mp(results)\\n\\n # Close multi-processing\\n self.pool.close()\\n\\n return (\\n getattr(self, \\\"model_vars\\\", None),\\n getattr(self, \\\"agent_vars\\\", None),\\n getattr(self, \\\"datacollector_model_reporters\\\", None),\\n getattr(self, \\\"datacollector_agent_reporters\\\", None),\\n )\\n\",\n \"path\": \"mesa/batchrunner.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"\"\"\"\nBatchrunner\n===========\n\nA single class to manage a batch run or parameter sweep of a given model.\n\n\"\"\"\nimport copy\nimport itertools\nimport random\nfrom collections import OrderedDict\nfrom functools import partial\nfrom itertools import count, product\nfrom multiprocessing import Pool, cpu_count\nfrom warnings import warn\nfrom typing import (\n Any,\n Counter,\n Dict,\n Iterable,\n List,\n Mapping,\n Optional,\n Tuple,\n Type,\n Union,\n)\n\nimport pandas as pd\nfrom tqdm import tqdm\n\nfrom mesa.model import Model\n\n\ndef batch_run(\n model_cls: Type[Model],\n parameters: Mapping[str, Union[Any, Iterable[Any]]],\n number_processes: Optional[int] = None,\n iterations: int = 1,\n data_collection_period: int = -1,\n max_steps: int = 1000,\n display_progress: bool = True,\n) -> List[Dict[str, Any]]:\n \"\"\"Batch run a mesa model with a set of parameter values.\n\n Parameters\n ----------\n model_cls : Type[Model]\n The model class to batch-run\n parameters : Mapping[str, Union[Any, Iterable[Any]]],\n Dictionary with model parameters over which to run the model. You can either pass single values or iterables.\n number_processes : int, optional\n Number of processes used. Set to None (default) to use all available processors\n iterations : int, optional\n Number of iterations for each parameter combination, by default 1\n data_collection_period : int, optional\n Number of steps after which data gets collected, by default -1 (end of episode)\n max_steps : int, optional\n Maximum number of model steps after which the model halts, by default 1000\n display_progress : bool, optional\n Display batch run process, by default True\n\n Returns\n -------\n List[Dict[str, Any]]\n [description]\n \"\"\"\n\n kwargs_list = _make_model_kwargs(parameters) * iterations\n process_func = partial(\n _model_run_func,\n model_cls,\n max_steps=max_steps,\n data_collection_period=data_collection_period,\n )\n\n total_iterations = len(kwargs_list) * iterations\n run_counter = count()\n\n results: List[Dict[str, Any]] = []\n\n with tqdm(total_iterations, disable=not display_progress) as pbar:\n if number_processes == 1:\n for iteration in range(iterations):\n for kwargs in kwargs_list:\n _, rawdata = process_func(kwargs)\n run_id = next(run_counter)\n data = []\n for run_data in rawdata:\n out = {\"RunId\": run_id, \"iteration\": iteration - 1}\n out.update(run_data)\n data.append(out)\n results.extend(data)\n pbar.update()\n\n else:\n iteration_counter: Counter[Tuple[Any, ...]] = Counter()\n with Pool(number_processes) as p:\n for paramValues, rawdata in p.imap_unordered(process_func, kwargs_list):\n iteration_counter[paramValues] += 1\n iteration = iteration_counter[paramValues]\n run_id = next(run_counter)\n data = []\n for run_data in rawdata:\n out = {\"RunId\": run_id, \"iteration\": iteration - 1}\n out.update(run_data)\n data.append(out)\n results.extend(data)\n pbar.update()\n\n return results\n\n\ndef _make_model_kwargs(\n parameters: Mapping[str, Union[Any, Iterable[Any]]]\n) -> List[Dict[str, Any]]:\n \"\"\"Create model kwargs from parameters dictionary.\n\n Parameters\n ----------\n parameters : Mapping[str, Union[Any, Iterable[Any]]]\n Single or multiple values for each model parameter name\n\n Returns\n -------\n List[Dict[str, Any]]\n A list of all kwargs combinations.\n \"\"\"\n parameter_list = []\n for param, values in parameters.items():\n try:\n all_values = [(param, value) for value in values]\n except TypeError:\n all_values = [(param, values)]\n parameter_list.append(all_values)\n all_kwargs = itertools.product(*parameter_list)\n kwargs_list = [dict(kwargs) for kwargs in all_kwargs]\n return kwargs_list\n\n\ndef _model_run_func(\n model_cls: Type[Model],\n kwargs: Dict[str, Any],\n max_steps: int,\n data_collection_period: int,\n) -> Tuple[Tuple[Any, ...], List[Dict[str, Any]]]:\n \"\"\"Run a single model run and collect model and agent data.\n\n Parameters\n ----------\n model_cls : Type[Model]\n The model class to batch-run\n kwargs : Dict[str, Any]\n model kwargs used for this run\n max_steps : int\n Maximum number of model steps after which the model halts, by default 1000\n data_collection_period : int\n Number of steps after which data gets collected\n\n Returns\n -------\n Tuple[Tuple[Any, ...], List[Dict[str, Any]]]\n Return model_data, agent_data from the reporters\n \"\"\"\n model = model_cls(**kwargs)\n while model.running and model.schedule.steps <= max_steps:\n model.step()\n\n data = []\n\n steps = list(range(0, model.schedule.steps, data_collection_period))\n if not steps or steps[-1] != model.schedule.steps - 1:\n steps.append(model.schedule.steps - 1)\n\n for step in steps:\n model_data, all_agents_data = _collect_data(model, step)\n\n # If there are agent_reporters, then create an entry for each agent\n if all_agents_data:\n stepdata = [\n {**{\"Step\": step}, **kwargs, **model_data, **agent_data}\n for agent_data in all_agents_data\n ]\n # If there is only model data, then create a single entry for the step\n else:\n stepdata = [{**{\"Step\": step}, **kwargs, **model_data}]\n data.extend(stepdata)\n\n return tuple(kwargs.values()), data\n\n\ndef _collect_data(\n model: Model,\n step: int,\n) -> Tuple[Dict[str, Any], List[Dict[str, Any]]]:\n \"\"\"Collect model and agent data from a model using mesas datacollector.\"\"\"\n dc = model.datacollector\n\n model_data = {param: values[step] for param, values in dc.model_vars.items()}\n\n all_agents_data = []\n raw_agent_data = dc._agent_records.get(step, [])\n for data in raw_agent_data:\n agent_dict = {\"AgentID\": data[1]}\n agent_dict.update(zip(dc.agent_reporters, data[2:]))\n all_agents_data.append(agent_dict)\n return model_data, all_agents_data\n\n\nclass ParameterError(TypeError):\n MESSAGE = (\n \"Parameters must map a name to a value. \"\n \"These names did not match parameters: {}\"\n )\n\n def __init__(self, bad_names):\n self.bad_names = bad_names\n\n def __str__(self):\n return self.MESSAGE.format(self.bad_names)\n\n\nclass VariableParameterError(ParameterError):\n MESSAGE = (\n \"Variable_parameters must map a name to a sequence of values. \"\n \"These parameters were given with non-sequence values: {}\"\n )\n\n def __init__(self, bad_names):\n super().__init__(bad_names)\n\n\nclass FixedBatchRunner:\n \"\"\"This class is instantiated with a model class, and model parameters\n associated with one or more values. It is also instantiated with model and\n agent-level reporters, dictionaries mapping a variable name to a function\n which collects some data from the model or its agents at the end of the run\n and stores it.\n\n Note that by default, the reporters only collect data at the *end* of the\n run. To get step by step data, simply have a reporter store the model's\n entire DataCollector object.\n \"\"\"\n\n def __init__(\n self,\n model_cls,\n parameters_list=None,\n fixed_parameters=None,\n iterations=1,\n max_steps=1000,\n model_reporters=None,\n agent_reporters=None,\n display_progress=True,\n ):\n \"\"\"Create a new BatchRunner for a given model with the given\n parameters.\n\n Args:\n model_cls: The class of model to batch-run.\n parameters_list: A list of dictionaries of parameter sets.\n The model will be run with dictionary of parameters.\n For example, given parameters_list of\n [{\"homophily\": 3, \"density\": 0.8, \"minority_pc\": 0.2},\n {\"homophily\": 2, \"density\": 0.9, \"minority_pc\": 0.1},\n {\"homophily\": 4, \"density\": 0.6, \"minority_pc\": 0.5}]\n 3 models will be run, one for each provided set of parameters.\n fixed_parameters: Dictionary of parameters that stay same through\n all batch runs. For example, given fixed_parameters of\n {\"constant_parameter\": 3},\n every instantiated model will be passed constant_parameter=3\n as a kwarg.\n iterations: The total number of times to run the model for each set\n of parameters.\n max_steps: Upper limit of steps above which each run will be halted\n if it hasn't halted on its own.\n model_reporters: The dictionary of variables to collect on each run\n at the end, with variable names mapped to a function to collect\n them. For example:\n {\"agent_count\": lambda m: m.schedule.get_agent_count()}\n agent_reporters: Like model_reporters, but each variable is now\n collected at the level of each agent present in the model at\n the end of the run.\n display_progress: Display progress bar with time estimation?\n\n \"\"\"\n self.model_cls = model_cls\n if parameters_list is None:\n parameters_list = []\n self.parameters_list = list(parameters_list)\n self.fixed_parameters = fixed_parameters or {}\n self._include_fixed = len(self.fixed_parameters.keys()) > 0\n self.iterations = iterations\n self.max_steps = max_steps\n\n for params in self.parameters_list:\n if list(params) != list(self.parameters_list[0]):\n msg = \"parameter names in parameters_list are not equal across the list\"\n raise ValueError(msg)\n\n self.model_reporters = model_reporters\n self.agent_reporters = agent_reporters\n\n if self.model_reporters:\n self.model_vars = {}\n\n if self.agent_reporters:\n self.agent_vars = {}\n\n # Make Compatible with Python 3.5\n self.datacollector_model_reporters = OrderedDict()\n self.datacollector_agent_reporters = OrderedDict()\n\n self.display_progress = display_progress\n\n def _make_model_args(self):\n \"\"\"Prepare all combinations of parameter values for `run_all`\n\n Returns:\n Tuple with the form:\n (total_iterations, all_kwargs, all_param_values)\n \"\"\"\n total_iterations = self.iterations\n all_kwargs = []\n all_param_values = []\n\n count = len(self.parameters_list)\n if count:\n for params in self.parameters_list:\n kwargs = params.copy()\n kwargs.update(self.fixed_parameters)\n all_kwargs.append(kwargs)\n all_param_values.append(list(params.values()))\n\n elif len(self.fixed_parameters):\n count = 1\n kwargs = self.fixed_parameters.copy()\n all_kwargs.append(kwargs)\n all_param_values.append(list(kwargs.values()))\n\n total_iterations *= count\n\n return total_iterations, all_kwargs, all_param_values\n\n def run_all(self):\n \"\"\"Run the model at all parameter combinations and store results.\"\"\"\n run_count = count()\n total_iterations, all_kwargs, all_param_values = self._make_model_args()\n\n with tqdm(total_iterations, disable=not self.display_progress) as pbar:\n for i, kwargs in enumerate(all_kwargs):\n param_values = all_param_values[i]\n for _ in range(self.iterations):\n self.run_iteration(kwargs, param_values, next(run_count))\n pbar.update()\n\n def run_iteration(self, kwargs, param_values, run_count):\n model = self.model_cls(**kwargs)\n results = self.run_model(model)\n if param_values is not None:\n model_key = tuple(param_values) + (run_count,)\n else:\n model_key = (run_count,)\n\n if self.model_reporters:\n self.model_vars[model_key] = self.collect_model_vars(model)\n if self.agent_reporters:\n agent_vars = self.collect_agent_vars(model)\n for agent_id, reports in agent_vars.items():\n agent_key = model_key + (agent_id,)\n self.agent_vars[agent_key] = reports\n # Collects data from datacollector object in model\n if results is not None:\n if results.model_reporters is not None:\n self.datacollector_model_reporters[\n model_key\n ] = results.get_model_vars_dataframe()\n if results.agent_reporters is not None:\n self.datacollector_agent_reporters[\n model_key\n ] = results.get_agent_vars_dataframe()\n\n return (\n getattr(self, \"model_vars\", None),\n getattr(self, \"agent_vars\", None),\n getattr(self, \"datacollector_model_reporters\", None),\n getattr(self, \"datacollector_agent_reporters\", None),\n )\n\n def run_model(self, model):\n \"\"\"Run a model object to completion, or until reaching max steps.\n\n If your model runs in a non-standard way, this is the method to modify\n in your subclass.\n\n \"\"\"\n while model.running and model.schedule.steps < self.max_steps:\n model.step()\n\n if hasattr(model, \"datacollector\"):\n return model.datacollector\n else:\n return None\n\n def collect_model_vars(self, model):\n \"\"\"Run reporters and collect model-level variables.\"\"\"\n model_vars = OrderedDict()\n for var, reporter in self.model_reporters.items():\n model_vars[var] = reporter(model)\n\n return model_vars\n\n def collect_agent_vars(self, model):\n \"\"\"Run reporters and collect agent-level variables.\"\"\"\n agent_vars = OrderedDict()\n for agent in model.schedule._agents.values():\n agent_record = OrderedDict()\n for var, reporter in self.agent_reporters.items():\n agent_record[var] = getattr(agent, reporter)\n agent_vars[agent.unique_id] = agent_record\n return agent_vars\n\n def get_model_vars_dataframe(self):\n \"\"\"Generate a pandas DataFrame from the model-level variables\n collected.\n \"\"\"\n\n return self._prepare_report_table(self.model_vars)\n\n def get_agent_vars_dataframe(self):\n \"\"\"Generate a pandas DataFrame from the agent-level variables\n collected.\n \"\"\"\n\n return self._prepare_report_table(self.agent_vars, extra_cols=[\"AgentId\"])\n\n def get_collector_model(self):\n \"\"\"\n Passes pandas dataframes from datacollector module in dictionary format of model reporters\n :return: dict {(Param1, Param2,...,iteration): <DataCollector Pandas DataFrame>}\n \"\"\"\n\n return self.datacollector_model_reporters\n\n def get_collector_agents(self):\n \"\"\"\n Passes pandas dataframes from datacollector module in dictionary format of agent reporters\n :return: dict {(Param1, Param2,...,iteration): <DataCollector Pandas DataFrame>}\n \"\"\"\n return self.datacollector_agent_reporters\n\n def _prepare_report_table(self, vars_dict, extra_cols=None):\n \"\"\"\n Creates a dataframe from collected records and sorts it using 'Run'\n column as a key.\n \"\"\"\n extra_cols = [\"Run\"] + (extra_cols or [])\n index_cols = []\n if self.parameters_list:\n index_cols = list(self.parameters_list[0].keys())\n index_cols += extra_cols\n\n records = []\n for param_key, values in vars_dict.items():\n record = dict(zip(index_cols, param_key))\n record.update(values)\n records.append(record)\n\n df = pd.DataFrame(records)\n rest_cols = set(df.columns) - set(index_cols)\n ordered = df[index_cols + list(sorted(rest_cols))]\n ordered.sort_values(by=\"Run\", inplace=True)\n if self._include_fixed:\n for param in self.fixed_parameters.keys():\n val = self.fixed_parameters[param]\n\n # avoid error when val is an iterable\n vallist = [val for i in range(ordered.shape[0])]\n ordered[param] = vallist\n return ordered\n\n\nclass ParameterProduct:\n def __init__(self, variable_parameters):\n self.param_names, self.param_lists = zip(\n *(copy.deepcopy(variable_parameters)).items()\n )\n self._product = product(*self.param_lists)\n\n def __iter__(self):\n return self\n\n def __next__(self):\n return dict(zip(self.param_names, next(self._product)))\n\n\n# Roughly inspired by sklearn.model_selection.ParameterSampler. Does not handle\n# distributions, only lists.\nclass ParameterSampler:\n def __init__(self, parameter_lists, n, random_state=None):\n self.param_names, self.param_lists = zip(\n *(copy.deepcopy(parameter_lists)).items()\n )\n self.n = n\n if random_state is None:\n self.random_state = random.Random()\n elif isinstance(random_state, int):\n self.random_state = random.Random(random_state)\n else:\n self.random_state = random_state\n self.count = 0\n\n def __iter__(self):\n return self\n\n def __next__(self):\n self.count += 1\n if self.count <= self.n:\n return dict(\n zip(\n self.param_names,\n [self.random_state.choice(p_list) for p_list in self.param_lists],\n )\n )\n raise StopIteration()\n\n\nclass BatchRunner(FixedBatchRunner):\n \"\"\"DEPRECATION WARNING: BatchRunner Class has been replaced batch_run function\n This class is instantiated with a model class, and model parameters\n associated with one or more values. It is also instantiated with model and\n agent-level reporters, dictionaries mapping a variable name to a function\n which collects some data from the model or its agents at the end of the run\n and stores it.\n\n Note that by default, the reporters only collect data at the *end* of the\n run. To get step by step data, simply have a reporter store the model's\n entire DataCollector object.\n\n \"\"\"\n\n def __init__(\n self,\n model_cls,\n variable_parameters=None,\n fixed_parameters=None,\n iterations=1,\n max_steps=1000,\n model_reporters=None,\n agent_reporters=None,\n display_progress=True,\n ):\n \"\"\"Create a new BatchRunner for a given model with the given\n parameters.\n\n Args:\n model_cls: The class of model to batch-run.\n variable_parameters: Dictionary of parameters to lists of values.\n The model will be run with every combo of these parameters.\n For example, given variable_parameters of\n {\"param_1\": range(5),\n \"param_2\": [1, 5, 10]}\n models will be run with {param_1=1, param_2=1},\n {param_1=2, param_2=1}, ..., {param_1=4, param_2=10}.\n fixed_parameters: Dictionary of parameters that stay same through\n all batch runs. For example, given fixed_parameters of\n {\"constant_parameter\": 3},\n every instantiated model will be passed constant_parameter=3\n as a kwarg.\n iterations: The total number of times to run the model for each\n combination of parameters.\n max_steps: Upper limit of steps above which each run will be halted\n if it hasn't halted on its own.\n model_reporters: The dictionary of variables to collect on each run\n at the end, with variable names mapped to a function to collect\n them. For example:\n {\"agent_count\": lambda m: m.schedule.get_agent_count()}\n agent_reporters: Like model_reporters, but each variable is now\n collected at the level of each agent present in the model at\n the end of the run.\n display_progress: Display progress bar with time estimation?\n\n \"\"\"\n warn(\n \"BatchRunner class has been replaced by batch_run function. Please see documentation.\",\n DeprecationWarning,\n 2,\n )\n if variable_parameters is None:\n super().__init__(\n model_cls,\n variable_parameters,\n fixed_parameters,\n iterations,\n max_steps,\n model_reporters,\n agent_reporters,\n display_progress,\n )\n else:\n super().__init__(\n model_cls,\n ParameterProduct(variable_parameters),\n fixed_parameters,\n iterations,\n max_steps,\n model_reporters,\n agent_reporters,\n display_progress,\n )\n\n\nclass BatchRunnerMP(BatchRunner): # pragma: no cover\n \"\"\"DEPRECATION WARNING: BatchRunner class has been replaced by batch_run\n Child class of BatchRunner, extended with multiprocessing support.\"\"\"\n\n def __init__(self, model_cls, nr_processes=None, **kwargs):\n \"\"\"Create a new BatchRunnerMP for a given model with the given\n parameters.\n\n model_cls: The class of model to batch-run.\n nr_processes: int\n the number of separate processes the BatchRunner\n should start, all running in parallel.\n kwargs: the kwargs required for the parent BatchRunner class\n \"\"\"\n warn(\n \"BatchRunnerMP class has been replaced by batch_run function. Please see documentation.\",\n DeprecationWarning,\n 2,\n )\n if nr_processes is None:\n # identify the number of processors available on users machine\n available_processors = cpu_count()\n self.processes = available_processors\n print(f\"BatchRunner MP will use {self.processes} processors.\")\n else:\n self.processes = nr_processes\n\n super().__init__(model_cls, **kwargs)\n self.pool = Pool(self.processes)\n\n def _make_model_args_mp(self):\n \"\"\"Prepare all combinations of parameter values for `run_all`\n Due to multiprocessing requirements of @StaticMethod takes different input, hence the similar function\n Returns:\n List of list with the form:\n [[model_object, dictionary_of_kwargs, max_steps, iterations]]\n \"\"\"\n total_iterations = self.iterations\n all_kwargs = []\n\n count = len(self.parameters_list)\n if count:\n for params in self.parameters_list:\n kwargs = params.copy()\n kwargs.update(self.fixed_parameters)\n # run each iterations specific number of times\n for iter in range(self.iterations):\n kwargs_repeated = kwargs.copy()\n all_kwargs.append(\n [self.model_cls, kwargs_repeated, self.max_steps, iter]\n )\n\n elif len(self.fixed_parameters):\n count = 1\n kwargs = self.fixed_parameters.copy()\n all_kwargs.append(kwargs)\n\n total_iterations *= count\n\n return all_kwargs, total_iterations\n\n @staticmethod\n def _run_wrappermp(iter_args):\n \"\"\"\n Based on requirement of Python multiprocessing requires @staticmethod decorator;\n this is primarily to ensure functionality on Windows OS and does not impact MAC or Linux distros\n\n :param iter_args: List of arguments for model run\n iter_args[0] = model object\n iter_args[1] = key word arguments needed for model object\n iter_args[2] = maximum number of steps for model\n iter_args[3] = number of time to run model for stochastic/random variation with same parameters\n :return:\n tuple of param values which serves as a unique key for model results\n model object\n \"\"\"\n\n model_i = iter_args[0]\n kwargs = iter_args[1]\n max_steps = iter_args[2]\n iteration = iter_args[3]\n\n # instantiate version of model with correct parameters\n model = model_i(**kwargs)\n while model.running and model.schedule.steps < max_steps:\n model.step()\n\n # add iteration number to dictionary to make unique_key\n kwargs[\"iteration\"] = iteration\n\n # convert kwargs dict to tuple to make consistent\n param_values = tuple(kwargs.values())\n\n return param_values, model\n\n def _result_prep_mp(self, results):\n \"\"\"\n Helper Function\n :param results: Takes results dictionary from Processpool and single processor debug run and fixes format to\n make compatible with BatchRunner Output\n :updates model_vars and agents_vars so consistent across all batchrunner\n \"\"\"\n # Take results and convert to dictionary so dataframe can be called\n for model_key, model in results.items():\n if self.model_reporters:\n self.model_vars[model_key] = self.collect_model_vars(model)\n if self.agent_reporters:\n agent_vars = self.collect_agent_vars(model)\n for agent_id, reports in agent_vars.items():\n agent_key = model_key + (agent_id,)\n self.agent_vars[agent_key] = reports\n if hasattr(model, \"datacollector\"):\n if model.datacollector.model_reporters is not None:\n self.datacollector_model_reporters[\n model_key\n ] = model.datacollector.get_model_vars_dataframe()\n if model.datacollector.agent_reporters is not None:\n self.datacollector_agent_reporters[\n model_key\n ] = model.datacollector.get_agent_vars_dataframe()\n\n # Make results consistent\n if len(self.datacollector_model_reporters.keys()) == 0:\n self.datacollector_model_reporters = None\n if len(self.datacollector_agent_reporters.keys()) == 0:\n self.datacollector_agent_reporters = None\n\n def run_all(self):\n \"\"\"\n Run the model at all parameter combinations and store results,\n overrides run_all from BatchRunner.\n \"\"\"\n\n run_iter_args, total_iterations = self._make_model_args_mp()\n # register the process pool and init a queue\n # store results in ordered dictionary\n results = {}\n\n if self.processes > 1:\n with tqdm(total_iterations, disable=not self.display_progress) as pbar:\n for params, model in self.pool.imap_unordered(\n self._run_wrappermp, run_iter_args\n ):\n results[params] = model\n pbar.update()\n\n self._result_prep_mp(results)\n # For debugging model due to difficulty of getting errors during multiprocessing\n else:\n for run in run_iter_args:\n params, model_data = self._run_wrappermp(run)\n results[params] = model_data\n\n self._result_prep_mp(results)\n\n # Close multi-processing\n self.pool.close()\n\n return (\n getattr(self, \"model_vars\", None),\n getattr(self, \"agent_vars\", None),\n getattr(self, \"datacollector_model_reporters\", None),\n getattr(self, \"datacollector_agent_reporters\", None),\n )\n","path":"mesa/batchrunner.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"\\nBatchrunner\\n===========\\n\\nA single class to manage a batch run or parameter sweep of a given model.\\n\\n\\\"\\\"\\\"\\nimport copy\\nimport itertools\\nimport random\\nfrom collections import OrderedDict\\nfrom functools import partial\\nfrom itertools import count, product\\nfrom multiprocessing import Pool, cpu_count\\nfrom warnings import warn\\nfrom typing import (\\n Any,\\n Counter,\\n Dict,\\n Iterable,\\n List,\\n Mapping,\\n Optional,\\n Tuple,\\n Type,\\n Union,\\n)\\n\\nimport pandas as pd\\nfrom tqdm import tqdm\\n\\nfrom mesa.model import Model\\n\\n\\ndef batch_run(\\n model_cls: Type[Model],\\n parameters: Mapping[str, Union[Any, Iterable[Any]]],\\n number_processes: Optional[int] = None,\\n iterations: int = 1,\\n data_collection_period: int = -1,\\n max_steps: int = 1000,\\n display_progress: bool = True,\\n) -> List[Dict[str, Any]]:\\n \\\"\\\"\\\"Batch run a mesa model with a set of parameter values.\\n\\n Parameters\\n ----------\\n model_cls : Type[Model]\\n The model class to batch-run\\n parameters : Mapping[str, Union[Any, Iterable[Any]]],\\n Dictionary with model parameters over which to run the model. You can either pass single values or iterables.\\n number_processes : int, optional\\n Number of processes used. Set to None (default) to use all available processors\\n iterations : int, optional\\n Number of iterations for each parameter combination, by default 1\\n data_collection_period : int, optional\\n Number of steps after which data gets collected, by default -1 (end of episode)\\n max_steps : int, optional\\n Maximum number of model steps after which the model halts, by default 1000\\n display_progress : bool, optional\\n Display batch run process, by default True\\n\\n Returns\\n -------\\n List[Dict[str, Any]]\\n [description]\\n \\\"\\\"\\\"\\n\\n kwargs_list = _make_model_kwargs(parameters) * iterations\\n process_func = partial(\\n _model_run_func,\\n model_cls,\\n max_steps=max_steps,\\n data_collection_period=data_collection_period,\\n )\\n\\n total_iterations = len(kwargs_list) * iterations\\n run_counter = count()\\n\\n results: List[Dict[str, Any]] = []\\n\\n with tqdm(total_iterations, disable=not display_progress) as pbar:\\n if number_processes == 1:\\n for iteration in range(iterations):\\n for kwargs in kwargs_list:\\n _, rawdata = process_func(kwargs)\\n run_id = next(run_counter)\\n data = []\\n for run_data in rawdata:\\n out = {\\\"RunId\\\": run_id, \\\"iteration\\\": iteration - 1}\\n out.update(run_data)\\n data.append(out)\\n results.extend(data)\\n pbar.update()\\n\\n else:\\n iteration_counter: Counter[Tuple[Any, ...]] = Counter()\\n with Pool(number_processes) as p:\\n for paramValues, rawdata in p.imap_unordered(process_func, kwargs_list):\\n iteration_counter[paramValues] += 1\\n iteration = iteration_counter[paramValues]\\n run_id = next(run_counter)\\n data = []\\n for run_data in rawdata:\\n out = {\\\"RunId\\\": run_id, \\\"iteration\\\": iteration - 1}\\n out.update(run_data)\\n data.append(out)\\n results.extend(data)\\n pbar.update()\\n\\n return results\\n\\n\\ndef _make_model_kwargs(\\n parameters: Mapping[str, Union[Any, Iterable[Any]]]\\n) -> List[Dict[str, Any]]:\\n \\\"\\\"\\\"Create model kwargs from parameters dictionary.\\n\\n Parameters\\n ----------\\n parameters : Mapping[str, Union[Any, Iterable[Any]]]\\n Single or multiple values for each model parameter name\\n\\n Returns\\n -------\\n List[Dict[str, Any]]\\n A list of all kwargs combinations.\\n \\\"\\\"\\\"\\n parameter_list = []\\n for param, values in parameters.items():\\n try:\\n all_values = [(param, value) for value in values]\\n except TypeError:\\n all_values = [(param, values)]\\n parameter_list.append(all_values)\\n all_kwargs = itertools.product(*parameter_list)\\n kwargs_list = [dict(kwargs) for kwargs in all_kwargs]\\n return kwargs_list\\n\\n\\ndef _model_run_func(\\n model_cls: Type[Model],\\n kwargs: Dict[str, Any],\\n max_steps: int,\\n data_collection_period: int,\\n) -> Tuple[Tuple[Any, ...], List[Dict[str, Any]]]:\\n \\\"\\\"\\\"Run a single model run and collect model and agent data.\\n\\n Parameters\\n ----------\\n model_cls : Type[Model]\\n The model class to batch-run\\n kwargs : Dict[str, Any]\\n model kwargs used for this run\\n max_steps : int\\n Maximum number of model steps after which the model halts, by default 1000\\n data_collection_period : int\\n Number of steps after which data gets collected\\n\\n Returns\\n -------\\n Tuple[Tuple[Any, ...], List[Dict[str, Any]]]\\n Return model_data, agent_data from the reporters\\n \\\"\\\"\\\"\\n model = model_cls(**kwargs)\\n while model.running and model.schedule.steps <= max_steps:\\n model.step()\\n\\n data = []\\n\\n steps = list(range(0, model.schedule.steps, data_collection_period))\\n if not steps or steps[-1] != model.schedule.steps - 1:\\n steps.append(model.schedule.steps - 1)\\n\\n for step in steps:\\n model_data, all_agents_data = _collect_data(model, step)\\n\\n # If there are agent_reporters, then create an entry for each agent\\n if all_agents_data:\\n stepdata = [\\n {**{\\\"Step\\\": step}, **kwargs, **model_data, **agent_data}\\n for agent_data in all_agents_data\\n ]\\n # If there is only model data, then create a single entry for the step\\n else:\\n stepdata = [{**{\\\"Step\\\": step}, **kwargs, **model_data}]\\n data.extend(stepdata)\\n\\n return tuple(kwargs.values()), data\\n\\n\\ndef _collect_data(\\n model: Model,\\n step: int,\\n) -> Tuple[Dict[str, Any], List[Dict[str, Any]]]:\\n \\\"\\\"\\\"Collect model and agent data from a model using mesas datacollector.\\\"\\\"\\\"\\n dc = model.datacollector\\n\\n model_data = {param: values[step] for param, values in dc.model_vars.items()}\\n\\n all_agents_data = []\\n raw_agent_data = dc._agent_records.get(step, [])\\n for data in raw_agent_data:\\n agent_dict = {\\\"AgentID\\\": data[1]}\\n agent_dict.update(zip(dc.agent_reporters, data[2:]))\\n all_agents_data.append(agent_dict)\\n return model_data, all_agents_data\\n\\n\\nclass ParameterError(TypeError):\\n MESSAGE = (\\n \\\"Parameters must map a name to a value. \\\"\\n \\\"These names did not match parameters: {}\\\"\\n )\\n\\n def __init__(self, bad_names):\\n self.bad_names = bad_names\\n\\n def __str__(self):\\n return self.MESSAGE.format(self.bad_names)\\n\\n\\nclass VariableParameterError(ParameterError):\\n MESSAGE = (\\n \\\"Variable_parameters must map a name to a sequence of values. \\\"\\n \\\"These parameters were given with non-sequence values: {}\\\"\\n )\\n\\n def __init__(self, bad_names):\\n super().__init__(bad_names)\\n\\n\\nclass FixedBatchRunner:\\n \\\"\\\"\\\"This class is instantiated with a model class, and model parameters\\n associated with one or more values. It is also instantiated with model and\\n agent-level reporters, dictionaries mapping a variable name to a function\\n which collects some data from the model or its agents at the end of the run\\n and stores it.\\n\\n Note that by default, the reporters only collect data at the *end* of the\\n run. To get step by step data, simply have a reporter store the model's\\n entire DataCollector object.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n model_cls,\\n parameters_list=None,\\n fixed_parameters=None,\\n iterations=1,\\n max_steps=1000,\\n model_reporters=None,\\n agent_reporters=None,\\n display_progress=True,\\n ):\\n \\\"\\\"\\\"Create a new BatchRunner for a given model with the given\\n parameters.\\n\\n Args:\\n model_cls: The class of model to batch-run.\\n parameters_list: A list of dictionaries of parameter sets.\\n The model will be run with dictionary of parameters.\\n For example, given parameters_list of\\n [{\\\"homophily\\\": 3, \\\"density\\\": 0.8, \\\"minority_pc\\\": 0.2},\\n {\\\"homophily\\\": 2, \\\"density\\\": 0.9, \\\"minority_pc\\\": 0.1},\\n {\\\"homophily\\\": 4, \\\"density\\\": 0.6, \\\"minority_pc\\\": 0.5}]\\n 3 models will be run, one for each provided set of parameters.\\n fixed_parameters: Dictionary of parameters that stay same through\\n all batch runs. For example, given fixed_parameters of\\n {\\\"constant_parameter\\\": 3},\\n every instantiated model will be passed constant_parameter=3\\n as a kwarg.\\n iterations: The total number of times to run the model for each set\\n of parameters.\\n max_steps: Upper limit of steps above which each run will be halted\\n if it hasn't halted on its own.\\n model_reporters: The dictionary of variables to collect on each run\\n at the end, with variable names mapped to a function to collect\\n them. For example:\\n {\\\"agent_count\\\": lambda m: m.schedule.get_agent_count()}\\n agent_reporters: Like model_reporters, but each variable is now\\n collected at the level of each agent present in the model at\\n the end of the run.\\n display_progress: Display progress bar with time estimation?\\n\\n \\\"\\\"\\\"\\n self.model_cls = model_cls\\n if parameters_list is None:\\n parameters_list = []\\n self.parameters_list = list(parameters_list)\\n self.fixed_parameters = fixed_parameters or {}\\n self._include_fixed = len(self.fixed_parameters.keys()) > 0\\n self.iterations = iterations\\n self.max_steps = max_steps\\n\\n for params in self.parameters_list:\\n if list(params) != list(self.parameters_list[0]):\\n msg = \\\"parameter names in parameters_list are not equal across the list\\\"\\n raise ValueError(msg)\\n\\n self.model_reporters = model_reporters\\n self.agent_reporters = agent_reporters\\n\\n if self.model_reporters:\\n self.model_vars = {}\\n\\n if self.agent_reporters:\\n self.agent_vars = {}\\n\\n # Make Compatible with Python 3.5\\n self.datacollector_model_reporters = OrderedDict()\\n self.datacollector_agent_reporters = OrderedDict()\\n\\n self.display_progress = display_progress\\n\\n def _make_model_args(self):\\n \\\"\\\"\\\"Prepare all combinations of parameter values for `run_all`\\n\\n Returns:\\n Tuple with the form:\\n (total_iterations, all_kwargs, all_param_values)\\n \\\"\\\"\\\"\\n total_iterations = self.iterations\\n all_kwargs = []\\n all_param_values = []\\n\\n count = len(self.parameters_list)\\n if count:\\n for params in self.parameters_list:\\n kwargs = params.copy()\\n kwargs.update(self.fixed_parameters)\\n all_kwargs.append(kwargs)\\n all_param_values.append(list(params.values()))\\n\\n elif len(self.fixed_parameters):\\n count = 1\\n kwargs = self.fixed_parameters.copy()\\n all_kwargs.append(kwargs)\\n all_param_values.append(list(kwargs.values()))\\n\\n total_iterations *= count\\n\\n return total_iterations, all_kwargs, all_param_values\\n\\n def run_all(self):\\n \\\"\\\"\\\"Run the model at all parameter combinations and store results.\\\"\\\"\\\"\\n run_count = count()\\n total_iterations, all_kwargs, all_param_values = self._make_model_args()\\n\\n with tqdm(total_iterations, disable=not self.display_progress) as pbar:\\n for i, kwargs in enumerate(all_kwargs):\\n param_values = all_param_values[i]\\n for _ in range(self.iterations):\\n self.run_iteration(kwargs, param_values, next(run_count))\\n pbar.update()\\n\\n def run_iteration(self, kwargs, param_values, run_count):\\n model = self.model_cls(**kwargs)\\n results = self.run_model(model)\\n if param_values is not None:\\n model_key = tuple(param_values) + (run_count,)\\n else:\\n model_key = (run_count,)\\n\\n if self.model_reporters:\\n self.model_vars[model_key] = self.collect_model_vars(model)\\n if self.agent_reporters:\\n agent_vars = self.collect_agent_vars(model)\\n for agent_id, reports in agent_vars.items():\\n agent_key = model_key + (agent_id,)\\n self.agent_vars[agent_key] = reports\\n # Collects data from datacollector object in model\\n if results is not None:\\n if results.model_reporters is not None:\\n self.datacollector_model_reporters[\\n model_key\\n ] = results.get_model_vars_dataframe()\\n if results.agent_reporters is not None:\\n self.datacollector_agent_reporters[\\n model_key\\n ] = results.get_agent_vars_dataframe()\\n\\n return (\\n getattr(self, \\\"model_vars\\\", None),\\n getattr(self, \\\"agent_vars\\\", None),\\n getattr(self, \\\"datacollector_model_reporters\\\", None),\\n getattr(self, \\\"datacollector_agent_reporters\\\", None),\\n )\\n\\n def run_model(self, model):\\n \\\"\\\"\\\"Run a model object to completion, or until reaching max steps.\\n\\n If your model runs in a non-standard way, this is the method to modify\\n in your subclass.\\n\\n \\\"\\\"\\\"\\n while model.running and model.schedule.steps < self.max_steps:\\n model.step()\\n\\n if hasattr(model, \\\"datacollector\\\"):\\n return model.datacollector\\n else:\\n return None\\n\\n def collect_model_vars(self, model):\\n \\\"\\\"\\\"Run reporters and collect model-level variables.\\\"\\\"\\\"\\n model_vars = OrderedDict()\\n for var, reporter in self.model_reporters.items():\\n model_vars[var] = reporter(model)\\n\\n return model_vars\\n\\n def collect_agent_vars(self, model):\\n \\\"\\\"\\\"Run reporters and collect agent-level variables.\\\"\\\"\\\"\\n agent_vars = OrderedDict()\\n for agent in model.schedule._agents.values():\\n agent_record = OrderedDict()\\n for var, reporter in self.agent_reporters.items():\\n agent_record[var] = getattr(agent, reporter)\\n agent_vars[agent.unique_id] = agent_record\\n return agent_vars\\n\\n def get_model_vars_dataframe(self):\\n \\\"\\\"\\\"Generate a pandas DataFrame from the model-level variables\\n collected.\\n \\\"\\\"\\\"\\n\\n return self._prepare_report_table(self.model_vars)\\n\\n def get_agent_vars_dataframe(self):\\n \\\"\\\"\\\"Generate a pandas DataFrame from the agent-level variables\\n collected.\\n \\\"\\\"\\\"\\n\\n return self._prepare_report_table(self.agent_vars, extra_cols=[\\\"AgentId\\\"])\\n\\n def get_collector_model(self):\\n \\\"\\\"\\\"\\n Passes pandas dataframes from datacollector module in dictionary format of model reporters\\n :return: dict {(Param1, Param2,...,iteration): <DataCollector Pandas DataFrame>}\\n \\\"\\\"\\\"\\n\\n return self.datacollector_model_reporters\\n\\n def get_collector_agents(self):\\n \\\"\\\"\\\"\\n Passes pandas dataframes from datacollector module in dictionary format of agent reporters\\n :return: dict {(Param1, Param2,...,iteration): <DataCollector Pandas DataFrame>}\\n \\\"\\\"\\\"\\n return self.datacollector_agent_reporters\\n\\n def _prepare_report_table(self, vars_dict, extra_cols=None):\\n \\\"\\\"\\\"\\n Creates a dataframe from collected records and sorts it using 'Run'\\n column as a key.\\n \\\"\\\"\\\"\\n extra_cols = [\\\"Run\\\"] + (extra_cols or [])\\n index_cols = []\\n if self.parameters_list:\\n index_cols = list(self.parameters_list[0].keys())\\n index_cols += extra_cols\\n\\n records = []\\n for param_key, values in vars_dict.items():\\n record = dict(zip(index_cols, param_key))\\n record.update(values)\\n records.append(record)\\n\\n df = pd.DataFrame(records)\\n rest_cols = set(df.columns) - set(index_cols)\\n ordered = df[index_cols + list(sorted(rest_cols))]\\n ordered.sort_values(by=\\\"Run\\\", inplace=True)\\n if self._include_fixed:\\n for param in self.fixed_parameters.keys():\\n val = self.fixed_parameters[param]\\n\\n # avoid error when val is an iterable\\n vallist = [val for i in range(ordered.shape[0])]\\n ordered[param] = vallist\\n return ordered\\n\\n\\nclass ParameterProduct:\\n def __init__(self, variable_parameters):\\n self.param_names, self.param_lists = zip(\\n *(copy.deepcopy(variable_parameters)).items()\\n )\\n self._product = product(*self.param_lists)\\n\\n def __iter__(self):\\n return self\\n\\n def __next__(self):\\n return dict(zip(self.param_names, next(self._product)))\\n\\n\\n# Roughly inspired by sklearn.model_selection.ParameterSampler. Does not handle\\n# distributions, only lists.\\nclass ParameterSampler:\\n def __init__(self, parameter_lists, n, random_state=None):\\n self.param_names, self.param_lists = zip(\\n *(copy.deepcopy(parameter_lists)).items()\\n )\\n self.n = n\\n if random_state is None:\\n self.random_state = random.Random()\\n elif isinstance(random_state, int):\\n self.random_state = random.Random(random_state)\\n else:\\n self.random_state = random_state\\n self.count = 0\\n\\n def __iter__(self):\\n return self\\n\\n def __next__(self):\\n self.count += 1\\n if self.count <= self.n:\\n return dict(\\n zip(\\n self.param_names,\\n [self.random_state.choice(p_list) for p_list in self.param_lists],\\n )\\n )\\n raise StopIteration()\\n\\n\\nclass BatchRunner(FixedBatchRunner):\\n \\\"\\\"\\\"DEPRECATION WARNING: BatchRunner Class has been replaced batch_run function\\n This class is instantiated with a model class, and model parameters\\n associated with one or more values. It is also instantiated with model and\\n agent-level reporters, dictionaries mapping a variable name to a function\\n which collects some data from the model or its agents at the end of the run\\n and stores it.\\n\\n Note that by default, the reporters only collect data at the *end* of the\\n run. To get step by step data, simply have a reporter store the model's\\n entire DataCollector object.\\n\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n model_cls,\\n variable_parameters=None,\\n fixed_parameters=None,\\n iterations=1,\\n max_steps=1000,\\n model_reporters=None,\\n agent_reporters=None,\\n display_progress=True,\\n ):\\n \\\"\\\"\\\"Create a new BatchRunner for a given model with the given\\n parameters.\\n\\n Args:\\n model_cls: The class of model to batch-run.\\n variable_parameters: Dictionary of parameters to lists of values.\\n The model will be run with every combo of these parameters.\\n For example, given variable_parameters of\\n {\\\"param_1\\\": range(5),\\n \\\"param_2\\\": [1, 5, 10]}\\n models will be run with {param_1=1, param_2=1},\\n {param_1=2, param_2=1}, ..., {param_1=4, param_2=10}.\\n fixed_parameters: Dictionary of parameters that stay same through\\n all batch runs. For example, given fixed_parameters of\\n {\\\"constant_parameter\\\": 3},\\n every instantiated model will be passed constant_parameter=3\\n as a kwarg.\\n iterations: The total number of times to run the model for each\\n combination of parameters.\\n max_steps: Upper limit of steps above which each run will be halted\\n if it hasn't halted on its own.\\n model_reporters: The dictionary of variables to collect on each run\\n at the end, with variable names mapped to a function to collect\\n them. For example:\\n {\\\"agent_count\\\": lambda m: m.schedule.get_agent_count()}\\n agent_reporters: Like model_reporters, but each variable is now\\n collected at the level of each agent present in the model at\\n the end of the run.\\n display_progress: Display progress bar with time estimation?\\n\\n \\\"\\\"\\\"\\n warn(\\n \\\"BatchRunner class has been replaced by batch_run function. Please see documentation.\\\",\\n DeprecationWarning,\\n 2,\\n )\\n if variable_parameters is None:\\n super().__init__(\\n model_cls,\\n variable_parameters,\\n fixed_parameters,\\n iterations,\\n max_steps,\\n model_reporters,\\n agent_reporters,\\n display_progress,\\n )\\n else:\\n super().__init__(\\n model_cls,\\n ParameterProduct(variable_parameters),\\n fixed_parameters,\\n iterations,\\n max_steps,\\n model_reporters,\\n agent_reporters,\\n display_progress,\\n )\\n\\n\\nclass BatchRunnerMP(BatchRunner): # pragma: no cover\\n \\\"\\\"\\\"DEPRECATION WARNING: BatchRunner class has been replaced by batch_run\\n Child class of BatchRunner, extended with multiprocessing support.\\\"\\\"\\\"\\n\\n def __init__(self, model_cls, nr_processes=None, **kwargs):\\n \\\"\\\"\\\"Create a new BatchRunnerMP for a given model with the given\\n parameters.\\n\\n model_cls: The class of model to batch-run.\\n nr_processes: int\\n the number of separate processes the BatchRunner\\n should start, all running in parallel.\\n kwargs: the kwargs required for the parent BatchRunner class\\n \\\"\\\"\\\"\\n warn(\\n \\\"BatchRunnerMP class has been replaced by batch_run function. Please see documentation.\\\",\\n DeprecationWarning,\\n 2,\\n )\\n if nr_processes is None:\\n # identify the number of processors available on users machine\\n available_processors = cpu_count()\\n self.processes = available_processors\\n print(f\\\"BatchRunner MP will use {self.processes} processors.\\\")\\n else:\\n self.processes = nr_processes\\n\\n super().__init__(model_cls, **kwargs)\\n self.pool = Pool(self.processes)\\n\\n def _make_model_args_mp(self):\\n \\\"\\\"\\\"Prepare all combinations of parameter values for `run_all`\\n Due to multiprocessing requirements of @StaticMethod takes different input, hence the similar function\\n Returns:\\n List of list with the form:\\n [[model_object, dictionary_of_kwargs, max_steps, iterations]]\\n \\\"\\\"\\\"\\n total_iterations = self.iterations\\n all_kwargs = []\\n\\n count = len(self.parameters_list)\\n if count:\\n for params in self.parameters_list:\\n kwargs = params.copy()\\n kwargs.update(self.fixed_parameters)\\n # run each iterations specific number of times\\n for iter in range(self.iterations):\\n kwargs_repeated = kwargs.copy()\\n all_kwargs.append(\\n [self.model_cls, kwargs_repeated, self.max_steps, iter]\\n )\\n\\n elif len(self.fixed_parameters):\\n count = 1\\n kwargs = self.fixed_parameters.copy()\\n all_kwargs.append(kwargs)\\n\\n total_iterations *= count\\n\\n return all_kwargs, total_iterations\\n\\n @staticmethod\\n def _run_wrappermp(iter_args):\\n \\\"\\\"\\\"\\n Based on requirement of Python multiprocessing requires @staticmethod decorator;\\n this is primarily to ensure functionality on Windows OS and does not impact MAC or Linux distros\\n\\n :param iter_args: List of arguments for model run\\n iter_args[0] = model object\\n iter_args[1] = key word arguments needed for model object\\n iter_args[2] = maximum number of steps for model\\n iter_args[3] = number of time to run model for stochastic/random variation with same parameters\\n :return:\\n tuple of param values which serves as a unique key for model results\\n model object\\n \\\"\\\"\\\"\\n\\n model_i = iter_args[0]\\n kwargs = iter_args[1]\\n max_steps = iter_args[2]\\n iteration = iter_args[3]\\n\\n # instantiate version of model with correct parameters\\n model = model_i(**kwargs)\\n while model.running and model.schedule.steps < max_steps:\\n model.step()\\n\\n # add iteration number to dictionary to make unique_key\\n kwargs[\\\"iteration\\\"] = iteration\\n\\n # convert kwargs dict to tuple to make consistent\\n param_values = tuple(kwargs.values())\\n\\n return param_values, model\\n\\n def _result_prep_mp(self, results):\\n \\\"\\\"\\\"\\n Helper Function\\n :param results: Takes results dictionary from Processpool and single processor debug run and fixes format to\\n make compatible with BatchRunner Output\\n :updates model_vars and agents_vars so consistent across all batchrunner\\n \\\"\\\"\\\"\\n # Take results and convert to dictionary so dataframe can be called\\n for model_key, model in results.items():\\n if self.model_reporters:\\n self.model_vars[model_key] = self.collect_model_vars(model)\\n if self.agent_reporters:\\n agent_vars = self.collect_agent_vars(model)\\n for agent_id, reports in agent_vars.items():\\n agent_key = model_key + (agent_id,)\\n self.agent_vars[agent_key] = reports\\n if hasattr(model, \\\"datacollector\\\"):\\n if model.datacollector.model_reporters is not None:\\n self.datacollector_model_reporters[\\n model_key\\n ] = model.datacollector.get_model_vars_dataframe()\\n if model.datacollector.agent_reporters is not None:\\n self.datacollector_agent_reporters[\\n model_key\\n ] = model.datacollector.get_agent_vars_dataframe()\\n\\n # Make results consistent\\n if len(self.datacollector_model_reporters.keys()) == 0:\\n self.datacollector_model_reporters = None\\n if len(self.datacollector_agent_reporters.keys()) == 0:\\n self.datacollector_agent_reporters = None\\n\\n def run_all(self):\\n \\\"\\\"\\\"\\n Run the model at all parameter combinations and store results,\\n overrides run_all from BatchRunner.\\n \\\"\\\"\\\"\\n\\n run_iter_args, total_iterations = self._make_model_args_mp()\\n # register the process pool and init a queue\\n # store results in ordered dictionary\\n results = {}\\n\\n if self.processes > 1:\\n with tqdm(total_iterations, disable=not self.display_progress) as pbar:\\n for params, model in self.pool.imap_unordered(\\n self._run_wrappermp, run_iter_args\\n ):\\n results[params] = model\\n pbar.update()\\n\\n self._result_prep_mp(results)\\n # For debugging model due to difficulty of getting errors during multiprocessing\\n else:\\n for run in run_iter_args:\\n params, model_data = self._run_wrappermp(run)\\n results[params] = model_data\\n\\n self._result_prep_mp(results)\\n\\n # Close multi-processing\\n self.pool.close()\\n\\n return (\\n getattr(self, \\\"model_vars\\\", None),\\n getattr(self, \\\"agent_vars\\\", None),\\n getattr(self, \\\"datacollector_model_reporters\\\", None),\\n getattr(self, \\\"datacollector_agent_reporters\\\", None),\\n )\\n\",\n \"path\": \"mesa/batchrunner.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/mesa/batchrunner.py b/mesa/batchrunner.py\nindex 4b19c47ee9c..0556a38f461 100644\n--- a/mesa/batchrunner.py\n+++ b/mesa/batchrunner.py\n@@ -610,7 +610,7 @@ def __init__(\n )\n \n \n-class BatchRunnerMP(BatchRunner):\n+class BatchRunnerMP(BatchRunner): # pragma: no cover\n \"\"\"DEPRECATION WARNING: BatchRunner class has been replaced by batch_run\n Child class of BatchRunner, extended with multiprocessing support.\"\"\"\n \ndiff --git a/tests/test_batchrunnerMP.py b/tests/test_batchrunnerMP.py\nindex 963eae60e39..d6ff3001eae 100644\n--- a/tests/test_batchrunnerMP.py\n+++ b/tests/test_batchrunnerMP.py\n@@ -87,6 +87,7 @@ class TestBatchRunnerMP(unittest.TestCase):\n \"\"\"\r\n \r\n def setUp(self):\r\n+ self.skipTest(\"Disabled due to consistent hangs\")\r\n self.mock_model = MockModel\r\n self.model_reporters = {\r\n \"reported_variable_value\": lambda m: m.variable_model_param,\r\n"}}},{"rowIdx":2689,"cells":{"in_source_id":{"kind":"string","value":"ManimCommunity__manim-235"},"issue":{"kind":"string","value":"-f broken on windows\nBasically the title.\r\nWhen passing -f on windows in show the video file with the default video browser (like -p does) and not in the file explorer. \n"},"before_files":{"kind":"list like","value":[{"content":"import inspect\nimport os\nimport platform\nimport subprocess as sp\nimport sys\nimport re\nimport traceback\nimport importlib.util\nimport types\n\nfrom .config import file_writer_config\nfrom .scene.scene import Scene\nfrom .utils.sounds import play_error_sound\nfrom .utils.sounds import play_finish_sound\nfrom . import constants\nfrom .logger import logger, console\n\n\ndef open_file_if_needed(file_writer):\n if file_writer_config[\"quiet\"]:\n curr_stdout = sys.stdout\n sys.stdout = open(os.devnull, \"w\")\n\n open_file = any(\n [file_writer_config[\"preview\"], file_writer_config[\"show_file_in_finder\"]]\n )\n if open_file:\n current_os = platform.system()\n file_paths = []\n\n if file_writer_config[\"save_last_frame\"]:\n file_paths.append(file_writer.get_image_file_path())\n if file_writer_config[\"write_to_movie\"]:\n file_paths.append(file_writer.get_movie_file_path())\n\n for file_path in file_paths:\n if current_os == \"Windows\":\n os.startfile(file_path)\n else:\n commands = []\n if current_os == \"Linux\":\n commands.append(\"xdg-open\")\n elif current_os.startswith(\"CYGWIN\"):\n commands.append(\"cygstart\")\n else: # Assume macOS\n commands.append(\"open\")\n\n if file_writer_config[\"show_file_in_finder\"]:\n commands.append(\"-R\")\n\n commands.append(file_path)\n\n # commands.append(\"-g\")\n FNULL = open(os.devnull, \"w\")\n sp.call(commands, stdout=FNULL, stderr=sp.STDOUT)\n FNULL.close()\n\n if file_writer_config[\"quiet\"]:\n sys.stdout.close()\n sys.stdout = curr_stdout\n\n\ndef is_child_scene(obj, module):\n return (\n inspect.isclass(obj)\n and issubclass(obj, Scene)\n and obj != Scene\n and obj.__module__.startswith(module.__name__)\n )\n\n\ndef prompt_user_for_choice(scene_classes):\n num_to_class = {}\n for count, scene_class in enumerate(scene_classes):\n count += 1 # start with 1 instead of 0\n name = scene_class.__name__\n console.print(f\"{count}: {name}\", style=\"logging.level.info\")\n num_to_class[count] = scene_class\n try:\n user_input = console.input(\n f\"[log.message] {constants.CHOOSE_NUMBER_MESSAGE} [/log.message]\"\n )\n return [\n num_to_class[int(num_str)]\n for num_str in re.split(r\"\\s*,\\s*\", user_input.strip())\n ]\n except KeyError:\n logger.error(constants.INVALID_NUMBER_MESSAGE)\n sys.exit(2)\n except EOFError:\n sys.exit(1)\n\n\ndef get_scenes_to_render(scene_classes):\n if not scene_classes:\n logger.error(constants.NO_SCENE_MESSAGE)\n return []\n if file_writer_config[\"write_all\"]:\n return scene_classes\n result = []\n for scene_name in file_writer_config[\"scene_names\"]:\n found = False\n for scene_class in scene_classes:\n if scene_class.__name__ == scene_name:\n result.append(scene_class)\n found = True\n break\n if not found and (scene_name != \"\"):\n logger.error(constants.SCENE_NOT_FOUND_MESSAGE.format(scene_name))\n if result:\n return result\n return (\n [scene_classes[0]]\n if len(scene_classes) == 1\n else prompt_user_for_choice(scene_classes)\n )\n\n\ndef get_scene_classes_from_module(module):\n return [\n member[1]\n for member in inspect.getmembers(module, lambda x: is_child_scene(x, module))\n ]\n\n\ndef get_module(file_name):\n if file_name == \"-\":\n module = types.ModuleType(\"input_scenes\")\n logger.info(\n \"Enter the animation's code & end with an EOF (CTRL+D on Linux/Unix, CTRL+Z on Windows):\"\n )\n code = sys.stdin.read()\n if not code.startswith(\"from manim import\"):\n logger.warn(\n \"Didn't find an import statement for Manim. Importing automatically...\"\n )\n code = \"from manim import *\\n\" + code\n logger.info(\"Rendering animation from typed code...\")\n try:\n exec(code, module.__dict__)\n return module\n except Exception as e:\n logger.error(f\"Failed to render scene: {str(e)}\")\n sys.exit(2)\n else:\n if os.path.exists(file_name):\n if file_name[-3:] != \".py\":\n raise Exception(f\"{file_name} is not a valid Manim python script.\")\n module_name = file_name[:-3].replace(os.sep, \".\").split(\".\")[-1]\n spec = importlib.util.spec_from_file_location(module_name, file_name)\n module = importlib.util.module_from_spec(spec)\n spec.loader.exec_module(module)\n return module\n else:\n raise FileNotFoundError(f\"{file_name} not found\")\n\n\ndef main():\n module = get_module(file_writer_config[\"input_file\"])\n all_scene_classes = get_scene_classes_from_module(module)\n scene_classes_to_render = get_scenes_to_render(all_scene_classes)\n sound_on = file_writer_config[\"sound\"]\n for SceneClass in scene_classes_to_render:\n try:\n # By invoking, this renders the full scene\n scene = SceneClass()\n open_file_if_needed(scene.file_writer)\n if sound_on:\n play_finish_sound()\n except Exception:\n print(\"\\n\\n\")\n traceback.print_exc()\n print(\"\\n\\n\")\n if sound_on:\n play_error_sound()\n\n\nif __name__ == \"__main__\":\n main()\n","path":"manim/__main__.py"}],"string":"[\n {\n \"content\": \"import inspect\\nimport os\\nimport platform\\nimport subprocess as sp\\nimport sys\\nimport re\\nimport traceback\\nimport importlib.util\\nimport types\\n\\nfrom .config import file_writer_config\\nfrom .scene.scene import Scene\\nfrom .utils.sounds import play_error_sound\\nfrom .utils.sounds import play_finish_sound\\nfrom . import constants\\nfrom .logger import logger, console\\n\\n\\ndef open_file_if_needed(file_writer):\\n if file_writer_config[\\\"quiet\\\"]:\\n curr_stdout = sys.stdout\\n sys.stdout = open(os.devnull, \\\"w\\\")\\n\\n open_file = any(\\n [file_writer_config[\\\"preview\\\"], file_writer_config[\\\"show_file_in_finder\\\"]]\\n )\\n if open_file:\\n current_os = platform.system()\\n file_paths = []\\n\\n if file_writer_config[\\\"save_last_frame\\\"]:\\n file_paths.append(file_writer.get_image_file_path())\\n if file_writer_config[\\\"write_to_movie\\\"]:\\n file_paths.append(file_writer.get_movie_file_path())\\n\\n for file_path in file_paths:\\n if current_os == \\\"Windows\\\":\\n os.startfile(file_path)\\n else:\\n commands = []\\n if current_os == \\\"Linux\\\":\\n commands.append(\\\"xdg-open\\\")\\n elif current_os.startswith(\\\"CYGWIN\\\"):\\n commands.append(\\\"cygstart\\\")\\n else: # Assume macOS\\n commands.append(\\\"open\\\")\\n\\n if file_writer_config[\\\"show_file_in_finder\\\"]:\\n commands.append(\\\"-R\\\")\\n\\n commands.append(file_path)\\n\\n # commands.append(\\\"-g\\\")\\n FNULL = open(os.devnull, \\\"w\\\")\\n sp.call(commands, stdout=FNULL, stderr=sp.STDOUT)\\n FNULL.close()\\n\\n if file_writer_config[\\\"quiet\\\"]:\\n sys.stdout.close()\\n sys.stdout = curr_stdout\\n\\n\\ndef is_child_scene(obj, module):\\n return (\\n inspect.isclass(obj)\\n and issubclass(obj, Scene)\\n and obj != Scene\\n and obj.__module__.startswith(module.__name__)\\n )\\n\\n\\ndef prompt_user_for_choice(scene_classes):\\n num_to_class = {}\\n for count, scene_class in enumerate(scene_classes):\\n count += 1 # start with 1 instead of 0\\n name = scene_class.__name__\\n console.print(f\\\"{count}: {name}\\\", style=\\\"logging.level.info\\\")\\n num_to_class[count] = scene_class\\n try:\\n user_input = console.input(\\n f\\\"[log.message] {constants.CHOOSE_NUMBER_MESSAGE} [/log.message]\\\"\\n )\\n return [\\n num_to_class[int(num_str)]\\n for num_str in re.split(r\\\"\\\\s*,\\\\s*\\\", user_input.strip())\\n ]\\n except KeyError:\\n logger.error(constants.INVALID_NUMBER_MESSAGE)\\n sys.exit(2)\\n except EOFError:\\n sys.exit(1)\\n\\n\\ndef get_scenes_to_render(scene_classes):\\n if not scene_classes:\\n logger.error(constants.NO_SCENE_MESSAGE)\\n return []\\n if file_writer_config[\\\"write_all\\\"]:\\n return scene_classes\\n result = []\\n for scene_name in file_writer_config[\\\"scene_names\\\"]:\\n found = False\\n for scene_class in scene_classes:\\n if scene_class.__name__ == scene_name:\\n result.append(scene_class)\\n found = True\\n break\\n if not found and (scene_name != \\\"\\\"):\\n logger.error(constants.SCENE_NOT_FOUND_MESSAGE.format(scene_name))\\n if result:\\n return result\\n return (\\n [scene_classes[0]]\\n if len(scene_classes) == 1\\n else prompt_user_for_choice(scene_classes)\\n )\\n\\n\\ndef get_scene_classes_from_module(module):\\n return [\\n member[1]\\n for member in inspect.getmembers(module, lambda x: is_child_scene(x, module))\\n ]\\n\\n\\ndef get_module(file_name):\\n if file_name == \\\"-\\\":\\n module = types.ModuleType(\\\"input_scenes\\\")\\n logger.info(\\n \\\"Enter the animation's code & end with an EOF (CTRL+D on Linux/Unix, CTRL+Z on Windows):\\\"\\n )\\n code = sys.stdin.read()\\n if not code.startswith(\\\"from manim import\\\"):\\n logger.warn(\\n \\\"Didn't find an import statement for Manim. Importing automatically...\\\"\\n )\\n code = \\\"from manim import *\\\\n\\\" + code\\n logger.info(\\\"Rendering animation from typed code...\\\")\\n try:\\n exec(code, module.__dict__)\\n return module\\n except Exception as e:\\n logger.error(f\\\"Failed to render scene: {str(e)}\\\")\\n sys.exit(2)\\n else:\\n if os.path.exists(file_name):\\n if file_name[-3:] != \\\".py\\\":\\n raise Exception(f\\\"{file_name} is not a valid Manim python script.\\\")\\n module_name = file_name[:-3].replace(os.sep, \\\".\\\").split(\\\".\\\")[-1]\\n spec = importlib.util.spec_from_file_location(module_name, file_name)\\n module = importlib.util.module_from_spec(spec)\\n spec.loader.exec_module(module)\\n return module\\n else:\\n raise FileNotFoundError(f\\\"{file_name} not found\\\")\\n\\n\\ndef main():\\n module = get_module(file_writer_config[\\\"input_file\\\"])\\n all_scene_classes = get_scene_classes_from_module(module)\\n scene_classes_to_render = get_scenes_to_render(all_scene_classes)\\n sound_on = file_writer_config[\\\"sound\\\"]\\n for SceneClass in scene_classes_to_render:\\n try:\\n # By invoking, this renders the full scene\\n scene = SceneClass()\\n open_file_if_needed(scene.file_writer)\\n if sound_on:\\n play_finish_sound()\\n except Exception:\\n print(\\\"\\\\n\\\\n\\\")\\n traceback.print_exc()\\n print(\\\"\\\\n\\\\n\\\")\\n if sound_on:\\n play_error_sound()\\n\\n\\nif __name__ == \\\"__main__\\\":\\n main()\\n\",\n \"path\": \"manim/__main__.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import inspect\nimport os\nimport platform\nimport subprocess as sp\nimport sys\nimport re\nimport traceback\nimport importlib.util\nimport types\n\nfrom .config import file_writer_config\nfrom .scene.scene import Scene\nfrom .utils.sounds import play_error_sound\nfrom .utils.sounds import play_finish_sound\nfrom . import constants\nfrom .logger import logger,console\n\n\ndef open_file_if_needed(file_writer):\n if file_writer_config[\"quiet\"]:\n curr_stdout = sys.stdout\n sys.stdout = open(os.devnull, \"w\")\n\n open_file = any([\n file_writer_config[\"preview\"],\n file_writer_config[\"show_file_in_finder\"]\n ])\n if open_file:\n current_os = platform.system()\n file_paths = []\n\n if file_writer_config[\"save_last_frame\"]:\n file_paths.append(file_writer.get_image_file_path())\n if file_writer_config[\"write_to_movie\"]:\n file_paths.append(file_writer.get_movie_file_path())\n\n for file_path in file_paths:\n if current_os == \"Windows\":\n os.startfile(os.path.dirname(file_path))\n else:\n commands = []\n if current_os == \"Linux\":\n commands.append(\"xdg-open\")\n elif current_os.startswith(\"CYGWIN\"):\n commands.append(\"cygstart\")\n else: # Assume macOS\n commands.append(\"open\")\n\n if file_writer_config[\"show_file_in_finder\"]:\n commands.append(\"-R\")\n\n commands.append(file_path)\n\n # commands.append(\"-g\")\n FNULL = open(os.devnull, 'w')\n sp.call(commands, stdout=FNULL, stderr=sp.STDOUT)\n FNULL.close()\n\n if file_writer_config[\"quiet\"]:\n sys.stdout.close()\n sys.stdout = curr_stdout\n\n\ndef is_child_scene(obj, module):\n return (inspect.isclass(obj)\n and issubclass(obj, Scene)\n and obj != Scene\n and obj.__module__.startswith(module.__name__))\n\n\ndef prompt_user_for_choice(scene_classes):\n num_to_class = {}\n for count, scene_class in enumerate(scene_classes):\n count += 1 # start with 1 instead of 0\n name = scene_class.__name__\n console.print(f\"{count}: {name}\", style=\"logging.level.info\")\n num_to_class[count] = scene_class\n try:\n user_input = console.input(f\"[log.message] {constants.CHOOSE_NUMBER_MESSAGE} [/log.message]\")\n return [num_to_class[int(num_str)]\n for num_str in re.split(r\"\\s*,\\s*\", user_input.strip())]\n except KeyError:\n logger.error(constants.INVALID_NUMBER_MESSAGE)\n sys.exit(2)\n except EOFError:\n sys.exit(1)\n\n\ndef get_scenes_to_render(scene_classes):\n if not scene_classes:\n logger.error(constants.NO_SCENE_MESSAGE)\n return []\n if file_writer_config[\"write_all\"]:\n return scene_classes\n result = []\n for scene_name in file_writer_config[\"scene_names\"]:\n found = False\n for scene_class in scene_classes:\n if scene_class.__name__ == scene_name:\n result.append(scene_class)\n found = True\n break\n if not found and (scene_name != \"\"):\n logger.error(\n constants.SCENE_NOT_FOUND_MESSAGE.format(\n scene_name\n )\n )\n if result:\n return result\n return [scene_classes[0]] if len(scene_classes) == 1 else prompt_user_for_choice(scene_classes)\n\n\ndef get_scene_classes_from_module(module):\n return [\n member[1]\n for member in inspect.getmembers(\n module,\n lambda x: is_child_scene(x, module)\n )\n ]\n\n\ndef get_module(file_name):\n if file_name == \"-\":\n module = types.ModuleType(\"input_scenes\")\n logger.info(\"Enter the animation's code & end with an EOF (CTRL+D on Linux/Unix, CTRL+Z on Windows):\")\n code = sys.stdin.read()\n if not code.startswith(\"from manim import\"):\n logger.warn(\"Didn't find an import statement for Manim. Importing automatically...\")\n code=\"from manim import *\\n\"+code\n logger.info(\"Rendering animation from typed code...\")\n try:\n exec(code, module.__dict__)\n return module\n except Exception as e:\n logger.error(f\"Failed to render scene: {str(e)}\")\n sys.exit(2)\n else:\n if os.path.exists(file_name):\n if file_name[-3:] != \".py\":\n raise Exception(f\"{file_name} is not a valid Manim python script.\")\n module_name = file_name[:-3].replace(os.sep, '.').split('.')[-1]\n spec = importlib.util.spec_from_file_location(module_name, file_name)\n module = importlib.util.module_from_spec(spec)\n spec.loader.exec_module(module)\n return module\n else:\n raise FileNotFoundError(f'{file_name} not found')\n\n\ndef main():\n module = get_module(file_writer_config[\"input_file\"])\n all_scene_classes = get_scene_classes_from_module(module)\n scene_classes_to_render = get_scenes_to_render(all_scene_classes)\n sound_on = file_writer_config[\"sound\"]\n for SceneClass in scene_classes_to_render:\n try:\n # By invoking, this renders the full scene\n scene = SceneClass()\n open_file_if_needed(scene.file_writer)\n if sound_on:\n play_finish_sound()\n except Exception:\n print(\"\\n\\n\")\n traceback.print_exc()\n print(\"\\n\\n\")\n if sound_on:\n play_error_sound()\n\n\nif __name__ == \"__main__\":\n main()\n","path":"manim/__main__.py"}],"string":"[\n {\n \"content\": \"import inspect\\nimport os\\nimport platform\\nimport subprocess as sp\\nimport sys\\nimport re\\nimport traceback\\nimport importlib.util\\nimport types\\n\\nfrom .config import file_writer_config\\nfrom .scene.scene import Scene\\nfrom .utils.sounds import play_error_sound\\nfrom .utils.sounds import play_finish_sound\\nfrom . import constants\\nfrom .logger import logger,console\\n\\n\\ndef open_file_if_needed(file_writer):\\n if file_writer_config[\\\"quiet\\\"]:\\n curr_stdout = sys.stdout\\n sys.stdout = open(os.devnull, \\\"w\\\")\\n\\n open_file = any([\\n file_writer_config[\\\"preview\\\"],\\n file_writer_config[\\\"show_file_in_finder\\\"]\\n ])\\n if open_file:\\n current_os = platform.system()\\n file_paths = []\\n\\n if file_writer_config[\\\"save_last_frame\\\"]:\\n file_paths.append(file_writer.get_image_file_path())\\n if file_writer_config[\\\"write_to_movie\\\"]:\\n file_paths.append(file_writer.get_movie_file_path())\\n\\n for file_path in file_paths:\\n if current_os == \\\"Windows\\\":\\n os.startfile(os.path.dirname(file_path))\\n else:\\n commands = []\\n if current_os == \\\"Linux\\\":\\n commands.append(\\\"xdg-open\\\")\\n elif current_os.startswith(\\\"CYGWIN\\\"):\\n commands.append(\\\"cygstart\\\")\\n else: # Assume macOS\\n commands.append(\\\"open\\\")\\n\\n if file_writer_config[\\\"show_file_in_finder\\\"]:\\n commands.append(\\\"-R\\\")\\n\\n commands.append(file_path)\\n\\n # commands.append(\\\"-g\\\")\\n FNULL = open(os.devnull, 'w')\\n sp.call(commands, stdout=FNULL, stderr=sp.STDOUT)\\n FNULL.close()\\n\\n if file_writer_config[\\\"quiet\\\"]:\\n sys.stdout.close()\\n sys.stdout = curr_stdout\\n\\n\\ndef is_child_scene(obj, module):\\n return (inspect.isclass(obj)\\n and issubclass(obj, Scene)\\n and obj != Scene\\n and obj.__module__.startswith(module.__name__))\\n\\n\\ndef prompt_user_for_choice(scene_classes):\\n num_to_class = {}\\n for count, scene_class in enumerate(scene_classes):\\n count += 1 # start with 1 instead of 0\\n name = scene_class.__name__\\n console.print(f\\\"{count}: {name}\\\", style=\\\"logging.level.info\\\")\\n num_to_class[count] = scene_class\\n try:\\n user_input = console.input(f\\\"[log.message] {constants.CHOOSE_NUMBER_MESSAGE} [/log.message]\\\")\\n return [num_to_class[int(num_str)]\\n for num_str in re.split(r\\\"\\\\s*,\\\\s*\\\", user_input.strip())]\\n except KeyError:\\n logger.error(constants.INVALID_NUMBER_MESSAGE)\\n sys.exit(2)\\n except EOFError:\\n sys.exit(1)\\n\\n\\ndef get_scenes_to_render(scene_classes):\\n if not scene_classes:\\n logger.error(constants.NO_SCENE_MESSAGE)\\n return []\\n if file_writer_config[\\\"write_all\\\"]:\\n return scene_classes\\n result = []\\n for scene_name in file_writer_config[\\\"scene_names\\\"]:\\n found = False\\n for scene_class in scene_classes:\\n if scene_class.__name__ == scene_name:\\n result.append(scene_class)\\n found = True\\n break\\n if not found and (scene_name != \\\"\\\"):\\n logger.error(\\n constants.SCENE_NOT_FOUND_MESSAGE.format(\\n scene_name\\n )\\n )\\n if result:\\n return result\\n return [scene_classes[0]] if len(scene_classes) == 1 else prompt_user_for_choice(scene_classes)\\n\\n\\ndef get_scene_classes_from_module(module):\\n return [\\n member[1]\\n for member in inspect.getmembers(\\n module,\\n lambda x: is_child_scene(x, module)\\n )\\n ]\\n\\n\\ndef get_module(file_name):\\n if file_name == \\\"-\\\":\\n module = types.ModuleType(\\\"input_scenes\\\")\\n logger.info(\\\"Enter the animation's code & end with an EOF (CTRL+D on Linux/Unix, CTRL+Z on Windows):\\\")\\n code = sys.stdin.read()\\n if not code.startswith(\\\"from manim import\\\"):\\n logger.warn(\\\"Didn't find an import statement for Manim. Importing automatically...\\\")\\n code=\\\"from manim import *\\\\n\\\"+code\\n logger.info(\\\"Rendering animation from typed code...\\\")\\n try:\\n exec(code, module.__dict__)\\n return module\\n except Exception as e:\\n logger.error(f\\\"Failed to render scene: {str(e)}\\\")\\n sys.exit(2)\\n else:\\n if os.path.exists(file_name):\\n if file_name[-3:] != \\\".py\\\":\\n raise Exception(f\\\"{file_name} is not a valid Manim python script.\\\")\\n module_name = file_name[:-3].replace(os.sep, '.').split('.')[-1]\\n spec = importlib.util.spec_from_file_location(module_name, file_name)\\n module = importlib.util.module_from_spec(spec)\\n spec.loader.exec_module(module)\\n return module\\n else:\\n raise FileNotFoundError(f'{file_name} not found')\\n\\n\\ndef main():\\n module = get_module(file_writer_config[\\\"input_file\\\"])\\n all_scene_classes = get_scene_classes_from_module(module)\\n scene_classes_to_render = get_scenes_to_render(all_scene_classes)\\n sound_on = file_writer_config[\\\"sound\\\"]\\n for SceneClass in scene_classes_to_render:\\n try:\\n # By invoking, this renders the full scene\\n scene = SceneClass()\\n open_file_if_needed(scene.file_writer)\\n if sound_on:\\n play_finish_sound()\\n except Exception:\\n print(\\\"\\\\n\\\\n\\\")\\n traceback.print_exc()\\n print(\\\"\\\\n\\\\n\\\")\\n if sound_on:\\n play_error_sound()\\n\\n\\nif __name__ == \\\"__main__\\\":\\n main()\\n\",\n \"path\": \"manim/__main__.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/manim/__main__.py b/manim/__main__.py\nindex fed9b7827a..1cee5c05a5 100644\n--- a/manim/__main__.py\n+++ b/manim/__main__.py\n@@ -36,7 +36,7 @@ def open_file_if_needed(file_writer):\n \n for file_path in file_paths:\n if current_os == \"Windows\":\n- os.startfile(file_path)\n+ os.startfile(os.path.dirname(file_path))\n else:\n commands = []\n if current_os == \"Linux\":\n"}}},{"rowIdx":2690,"cells":{"in_source_id":{"kind":"string","value":"plotly__plotly.py-3763"},"issue":{"kind":"string","value":"graphs from plotly >= 5.8 don't render in databricks\ndisplaying a python figure in an iframe within databricks works with plotly==5.7 but when I attempt to do it using 5.8 it fails with `Uncaught SyntaxError: Unexpected token '&&'`:\r\n\r\n\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"import uuid\nimport os\nfrom pathlib import Path\nimport webbrowser\n\nfrom _plotly_utils.optional_imports import get_module\nfrom plotly.io._utils import validate_coerce_fig_to_dict, plotly_cdn_url\nfrom plotly.offline.offline import _get_jconfig, get_plotlyjs\nfrom plotly import utils\n\n_json = get_module(\"json\")\n\n\n# Build script to set global PlotlyConfig object. This must execute before\n# plotly.js is loaded.\n_window_plotly_config = \"\"\"\\\n<script type=\"text/javascript\">\\\nwindow.PlotlyConfig = {MathJaxConfig: 'local'};\\\n</script>\"\"\"\n\n_mathjax_config = \"\"\"\\\n<script type=\"text/javascript\">\\\nif (window.MathJax && window.MathJax.Hub && && window.MathJax.Hub.Config) {window.MathJax.Hub.Config({SVG: {font: \"STIX-Web\"}});}\\\n</script>\"\"\"\n\n\ndef to_html(\n fig,\n config=None,\n auto_play=True,\n include_plotlyjs=True,\n include_mathjax=False,\n post_script=None,\n full_html=True,\n animation_opts=None,\n default_width=\"100%\",\n default_height=\"100%\",\n validate=True,\n div_id=None,\n):\n \"\"\"\n Convert a figure to an HTML string representation.\n\n Parameters\n ----------\n fig:\n Figure object or dict representing a figure\n config: dict or None (default None)\n Plotly.js figure config options\n auto_play: bool (default=True)\n Whether to automatically start the animation sequence on page load\n if the figure contains frames. Has no effect if the figure does not\n contain frames.\n include_plotlyjs: bool or string (default True)\n Specifies how the plotly.js library is included/loaded in the output\n div string.\n\n If True, a script tag containing the plotly.js source code (~3MB)\n is included in the output. HTML files generated with this option are\n fully self-contained and can be used offline.\n\n If 'cdn', a script tag that references the plotly.js CDN is included\n in the output. The url used is versioned to match the bundled plotly.js.\n HTML files generated with this option are about 3MB smaller than those\n generated with include_plotlyjs=True, but they require an active\n internet connection in order to load the plotly.js library.\n\n If 'directory', a script tag is included that references an external\n plotly.min.js bundle that is assumed to reside in the same\n directory as the HTML file.\n\n If 'require', Plotly.js is loaded using require.js. This option\n assumes that require.js is globally available and that it has been\n globally configured to know how to find Plotly.js as 'plotly'.\n This option is not advised when full_html=True as it will result\n in a non-functional html file.\n\n If a string that ends in '.js', a script tag is included that\n references the specified path. This approach can be used to point\n the resulting HTML file to an alternative CDN or local bundle.\n\n If False, no script tag referencing plotly.js is included. This is\n useful when the resulting div string will be placed inside an HTML\n document that already loads plotly.js. This option is not advised\n when full_html=True as it will result in a non-functional html file.\n include_mathjax: bool or string (default False)\n Specifies how the MathJax.js library is included in the output html\n div string. MathJax is required in order to display labels\n with LaTeX typesetting.\n\n If False, no script tag referencing MathJax.js will be included in the\n output.\n\n If 'cdn', a script tag that references a MathJax CDN location will be\n included in the output. HTML div strings generated with this option\n will be able to display LaTeX typesetting as long as internet access\n is available.\n\n If a string that ends in '.js', a script tag is included that\n references the specified path. This approach can be used to point the\n resulting HTML div string to an alternative CDN.\n post_script: str or list or None (default None)\n JavaScript snippet(s) to be included in the resulting div just after\n plot creation. The string(s) may include '{plot_id}' placeholders\n that will then be replaced by the `id` of the div element that the\n plotly.js figure is associated with. One application for this script\n is to install custom plotly.js event handlers.\n full_html: bool (default True)\n If True, produce a string containing a complete HTML document\n starting with an <html> tag. If False, produce a string containing\n a single <div> element.\n animation_opts: dict or None (default None)\n dict of custom animation parameters to be passed to the function\n Plotly.animate in Plotly.js. See\n https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js\n for available options. Has no effect if the figure does not contain\n frames, or auto_play is False.\n default_width, default_height: number or str (default '100%')\n The default figure width/height to use if the provided figure does not\n specify its own layout.width/layout.height property. May be\n specified in pixels as an integer (e.g. 500), or as a css width style\n string (e.g. '500px', '100%').\n validate: bool (default True)\n True if the figure should be validated before being converted to\n JSON, False otherwise.\n div_id: str (default None)\n If provided, this is the value of the id attribute of the div tag. If None, the\n id attribute is a UUID.\n\n Returns\n -------\n str\n Representation of figure as an HTML div string\n \"\"\"\n from plotly.io.json import to_json_plotly\n\n # ## Validate figure ##\n fig_dict = validate_coerce_fig_to_dict(fig, validate)\n\n # ## Generate div id ##\n plotdivid = div_id or str(uuid.uuid4())\n\n # ## Serialize figure ##\n jdata = to_json_plotly(fig_dict.get(\"data\", []))\n jlayout = to_json_plotly(fig_dict.get(\"layout\", {}))\n\n if fig_dict.get(\"frames\", None):\n jframes = to_json_plotly(fig_dict.get(\"frames\", []))\n else:\n jframes = None\n\n # ## Serialize figure config ##\n config = _get_jconfig(config)\n\n # Set responsive\n config.setdefault(\"responsive\", True)\n\n # Get div width/height\n layout_dict = fig_dict.get(\"layout\", {})\n template_dict = fig_dict.get(\"layout\", {}).get(\"template\", {}).get(\"layout\", {})\n\n div_width = layout_dict.get(\"width\", template_dict.get(\"width\", default_width))\n div_height = layout_dict.get(\"height\", template_dict.get(\"height\", default_height))\n\n # Add 'px' suffix to numeric widths\n try:\n float(div_width)\n except (ValueError, TypeError):\n pass\n else:\n div_width = str(div_width) + \"px\"\n\n try:\n float(div_height)\n except (ValueError, TypeError):\n pass\n else:\n div_height = str(div_height) + \"px\"\n\n # ## Get platform URL ##\n if config.get(\"showLink\", False) or config.get(\"showSendToCloud\", False):\n # Figure is going to include a Chart Studio link or send-to-cloud button,\n # So we need to configure the PLOTLYENV.BASE_URL property\n base_url_line = \"\"\"\n window.PLOTLYENV.BASE_URL='{plotly_platform_url}';\\\n\"\"\".format(\n plotly_platform_url=config.get(\"plotlyServerURL\", \"https://plot.ly\")\n )\n else:\n # Figure is not going to include a Chart Studio link or send-to-cloud button,\n # In this case we don't want https://plot.ly to show up anywhere in the HTML\n # output\n config.pop(\"plotlyServerURL\", None)\n config.pop(\"linkText\", None)\n config.pop(\"showLink\", None)\n base_url_line = \"\"\n\n # ## Build script body ##\n # This is the part that actually calls Plotly.js\n\n # build post script snippet(s)\n then_post_script = \"\"\n if post_script:\n if not isinstance(post_script, (list, tuple)):\n post_script = [post_script]\n for ps in post_script:\n then_post_script += \"\"\".then(function(){{\n {post_script}\n }})\"\"\".format(\n post_script=ps.replace(\"{plot_id}\", plotdivid)\n )\n\n then_addframes = \"\"\n then_animate = \"\"\n if jframes:\n then_addframes = \"\"\".then(function(){{\n Plotly.addFrames('{id}', {frames});\n }})\"\"\".format(\n id=plotdivid, frames=jframes\n )\n\n if auto_play:\n if animation_opts:\n animation_opts_arg = \", \" + _json.dumps(animation_opts)\n else:\n animation_opts_arg = \"\"\n then_animate = \"\"\".then(function(){{\n Plotly.animate('{id}', null{animation_opts});\n }})\"\"\".format(\n id=plotdivid, animation_opts=animation_opts_arg\n )\n\n # Serialize config dict to JSON\n jconfig = _json.dumps(config)\n\n script = \"\"\"\\\n if (document.getElementById(\"{id}\")) {{\\\n Plotly.newPlot(\\\n \"{id}\",\\\n {data},\\\n {layout},\\\n {config}\\\n ){then_addframes}{then_animate}{then_post_script}\\\n }}\"\"\".format(\n id=plotdivid,\n data=jdata,\n layout=jlayout,\n config=jconfig,\n then_addframes=then_addframes,\n then_animate=then_animate,\n then_post_script=then_post_script,\n )\n\n # ## Handle loading/initializing plotly.js ##\n include_plotlyjs_orig = include_plotlyjs\n if isinstance(include_plotlyjs, str):\n include_plotlyjs = include_plotlyjs.lower()\n\n # Start/end of requirejs block (if any)\n require_start = \"\"\n require_end = \"\"\n\n # Init and load\n load_plotlyjs = \"\"\n\n # Init plotlyjs. This block needs to run before plotly.js is loaded in\n # order for MathJax configuration to work properly\n if include_plotlyjs == \"require\":\n require_start = 'require([\"plotly\"], function(Plotly) {'\n require_end = \"});\"\n\n elif include_plotlyjs == \"cdn\":\n load_plotlyjs = \"\"\"\\\n {win_config}\n <script src=\"{cdn_url}\"></script>\\\n \"\"\".format(\n win_config=_window_plotly_config, cdn_url=plotly_cdn_url()\n )\n\n elif include_plotlyjs == \"directory\":\n load_plotlyjs = \"\"\"\\\n {win_config}\n <script src=\"plotly.min.js\"></script>\\\n \"\"\".format(\n win_config=_window_plotly_config\n )\n\n elif isinstance(include_plotlyjs, str) and include_plotlyjs.endswith(\".js\"):\n load_plotlyjs = \"\"\"\\\n {win_config}\n <script src=\"{url}\"></script>\\\n \"\"\".format(\n win_config=_window_plotly_config, url=include_plotlyjs_orig\n )\n\n elif include_plotlyjs:\n load_plotlyjs = \"\"\"\\\n {win_config}\n <script type=\"text/javascript\">{plotlyjs}</script>\\\n \"\"\".format(\n win_config=_window_plotly_config, plotlyjs=get_plotlyjs()\n )\n\n # ## Handle loading/initializing MathJax ##\n include_mathjax_orig = include_mathjax\n if isinstance(include_mathjax, str):\n include_mathjax = include_mathjax.lower()\n\n mathjax_template = \"\"\"\\\n <script src=\"{url}?config=TeX-AMS-MML_SVG\"></script>\"\"\"\n\n if include_mathjax == \"cdn\":\n mathjax_script = (\n mathjax_template.format(\n url=(\n \"https://cdnjs.cloudflare.com\" \"/ajax/libs/mathjax/2.7.5/MathJax.js\"\n )\n )\n + _mathjax_config\n )\n\n elif isinstance(include_mathjax, str) and include_mathjax.endswith(\".js\"):\n\n mathjax_script = (\n mathjax_template.format(url=include_mathjax_orig) + _mathjax_config\n )\n elif not include_mathjax:\n mathjax_script = \"\"\n else:\n raise ValueError(\n \"\"\"\\\nInvalid value of type {typ} received as the include_mathjax argument\n Received value: {val}\n\ninclude_mathjax may be specified as False, 'cdn', or a string ending with '.js'\n \"\"\".format(\n typ=type(include_mathjax), val=repr(include_mathjax)\n )\n )\n\n plotly_html_div = \"\"\"\\\n<div>\\\n {mathjax_script}\\\n {load_plotlyjs}\\\n <div id=\"{id}\" class=\"plotly-graph-div\" \\\nstyle=\"height:{height}; width:{width};\"></div>\\\n <script type=\"text/javascript\">\\\n {require_start}\\\n window.PLOTLYENV=window.PLOTLYENV || {{}};{base_url_line}\\\n {script};\\\n {require_end}\\\n </script>\\\n </div>\"\"\".format(\n mathjax_script=mathjax_script,\n load_plotlyjs=load_plotlyjs,\n id=plotdivid,\n width=div_width,\n height=div_height,\n base_url_line=base_url_line,\n require_start=require_start,\n script=script,\n require_end=require_end,\n ).strip()\n\n if full_html:\n return \"\"\"\\\n<html>\n<head><meta charset=\"utf-8\" /></head>\n<body>\n {div}\n</body>\n</html>\"\"\".format(\n div=plotly_html_div\n )\n else:\n return plotly_html_div\n\n\ndef write_html(\n fig,\n file,\n config=None,\n auto_play=True,\n include_plotlyjs=True,\n include_mathjax=False,\n post_script=None,\n full_html=True,\n animation_opts=None,\n validate=True,\n default_width=\"100%\",\n default_height=\"100%\",\n auto_open=False,\n div_id=None,\n):\n \"\"\"\n Write a figure to an HTML file representation\n\n Parameters\n ----------\n fig:\n Figure object or dict representing a figure\n file: str or writeable\n A string representing a local file path or a writeable object\n (e.g. a pathlib.Path object or an open file descriptor)\n config: dict or None (default None)\n Plotly.js figure config options\n auto_play: bool (default=True)\n Whether to automatically start the animation sequence on page load\n if the figure contains frames. Has no effect if the figure does not\n contain frames.\n include_plotlyjs: bool or string (default True)\n Specifies how the plotly.js library is included/loaded in the output\n div string.\n\n If True, a script tag containing the plotly.js source code (~3MB)\n is included in the output. HTML files generated with this option are\n fully self-contained and can be used offline.\n\n If 'cdn', a script tag that references the plotly.js CDN is included\n in the output. The url used is versioned to match the bundled plotly.js.\n HTML files generated with this option are about 3MB smaller than those\n generated with include_plotlyjs=True, but they require an active\n internet connection in order to load the plotly.js library.\n\n If 'directory', a script tag is included that references an external\n plotly.min.js bundle that is assumed to reside in the same\n directory as the HTML file. If `file` is a string to a local file\n path and `full_html` is True, then the plotly.min.js bundle is copied\n into the directory of the resulting HTML file. If a file named\n plotly.min.js already exists in the output directory then this file\n is left unmodified and no copy is performed. HTML files generated\n with this option can be used offline, but they require a copy of\n the plotly.min.js bundle in the same directory. This option is\n useful when many figures will be saved as HTML files in the same\n directory because the plotly.js source code will be included only\n once per output directory, rather than once per output file.\n\n If 'require', Plotly.js is loaded using require.js. This option\n assumes that require.js is globally available and that it has been\n globally configured to know how to find Plotly.js as 'plotly'.\n This option is not advised when full_html=True as it will result\n in a non-functional html file.\n\n If a string that ends in '.js', a script tag is included that\n references the specified path. This approach can be used to point\n the resulting HTML file to an alternative CDN or local bundle.\n\n If False, no script tag referencing plotly.js is included. This is\n useful when the resulting div string will be placed inside an HTML\n document that already loads plotly.js. This option is not advised\n when full_html=True as it will result in a non-functional html file.\n\n include_mathjax: bool or string (default False)\n Specifies how the MathJax.js library is included in the output html\n div string. MathJax is required in order to display labels\n with LaTeX typesetting.\n\n If False, no script tag referencing MathJax.js will be included in the\n output.\n\n If 'cdn', a script tag that references a MathJax CDN location will be\n included in the output. HTML div strings generated with this option\n will be able to display LaTeX typesetting as long as internet access\n is available.\n\n If a string that ends in '.js', a script tag is included that\n references the specified path. This approach can be used to point the\n resulting HTML div string to an alternative CDN.\n post_script: str or list or None (default None)\n JavaScript snippet(s) to be included in the resulting div just after\n plot creation. The string(s) may include '{plot_id}' placeholders\n that will then be replaced by the `id` of the div element that the\n plotly.js figure is associated with. One application for this script\n is to install custom plotly.js event handlers.\n full_html: bool (default True)\n If True, produce a string containing a complete HTML document\n starting with an <html> tag. If False, produce a string containing\n a single <div> element.\n animation_opts: dict or None (default None)\n dict of custom animation parameters to be passed to the function\n Plotly.animate in Plotly.js. See\n https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js\n for available options. Has no effect if the figure does not contain\n frames, or auto_play is False.\n default_width, default_height: number or str (default '100%')\n The default figure width/height to use if the provided figure does not\n specify its own layout.width/layout.height property. May be\n specified in pixels as an integer (e.g. 500), or as a css width style\n string (e.g. '500px', '100%').\n validate: bool (default True)\n True if the figure should be validated before being converted to\n JSON, False otherwise.\n auto_open: bool (default True)\n If True, open the saved file in a web browser after saving.\n This argument only applies if `full_html` is True.\n div_id: str (default None)\n If provided, this is the value of the id attribute of the div tag. If None, the\n id attribute is a UUID.\n\n Returns\n -------\n str\n Representation of figure as an HTML div string\n \"\"\"\n\n # Build HTML string\n html_str = to_html(\n fig,\n config=config,\n auto_play=auto_play,\n include_plotlyjs=include_plotlyjs,\n include_mathjax=include_mathjax,\n post_script=post_script,\n full_html=full_html,\n animation_opts=animation_opts,\n default_width=default_width,\n default_height=default_height,\n validate=validate,\n div_id=div_id,\n )\n\n # Check if file is a string\n if isinstance(file, str):\n # Use the standard pathlib constructor to make a pathlib object.\n path = Path(file)\n elif isinstance(file, Path): # PurePath is the most general pathlib object.\n # `file` is already a pathlib object.\n path = file\n else:\n # We could not make a pathlib object out of file. Either `file` is an open file\n # descriptor with a `write()` method or it's an invalid object.\n path = None\n\n # Write HTML string\n if path is not None:\n path.write_text(html_str)\n else:\n file.write(html_str)\n\n # Check if we should copy plotly.min.js to output directory\n if path is not None and full_html and include_plotlyjs == \"directory\":\n bundle_path = path.parent / \"plotly.min.js\"\n\n if not bundle_path.exists():\n bundle_path.write_text(get_plotlyjs())\n\n # Handle auto_open\n if path is not None and full_html and auto_open:\n url = path.absolute().as_uri()\n webbrowser.open(url)\n","path":"packages/python/plotly/plotly/io/_html.py"}],"string":"[\n {\n \"content\": \"import uuid\\nimport os\\nfrom pathlib import Path\\nimport webbrowser\\n\\nfrom _plotly_utils.optional_imports import get_module\\nfrom plotly.io._utils import validate_coerce_fig_to_dict, plotly_cdn_url\\nfrom plotly.offline.offline import _get_jconfig, get_plotlyjs\\nfrom plotly import utils\\n\\n_json = get_module(\\\"json\\\")\\n\\n\\n# Build script to set global PlotlyConfig object. This must execute before\\n# plotly.js is loaded.\\n_window_plotly_config = \\\"\\\"\\\"\\\\\\n<script type=\\\"text/javascript\\\">\\\\\\nwindow.PlotlyConfig = {MathJaxConfig: 'local'};\\\\\\n</script>\\\"\\\"\\\"\\n\\n_mathjax_config = \\\"\\\"\\\"\\\\\\n<script type=\\\"text/javascript\\\">\\\\\\nif (window.MathJax && window.MathJax.Hub && && window.MathJax.Hub.Config) {window.MathJax.Hub.Config({SVG: {font: \\\"STIX-Web\\\"}});}\\\\\\n</script>\\\"\\\"\\\"\\n\\n\\ndef to_html(\\n fig,\\n config=None,\\n auto_play=True,\\n include_plotlyjs=True,\\n include_mathjax=False,\\n post_script=None,\\n full_html=True,\\n animation_opts=None,\\n default_width=\\\"100%\\\",\\n default_height=\\\"100%\\\",\\n validate=True,\\n div_id=None,\\n):\\n \\\"\\\"\\\"\\n Convert a figure to an HTML string representation.\\n\\n Parameters\\n ----------\\n fig:\\n Figure object or dict representing a figure\\n config: dict or None (default None)\\n Plotly.js figure config options\\n auto_play: bool (default=True)\\n Whether to automatically start the animation sequence on page load\\n if the figure contains frames. Has no effect if the figure does not\\n contain frames.\\n include_plotlyjs: bool or string (default True)\\n Specifies how the plotly.js library is included/loaded in the output\\n div string.\\n\\n If True, a script tag containing the plotly.js source code (~3MB)\\n is included in the output. HTML files generated with this option are\\n fully self-contained and can be used offline.\\n\\n If 'cdn', a script tag that references the plotly.js CDN is included\\n in the output. The url used is versioned to match the bundled plotly.js.\\n HTML files generated with this option are about 3MB smaller than those\\n generated with include_plotlyjs=True, but they require an active\\n internet connection in order to load the plotly.js library.\\n\\n If 'directory', a script tag is included that references an external\\n plotly.min.js bundle that is assumed to reside in the same\\n directory as the HTML file.\\n\\n If 'require', Plotly.js is loaded using require.js. This option\\n assumes that require.js is globally available and that it has been\\n globally configured to know how to find Plotly.js as 'plotly'.\\n This option is not advised when full_html=True as it will result\\n in a non-functional html file.\\n\\n If a string that ends in '.js', a script tag is included that\\n references the specified path. This approach can be used to point\\n the resulting HTML file to an alternative CDN or local bundle.\\n\\n If False, no script tag referencing plotly.js is included. This is\\n useful when the resulting div string will be placed inside an HTML\\n document that already loads plotly.js. This option is not advised\\n when full_html=True as it will result in a non-functional html file.\\n include_mathjax: bool or string (default False)\\n Specifies how the MathJax.js library is included in the output html\\n div string. MathJax is required in order to display labels\\n with LaTeX typesetting.\\n\\n If False, no script tag referencing MathJax.js will be included in the\\n output.\\n\\n If 'cdn', a script tag that references a MathJax CDN location will be\\n included in the output. HTML div strings generated with this option\\n will be able to display LaTeX typesetting as long as internet access\\n is available.\\n\\n If a string that ends in '.js', a script tag is included that\\n references the specified path. This approach can be used to point the\\n resulting HTML div string to an alternative CDN.\\n post_script: str or list or None (default None)\\n JavaScript snippet(s) to be included in the resulting div just after\\n plot creation. The string(s) may include '{plot_id}' placeholders\\n that will then be replaced by the `id` of the div element that the\\n plotly.js figure is associated with. One application for this script\\n is to install custom plotly.js event handlers.\\n full_html: bool (default True)\\n If True, produce a string containing a complete HTML document\\n starting with an <html> tag. If False, produce a string containing\\n a single <div> element.\\n animation_opts: dict or None (default None)\\n dict of custom animation parameters to be passed to the function\\n Plotly.animate in Plotly.js. See\\n https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js\\n for available options. Has no effect if the figure does not contain\\n frames, or auto_play is False.\\n default_width, default_height: number or str (default '100%')\\n The default figure width/height to use if the provided figure does not\\n specify its own layout.width/layout.height property. May be\\n specified in pixels as an integer (e.g. 500), or as a css width style\\n string (e.g. '500px', '100%').\\n validate: bool (default True)\\n True if the figure should be validated before being converted to\\n JSON, False otherwise.\\n div_id: str (default None)\\n If provided, this is the value of the id attribute of the div tag. If None, the\\n id attribute is a UUID.\\n\\n Returns\\n -------\\n str\\n Representation of figure as an HTML div string\\n \\\"\\\"\\\"\\n from plotly.io.json import to_json_plotly\\n\\n # ## Validate figure ##\\n fig_dict = validate_coerce_fig_to_dict(fig, validate)\\n\\n # ## Generate div id ##\\n plotdivid = div_id or str(uuid.uuid4())\\n\\n # ## Serialize figure ##\\n jdata = to_json_plotly(fig_dict.get(\\\"data\\\", []))\\n jlayout = to_json_plotly(fig_dict.get(\\\"layout\\\", {}))\\n\\n if fig_dict.get(\\\"frames\\\", None):\\n jframes = to_json_plotly(fig_dict.get(\\\"frames\\\", []))\\n else:\\n jframes = None\\n\\n # ## Serialize figure config ##\\n config = _get_jconfig(config)\\n\\n # Set responsive\\n config.setdefault(\\\"responsive\\\", True)\\n\\n # Get div width/height\\n layout_dict = fig_dict.get(\\\"layout\\\", {})\\n template_dict = fig_dict.get(\\\"layout\\\", {}).get(\\\"template\\\", {}).get(\\\"layout\\\", {})\\n\\n div_width = layout_dict.get(\\\"width\\\", template_dict.get(\\\"width\\\", default_width))\\n div_height = layout_dict.get(\\\"height\\\", template_dict.get(\\\"height\\\", default_height))\\n\\n # Add 'px' suffix to numeric widths\\n try:\\n float(div_width)\\n except (ValueError, TypeError):\\n pass\\n else:\\n div_width = str(div_width) + \\\"px\\\"\\n\\n try:\\n float(div_height)\\n except (ValueError, TypeError):\\n pass\\n else:\\n div_height = str(div_height) + \\\"px\\\"\\n\\n # ## Get platform URL ##\\n if config.get(\\\"showLink\\\", False) or config.get(\\\"showSendToCloud\\\", False):\\n # Figure is going to include a Chart Studio link or send-to-cloud button,\\n # So we need to configure the PLOTLYENV.BASE_URL property\\n base_url_line = \\\"\\\"\\\"\\n window.PLOTLYENV.BASE_URL='{plotly_platform_url}';\\\\\\n\\\"\\\"\\\".format(\\n plotly_platform_url=config.get(\\\"plotlyServerURL\\\", \\\"https://plot.ly\\\")\\n )\\n else:\\n # Figure is not going to include a Chart Studio link or send-to-cloud button,\\n # In this case we don't want https://plot.ly to show up anywhere in the HTML\\n # output\\n config.pop(\\\"plotlyServerURL\\\", None)\\n config.pop(\\\"linkText\\\", None)\\n config.pop(\\\"showLink\\\", None)\\n base_url_line = \\\"\\\"\\n\\n # ## Build script body ##\\n # This is the part that actually calls Plotly.js\\n\\n # build post script snippet(s)\\n then_post_script = \\\"\\\"\\n if post_script:\\n if not isinstance(post_script, (list, tuple)):\\n post_script = [post_script]\\n for ps in post_script:\\n then_post_script += \\\"\\\"\\\".then(function(){{\\n {post_script}\\n }})\\\"\\\"\\\".format(\\n post_script=ps.replace(\\\"{plot_id}\\\", plotdivid)\\n )\\n\\n then_addframes = \\\"\\\"\\n then_animate = \\\"\\\"\\n if jframes:\\n then_addframes = \\\"\\\"\\\".then(function(){{\\n Plotly.addFrames('{id}', {frames});\\n }})\\\"\\\"\\\".format(\\n id=plotdivid, frames=jframes\\n )\\n\\n if auto_play:\\n if animation_opts:\\n animation_opts_arg = \\\", \\\" + _json.dumps(animation_opts)\\n else:\\n animation_opts_arg = \\\"\\\"\\n then_animate = \\\"\\\"\\\".then(function(){{\\n Plotly.animate('{id}', null{animation_opts});\\n }})\\\"\\\"\\\".format(\\n id=plotdivid, animation_opts=animation_opts_arg\\n )\\n\\n # Serialize config dict to JSON\\n jconfig = _json.dumps(config)\\n\\n script = \\\"\\\"\\\"\\\\\\n if (document.getElementById(\\\"{id}\\\")) {{\\\\\\n Plotly.newPlot(\\\\\\n \\\"{id}\\\",\\\\\\n {data},\\\\\\n {layout},\\\\\\n {config}\\\\\\n ){then_addframes}{then_animate}{then_post_script}\\\\\\n }}\\\"\\\"\\\".format(\\n id=plotdivid,\\n data=jdata,\\n layout=jlayout,\\n config=jconfig,\\n then_addframes=then_addframes,\\n then_animate=then_animate,\\n then_post_script=then_post_script,\\n )\\n\\n # ## Handle loading/initializing plotly.js ##\\n include_plotlyjs_orig = include_plotlyjs\\n if isinstance(include_plotlyjs, str):\\n include_plotlyjs = include_plotlyjs.lower()\\n\\n # Start/end of requirejs block (if any)\\n require_start = \\\"\\\"\\n require_end = \\\"\\\"\\n\\n # Init and load\\n load_plotlyjs = \\\"\\\"\\n\\n # Init plotlyjs. This block needs to run before plotly.js is loaded in\\n # order for MathJax configuration to work properly\\n if include_plotlyjs == \\\"require\\\":\\n require_start = 'require([\\\"plotly\\\"], function(Plotly) {'\\n require_end = \\\"});\\\"\\n\\n elif include_plotlyjs == \\\"cdn\\\":\\n load_plotlyjs = \\\"\\\"\\\"\\\\\\n {win_config}\\n <script src=\\\"{cdn_url}\\\"></script>\\\\\\n \\\"\\\"\\\".format(\\n win_config=_window_plotly_config, cdn_url=plotly_cdn_url()\\n )\\n\\n elif include_plotlyjs == \\\"directory\\\":\\n load_plotlyjs = \\\"\\\"\\\"\\\\\\n {win_config}\\n <script src=\\\"plotly.min.js\\\"></script>\\\\\\n \\\"\\\"\\\".format(\\n win_config=_window_plotly_config\\n )\\n\\n elif isinstance(include_plotlyjs, str) and include_plotlyjs.endswith(\\\".js\\\"):\\n load_plotlyjs = \\\"\\\"\\\"\\\\\\n {win_config}\\n <script src=\\\"{url}\\\"></script>\\\\\\n \\\"\\\"\\\".format(\\n win_config=_window_plotly_config, url=include_plotlyjs_orig\\n )\\n\\n elif include_plotlyjs:\\n load_plotlyjs = \\\"\\\"\\\"\\\\\\n {win_config}\\n <script type=\\\"text/javascript\\\">{plotlyjs}</script>\\\\\\n \\\"\\\"\\\".format(\\n win_config=_window_plotly_config, plotlyjs=get_plotlyjs()\\n )\\n\\n # ## Handle loading/initializing MathJax ##\\n include_mathjax_orig = include_mathjax\\n if isinstance(include_mathjax, str):\\n include_mathjax = include_mathjax.lower()\\n\\n mathjax_template = \\\"\\\"\\\"\\\\\\n <script src=\\\"{url}?config=TeX-AMS-MML_SVG\\\"></script>\\\"\\\"\\\"\\n\\n if include_mathjax == \\\"cdn\\\":\\n mathjax_script = (\\n mathjax_template.format(\\n url=(\\n \\\"https://cdnjs.cloudflare.com\\\" \\\"/ajax/libs/mathjax/2.7.5/MathJax.js\\\"\\n )\\n )\\n + _mathjax_config\\n )\\n\\n elif isinstance(include_mathjax, str) and include_mathjax.endswith(\\\".js\\\"):\\n\\n mathjax_script = (\\n mathjax_template.format(url=include_mathjax_orig) + _mathjax_config\\n )\\n elif not include_mathjax:\\n mathjax_script = \\\"\\\"\\n else:\\n raise ValueError(\\n \\\"\\\"\\\"\\\\\\nInvalid value of type {typ} received as the include_mathjax argument\\n Received value: {val}\\n\\ninclude_mathjax may be specified as False, 'cdn', or a string ending with '.js'\\n \\\"\\\"\\\".format(\\n typ=type(include_mathjax), val=repr(include_mathjax)\\n )\\n )\\n\\n plotly_html_div = \\\"\\\"\\\"\\\\\\n<div>\\\\\\n {mathjax_script}\\\\\\n {load_plotlyjs}\\\\\\n <div id=\\\"{id}\\\" class=\\\"plotly-graph-div\\\" \\\\\\nstyle=\\\"height:{height}; width:{width};\\\"></div>\\\\\\n <script type=\\\"text/javascript\\\">\\\\\\n {require_start}\\\\\\n window.PLOTLYENV=window.PLOTLYENV || {{}};{base_url_line}\\\\\\n {script};\\\\\\n {require_end}\\\\\\n </script>\\\\\\n </div>\\\"\\\"\\\".format(\\n mathjax_script=mathjax_script,\\n load_plotlyjs=load_plotlyjs,\\n id=plotdivid,\\n width=div_width,\\n height=div_height,\\n base_url_line=base_url_line,\\n require_start=require_start,\\n script=script,\\n require_end=require_end,\\n ).strip()\\n\\n if full_html:\\n return \\\"\\\"\\\"\\\\\\n<html>\\n<head><meta charset=\\\"utf-8\\\" /></head>\\n<body>\\n {div}\\n</body>\\n</html>\\\"\\\"\\\".format(\\n div=plotly_html_div\\n )\\n else:\\n return plotly_html_div\\n\\n\\ndef write_html(\\n fig,\\n file,\\n config=None,\\n auto_play=True,\\n include_plotlyjs=True,\\n include_mathjax=False,\\n post_script=None,\\n full_html=True,\\n animation_opts=None,\\n validate=True,\\n default_width=\\\"100%\\\",\\n default_height=\\\"100%\\\",\\n auto_open=False,\\n div_id=None,\\n):\\n \\\"\\\"\\\"\\n Write a figure to an HTML file representation\\n\\n Parameters\\n ----------\\n fig:\\n Figure object or dict representing a figure\\n file: str or writeable\\n A string representing a local file path or a writeable object\\n (e.g. a pathlib.Path object or an open file descriptor)\\n config: dict or None (default None)\\n Plotly.js figure config options\\n auto_play: bool (default=True)\\n Whether to automatically start the animation sequence on page load\\n if the figure contains frames. Has no effect if the figure does not\\n contain frames.\\n include_plotlyjs: bool or string (default True)\\n Specifies how the plotly.js library is included/loaded in the output\\n div string.\\n\\n If True, a script tag containing the plotly.js source code (~3MB)\\n is included in the output. HTML files generated with this option are\\n fully self-contained and can be used offline.\\n\\n If 'cdn', a script tag that references the plotly.js CDN is included\\n in the output. The url used is versioned to match the bundled plotly.js.\\n HTML files generated with this option are about 3MB smaller than those\\n generated with include_plotlyjs=True, but they require an active\\n internet connection in order to load the plotly.js library.\\n\\n If 'directory', a script tag is included that references an external\\n plotly.min.js bundle that is assumed to reside in the same\\n directory as the HTML file. If `file` is a string to a local file\\n path and `full_html` is True, then the plotly.min.js bundle is copied\\n into the directory of the resulting HTML file. If a file named\\n plotly.min.js already exists in the output directory then this file\\n is left unmodified and no copy is performed. HTML files generated\\n with this option can be used offline, but they require a copy of\\n the plotly.min.js bundle in the same directory. This option is\\n useful when many figures will be saved as HTML files in the same\\n directory because the plotly.js source code will be included only\\n once per output directory, rather than once per output file.\\n\\n If 'require', Plotly.js is loaded using require.js. This option\\n assumes that require.js is globally available and that it has been\\n globally configured to know how to find Plotly.js as 'plotly'.\\n This option is not advised when full_html=True as it will result\\n in a non-functional html file.\\n\\n If a string that ends in '.js', a script tag is included that\\n references the specified path. This approach can be used to point\\n the resulting HTML file to an alternative CDN or local bundle.\\n\\n If False, no script tag referencing plotly.js is included. This is\\n useful when the resulting div string will be placed inside an HTML\\n document that already loads plotly.js. This option is not advised\\n when full_html=True as it will result in a non-functional html file.\\n\\n include_mathjax: bool or string (default False)\\n Specifies how the MathJax.js library is included in the output html\\n div string. MathJax is required in order to display labels\\n with LaTeX typesetting.\\n\\n If False, no script tag referencing MathJax.js will be included in the\\n output.\\n\\n If 'cdn', a script tag that references a MathJax CDN location will be\\n included in the output. HTML div strings generated with this option\\n will be able to display LaTeX typesetting as long as internet access\\n is available.\\n\\n If a string that ends in '.js', a script tag is included that\\n references the specified path. This approach can be used to point the\\n resulting HTML div string to an alternative CDN.\\n post_script: str or list or None (default None)\\n JavaScript snippet(s) to be included in the resulting div just after\\n plot creation. The string(s) may include '{plot_id}' placeholders\\n that will then be replaced by the `id` of the div element that the\\n plotly.js figure is associated with. One application for this script\\n is to install custom plotly.js event handlers.\\n full_html: bool (default True)\\n If True, produce a string containing a complete HTML document\\n starting with an <html> tag. If False, produce a string containing\\n a single <div> element.\\n animation_opts: dict or None (default None)\\n dict of custom animation parameters to be passed to the function\\n Plotly.animate in Plotly.js. See\\n https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js\\n for available options. Has no effect if the figure does not contain\\n frames, or auto_play is False.\\n default_width, default_height: number or str (default '100%')\\n The default figure width/height to use if the provided figure does not\\n specify its own layout.width/layout.height property. May be\\n specified in pixels as an integer (e.g. 500), or as a css width style\\n string (e.g. '500px', '100%').\\n validate: bool (default True)\\n True if the figure should be validated before being converted to\\n JSON, False otherwise.\\n auto_open: bool (default True)\\n If True, open the saved file in a web browser after saving.\\n This argument only applies if `full_html` is True.\\n div_id: str (default None)\\n If provided, this is the value of the id attribute of the div tag. If None, the\\n id attribute is a UUID.\\n\\n Returns\\n -------\\n str\\n Representation of figure as an HTML div string\\n \\\"\\\"\\\"\\n\\n # Build HTML string\\n html_str = to_html(\\n fig,\\n config=config,\\n auto_play=auto_play,\\n include_plotlyjs=include_plotlyjs,\\n include_mathjax=include_mathjax,\\n post_script=post_script,\\n full_html=full_html,\\n animation_opts=animation_opts,\\n default_width=default_width,\\n default_height=default_height,\\n validate=validate,\\n div_id=div_id,\\n )\\n\\n # Check if file is a string\\n if isinstance(file, str):\\n # Use the standard pathlib constructor to make a pathlib object.\\n path = Path(file)\\n elif isinstance(file, Path): # PurePath is the most general pathlib object.\\n # `file` is already a pathlib object.\\n path = file\\n else:\\n # We could not make a pathlib object out of file. Either `file` is an open file\\n # descriptor with a `write()` method or it's an invalid object.\\n path = None\\n\\n # Write HTML string\\n if path is not None:\\n path.write_text(html_str)\\n else:\\n file.write(html_str)\\n\\n # Check if we should copy plotly.min.js to output directory\\n if path is not None and full_html and include_plotlyjs == \\\"directory\\\":\\n bundle_path = path.parent / \\\"plotly.min.js\\\"\\n\\n if not bundle_path.exists():\\n bundle_path.write_text(get_plotlyjs())\\n\\n # Handle auto_open\\n if path is not None and full_html and auto_open:\\n url = path.absolute().as_uri()\\n webbrowser.open(url)\\n\",\n \"path\": \"packages/python/plotly/plotly/io/_html.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import uuid\nimport os\nfrom pathlib import Path\nimport webbrowser\n\nfrom _plotly_utils.optional_imports import get_module\nfrom plotly.io._utils import validate_coerce_fig_to_dict, plotly_cdn_url\nfrom plotly.offline.offline import _get_jconfig, get_plotlyjs\nfrom plotly import utils\n\n_json = get_module(\"json\")\n\n\n# Build script to set global PlotlyConfig object. This must execute before\n# plotly.js is loaded.\n_window_plotly_config = \"\"\"\\\n<script type=\"text/javascript\">\\\nwindow.PlotlyConfig = {MathJaxConfig: 'local'};\\\n</script>\"\"\"\n\n_mathjax_config = \"\"\"\\\n<script type=\"text/javascript\">\\\nif (window.MathJax && window.MathJax.Hub && window.MathJax.Hub.Config) {window.MathJax.Hub.Config({SVG: {font: \"STIX-Web\"}});}\\\n</script>\"\"\"\n\n\ndef to_html(\n fig,\n config=None,\n auto_play=True,\n include_plotlyjs=True,\n include_mathjax=False,\n post_script=None,\n full_html=True,\n animation_opts=None,\n default_width=\"100%\",\n default_height=\"100%\",\n validate=True,\n div_id=None,\n):\n \"\"\"\n Convert a figure to an HTML string representation.\n\n Parameters\n ----------\n fig:\n Figure object or dict representing a figure\n config: dict or None (default None)\n Plotly.js figure config options\n auto_play: bool (default=True)\n Whether to automatically start the animation sequence on page load\n if the figure contains frames. Has no effect if the figure does not\n contain frames.\n include_plotlyjs: bool or string (default True)\n Specifies how the plotly.js library is included/loaded in the output\n div string.\n\n If True, a script tag containing the plotly.js source code (~3MB)\n is included in the output. HTML files generated with this option are\n fully self-contained and can be used offline.\n\n If 'cdn', a script tag that references the plotly.js CDN is included\n in the output. The url used is versioned to match the bundled plotly.js.\n HTML files generated with this option are about 3MB smaller than those\n generated with include_plotlyjs=True, but they require an active\n internet connection in order to load the plotly.js library.\n\n If 'directory', a script tag is included that references an external\n plotly.min.js bundle that is assumed to reside in the same\n directory as the HTML file.\n\n If 'require', Plotly.js is loaded using require.js. This option\n assumes that require.js is globally available and that it has been\n globally configured to know how to find Plotly.js as 'plotly'.\n This option is not advised when full_html=True as it will result\n in a non-functional html file.\n\n If a string that ends in '.js', a script tag is included that\n references the specified path. This approach can be used to point\n the resulting HTML file to an alternative CDN or local bundle.\n\n If False, no script tag referencing plotly.js is included. This is\n useful when the resulting div string will be placed inside an HTML\n document that already loads plotly.js. This option is not advised\n when full_html=True as it will result in a non-functional html file.\n include_mathjax: bool or string (default False)\n Specifies how the MathJax.js library is included in the output html\n div string. MathJax is required in order to display labels\n with LaTeX typesetting.\n\n If False, no script tag referencing MathJax.js will be included in the\n output.\n\n If 'cdn', a script tag that references a MathJax CDN location will be\n included in the output. HTML div strings generated with this option\n will be able to display LaTeX typesetting as long as internet access\n is available.\n\n If a string that ends in '.js', a script tag is included that\n references the specified path. This approach can be used to point the\n resulting HTML div string to an alternative CDN.\n post_script: str or list or None (default None)\n JavaScript snippet(s) to be included in the resulting div just after\n plot creation. The string(s) may include '{plot_id}' placeholders\n that will then be replaced by the `id` of the div element that the\n plotly.js figure is associated with. One application for this script\n is to install custom plotly.js event handlers.\n full_html: bool (default True)\n If True, produce a string containing a complete HTML document\n starting with an <html> tag. If False, produce a string containing\n a single <div> element.\n animation_opts: dict or None (default None)\n dict of custom animation parameters to be passed to the function\n Plotly.animate in Plotly.js. See\n https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js\n for available options. Has no effect if the figure does not contain\n frames, or auto_play is False.\n default_width, default_height: number or str (default '100%')\n The default figure width/height to use if the provided figure does not\n specify its own layout.width/layout.height property. May be\n specified in pixels as an integer (e.g. 500), or as a css width style\n string (e.g. '500px', '100%').\n validate: bool (default True)\n True if the figure should be validated before being converted to\n JSON, False otherwise.\n div_id: str (default None)\n If provided, this is the value of the id attribute of the div tag. If None, the\n id attribute is a UUID.\n\n Returns\n -------\n str\n Representation of figure as an HTML div string\n \"\"\"\n from plotly.io.json import to_json_plotly\n\n # ## Validate figure ##\n fig_dict = validate_coerce_fig_to_dict(fig, validate)\n\n # ## Generate div id ##\n plotdivid = div_id or str(uuid.uuid4())\n\n # ## Serialize figure ##\n jdata = to_json_plotly(fig_dict.get(\"data\", []))\n jlayout = to_json_plotly(fig_dict.get(\"layout\", {}))\n\n if fig_dict.get(\"frames\", None):\n jframes = to_json_plotly(fig_dict.get(\"frames\", []))\n else:\n jframes = None\n\n # ## Serialize figure config ##\n config = _get_jconfig(config)\n\n # Set responsive\n config.setdefault(\"responsive\", True)\n\n # Get div width/height\n layout_dict = fig_dict.get(\"layout\", {})\n template_dict = fig_dict.get(\"layout\", {}).get(\"template\", {}).get(\"layout\", {})\n\n div_width = layout_dict.get(\"width\", template_dict.get(\"width\", default_width))\n div_height = layout_dict.get(\"height\", template_dict.get(\"height\", default_height))\n\n # Add 'px' suffix to numeric widths\n try:\n float(div_width)\n except (ValueError, TypeError):\n pass\n else:\n div_width = str(div_width) + \"px\"\n\n try:\n float(div_height)\n except (ValueError, TypeError):\n pass\n else:\n div_height = str(div_height) + \"px\"\n\n # ## Get platform URL ##\n if config.get(\"showLink\", False) or config.get(\"showSendToCloud\", False):\n # Figure is going to include a Chart Studio link or send-to-cloud button,\n # So we need to configure the PLOTLYENV.BASE_URL property\n base_url_line = \"\"\"\n window.PLOTLYENV.BASE_URL='{plotly_platform_url}';\\\n\"\"\".format(\n plotly_platform_url=config.get(\"plotlyServerURL\", \"https://plot.ly\")\n )\n else:\n # Figure is not going to include a Chart Studio link or send-to-cloud button,\n # In this case we don't want https://plot.ly to show up anywhere in the HTML\n # output\n config.pop(\"plotlyServerURL\", None)\n config.pop(\"linkText\", None)\n config.pop(\"showLink\", None)\n base_url_line = \"\"\n\n # ## Build script body ##\n # This is the part that actually calls Plotly.js\n\n # build post script snippet(s)\n then_post_script = \"\"\n if post_script:\n if not isinstance(post_script, (list, tuple)):\n post_script = [post_script]\n for ps in post_script:\n then_post_script += \"\"\".then(function(){{\n {post_script}\n }})\"\"\".format(\n post_script=ps.replace(\"{plot_id}\", plotdivid)\n )\n\n then_addframes = \"\"\n then_animate = \"\"\n if jframes:\n then_addframes = \"\"\".then(function(){{\n Plotly.addFrames('{id}', {frames});\n }})\"\"\".format(\n id=plotdivid, frames=jframes\n )\n\n if auto_play:\n if animation_opts:\n animation_opts_arg = \", \" + _json.dumps(animation_opts)\n else:\n animation_opts_arg = \"\"\n then_animate = \"\"\".then(function(){{\n Plotly.animate('{id}', null{animation_opts});\n }})\"\"\".format(\n id=plotdivid, animation_opts=animation_opts_arg\n )\n\n # Serialize config dict to JSON\n jconfig = _json.dumps(config)\n\n script = \"\"\"\\\n if (document.getElementById(\"{id}\")) {{\\\n Plotly.newPlot(\\\n \"{id}\",\\\n {data},\\\n {layout},\\\n {config}\\\n ){then_addframes}{then_animate}{then_post_script}\\\n }}\"\"\".format(\n id=plotdivid,\n data=jdata,\n layout=jlayout,\n config=jconfig,\n then_addframes=then_addframes,\n then_animate=then_animate,\n then_post_script=then_post_script,\n )\n\n # ## Handle loading/initializing plotly.js ##\n include_plotlyjs_orig = include_plotlyjs\n if isinstance(include_plotlyjs, str):\n include_plotlyjs = include_plotlyjs.lower()\n\n # Start/end of requirejs block (if any)\n require_start = \"\"\n require_end = \"\"\n\n # Init and load\n load_plotlyjs = \"\"\n\n # Init plotlyjs. This block needs to run before plotly.js is loaded in\n # order for MathJax configuration to work properly\n if include_plotlyjs == \"require\":\n require_start = 'require([\"plotly\"], function(Plotly) {'\n require_end = \"});\"\n\n elif include_plotlyjs == \"cdn\":\n load_plotlyjs = \"\"\"\\\n {win_config}\n <script src=\"{cdn_url}\"></script>\\\n \"\"\".format(\n win_config=_window_plotly_config, cdn_url=plotly_cdn_url()\n )\n\n elif include_plotlyjs == \"directory\":\n load_plotlyjs = \"\"\"\\\n {win_config}\n <script src=\"plotly.min.js\"></script>\\\n \"\"\".format(\n win_config=_window_plotly_config\n )\n\n elif isinstance(include_plotlyjs, str) and include_plotlyjs.endswith(\".js\"):\n load_plotlyjs = \"\"\"\\\n {win_config}\n <script src=\"{url}\"></script>\\\n \"\"\".format(\n win_config=_window_plotly_config, url=include_plotlyjs_orig\n )\n\n elif include_plotlyjs:\n load_plotlyjs = \"\"\"\\\n {win_config}\n <script type=\"text/javascript\">{plotlyjs}</script>\\\n \"\"\".format(\n win_config=_window_plotly_config, plotlyjs=get_plotlyjs()\n )\n\n # ## Handle loading/initializing MathJax ##\n include_mathjax_orig = include_mathjax\n if isinstance(include_mathjax, str):\n include_mathjax = include_mathjax.lower()\n\n mathjax_template = \"\"\"\\\n <script src=\"{url}?config=TeX-AMS-MML_SVG\"></script>\"\"\"\n\n if include_mathjax == \"cdn\":\n mathjax_script = (\n mathjax_template.format(\n url=(\n \"https://cdnjs.cloudflare.com\" \"/ajax/libs/mathjax/2.7.5/MathJax.js\"\n )\n )\n + _mathjax_config\n )\n\n elif isinstance(include_mathjax, str) and include_mathjax.endswith(\".js\"):\n\n mathjax_script = (\n mathjax_template.format(url=include_mathjax_orig) + _mathjax_config\n )\n elif not include_mathjax:\n mathjax_script = \"\"\n else:\n raise ValueError(\n \"\"\"\\\nInvalid value of type {typ} received as the include_mathjax argument\n Received value: {val}\n\ninclude_mathjax may be specified as False, 'cdn', or a string ending with '.js'\n \"\"\".format(\n typ=type(include_mathjax), val=repr(include_mathjax)\n )\n )\n\n plotly_html_div = \"\"\"\\\n<div>\\\n {mathjax_script}\\\n {load_plotlyjs}\\\n <div id=\"{id}\" class=\"plotly-graph-div\" \\\nstyle=\"height:{height}; width:{width};\"></div>\\\n <script type=\"text/javascript\">\\\n {require_start}\\\n window.PLOTLYENV=window.PLOTLYENV || {{}};{base_url_line}\\\n {script};\\\n {require_end}\\\n </script>\\\n </div>\"\"\".format(\n mathjax_script=mathjax_script,\n load_plotlyjs=load_plotlyjs,\n id=plotdivid,\n width=div_width,\n height=div_height,\n base_url_line=base_url_line,\n require_start=require_start,\n script=script,\n require_end=require_end,\n ).strip()\n\n if full_html:\n return \"\"\"\\\n<html>\n<head><meta charset=\"utf-8\" /></head>\n<body>\n {div}\n</body>\n</html>\"\"\".format(\n div=plotly_html_div\n )\n else:\n return plotly_html_div\n\n\ndef write_html(\n fig,\n file,\n config=None,\n auto_play=True,\n include_plotlyjs=True,\n include_mathjax=False,\n post_script=None,\n full_html=True,\n animation_opts=None,\n validate=True,\n default_width=\"100%\",\n default_height=\"100%\",\n auto_open=False,\n div_id=None,\n):\n \"\"\"\n Write a figure to an HTML file representation\n\n Parameters\n ----------\n fig:\n Figure object or dict representing a figure\n file: str or writeable\n A string representing a local file path or a writeable object\n (e.g. a pathlib.Path object or an open file descriptor)\n config: dict or None (default None)\n Plotly.js figure config options\n auto_play: bool (default=True)\n Whether to automatically start the animation sequence on page load\n if the figure contains frames. Has no effect if the figure does not\n contain frames.\n include_plotlyjs: bool or string (default True)\n Specifies how the plotly.js library is included/loaded in the output\n div string.\n\n If True, a script tag containing the plotly.js source code (~3MB)\n is included in the output. HTML files generated with this option are\n fully self-contained and can be used offline.\n\n If 'cdn', a script tag that references the plotly.js CDN is included\n in the output. The url used is versioned to match the bundled plotly.js.\n HTML files generated with this option are about 3MB smaller than those\n generated with include_plotlyjs=True, but they require an active\n internet connection in order to load the plotly.js library.\n\n If 'directory', a script tag is included that references an external\n plotly.min.js bundle that is assumed to reside in the same\n directory as the HTML file. If `file` is a string to a local file\n path and `full_html` is True, then the plotly.min.js bundle is copied\n into the directory of the resulting HTML file. If a file named\n plotly.min.js already exists in the output directory then this file\n is left unmodified and no copy is performed. HTML files generated\n with this option can be used offline, but they require a copy of\n the plotly.min.js bundle in the same directory. This option is\n useful when many figures will be saved as HTML files in the same\n directory because the plotly.js source code will be included only\n once per output directory, rather than once per output file.\n\n If 'require', Plotly.js is loaded using require.js. This option\n assumes that require.js is globally available and that it has been\n globally configured to know how to find Plotly.js as 'plotly'.\n This option is not advised when full_html=True as it will result\n in a non-functional html file.\n\n If a string that ends in '.js', a script tag is included that\n references the specified path. This approach can be used to point\n the resulting HTML file to an alternative CDN or local bundle.\n\n If False, no script tag referencing plotly.js is included. This is\n useful when the resulting div string will be placed inside an HTML\n document that already loads plotly.js. This option is not advised\n when full_html=True as it will result in a non-functional html file.\n\n include_mathjax: bool or string (default False)\n Specifies how the MathJax.js library is included in the output html\n div string. MathJax is required in order to display labels\n with LaTeX typesetting.\n\n If False, no script tag referencing MathJax.js will be included in the\n output.\n\n If 'cdn', a script tag that references a MathJax CDN location will be\n included in the output. HTML div strings generated with this option\n will be able to display LaTeX typesetting as long as internet access\n is available.\n\n If a string that ends in '.js', a script tag is included that\n references the specified path. This approach can be used to point the\n resulting HTML div string to an alternative CDN.\n post_script: str or list or None (default None)\n JavaScript snippet(s) to be included in the resulting div just after\n plot creation. The string(s) may include '{plot_id}' placeholders\n that will then be replaced by the `id` of the div element that the\n plotly.js figure is associated with. One application for this script\n is to install custom plotly.js event handlers.\n full_html: bool (default True)\n If True, produce a string containing a complete HTML document\n starting with an <html> tag. If False, produce a string containing\n a single <div> element.\n animation_opts: dict or None (default None)\n dict of custom animation parameters to be passed to the function\n Plotly.animate in Plotly.js. See\n https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js\n for available options. Has no effect if the figure does not contain\n frames, or auto_play is False.\n default_width, default_height: number or str (default '100%')\n The default figure width/height to use if the provided figure does not\n specify its own layout.width/layout.height property. May be\n specified in pixels as an integer (e.g. 500), or as a css width style\n string (e.g. '500px', '100%').\n validate: bool (default True)\n True if the figure should be validated before being converted to\n JSON, False otherwise.\n auto_open: bool (default True)\n If True, open the saved file in a web browser after saving.\n This argument only applies if `full_html` is True.\n div_id: str (default None)\n If provided, this is the value of the id attribute of the div tag. If None, the\n id attribute is a UUID.\n\n Returns\n -------\n str\n Representation of figure as an HTML div string\n \"\"\"\n\n # Build HTML string\n html_str = to_html(\n fig,\n config=config,\n auto_play=auto_play,\n include_plotlyjs=include_plotlyjs,\n include_mathjax=include_mathjax,\n post_script=post_script,\n full_html=full_html,\n animation_opts=animation_opts,\n default_width=default_width,\n default_height=default_height,\n validate=validate,\n div_id=div_id,\n )\n\n # Check if file is a string\n if isinstance(file, str):\n # Use the standard pathlib constructor to make a pathlib object.\n path = Path(file)\n elif isinstance(file, Path): # PurePath is the most general pathlib object.\n # `file` is already a pathlib object.\n path = file\n else:\n # We could not make a pathlib object out of file. Either `file` is an open file\n # descriptor with a `write()` method or it's an invalid object.\n path = None\n\n # Write HTML string\n if path is not None:\n path.write_text(html_str)\n else:\n file.write(html_str)\n\n # Check if we should copy plotly.min.js to output directory\n if path is not None and full_html and include_plotlyjs == \"directory\":\n bundle_path = path.parent / \"plotly.min.js\"\n\n if not bundle_path.exists():\n bundle_path.write_text(get_plotlyjs())\n\n # Handle auto_open\n if path is not None and full_html and auto_open:\n url = path.absolute().as_uri()\n webbrowser.open(url)\n","path":"packages/python/plotly/plotly/io/_html.py"}],"string":"[\n {\n \"content\": \"import uuid\\nimport os\\nfrom pathlib import Path\\nimport webbrowser\\n\\nfrom _plotly_utils.optional_imports import get_module\\nfrom plotly.io._utils import validate_coerce_fig_to_dict, plotly_cdn_url\\nfrom plotly.offline.offline import _get_jconfig, get_plotlyjs\\nfrom plotly import utils\\n\\n_json = get_module(\\\"json\\\")\\n\\n\\n# Build script to set global PlotlyConfig object. This must execute before\\n# plotly.js is loaded.\\n_window_plotly_config = \\\"\\\"\\\"\\\\\\n<script type=\\\"text/javascript\\\">\\\\\\nwindow.PlotlyConfig = {MathJaxConfig: 'local'};\\\\\\n</script>\\\"\\\"\\\"\\n\\n_mathjax_config = \\\"\\\"\\\"\\\\\\n<script type=\\\"text/javascript\\\">\\\\\\nif (window.MathJax && window.MathJax.Hub && window.MathJax.Hub.Config) {window.MathJax.Hub.Config({SVG: {font: \\\"STIX-Web\\\"}});}\\\\\\n</script>\\\"\\\"\\\"\\n\\n\\ndef to_html(\\n fig,\\n config=None,\\n auto_play=True,\\n include_plotlyjs=True,\\n include_mathjax=False,\\n post_script=None,\\n full_html=True,\\n animation_opts=None,\\n default_width=\\\"100%\\\",\\n default_height=\\\"100%\\\",\\n validate=True,\\n div_id=None,\\n):\\n \\\"\\\"\\\"\\n Convert a figure to an HTML string representation.\\n\\n Parameters\\n ----------\\n fig:\\n Figure object or dict representing a figure\\n config: dict or None (default None)\\n Plotly.js figure config options\\n auto_play: bool (default=True)\\n Whether to automatically start the animation sequence on page load\\n if the figure contains frames. Has no effect if the figure does not\\n contain frames.\\n include_plotlyjs: bool or string (default True)\\n Specifies how the plotly.js library is included/loaded in the output\\n div string.\\n\\n If True, a script tag containing the plotly.js source code (~3MB)\\n is included in the output. HTML files generated with this option are\\n fully self-contained and can be used offline.\\n\\n If 'cdn', a script tag that references the plotly.js CDN is included\\n in the output. The url used is versioned to match the bundled plotly.js.\\n HTML files generated with this option are about 3MB smaller than those\\n generated with include_plotlyjs=True, but they require an active\\n internet connection in order to load the plotly.js library.\\n\\n If 'directory', a script tag is included that references an external\\n plotly.min.js bundle that is assumed to reside in the same\\n directory as the HTML file.\\n\\n If 'require', Plotly.js is loaded using require.js. This option\\n assumes that require.js is globally available and that it has been\\n globally configured to know how to find Plotly.js as 'plotly'.\\n This option is not advised when full_html=True as it will result\\n in a non-functional html file.\\n\\n If a string that ends in '.js', a script tag is included that\\n references the specified path. This approach can be used to point\\n the resulting HTML file to an alternative CDN or local bundle.\\n\\n If False, no script tag referencing plotly.js is included. This is\\n useful when the resulting div string will be placed inside an HTML\\n document that already loads plotly.js. This option is not advised\\n when full_html=True as it will result in a non-functional html file.\\n include_mathjax: bool or string (default False)\\n Specifies how the MathJax.js library is included in the output html\\n div string. MathJax is required in order to display labels\\n with LaTeX typesetting.\\n\\n If False, no script tag referencing MathJax.js will be included in the\\n output.\\n\\n If 'cdn', a script tag that references a MathJax CDN location will be\\n included in the output. HTML div strings generated with this option\\n will be able to display LaTeX typesetting as long as internet access\\n is available.\\n\\n If a string that ends in '.js', a script tag is included that\\n references the specified path. This approach can be used to point the\\n resulting HTML div string to an alternative CDN.\\n post_script: str or list or None (default None)\\n JavaScript snippet(s) to be included in the resulting div just after\\n plot creation. The string(s) may include '{plot_id}' placeholders\\n that will then be replaced by the `id` of the div element that the\\n plotly.js figure is associated with. One application for this script\\n is to install custom plotly.js event handlers.\\n full_html: bool (default True)\\n If True, produce a string containing a complete HTML document\\n starting with an <html> tag. If False, produce a string containing\\n a single <div> element.\\n animation_opts: dict or None (default None)\\n dict of custom animation parameters to be passed to the function\\n Plotly.animate in Plotly.js. See\\n https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js\\n for available options. Has no effect if the figure does not contain\\n frames, or auto_play is False.\\n default_width, default_height: number or str (default '100%')\\n The default figure width/height to use if the provided figure does not\\n specify its own layout.width/layout.height property. May be\\n specified in pixels as an integer (e.g. 500), or as a css width style\\n string (e.g. '500px', '100%').\\n validate: bool (default True)\\n True if the figure should be validated before being converted to\\n JSON, False otherwise.\\n div_id: str (default None)\\n If provided, this is the value of the id attribute of the div tag. If None, the\\n id attribute is a UUID.\\n\\n Returns\\n -------\\n str\\n Representation of figure as an HTML div string\\n \\\"\\\"\\\"\\n from plotly.io.json import to_json_plotly\\n\\n # ## Validate figure ##\\n fig_dict = validate_coerce_fig_to_dict(fig, validate)\\n\\n # ## Generate div id ##\\n plotdivid = div_id or str(uuid.uuid4())\\n\\n # ## Serialize figure ##\\n jdata = to_json_plotly(fig_dict.get(\\\"data\\\", []))\\n jlayout = to_json_plotly(fig_dict.get(\\\"layout\\\", {}))\\n\\n if fig_dict.get(\\\"frames\\\", None):\\n jframes = to_json_plotly(fig_dict.get(\\\"frames\\\", []))\\n else:\\n jframes = None\\n\\n # ## Serialize figure config ##\\n config = _get_jconfig(config)\\n\\n # Set responsive\\n config.setdefault(\\\"responsive\\\", True)\\n\\n # Get div width/height\\n layout_dict = fig_dict.get(\\\"layout\\\", {})\\n template_dict = fig_dict.get(\\\"layout\\\", {}).get(\\\"template\\\", {}).get(\\\"layout\\\", {})\\n\\n div_width = layout_dict.get(\\\"width\\\", template_dict.get(\\\"width\\\", default_width))\\n div_height = layout_dict.get(\\\"height\\\", template_dict.get(\\\"height\\\", default_height))\\n\\n # Add 'px' suffix to numeric widths\\n try:\\n float(div_width)\\n except (ValueError, TypeError):\\n pass\\n else:\\n div_width = str(div_width) + \\\"px\\\"\\n\\n try:\\n float(div_height)\\n except (ValueError, TypeError):\\n pass\\n else:\\n div_height = str(div_height) + \\\"px\\\"\\n\\n # ## Get platform URL ##\\n if config.get(\\\"showLink\\\", False) or config.get(\\\"showSendToCloud\\\", False):\\n # Figure is going to include a Chart Studio link or send-to-cloud button,\\n # So we need to configure the PLOTLYENV.BASE_URL property\\n base_url_line = \\\"\\\"\\\"\\n window.PLOTLYENV.BASE_URL='{plotly_platform_url}';\\\\\\n\\\"\\\"\\\".format(\\n plotly_platform_url=config.get(\\\"plotlyServerURL\\\", \\\"https://plot.ly\\\")\\n )\\n else:\\n # Figure is not going to include a Chart Studio link or send-to-cloud button,\\n # In this case we don't want https://plot.ly to show up anywhere in the HTML\\n # output\\n config.pop(\\\"plotlyServerURL\\\", None)\\n config.pop(\\\"linkText\\\", None)\\n config.pop(\\\"showLink\\\", None)\\n base_url_line = \\\"\\\"\\n\\n # ## Build script body ##\\n # This is the part that actually calls Plotly.js\\n\\n # build post script snippet(s)\\n then_post_script = \\\"\\\"\\n if post_script:\\n if not isinstance(post_script, (list, tuple)):\\n post_script = [post_script]\\n for ps in post_script:\\n then_post_script += \\\"\\\"\\\".then(function(){{\\n {post_script}\\n }})\\\"\\\"\\\".format(\\n post_script=ps.replace(\\\"{plot_id}\\\", plotdivid)\\n )\\n\\n then_addframes = \\\"\\\"\\n then_animate = \\\"\\\"\\n if jframes:\\n then_addframes = \\\"\\\"\\\".then(function(){{\\n Plotly.addFrames('{id}', {frames});\\n }})\\\"\\\"\\\".format(\\n id=plotdivid, frames=jframes\\n )\\n\\n if auto_play:\\n if animation_opts:\\n animation_opts_arg = \\\", \\\" + _json.dumps(animation_opts)\\n else:\\n animation_opts_arg = \\\"\\\"\\n then_animate = \\\"\\\"\\\".then(function(){{\\n Plotly.animate('{id}', null{animation_opts});\\n }})\\\"\\\"\\\".format(\\n id=plotdivid, animation_opts=animation_opts_arg\\n )\\n\\n # Serialize config dict to JSON\\n jconfig = _json.dumps(config)\\n\\n script = \\\"\\\"\\\"\\\\\\n if (document.getElementById(\\\"{id}\\\")) {{\\\\\\n Plotly.newPlot(\\\\\\n \\\"{id}\\\",\\\\\\n {data},\\\\\\n {layout},\\\\\\n {config}\\\\\\n ){then_addframes}{then_animate}{then_post_script}\\\\\\n }}\\\"\\\"\\\".format(\\n id=plotdivid,\\n data=jdata,\\n layout=jlayout,\\n config=jconfig,\\n then_addframes=then_addframes,\\n then_animate=then_animate,\\n then_post_script=then_post_script,\\n )\\n\\n # ## Handle loading/initializing plotly.js ##\\n include_plotlyjs_orig = include_plotlyjs\\n if isinstance(include_plotlyjs, str):\\n include_plotlyjs = include_plotlyjs.lower()\\n\\n # Start/end of requirejs block (if any)\\n require_start = \\\"\\\"\\n require_end = \\\"\\\"\\n\\n # Init and load\\n load_plotlyjs = \\\"\\\"\\n\\n # Init plotlyjs. This block needs to run before plotly.js is loaded in\\n # order for MathJax configuration to work properly\\n if include_plotlyjs == \\\"require\\\":\\n require_start = 'require([\\\"plotly\\\"], function(Plotly) {'\\n require_end = \\\"});\\\"\\n\\n elif include_plotlyjs == \\\"cdn\\\":\\n load_plotlyjs = \\\"\\\"\\\"\\\\\\n {win_config}\\n <script src=\\\"{cdn_url}\\\"></script>\\\\\\n \\\"\\\"\\\".format(\\n win_config=_window_plotly_config, cdn_url=plotly_cdn_url()\\n )\\n\\n elif include_plotlyjs == \\\"directory\\\":\\n load_plotlyjs = \\\"\\\"\\\"\\\\\\n {win_config}\\n <script src=\\\"plotly.min.js\\\"></script>\\\\\\n \\\"\\\"\\\".format(\\n win_config=_window_plotly_config\\n )\\n\\n elif isinstance(include_plotlyjs, str) and include_plotlyjs.endswith(\\\".js\\\"):\\n load_plotlyjs = \\\"\\\"\\\"\\\\\\n {win_config}\\n <script src=\\\"{url}\\\"></script>\\\\\\n \\\"\\\"\\\".format(\\n win_config=_window_plotly_config, url=include_plotlyjs_orig\\n )\\n\\n elif include_plotlyjs:\\n load_plotlyjs = \\\"\\\"\\\"\\\\\\n {win_config}\\n <script type=\\\"text/javascript\\\">{plotlyjs}</script>\\\\\\n \\\"\\\"\\\".format(\\n win_config=_window_plotly_config, plotlyjs=get_plotlyjs()\\n )\\n\\n # ## Handle loading/initializing MathJax ##\\n include_mathjax_orig = include_mathjax\\n if isinstance(include_mathjax, str):\\n include_mathjax = include_mathjax.lower()\\n\\n mathjax_template = \\\"\\\"\\\"\\\\\\n <script src=\\\"{url}?config=TeX-AMS-MML_SVG\\\"></script>\\\"\\\"\\\"\\n\\n if include_mathjax == \\\"cdn\\\":\\n mathjax_script = (\\n mathjax_template.format(\\n url=(\\n \\\"https://cdnjs.cloudflare.com\\\" \\\"/ajax/libs/mathjax/2.7.5/MathJax.js\\\"\\n )\\n )\\n + _mathjax_config\\n )\\n\\n elif isinstance(include_mathjax, str) and include_mathjax.endswith(\\\".js\\\"):\\n\\n mathjax_script = (\\n mathjax_template.format(url=include_mathjax_orig) + _mathjax_config\\n )\\n elif not include_mathjax:\\n mathjax_script = \\\"\\\"\\n else:\\n raise ValueError(\\n \\\"\\\"\\\"\\\\\\nInvalid value of type {typ} received as the include_mathjax argument\\n Received value: {val}\\n\\ninclude_mathjax may be specified as False, 'cdn', or a string ending with '.js'\\n \\\"\\\"\\\".format(\\n typ=type(include_mathjax), val=repr(include_mathjax)\\n )\\n )\\n\\n plotly_html_div = \\\"\\\"\\\"\\\\\\n<div>\\\\\\n {mathjax_script}\\\\\\n {load_plotlyjs}\\\\\\n <div id=\\\"{id}\\\" class=\\\"plotly-graph-div\\\" \\\\\\nstyle=\\\"height:{height}; width:{width};\\\"></div>\\\\\\n <script type=\\\"text/javascript\\\">\\\\\\n {require_start}\\\\\\n window.PLOTLYENV=window.PLOTLYENV || {{}};{base_url_line}\\\\\\n {script};\\\\\\n {require_end}\\\\\\n </script>\\\\\\n </div>\\\"\\\"\\\".format(\\n mathjax_script=mathjax_script,\\n load_plotlyjs=load_plotlyjs,\\n id=plotdivid,\\n width=div_width,\\n height=div_height,\\n base_url_line=base_url_line,\\n require_start=require_start,\\n script=script,\\n require_end=require_end,\\n ).strip()\\n\\n if full_html:\\n return \\\"\\\"\\\"\\\\\\n<html>\\n<head><meta charset=\\\"utf-8\\\" /></head>\\n<body>\\n {div}\\n</body>\\n</html>\\\"\\\"\\\".format(\\n div=plotly_html_div\\n )\\n else:\\n return plotly_html_div\\n\\n\\ndef write_html(\\n fig,\\n file,\\n config=None,\\n auto_play=True,\\n include_plotlyjs=True,\\n include_mathjax=False,\\n post_script=None,\\n full_html=True,\\n animation_opts=None,\\n validate=True,\\n default_width=\\\"100%\\\",\\n default_height=\\\"100%\\\",\\n auto_open=False,\\n div_id=None,\\n):\\n \\\"\\\"\\\"\\n Write a figure to an HTML file representation\\n\\n Parameters\\n ----------\\n fig:\\n Figure object or dict representing a figure\\n file: str or writeable\\n A string representing a local file path or a writeable object\\n (e.g. a pathlib.Path object or an open file descriptor)\\n config: dict or None (default None)\\n Plotly.js figure config options\\n auto_play: bool (default=True)\\n Whether to automatically start the animation sequence on page load\\n if the figure contains frames. Has no effect if the figure does not\\n contain frames.\\n include_plotlyjs: bool or string (default True)\\n Specifies how the plotly.js library is included/loaded in the output\\n div string.\\n\\n If True, a script tag containing the plotly.js source code (~3MB)\\n is included in the output. HTML files generated with this option are\\n fully self-contained and can be used offline.\\n\\n If 'cdn', a script tag that references the plotly.js CDN is included\\n in the output. The url used is versioned to match the bundled plotly.js.\\n HTML files generated with this option are about 3MB smaller than those\\n generated with include_plotlyjs=True, but they require an active\\n internet connection in order to load the plotly.js library.\\n\\n If 'directory', a script tag is included that references an external\\n plotly.min.js bundle that is assumed to reside in the same\\n directory as the HTML file. If `file` is a string to a local file\\n path and `full_html` is True, then the plotly.min.js bundle is copied\\n into the directory of the resulting HTML file. If a file named\\n plotly.min.js already exists in the output directory then this file\\n is left unmodified and no copy is performed. HTML files generated\\n with this option can be used offline, but they require a copy of\\n the plotly.min.js bundle in the same directory. This option is\\n useful when many figures will be saved as HTML files in the same\\n directory because the plotly.js source code will be included only\\n once per output directory, rather than once per output file.\\n\\n If 'require', Plotly.js is loaded using require.js. This option\\n assumes that require.js is globally available and that it has been\\n globally configured to know how to find Plotly.js as 'plotly'.\\n This option is not advised when full_html=True as it will result\\n in a non-functional html file.\\n\\n If a string that ends in '.js', a script tag is included that\\n references the specified path. This approach can be used to point\\n the resulting HTML file to an alternative CDN or local bundle.\\n\\n If False, no script tag referencing plotly.js is included. This is\\n useful when the resulting div string will be placed inside an HTML\\n document that already loads plotly.js. This option is not advised\\n when full_html=True as it will result in a non-functional html file.\\n\\n include_mathjax: bool or string (default False)\\n Specifies how the MathJax.js library is included in the output html\\n div string. MathJax is required in order to display labels\\n with LaTeX typesetting.\\n\\n If False, no script tag referencing MathJax.js will be included in the\\n output.\\n\\n If 'cdn', a script tag that references a MathJax CDN location will be\\n included in the output. HTML div strings generated with this option\\n will be able to display LaTeX typesetting as long as internet access\\n is available.\\n\\n If a string that ends in '.js', a script tag is included that\\n references the specified path. This approach can be used to point the\\n resulting HTML div string to an alternative CDN.\\n post_script: str or list or None (default None)\\n JavaScript snippet(s) to be included in the resulting div just after\\n plot creation. The string(s) may include '{plot_id}' placeholders\\n that will then be replaced by the `id` of the div element that the\\n plotly.js figure is associated with. One application for this script\\n is to install custom plotly.js event handlers.\\n full_html: bool (default True)\\n If True, produce a string containing a complete HTML document\\n starting with an <html> tag. If False, produce a string containing\\n a single <div> element.\\n animation_opts: dict or None (default None)\\n dict of custom animation parameters to be passed to the function\\n Plotly.animate in Plotly.js. See\\n https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js\\n for available options. Has no effect if the figure does not contain\\n frames, or auto_play is False.\\n default_width, default_height: number or str (default '100%')\\n The default figure width/height to use if the provided figure does not\\n specify its own layout.width/layout.height property. May be\\n specified in pixels as an integer (e.g. 500), or as a css width style\\n string (e.g. '500px', '100%').\\n validate: bool (default True)\\n True if the figure should be validated before being converted to\\n JSON, False otherwise.\\n auto_open: bool (default True)\\n If True, open the saved file in a web browser after saving.\\n This argument only applies if `full_html` is True.\\n div_id: str (default None)\\n If provided, this is the value of the id attribute of the div tag. If None, the\\n id attribute is a UUID.\\n\\n Returns\\n -------\\n str\\n Representation of figure as an HTML div string\\n \\\"\\\"\\\"\\n\\n # Build HTML string\\n html_str = to_html(\\n fig,\\n config=config,\\n auto_play=auto_play,\\n include_plotlyjs=include_plotlyjs,\\n include_mathjax=include_mathjax,\\n post_script=post_script,\\n full_html=full_html,\\n animation_opts=animation_opts,\\n default_width=default_width,\\n default_height=default_height,\\n validate=validate,\\n div_id=div_id,\\n )\\n\\n # Check if file is a string\\n if isinstance(file, str):\\n # Use the standard pathlib constructor to make a pathlib object.\\n path = Path(file)\\n elif isinstance(file, Path): # PurePath is the most general pathlib object.\\n # `file` is already a pathlib object.\\n path = file\\n else:\\n # We could not make a pathlib object out of file. Either `file` is an open file\\n # descriptor with a `write()` method or it's an invalid object.\\n path = None\\n\\n # Write HTML string\\n if path is not None:\\n path.write_text(html_str)\\n else:\\n file.write(html_str)\\n\\n # Check if we should copy plotly.min.js to output directory\\n if path is not None and full_html and include_plotlyjs == \\\"directory\\\":\\n bundle_path = path.parent / \\\"plotly.min.js\\\"\\n\\n if not bundle_path.exists():\\n bundle_path.write_text(get_plotlyjs())\\n\\n # Handle auto_open\\n if path is not None and full_html and auto_open:\\n url = path.absolute().as_uri()\\n webbrowser.open(url)\\n\",\n \"path\": \"packages/python/plotly/plotly/io/_html.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/packages/python/plotly/plotly/io/_html.py b/packages/python/plotly/plotly/io/_html.py\nindex b6f61facc5a..606df721f33 100644\n--- a/packages/python/plotly/plotly/io/_html.py\n+++ b/packages/python/plotly/plotly/io/_html.py\n@@ -20,7 +20,7 @@\n \n _mathjax_config = \"\"\"\\\n <script type=\"text/javascript\">\\\n-if (window.MathJax && window.MathJax.Hub && && window.MathJax.Hub.Config) {window.MathJax.Hub.Config({SVG: {font: \"STIX-Web\"}});}\\\n+if (window.MathJax && window.MathJax.Hub && window.MathJax.Hub.Config) {window.MathJax.Hub.Config({SVG: {font: \"STIX-Web\"}});}\\\n </script>\"\"\"\n \n \n"}}},{"rowIdx":2691,"cells":{"in_source_id":{"kind":"string","value":"AUTOMATIC1111__stable-diffusion-webui-12327"},"issue":{"kind":"string","value":"[Bug]: incorrect file path when prompt contains new line\n### Is there an existing issue for this?\n\n- [X] I have searched the existing issues and checked the recent builds/commits\n\n### What happened?\n\nprompt:\r\n```\r\nportrait of a woman, art by\r\nHenry Asencio\t\r\nAnton Fadeev\t\r\nArtgerm\r\nBastien Lecouffe-Deharme\t\r\nCarne Griffiths\t\r\nDarek Zabrocki\t\r\nPatrice Murciano\t\r\nRuss Mills\t\r\nWLOP\r\nYoji Shinkawa\t\r\n\r\n```\r\nerror:\r\n```\r\nOSError: [Errno 22] Invalid argument: 'outputs/txt2img-images\\\\02357-757535083-portrait of a woman, art by_Henry Asencio\\t_Anton Fadeev\\t_Artgerm_Bastien Lecouffe-Deharme\\t_Carne Griffiths\\t_Darek Zabrocki\\t_Patr.png'\r\n```\n\n### Steps to reproduce the problem\n\nuse prompt with new line symbol\n\n### What should have happened?\n\nThe script should convert that to safe saving reading name\n\n### Commit where the problem happens\n\n98947d173e3f1667eba29c904f681047dea9de90\n\n### What platforms do you use to access UI ?\n\nWindows\n\n### What browsers do you use to access the UI ?\n\nGoogle Chrome\n\n### Command Line Arguments\n\n_No response_\n\n### Additional information, context and logs\n\n_No response_\n"},"before_files":{"kind":"list like","value":[{"content":"from __future__ import annotations\r\n\r\nimport datetime\r\n\r\nimport pytz\r\nimport io\r\nimport math\r\nimport os\r\nfrom collections import namedtuple\r\nimport re\r\n\r\nimport numpy as np\r\nimport piexif\r\nimport piexif.helper\r\nfrom PIL import Image, ImageFont, ImageDraw, ImageColor, PngImagePlugin\r\nimport string\r\nimport json\r\nimport hashlib\r\n\r\nfrom modules import sd_samplers, shared, script_callbacks, errors\r\nfrom modules.paths_internal import roboto_ttf_file\r\nfrom modules.shared import opts\r\n\r\nimport modules.sd_vae as sd_vae\r\n\r\nLANCZOS = (Image.Resampling.LANCZOS if hasattr(Image, 'Resampling') else Image.LANCZOS)\r\n\r\n\r\ndef get_font(fontsize: int):\r\n try:\r\n return ImageFont.truetype(opts.font or roboto_ttf_file, fontsize)\r\n except Exception:\r\n return ImageFont.truetype(roboto_ttf_file, fontsize)\r\n\r\n\r\ndef image_grid(imgs, batch_size=1, rows=None):\r\n if rows is None:\r\n if opts.n_rows > 0:\r\n rows = opts.n_rows\r\n elif opts.n_rows == 0:\r\n rows = batch_size\r\n elif opts.grid_prevent_empty_spots:\r\n rows = math.floor(math.sqrt(len(imgs)))\r\n while len(imgs) % rows != 0:\r\n rows -= 1\r\n else:\r\n rows = math.sqrt(len(imgs))\r\n rows = round(rows)\r\n if rows > len(imgs):\r\n rows = len(imgs)\r\n\r\n cols = math.ceil(len(imgs) / rows)\r\n\r\n params = script_callbacks.ImageGridLoopParams(imgs, cols, rows)\r\n script_callbacks.image_grid_callback(params)\r\n\r\n w, h = imgs[0].size\r\n grid = Image.new('RGB', size=(params.cols * w, params.rows * h), color='black')\r\n\r\n for i, img in enumerate(params.imgs):\r\n grid.paste(img, box=(i % params.cols * w, i // params.cols * h))\r\n\r\n return grid\r\n\r\n\r\nGrid = namedtuple(\"Grid\", [\"tiles\", \"tile_w\", \"tile_h\", \"image_w\", \"image_h\", \"overlap\"])\r\n\r\n\r\ndef split_grid(image, tile_w=512, tile_h=512, overlap=64):\r\n w = image.width\r\n h = image.height\r\n\r\n non_overlap_width = tile_w - overlap\r\n non_overlap_height = tile_h - overlap\r\n\r\n cols = math.ceil((w - overlap) / non_overlap_width)\r\n rows = math.ceil((h - overlap) / non_overlap_height)\r\n\r\n dx = (w - tile_w) / (cols - 1) if cols > 1 else 0\r\n dy = (h - tile_h) / (rows - 1) if rows > 1 else 0\r\n\r\n grid = Grid([], tile_w, tile_h, w, h, overlap)\r\n for row in range(rows):\r\n row_images = []\r\n\r\n y = int(row * dy)\r\n\r\n if y + tile_h >= h:\r\n y = h - tile_h\r\n\r\n for col in range(cols):\r\n x = int(col * dx)\r\n\r\n if x + tile_w >= w:\r\n x = w - tile_w\r\n\r\n tile = image.crop((x, y, x + tile_w, y + tile_h))\r\n\r\n row_images.append([x, tile_w, tile])\r\n\r\n grid.tiles.append([y, tile_h, row_images])\r\n\r\n return grid\r\n\r\n\r\ndef combine_grid(grid):\r\n def make_mask_image(r):\r\n r = r * 255 / grid.overlap\r\n r = r.astype(np.uint8)\r\n return Image.fromarray(r, 'L')\r\n\r\n mask_w = make_mask_image(np.arange(grid.overlap, dtype=np.float32).reshape((1, grid.overlap)).repeat(grid.tile_h, axis=0))\r\n mask_h = make_mask_image(np.arange(grid.overlap, dtype=np.float32).reshape((grid.overlap, 1)).repeat(grid.image_w, axis=1))\r\n\r\n combined_image = Image.new(\"RGB\", (grid.image_w, grid.image_h))\r\n for y, h, row in grid.tiles:\r\n combined_row = Image.new(\"RGB\", (grid.image_w, h))\r\n for x, w, tile in row:\r\n if x == 0:\r\n combined_row.paste(tile, (0, 0))\r\n continue\r\n\r\n combined_row.paste(tile.crop((0, 0, grid.overlap, h)), (x, 0), mask=mask_w)\r\n combined_row.paste(tile.crop((grid.overlap, 0, w, h)), (x + grid.overlap, 0))\r\n\r\n if y == 0:\r\n combined_image.paste(combined_row, (0, 0))\r\n continue\r\n\r\n combined_image.paste(combined_row.crop((0, 0, combined_row.width, grid.overlap)), (0, y), mask=mask_h)\r\n combined_image.paste(combined_row.crop((0, grid.overlap, combined_row.width, h)), (0, y + grid.overlap))\r\n\r\n return combined_image\r\n\r\n\r\nclass GridAnnotation:\r\n def __init__(self, text='', is_active=True):\r\n self.text = text\r\n self.is_active = is_active\r\n self.size = None\r\n\r\n\r\ndef draw_grid_annotations(im, width, height, hor_texts, ver_texts, margin=0):\r\n\r\n color_active = ImageColor.getcolor(opts.grid_text_active_color, 'RGB')\r\n color_inactive = ImageColor.getcolor(opts.grid_text_inactive_color, 'RGB')\r\n color_background = ImageColor.getcolor(opts.grid_background_color, 'RGB')\r\n\r\n def wrap(drawing, text, font, line_length):\r\n lines = ['']\r\n for word in text.split():\r\n line = f'{lines[-1]} {word}'.strip()\r\n if drawing.textlength(line, font=font) <= line_length:\r\n lines[-1] = line\r\n else:\r\n lines.append(word)\r\n return lines\r\n\r\n def draw_texts(drawing, draw_x, draw_y, lines, initial_fnt, initial_fontsize):\r\n for line in lines:\r\n fnt = initial_fnt\r\n fontsize = initial_fontsize\r\n while drawing.multiline_textsize(line.text, font=fnt)[0] > line.allowed_width and fontsize > 0:\r\n fontsize -= 1\r\n fnt = get_font(fontsize)\r\n drawing.multiline_text((draw_x, draw_y + line.size[1] / 2), line.text, font=fnt, fill=color_active if line.is_active else color_inactive, anchor=\"mm\", align=\"center\")\r\n\r\n if not line.is_active:\r\n drawing.line((draw_x - line.size[0] // 2, draw_y + line.size[1] // 2, draw_x + line.size[0] // 2, draw_y + line.size[1] // 2), fill=color_inactive, width=4)\r\n\r\n draw_y += line.size[1] + line_spacing\r\n\r\n fontsize = (width + height) // 25\r\n line_spacing = fontsize // 2\r\n\r\n fnt = get_font(fontsize)\r\n\r\n pad_left = 0 if sum([sum([len(line.text) for line in lines]) for lines in ver_texts]) == 0 else width * 3 // 4\r\n\r\n cols = im.width // width\r\n rows = im.height // height\r\n\r\n assert cols == len(hor_texts), f'bad number of horizontal texts: {len(hor_texts)}; must be {cols}'\r\n assert rows == len(ver_texts), f'bad number of vertical texts: {len(ver_texts)}; must be {rows}'\r\n\r\n calc_img = Image.new(\"RGB\", (1, 1), color_background)\r\n calc_d = ImageDraw.Draw(calc_img)\r\n\r\n for texts, allowed_width in zip(hor_texts + ver_texts, [width] * len(hor_texts) + [pad_left] * len(ver_texts)):\r\n items = [] + texts\r\n texts.clear()\r\n\r\n for line in items:\r\n wrapped = wrap(calc_d, line.text, fnt, allowed_width)\r\n texts += [GridAnnotation(x, line.is_active) for x in wrapped]\r\n\r\n for line in texts:\r\n bbox = calc_d.multiline_textbbox((0, 0), line.text, font=fnt)\r\n line.size = (bbox[2] - bbox[0], bbox[3] - bbox[1])\r\n line.allowed_width = allowed_width\r\n\r\n hor_text_heights = [sum([line.size[1] + line_spacing for line in lines]) - line_spacing for lines in hor_texts]\r\n ver_text_heights = [sum([line.size[1] + line_spacing for line in lines]) - line_spacing * len(lines) for lines in ver_texts]\r\n\r\n pad_top = 0 if sum(hor_text_heights) == 0 else max(hor_text_heights) + line_spacing * 2\r\n\r\n result = Image.new(\"RGB\", (im.width + pad_left + margin * (cols-1), im.height + pad_top + margin * (rows-1)), color_background)\r\n\r\n for row in range(rows):\r\n for col in range(cols):\r\n cell = im.crop((width * col, height * row, width * (col+1), height * (row+1)))\r\n result.paste(cell, (pad_left + (width + margin) * col, pad_top + (height + margin) * row))\r\n\r\n d = ImageDraw.Draw(result)\r\n\r\n for col in range(cols):\r\n x = pad_left + (width + margin) * col + width / 2\r\n y = pad_top / 2 - hor_text_heights[col] / 2\r\n\r\n draw_texts(d, x, y, hor_texts[col], fnt, fontsize)\r\n\r\n for row in range(rows):\r\n x = pad_left / 2\r\n y = pad_top + (height + margin) * row + height / 2 - ver_text_heights[row] / 2\r\n\r\n draw_texts(d, x, y, ver_texts[row], fnt, fontsize)\r\n\r\n return result\r\n\r\n\r\ndef draw_prompt_matrix(im, width, height, all_prompts, margin=0):\r\n prompts = all_prompts[1:]\r\n boundary = math.ceil(len(prompts) / 2)\r\n\r\n prompts_horiz = prompts[:boundary]\r\n prompts_vert = prompts[boundary:]\r\n\r\n hor_texts = [[GridAnnotation(x, is_active=pos & (1 << i) != 0) for i, x in enumerate(prompts_horiz)] for pos in range(1 << len(prompts_horiz))]\r\n ver_texts = [[GridAnnotation(x, is_active=pos & (1 << i) != 0) for i, x in enumerate(prompts_vert)] for pos in range(1 << len(prompts_vert))]\r\n\r\n return draw_grid_annotations(im, width, height, hor_texts, ver_texts, margin)\r\n\r\n\r\ndef resize_image(resize_mode, im, width, height, upscaler_name=None):\r\n \"\"\"\r\n Resizes an image with the specified resize_mode, width, and height.\r\n\r\n Args:\r\n resize_mode: The mode to use when resizing the image.\r\n 0: Resize the image to the specified width and height.\r\n 1: Resize the image to fill the specified width and height, maintaining the aspect ratio, and then center the image within the dimensions, cropping the excess.\r\n 2: Resize the image to fit within the specified width and height, maintaining the aspect ratio, and then center the image within the dimensions, filling empty with data from image.\r\n im: The image to resize.\r\n width: The width to resize the image to.\r\n height: The height to resize the image to.\r\n upscaler_name: The name of the upscaler to use. If not provided, defaults to opts.upscaler_for_img2img.\r\n \"\"\"\r\n\r\n upscaler_name = upscaler_name or opts.upscaler_for_img2img\r\n\r\n def resize(im, w, h):\r\n if upscaler_name is None or upscaler_name == \"None\" or im.mode == 'L':\r\n return im.resize((w, h), resample=LANCZOS)\r\n\r\n scale = max(w / im.width, h / im.height)\r\n\r\n if scale > 1.0:\r\n upscalers = [x for x in shared.sd_upscalers if x.name == upscaler_name]\r\n if len(upscalers) == 0:\r\n upscaler = shared.sd_upscalers[0]\r\n print(f\"could not find upscaler named {upscaler_name or '<empty string>'}, using {upscaler.name} as a fallback\")\r\n else:\r\n upscaler = upscalers[0]\r\n\r\n im = upscaler.scaler.upscale(im, scale, upscaler.data_path)\r\n\r\n if im.width != w or im.height != h:\r\n im = im.resize((w, h), resample=LANCZOS)\r\n\r\n return im\r\n\r\n if resize_mode == 0:\r\n res = resize(im, width, height)\r\n\r\n elif resize_mode == 1:\r\n ratio = width / height\r\n src_ratio = im.width / im.height\r\n\r\n src_w = width if ratio > src_ratio else im.width * height // im.height\r\n src_h = height if ratio <= src_ratio else im.height * width // im.width\r\n\r\n resized = resize(im, src_w, src_h)\r\n res = Image.new(\"RGB\", (width, height))\r\n res.paste(resized, box=(width // 2 - src_w // 2, height // 2 - src_h // 2))\r\n\r\n else:\r\n ratio = width / height\r\n src_ratio = im.width / im.height\r\n\r\n src_w = width if ratio < src_ratio else im.width * height // im.height\r\n src_h = height if ratio >= src_ratio else im.height * width // im.width\r\n\r\n resized = resize(im, src_w, src_h)\r\n res = Image.new(\"RGB\", (width, height))\r\n res.paste(resized, box=(width // 2 - src_w // 2, height // 2 - src_h // 2))\r\n\r\n if ratio < src_ratio:\r\n fill_height = height // 2 - src_h // 2\r\n if fill_height > 0:\r\n res.paste(resized.resize((width, fill_height), box=(0, 0, width, 0)), box=(0, 0))\r\n res.paste(resized.resize((width, fill_height), box=(0, resized.height, width, resized.height)), box=(0, fill_height + src_h))\r\n elif ratio > src_ratio:\r\n fill_width = width // 2 - src_w // 2\r\n if fill_width > 0:\r\n res.paste(resized.resize((fill_width, height), box=(0, 0, 0, height)), box=(0, 0))\r\n res.paste(resized.resize((fill_width, height), box=(resized.width, 0, resized.width, height)), box=(fill_width + src_w, 0))\r\n\r\n return res\r\n\r\n\r\ninvalid_filename_chars = '<>:\"/\\\\|?*\\n'\r\ninvalid_filename_prefix = ' '\r\ninvalid_filename_postfix = ' .'\r\nre_nonletters = re.compile(r'[\\s' + string.punctuation + ']+')\r\nre_pattern = re.compile(r\"(.*?)(?:\\[([^\\[\\]]+)\\]|$)\")\r\nre_pattern_arg = re.compile(r\"(.*)<([^>]*)>$\")\r\nmax_filename_part_length = 128\r\nNOTHING_AND_SKIP_PREVIOUS_TEXT = object()\r\n\r\n\r\ndef sanitize_filename_part(text, replace_spaces=True):\r\n if text is None:\r\n return None\r\n\r\n if replace_spaces:\r\n text = text.replace(' ', '_')\r\n\r\n text = text.translate({ord(x): '_' for x in invalid_filename_chars})\r\n text = text.lstrip(invalid_filename_prefix)[:max_filename_part_length]\r\n text = text.rstrip(invalid_filename_postfix)\r\n return text\r\n\r\n\r\nclass FilenameGenerator:\r\n def get_vae_filename(self): #get the name of the VAE file.\r\n if sd_vae.loaded_vae_file is None:\r\n return \"NoneType\"\r\n file_name = os.path.basename(sd_vae.loaded_vae_file)\r\n split_file_name = file_name.split('.')\r\n if len(split_file_name) > 1 and split_file_name[0] == '':\r\n return split_file_name[1] # if the first character of the filename is \".\" then [1] is obtained.\r\n else:\r\n return split_file_name[0]\r\n\r\n replacements = {\r\n 'seed': lambda self: self.seed if self.seed is not None else '',\r\n 'seed_first': lambda self: self.seed if self.p.batch_size == 1 else self.p.all_seeds[0],\r\n 'seed_last': lambda self: NOTHING_AND_SKIP_PREVIOUS_TEXT if self.p.batch_size == 1 else self.p.all_seeds[-1],\r\n 'steps': lambda self: self.p and self.p.steps,\r\n 'cfg': lambda self: self.p and self.p.cfg_scale,\r\n 'width': lambda self: self.image.width,\r\n 'height': lambda self: self.image.height,\r\n 'styles': lambda self: self.p and sanitize_filename_part(\", \".join([style for style in self.p.styles if not style == \"None\"]) or \"None\", replace_spaces=False),\r\n 'sampler': lambda self: self.p and sanitize_filename_part(self.p.sampler_name, replace_spaces=False),\r\n 'model_hash': lambda self: getattr(self.p, \"sd_model_hash\", shared.sd_model.sd_model_hash),\r\n 'model_name': lambda self: sanitize_filename_part(shared.sd_model.sd_checkpoint_info.name_for_extra, replace_spaces=False),\r\n 'date': lambda self: datetime.datetime.now().strftime('%Y-%m-%d'),\r\n 'datetime': lambda self, *args: self.datetime(*args), # accepts formats: [datetime], [datetime<Format>], [datetime<Format><Time Zone>]\r\n 'job_timestamp': lambda self: getattr(self.p, \"job_timestamp\", shared.state.job_timestamp),\r\n 'prompt_hash': lambda self: hashlib.sha256(self.prompt.encode()).hexdigest()[0:8],\r\n 'prompt': lambda self: sanitize_filename_part(self.prompt),\r\n 'prompt_no_styles': lambda self: self.prompt_no_style(),\r\n 'prompt_spaces': lambda self: sanitize_filename_part(self.prompt, replace_spaces=False),\r\n 'prompt_words': lambda self: self.prompt_words(),\r\n 'batch_number': lambda self: NOTHING_AND_SKIP_PREVIOUS_TEXT if self.p.batch_size == 1 or self.zip else self.p.batch_index + 1,\r\n 'batch_size': lambda self: self.p.batch_size,\r\n 'generation_number': lambda self: NOTHING_AND_SKIP_PREVIOUS_TEXT if (self.p.n_iter == 1 and self.p.batch_size == 1) or self.zip else self.p.iteration * self.p.batch_size + self.p.batch_index + 1,\r\n 'hasprompt': lambda self, *args: self.hasprompt(*args), # accepts formats:[hasprompt<prompt1|default><prompt2>..]\r\n 'clip_skip': lambda self: opts.data[\"CLIP_stop_at_last_layers\"],\r\n 'denoising': lambda self: self.p.denoising_strength if self.p and self.p.denoising_strength else NOTHING_AND_SKIP_PREVIOUS_TEXT,\r\n 'user': lambda self: self.p.user,\r\n 'vae_filename': lambda self: self.get_vae_filename(),\r\n 'none': lambda self: '', # Overrides the default so you can get just the sequence number\r\n }\r\n default_time_format = '%Y%m%d%H%M%S'\r\n\r\n def __init__(self, p, seed, prompt, image, zip=False):\r\n self.p = p\r\n self.seed = seed\r\n self.prompt = prompt\r\n self.image = image\r\n self.zip = zip\r\n\r\n def hasprompt(self, *args):\r\n lower = self.prompt.lower()\r\n if self.p is None or self.prompt is None:\r\n return None\r\n outres = \"\"\r\n for arg in args:\r\n if arg != \"\":\r\n division = arg.split(\"|\")\r\n expected = division[0].lower()\r\n default = division[1] if len(division) > 1 else \"\"\r\n if lower.find(expected) >= 0:\r\n outres = f'{outres}{expected}'\r\n else:\r\n outres = outres if default == \"\" else f'{outres}{default}'\r\n return sanitize_filename_part(outres)\r\n\r\n def prompt_no_style(self):\r\n if self.p is None or self.prompt is None:\r\n return None\r\n\r\n prompt_no_style = self.prompt\r\n for style in shared.prompt_styles.get_style_prompts(self.p.styles):\r\n if style:\r\n for part in style.split(\"{prompt}\"):\r\n prompt_no_style = prompt_no_style.replace(part, \"\").replace(\", ,\", \",\").strip().strip(',')\r\n\r\n prompt_no_style = prompt_no_style.replace(style, \"\").strip().strip(',').strip()\r\n\r\n return sanitize_filename_part(prompt_no_style, replace_spaces=False)\r\n\r\n def prompt_words(self):\r\n words = [x for x in re_nonletters.split(self.prompt or \"\") if x]\r\n if len(words) == 0:\r\n words = [\"empty\"]\r\n return sanitize_filename_part(\" \".join(words[0:opts.directories_max_prompt_words]), replace_spaces=False)\r\n\r\n def datetime(self, *args):\r\n time_datetime = datetime.datetime.now()\r\n\r\n time_format = args[0] if (args and args[0] != \"\") else self.default_time_format\r\n try:\r\n time_zone = pytz.timezone(args[1]) if len(args) > 1 else None\r\n except pytz.exceptions.UnknownTimeZoneError:\r\n time_zone = None\r\n\r\n time_zone_time = time_datetime.astimezone(time_zone)\r\n try:\r\n formatted_time = time_zone_time.strftime(time_format)\r\n except (ValueError, TypeError):\r\n formatted_time = time_zone_time.strftime(self.default_time_format)\r\n\r\n return sanitize_filename_part(formatted_time, replace_spaces=False)\r\n\r\n def apply(self, x):\r\n res = ''\r\n\r\n for m in re_pattern.finditer(x):\r\n text, pattern = m.groups()\r\n\r\n if pattern is None:\r\n res += text\r\n continue\r\n\r\n pattern_args = []\r\n while True:\r\n m = re_pattern_arg.match(pattern)\r\n if m is None:\r\n break\r\n\r\n pattern, arg = m.groups()\r\n pattern_args.insert(0, arg)\r\n\r\n fun = self.replacements.get(pattern.lower())\r\n if fun is not None:\r\n try:\r\n replacement = fun(self, *pattern_args)\r\n except Exception:\r\n replacement = None\r\n errors.report(f\"Error adding [{pattern}] to filename\", exc_info=True)\r\n\r\n if replacement == NOTHING_AND_SKIP_PREVIOUS_TEXT:\r\n continue\r\n elif replacement is not None:\r\n res += text + str(replacement)\r\n continue\r\n\r\n res += f'{text}[{pattern}]'\r\n\r\n return res\r\n\r\n\r\ndef get_next_sequence_number(path, basename):\r\n \"\"\"\r\n Determines and returns the next sequence number to use when saving an image in the specified directory.\r\n\r\n The sequence starts at 0.\r\n \"\"\"\r\n result = -1\r\n if basename != '':\r\n basename = f\"{basename}-\"\r\n\r\n prefix_length = len(basename)\r\n for p in os.listdir(path):\r\n if p.startswith(basename):\r\n parts = os.path.splitext(p[prefix_length:])[0].split('-') # splits the filename (removing the basename first if one is defined, so the sequence number is always the first element)\r\n try:\r\n result = max(int(parts[0]), result)\r\n except ValueError:\r\n pass\r\n\r\n return result + 1\r\n\r\n\r\ndef save_image_with_geninfo(image, geninfo, filename, extension=None, existing_pnginfo=None, pnginfo_section_name='parameters'):\r\n \"\"\"\r\n Saves image to filename, including geninfo as text information for generation info.\r\n For PNG images, geninfo is added to existing pnginfo dictionary using the pnginfo_section_name argument as key.\r\n For JPG images, there's no dictionary and geninfo just replaces the EXIF description.\r\n \"\"\"\r\n\r\n if extension is None:\r\n extension = os.path.splitext(filename)[1]\r\n\r\n image_format = Image.registered_extensions()[extension]\r\n\r\n if extension.lower() == '.png':\r\n existing_pnginfo = existing_pnginfo or {}\r\n if opts.enable_pnginfo:\r\n existing_pnginfo[pnginfo_section_name] = geninfo\r\n\r\n if opts.enable_pnginfo:\r\n pnginfo_data = PngImagePlugin.PngInfo()\r\n for k, v in (existing_pnginfo or {}).items():\r\n pnginfo_data.add_text(k, str(v))\r\n else:\r\n pnginfo_data = None\r\n\r\n image.save(filename, format=image_format, quality=opts.jpeg_quality, pnginfo=pnginfo_data)\r\n\r\n elif extension.lower() in (\".jpg\", \".jpeg\", \".webp\"):\r\n if image.mode == 'RGBA':\r\n image = image.convert(\"RGB\")\r\n elif image.mode == 'I;16':\r\n image = image.point(lambda p: p * 0.0038910505836576).convert(\"RGB\" if extension.lower() == \".webp\" else \"L\")\r\n\r\n image.save(filename, format=image_format, quality=opts.jpeg_quality, lossless=opts.webp_lossless)\r\n\r\n if opts.enable_pnginfo and geninfo is not None:\r\n exif_bytes = piexif.dump({\r\n \"Exif\": {\r\n piexif.ExifIFD.UserComment: piexif.helper.UserComment.dump(geninfo or \"\", encoding=\"unicode\")\r\n },\r\n })\r\n\r\n piexif.insert(exif_bytes, filename)\r\n else:\r\n image.save(filename, format=image_format, quality=opts.jpeg_quality)\r\n\r\n\r\ndef save_image(image, path, basename, seed=None, prompt=None, extension='png', info=None, short_filename=False, no_prompt=False, grid=False, pnginfo_section_name='parameters', p=None, existing_info=None, forced_filename=None, suffix=\"\", save_to_dirs=None):\r\n \"\"\"Save an image.\r\n\r\n Args:\r\n image (`PIL.Image`):\r\n The image to be saved.\r\n path (`str`):\r\n The directory to save the image. Note, the option `save_to_dirs` will make the image to be saved into a sub directory.\r\n basename (`str`):\r\n The base filename which will be applied to `filename pattern`.\r\n seed, prompt, short_filename,\r\n extension (`str`):\r\n Image file extension, default is `png`.\r\n pngsectionname (`str`):\r\n Specify the name of the section which `info` will be saved in.\r\n info (`str` or `PngImagePlugin.iTXt`):\r\n PNG info chunks.\r\n existing_info (`dict`):\r\n Additional PNG info. `existing_info == {pngsectionname: info, ...}`\r\n no_prompt:\r\n TODO I don't know its meaning.\r\n p (`StableDiffusionProcessing`)\r\n forced_filename (`str`):\r\n If specified, `basename` and filename pattern will be ignored.\r\n save_to_dirs (bool):\r\n If true, the image will be saved into a subdirectory of `path`.\r\n\r\n Returns: (fullfn, txt_fullfn)\r\n fullfn (`str`):\r\n The full path of the saved imaged.\r\n txt_fullfn (`str` or None):\r\n If a text file is saved for this image, this will be its full path. Otherwise None.\r\n \"\"\"\r\n namegen = FilenameGenerator(p, seed, prompt, image)\r\n\r\n if save_to_dirs is None:\r\n save_to_dirs = (grid and opts.grid_save_to_dirs) or (not grid and opts.save_to_dirs and not no_prompt)\r\n\r\n if save_to_dirs:\r\n dirname = namegen.apply(opts.directories_filename_pattern or \"[prompt_words]\").lstrip(' ').rstrip('\\\\ /')\r\n path = os.path.join(path, dirname)\r\n\r\n os.makedirs(path, exist_ok=True)\r\n\r\n if forced_filename is None:\r\n if short_filename or seed is None:\r\n file_decoration = \"\"\r\n elif opts.save_to_dirs:\r\n file_decoration = opts.samples_filename_pattern or \"[seed]\"\r\n else:\r\n file_decoration = opts.samples_filename_pattern or \"[seed]-[prompt_spaces]\"\r\n\r\n file_decoration = namegen.apply(file_decoration) + suffix\r\n\r\n add_number = opts.save_images_add_number or file_decoration == ''\r\n\r\n if file_decoration != \"\" and add_number:\r\n file_decoration = f\"-{file_decoration}\"\r\n\r\n if add_number:\r\n basecount = get_next_sequence_number(path, basename)\r\n fullfn = None\r\n for i in range(500):\r\n fn = f\"{basecount + i:05}\" if basename == '' else f\"{basename}-{basecount + i:04}\"\r\n fullfn = os.path.join(path, f\"{fn}{file_decoration}.{extension}\")\r\n if not os.path.exists(fullfn):\r\n break\r\n else:\r\n fullfn = os.path.join(path, f\"{file_decoration}.{extension}\")\r\n else:\r\n fullfn = os.path.join(path, f\"{forced_filename}.{extension}\")\r\n\r\n pnginfo = existing_info or {}\r\n if info is not None:\r\n pnginfo[pnginfo_section_name] = info\r\n\r\n params = script_callbacks.ImageSaveParams(image, p, fullfn, pnginfo)\r\n script_callbacks.before_image_saved_callback(params)\r\n\r\n image = params.image\r\n fullfn = params.filename\r\n info = params.pnginfo.get(pnginfo_section_name, None)\r\n\r\n def _atomically_save_image(image_to_save, filename_without_extension, extension):\r\n \"\"\"\r\n save image with .tmp extension to avoid race condition when another process detects new image in the directory\r\n \"\"\"\r\n temp_file_path = f\"{filename_without_extension}.tmp\"\r\n\r\n save_image_with_geninfo(image_to_save, info, temp_file_path, extension, existing_pnginfo=params.pnginfo, pnginfo_section_name=pnginfo_section_name)\r\n\r\n os.replace(temp_file_path, filename_without_extension + extension)\r\n\r\n fullfn_without_extension, extension = os.path.splitext(params.filename)\r\n if hasattr(os, 'statvfs'):\r\n max_name_len = os.statvfs(path).f_namemax\r\n fullfn_without_extension = fullfn_without_extension[:max_name_len - max(4, len(extension))]\r\n params.filename = fullfn_without_extension + extension\r\n fullfn = params.filename\r\n _atomically_save_image(image, fullfn_without_extension, extension)\r\n\r\n image.already_saved_as = fullfn\r\n\r\n oversize = image.width > opts.target_side_length or image.height > opts.target_side_length\r\n if opts.export_for_4chan and (oversize or os.stat(fullfn).st_size > opts.img_downscale_threshold * 1024 * 1024):\r\n ratio = image.width / image.height\r\n resize_to = None\r\n if oversize and ratio > 1:\r\n resize_to = round(opts.target_side_length), round(image.height * opts.target_side_length / image.width)\r\n elif oversize:\r\n resize_to = round(image.width * opts.target_side_length / image.height), round(opts.target_side_length)\r\n\r\n if resize_to is not None:\r\n try:\r\n # Resizing image with LANCZOS could throw an exception if e.g. image mode is I;16\r\n image = image.resize(resize_to, LANCZOS)\r\n except Exception:\r\n image = image.resize(resize_to)\r\n try:\r\n _atomically_save_image(image, fullfn_without_extension, \".jpg\")\r\n except Exception as e:\r\n errors.display(e, \"saving image as downscaled JPG\")\r\n\r\n if opts.save_txt and info is not None:\r\n txt_fullfn = f\"{fullfn_without_extension}.txt\"\r\n with open(txt_fullfn, \"w\", encoding=\"utf8\") as file:\r\n file.write(f\"{info}\\n\")\r\n else:\r\n txt_fullfn = None\r\n\r\n script_callbacks.image_saved_callback(params)\r\n\r\n return fullfn, txt_fullfn\r\n\r\n\r\nIGNORED_INFO_KEYS = {\r\n 'jfif', 'jfif_version', 'jfif_unit', 'jfif_density', 'dpi', 'exif',\r\n 'loop', 'background', 'timestamp', 'duration', 'progressive', 'progression',\r\n 'icc_profile', 'chromaticity', 'photoshop',\r\n}\r\n\r\n\r\ndef read_info_from_image(image: Image.Image) -> tuple[str | None, dict]:\r\n items = (image.info or {}).copy()\r\n\r\n geninfo = items.pop('parameters', None)\r\n\r\n if \"exif\" in items:\r\n exif = piexif.load(items[\"exif\"])\r\n exif_comment = (exif or {}).get(\"Exif\", {}).get(piexif.ExifIFD.UserComment, b'')\r\n try:\r\n exif_comment = piexif.helper.UserComment.load(exif_comment)\r\n except ValueError:\r\n exif_comment = exif_comment.decode('utf8', errors=\"ignore\")\r\n\r\n if exif_comment:\r\n items['exif comment'] = exif_comment\r\n geninfo = exif_comment\r\n\r\n for field in IGNORED_INFO_KEYS:\r\n items.pop(field, None)\r\n\r\n if items.get(\"Software\", None) == \"NovelAI\":\r\n try:\r\n json_info = json.loads(items[\"Comment\"])\r\n sampler = sd_samplers.samplers_map.get(json_info[\"sampler\"], \"Euler a\")\r\n\r\n geninfo = f\"\"\"{items[\"Description\"]}\r\nNegative prompt: {json_info[\"uc\"]}\r\nSteps: {json_info[\"steps\"]}, Sampler: {sampler}, CFG scale: {json_info[\"scale\"]}, Seed: {json_info[\"seed\"]}, Size: {image.width}x{image.height}, Clip skip: 2, ENSD: 31337\"\"\"\r\n except Exception:\r\n errors.report(\"Error parsing NovelAI image generation parameters\", exc_info=True)\r\n\r\n return geninfo, items\r\n\r\n\r\ndef image_data(data):\r\n import gradio as gr\r\n\r\n try:\r\n image = Image.open(io.BytesIO(data))\r\n textinfo, _ = read_info_from_image(image)\r\n return textinfo, None\r\n except Exception:\r\n pass\r\n\r\n try:\r\n text = data.decode('utf8')\r\n assert len(text) < 10000\r\n return text, None\r\n\r\n except Exception:\r\n pass\r\n\r\n return gr.update(), None\r\n\r\n\r\ndef flatten(img, bgcolor):\r\n \"\"\"replaces transparency with bgcolor (example: \"#ffffff\"), returning an RGB mode image with no transparency\"\"\"\r\n\r\n if img.mode == \"RGBA\":\r\n background = Image.new('RGBA', img.size, bgcolor)\r\n background.paste(img, mask=img)\r\n img = background\r\n\r\n return img.convert('RGB')\r\n","path":"modules/images.py"}],"string":"[\n {\n \"content\": \"from __future__ import annotations\\r\\n\\r\\nimport datetime\\r\\n\\r\\nimport pytz\\r\\nimport io\\r\\nimport math\\r\\nimport os\\r\\nfrom collections import namedtuple\\r\\nimport re\\r\\n\\r\\nimport numpy as np\\r\\nimport piexif\\r\\nimport piexif.helper\\r\\nfrom PIL import Image, ImageFont, ImageDraw, ImageColor, PngImagePlugin\\r\\nimport string\\r\\nimport json\\r\\nimport hashlib\\r\\n\\r\\nfrom modules import sd_samplers, shared, script_callbacks, errors\\r\\nfrom modules.paths_internal import roboto_ttf_file\\r\\nfrom modules.shared import opts\\r\\n\\r\\nimport modules.sd_vae as sd_vae\\r\\n\\r\\nLANCZOS = (Image.Resampling.LANCZOS if hasattr(Image, 'Resampling') else Image.LANCZOS)\\r\\n\\r\\n\\r\\ndef get_font(fontsize: int):\\r\\n try:\\r\\n return ImageFont.truetype(opts.font or roboto_ttf_file, fontsize)\\r\\n except Exception:\\r\\n return ImageFont.truetype(roboto_ttf_file, fontsize)\\r\\n\\r\\n\\r\\ndef image_grid(imgs, batch_size=1, rows=None):\\r\\n if rows is None:\\r\\n if opts.n_rows > 0:\\r\\n rows = opts.n_rows\\r\\n elif opts.n_rows == 0:\\r\\n rows = batch_size\\r\\n elif opts.grid_prevent_empty_spots:\\r\\n rows = math.floor(math.sqrt(len(imgs)))\\r\\n while len(imgs) % rows != 0:\\r\\n rows -= 1\\r\\n else:\\r\\n rows = math.sqrt(len(imgs))\\r\\n rows = round(rows)\\r\\n if rows > len(imgs):\\r\\n rows = len(imgs)\\r\\n\\r\\n cols = math.ceil(len(imgs) / rows)\\r\\n\\r\\n params = script_callbacks.ImageGridLoopParams(imgs, cols, rows)\\r\\n script_callbacks.image_grid_callback(params)\\r\\n\\r\\n w, h = imgs[0].size\\r\\n grid = Image.new('RGB', size=(params.cols * w, params.rows * h), color='black')\\r\\n\\r\\n for i, img in enumerate(params.imgs):\\r\\n grid.paste(img, box=(i % params.cols * w, i // params.cols * h))\\r\\n\\r\\n return grid\\r\\n\\r\\n\\r\\nGrid = namedtuple(\\\"Grid\\\", [\\\"tiles\\\", \\\"tile_w\\\", \\\"tile_h\\\", \\\"image_w\\\", \\\"image_h\\\", \\\"overlap\\\"])\\r\\n\\r\\n\\r\\ndef split_grid(image, tile_w=512, tile_h=512, overlap=64):\\r\\n w = image.width\\r\\n h = image.height\\r\\n\\r\\n non_overlap_width = tile_w - overlap\\r\\n non_overlap_height = tile_h - overlap\\r\\n\\r\\n cols = math.ceil((w - overlap) / non_overlap_width)\\r\\n rows = math.ceil((h - overlap) / non_overlap_height)\\r\\n\\r\\n dx = (w - tile_w) / (cols - 1) if cols > 1 else 0\\r\\n dy = (h - tile_h) / (rows - 1) if rows > 1 else 0\\r\\n\\r\\n grid = Grid([], tile_w, tile_h, w, h, overlap)\\r\\n for row in range(rows):\\r\\n row_images = []\\r\\n\\r\\n y = int(row * dy)\\r\\n\\r\\n if y + tile_h >= h:\\r\\n y = h - tile_h\\r\\n\\r\\n for col in range(cols):\\r\\n x = int(col * dx)\\r\\n\\r\\n if x + tile_w >= w:\\r\\n x = w - tile_w\\r\\n\\r\\n tile = image.crop((x, y, x + tile_w, y + tile_h))\\r\\n\\r\\n row_images.append([x, tile_w, tile])\\r\\n\\r\\n grid.tiles.append([y, tile_h, row_images])\\r\\n\\r\\n return grid\\r\\n\\r\\n\\r\\ndef combine_grid(grid):\\r\\n def make_mask_image(r):\\r\\n r = r * 255 / grid.overlap\\r\\n r = r.astype(np.uint8)\\r\\n return Image.fromarray(r, 'L')\\r\\n\\r\\n mask_w = make_mask_image(np.arange(grid.overlap, dtype=np.float32).reshape((1, grid.overlap)).repeat(grid.tile_h, axis=0))\\r\\n mask_h = make_mask_image(np.arange(grid.overlap, dtype=np.float32).reshape((grid.overlap, 1)).repeat(grid.image_w, axis=1))\\r\\n\\r\\n combined_image = Image.new(\\\"RGB\\\", (grid.image_w, grid.image_h))\\r\\n for y, h, row in grid.tiles:\\r\\n combined_row = Image.new(\\\"RGB\\\", (grid.image_w, h))\\r\\n for x, w, tile in row:\\r\\n if x == 0:\\r\\n combined_row.paste(tile, (0, 0))\\r\\n continue\\r\\n\\r\\n combined_row.paste(tile.crop((0, 0, grid.overlap, h)), (x, 0), mask=mask_w)\\r\\n combined_row.paste(tile.crop((grid.overlap, 0, w, h)), (x + grid.overlap, 0))\\r\\n\\r\\n if y == 0:\\r\\n combined_image.paste(combined_row, (0, 0))\\r\\n continue\\r\\n\\r\\n combined_image.paste(combined_row.crop((0, 0, combined_row.width, grid.overlap)), (0, y), mask=mask_h)\\r\\n combined_image.paste(combined_row.crop((0, grid.overlap, combined_row.width, h)), (0, y + grid.overlap))\\r\\n\\r\\n return combined_image\\r\\n\\r\\n\\r\\nclass GridAnnotation:\\r\\n def __init__(self, text='', is_active=True):\\r\\n self.text = text\\r\\n self.is_active = is_active\\r\\n self.size = None\\r\\n\\r\\n\\r\\ndef draw_grid_annotations(im, width, height, hor_texts, ver_texts, margin=0):\\r\\n\\r\\n color_active = ImageColor.getcolor(opts.grid_text_active_color, 'RGB')\\r\\n color_inactive = ImageColor.getcolor(opts.grid_text_inactive_color, 'RGB')\\r\\n color_background = ImageColor.getcolor(opts.grid_background_color, 'RGB')\\r\\n\\r\\n def wrap(drawing, text, font, line_length):\\r\\n lines = ['']\\r\\n for word in text.split():\\r\\n line = f'{lines[-1]} {word}'.strip()\\r\\n if drawing.textlength(line, font=font) <= line_length:\\r\\n lines[-1] = line\\r\\n else:\\r\\n lines.append(word)\\r\\n return lines\\r\\n\\r\\n def draw_texts(drawing, draw_x, draw_y, lines, initial_fnt, initial_fontsize):\\r\\n for line in lines:\\r\\n fnt = initial_fnt\\r\\n fontsize = initial_fontsize\\r\\n while drawing.multiline_textsize(line.text, font=fnt)[0] > line.allowed_width and fontsize > 0:\\r\\n fontsize -= 1\\r\\n fnt = get_font(fontsize)\\r\\n drawing.multiline_text((draw_x, draw_y + line.size[1] / 2), line.text, font=fnt, fill=color_active if line.is_active else color_inactive, anchor=\\\"mm\\\", align=\\\"center\\\")\\r\\n\\r\\n if not line.is_active:\\r\\n drawing.line((draw_x - line.size[0] // 2, draw_y + line.size[1] // 2, draw_x + line.size[0] // 2, draw_y + line.size[1] // 2), fill=color_inactive, width=4)\\r\\n\\r\\n draw_y += line.size[1] + line_spacing\\r\\n\\r\\n fontsize = (width + height) // 25\\r\\n line_spacing = fontsize // 2\\r\\n\\r\\n fnt = get_font(fontsize)\\r\\n\\r\\n pad_left = 0 if sum([sum([len(line.text) for line in lines]) for lines in ver_texts]) == 0 else width * 3 // 4\\r\\n\\r\\n cols = im.width // width\\r\\n rows = im.height // height\\r\\n\\r\\n assert cols == len(hor_texts), f'bad number of horizontal texts: {len(hor_texts)}; must be {cols}'\\r\\n assert rows == len(ver_texts), f'bad number of vertical texts: {len(ver_texts)}; must be {rows}'\\r\\n\\r\\n calc_img = Image.new(\\\"RGB\\\", (1, 1), color_background)\\r\\n calc_d = ImageDraw.Draw(calc_img)\\r\\n\\r\\n for texts, allowed_width in zip(hor_texts + ver_texts, [width] * len(hor_texts) + [pad_left] * len(ver_texts)):\\r\\n items = [] + texts\\r\\n texts.clear()\\r\\n\\r\\n for line in items:\\r\\n wrapped = wrap(calc_d, line.text, fnt, allowed_width)\\r\\n texts += [GridAnnotation(x, line.is_active) for x in wrapped]\\r\\n\\r\\n for line in texts:\\r\\n bbox = calc_d.multiline_textbbox((0, 0), line.text, font=fnt)\\r\\n line.size = (bbox[2] - bbox[0], bbox[3] - bbox[1])\\r\\n line.allowed_width = allowed_width\\r\\n\\r\\n hor_text_heights = [sum([line.size[1] + line_spacing for line in lines]) - line_spacing for lines in hor_texts]\\r\\n ver_text_heights = [sum([line.size[1] + line_spacing for line in lines]) - line_spacing * len(lines) for lines in ver_texts]\\r\\n\\r\\n pad_top = 0 if sum(hor_text_heights) == 0 else max(hor_text_heights) + line_spacing * 2\\r\\n\\r\\n result = Image.new(\\\"RGB\\\", (im.width + pad_left + margin * (cols-1), im.height + pad_top + margin * (rows-1)), color_background)\\r\\n\\r\\n for row in range(rows):\\r\\n for col in range(cols):\\r\\n cell = im.crop((width * col, height * row, width * (col+1), height * (row+1)))\\r\\n result.paste(cell, (pad_left + (width + margin) * col, pad_top + (height + margin) * row))\\r\\n\\r\\n d = ImageDraw.Draw(result)\\r\\n\\r\\n for col in range(cols):\\r\\n x = pad_left + (width + margin) * col + width / 2\\r\\n y = pad_top / 2 - hor_text_heights[col] / 2\\r\\n\\r\\n draw_texts(d, x, y, hor_texts[col], fnt, fontsize)\\r\\n\\r\\n for row in range(rows):\\r\\n x = pad_left / 2\\r\\n y = pad_top + (height + margin) * row + height / 2 - ver_text_heights[row] / 2\\r\\n\\r\\n draw_texts(d, x, y, ver_texts[row], fnt, fontsize)\\r\\n\\r\\n return result\\r\\n\\r\\n\\r\\ndef draw_prompt_matrix(im, width, height, all_prompts, margin=0):\\r\\n prompts = all_prompts[1:]\\r\\n boundary = math.ceil(len(prompts) / 2)\\r\\n\\r\\n prompts_horiz = prompts[:boundary]\\r\\n prompts_vert = prompts[boundary:]\\r\\n\\r\\n hor_texts = [[GridAnnotation(x, is_active=pos & (1 << i) != 0) for i, x in enumerate(prompts_horiz)] for pos in range(1 << len(prompts_horiz))]\\r\\n ver_texts = [[GridAnnotation(x, is_active=pos & (1 << i) != 0) for i, x in enumerate(prompts_vert)] for pos in range(1 << len(prompts_vert))]\\r\\n\\r\\n return draw_grid_annotations(im, width, height, hor_texts, ver_texts, margin)\\r\\n\\r\\n\\r\\ndef resize_image(resize_mode, im, width, height, upscaler_name=None):\\r\\n \\\"\\\"\\\"\\r\\n Resizes an image with the specified resize_mode, width, and height.\\r\\n\\r\\n Args:\\r\\n resize_mode: The mode to use when resizing the image.\\r\\n 0: Resize the image to the specified width and height.\\r\\n 1: Resize the image to fill the specified width and height, maintaining the aspect ratio, and then center the image within the dimensions, cropping the excess.\\r\\n 2: Resize the image to fit within the specified width and height, maintaining the aspect ratio, and then center the image within the dimensions, filling empty with data from image.\\r\\n im: The image to resize.\\r\\n width: The width to resize the image to.\\r\\n height: The height to resize the image to.\\r\\n upscaler_name: The name of the upscaler to use. If not provided, defaults to opts.upscaler_for_img2img.\\r\\n \\\"\\\"\\\"\\r\\n\\r\\n upscaler_name = upscaler_name or opts.upscaler_for_img2img\\r\\n\\r\\n def resize(im, w, h):\\r\\n if upscaler_name is None or upscaler_name == \\\"None\\\" or im.mode == 'L':\\r\\n return im.resize((w, h), resample=LANCZOS)\\r\\n\\r\\n scale = max(w / im.width, h / im.height)\\r\\n\\r\\n if scale > 1.0:\\r\\n upscalers = [x for x in shared.sd_upscalers if x.name == upscaler_name]\\r\\n if len(upscalers) == 0:\\r\\n upscaler = shared.sd_upscalers[0]\\r\\n print(f\\\"could not find upscaler named {upscaler_name or '<empty string>'}, using {upscaler.name} as a fallback\\\")\\r\\n else:\\r\\n upscaler = upscalers[0]\\r\\n\\r\\n im = upscaler.scaler.upscale(im, scale, upscaler.data_path)\\r\\n\\r\\n if im.width != w or im.height != h:\\r\\n im = im.resize((w, h), resample=LANCZOS)\\r\\n\\r\\n return im\\r\\n\\r\\n if resize_mode == 0:\\r\\n res = resize(im, width, height)\\r\\n\\r\\n elif resize_mode == 1:\\r\\n ratio = width / height\\r\\n src_ratio = im.width / im.height\\r\\n\\r\\n src_w = width if ratio > src_ratio else im.width * height // im.height\\r\\n src_h = height if ratio <= src_ratio else im.height * width // im.width\\r\\n\\r\\n resized = resize(im, src_w, src_h)\\r\\n res = Image.new(\\\"RGB\\\", (width, height))\\r\\n res.paste(resized, box=(width // 2 - src_w // 2, height // 2 - src_h // 2))\\r\\n\\r\\n else:\\r\\n ratio = width / height\\r\\n src_ratio = im.width / im.height\\r\\n\\r\\n src_w = width if ratio < src_ratio else im.width * height // im.height\\r\\n src_h = height if ratio >= src_ratio else im.height * width // im.width\\r\\n\\r\\n resized = resize(im, src_w, src_h)\\r\\n res = Image.new(\\\"RGB\\\", (width, height))\\r\\n res.paste(resized, box=(width // 2 - src_w // 2, height // 2 - src_h // 2))\\r\\n\\r\\n if ratio < src_ratio:\\r\\n fill_height = height // 2 - src_h // 2\\r\\n if fill_height > 0:\\r\\n res.paste(resized.resize((width, fill_height), box=(0, 0, width, 0)), box=(0, 0))\\r\\n res.paste(resized.resize((width, fill_height), box=(0, resized.height, width, resized.height)), box=(0, fill_height + src_h))\\r\\n elif ratio > src_ratio:\\r\\n fill_width = width // 2 - src_w // 2\\r\\n if fill_width > 0:\\r\\n res.paste(resized.resize((fill_width, height), box=(0, 0, 0, height)), box=(0, 0))\\r\\n res.paste(resized.resize((fill_width, height), box=(resized.width, 0, resized.width, height)), box=(fill_width + src_w, 0))\\r\\n\\r\\n return res\\r\\n\\r\\n\\r\\ninvalid_filename_chars = '<>:\\\"/\\\\\\\\|?*\\\\n'\\r\\ninvalid_filename_prefix = ' '\\r\\ninvalid_filename_postfix = ' .'\\r\\nre_nonletters = re.compile(r'[\\\\s' + string.punctuation + ']+')\\r\\nre_pattern = re.compile(r\\\"(.*?)(?:\\\\[([^\\\\[\\\\]]+)\\\\]|$)\\\")\\r\\nre_pattern_arg = re.compile(r\\\"(.*)<([^>]*)>$\\\")\\r\\nmax_filename_part_length = 128\\r\\nNOTHING_AND_SKIP_PREVIOUS_TEXT = object()\\r\\n\\r\\n\\r\\ndef sanitize_filename_part(text, replace_spaces=True):\\r\\n if text is None:\\r\\n return None\\r\\n\\r\\n if replace_spaces:\\r\\n text = text.replace(' ', '_')\\r\\n\\r\\n text = text.translate({ord(x): '_' for x in invalid_filename_chars})\\r\\n text = text.lstrip(invalid_filename_prefix)[:max_filename_part_length]\\r\\n text = text.rstrip(invalid_filename_postfix)\\r\\n return text\\r\\n\\r\\n\\r\\nclass FilenameGenerator:\\r\\n def get_vae_filename(self): #get the name of the VAE file.\\r\\n if sd_vae.loaded_vae_file is None:\\r\\n return \\\"NoneType\\\"\\r\\n file_name = os.path.basename(sd_vae.loaded_vae_file)\\r\\n split_file_name = file_name.split('.')\\r\\n if len(split_file_name) > 1 and split_file_name[0] == '':\\r\\n return split_file_name[1] # if the first character of the filename is \\\".\\\" then [1] is obtained.\\r\\n else:\\r\\n return split_file_name[0]\\r\\n\\r\\n replacements = {\\r\\n 'seed': lambda self: self.seed if self.seed is not None else '',\\r\\n 'seed_first': lambda self: self.seed if self.p.batch_size == 1 else self.p.all_seeds[0],\\r\\n 'seed_last': lambda self: NOTHING_AND_SKIP_PREVIOUS_TEXT if self.p.batch_size == 1 else self.p.all_seeds[-1],\\r\\n 'steps': lambda self: self.p and self.p.steps,\\r\\n 'cfg': lambda self: self.p and self.p.cfg_scale,\\r\\n 'width': lambda self: self.image.width,\\r\\n 'height': lambda self: self.image.height,\\r\\n 'styles': lambda self: self.p and sanitize_filename_part(\\\", \\\".join([style for style in self.p.styles if not style == \\\"None\\\"]) or \\\"None\\\", replace_spaces=False),\\r\\n 'sampler': lambda self: self.p and sanitize_filename_part(self.p.sampler_name, replace_spaces=False),\\r\\n 'model_hash': lambda self: getattr(self.p, \\\"sd_model_hash\\\", shared.sd_model.sd_model_hash),\\r\\n 'model_name': lambda self: sanitize_filename_part(shared.sd_model.sd_checkpoint_info.name_for_extra, replace_spaces=False),\\r\\n 'date': lambda self: datetime.datetime.now().strftime('%Y-%m-%d'),\\r\\n 'datetime': lambda self, *args: self.datetime(*args), # accepts formats: [datetime], [datetime<Format>], [datetime<Format><Time Zone>]\\r\\n 'job_timestamp': lambda self: getattr(self.p, \\\"job_timestamp\\\", shared.state.job_timestamp),\\r\\n 'prompt_hash': lambda self: hashlib.sha256(self.prompt.encode()).hexdigest()[0:8],\\r\\n 'prompt': lambda self: sanitize_filename_part(self.prompt),\\r\\n 'prompt_no_styles': lambda self: self.prompt_no_style(),\\r\\n 'prompt_spaces': lambda self: sanitize_filename_part(self.prompt, replace_spaces=False),\\r\\n 'prompt_words': lambda self: self.prompt_words(),\\r\\n 'batch_number': lambda self: NOTHING_AND_SKIP_PREVIOUS_TEXT if self.p.batch_size == 1 or self.zip else self.p.batch_index + 1,\\r\\n 'batch_size': lambda self: self.p.batch_size,\\r\\n 'generation_number': lambda self: NOTHING_AND_SKIP_PREVIOUS_TEXT if (self.p.n_iter == 1 and self.p.batch_size == 1) or self.zip else self.p.iteration * self.p.batch_size + self.p.batch_index + 1,\\r\\n 'hasprompt': lambda self, *args: self.hasprompt(*args), # accepts formats:[hasprompt<prompt1|default><prompt2>..]\\r\\n 'clip_skip': lambda self: opts.data[\\\"CLIP_stop_at_last_layers\\\"],\\r\\n 'denoising': lambda self: self.p.denoising_strength if self.p and self.p.denoising_strength else NOTHING_AND_SKIP_PREVIOUS_TEXT,\\r\\n 'user': lambda self: self.p.user,\\r\\n 'vae_filename': lambda self: self.get_vae_filename(),\\r\\n 'none': lambda self: '', # Overrides the default so you can get just the sequence number\\r\\n }\\r\\n default_time_format = '%Y%m%d%H%M%S'\\r\\n\\r\\n def __init__(self, p, seed, prompt, image, zip=False):\\r\\n self.p = p\\r\\n self.seed = seed\\r\\n self.prompt = prompt\\r\\n self.image = image\\r\\n self.zip = zip\\r\\n\\r\\n def hasprompt(self, *args):\\r\\n lower = self.prompt.lower()\\r\\n if self.p is None or self.prompt is None:\\r\\n return None\\r\\n outres = \\\"\\\"\\r\\n for arg in args:\\r\\n if arg != \\\"\\\":\\r\\n division = arg.split(\\\"|\\\")\\r\\n expected = division[0].lower()\\r\\n default = division[1] if len(division) > 1 else \\\"\\\"\\r\\n if lower.find(expected) >= 0:\\r\\n outres = f'{outres}{expected}'\\r\\n else:\\r\\n outres = outres if default == \\\"\\\" else f'{outres}{default}'\\r\\n return sanitize_filename_part(outres)\\r\\n\\r\\n def prompt_no_style(self):\\r\\n if self.p is None or self.prompt is None:\\r\\n return None\\r\\n\\r\\n prompt_no_style = self.prompt\\r\\n for style in shared.prompt_styles.get_style_prompts(self.p.styles):\\r\\n if style:\\r\\n for part in style.split(\\\"{prompt}\\\"):\\r\\n prompt_no_style = prompt_no_style.replace(part, \\\"\\\").replace(\\\", ,\\\", \\\",\\\").strip().strip(',')\\r\\n\\r\\n prompt_no_style = prompt_no_style.replace(style, \\\"\\\").strip().strip(',').strip()\\r\\n\\r\\n return sanitize_filename_part(prompt_no_style, replace_spaces=False)\\r\\n\\r\\n def prompt_words(self):\\r\\n words = [x for x in re_nonletters.split(self.prompt or \\\"\\\") if x]\\r\\n if len(words) == 0:\\r\\n words = [\\\"empty\\\"]\\r\\n return sanitize_filename_part(\\\" \\\".join(words[0:opts.directories_max_prompt_words]), replace_spaces=False)\\r\\n\\r\\n def datetime(self, *args):\\r\\n time_datetime = datetime.datetime.now()\\r\\n\\r\\n time_format = args[0] if (args and args[0] != \\\"\\\") else self.default_time_format\\r\\n try:\\r\\n time_zone = pytz.timezone(args[1]) if len(args) > 1 else None\\r\\n except pytz.exceptions.UnknownTimeZoneError:\\r\\n time_zone = None\\r\\n\\r\\n time_zone_time = time_datetime.astimezone(time_zone)\\r\\n try:\\r\\n formatted_time = time_zone_time.strftime(time_format)\\r\\n except (ValueError, TypeError):\\r\\n formatted_time = time_zone_time.strftime(self.default_time_format)\\r\\n\\r\\n return sanitize_filename_part(formatted_time, replace_spaces=False)\\r\\n\\r\\n def apply(self, x):\\r\\n res = ''\\r\\n\\r\\n for m in re_pattern.finditer(x):\\r\\n text, pattern = m.groups()\\r\\n\\r\\n if pattern is None:\\r\\n res += text\\r\\n continue\\r\\n\\r\\n pattern_args = []\\r\\n while True:\\r\\n m = re_pattern_arg.match(pattern)\\r\\n if m is None:\\r\\n break\\r\\n\\r\\n pattern, arg = m.groups()\\r\\n pattern_args.insert(0, arg)\\r\\n\\r\\n fun = self.replacements.get(pattern.lower())\\r\\n if fun is not None:\\r\\n try:\\r\\n replacement = fun(self, *pattern_args)\\r\\n except Exception:\\r\\n replacement = None\\r\\n errors.report(f\\\"Error adding [{pattern}] to filename\\\", exc_info=True)\\r\\n\\r\\n if replacement == NOTHING_AND_SKIP_PREVIOUS_TEXT:\\r\\n continue\\r\\n elif replacement is not None:\\r\\n res += text + str(replacement)\\r\\n continue\\r\\n\\r\\n res += f'{text}[{pattern}]'\\r\\n\\r\\n return res\\r\\n\\r\\n\\r\\ndef get_next_sequence_number(path, basename):\\r\\n \\\"\\\"\\\"\\r\\n Determines and returns the next sequence number to use when saving an image in the specified directory.\\r\\n\\r\\n The sequence starts at 0.\\r\\n \\\"\\\"\\\"\\r\\n result = -1\\r\\n if basename != '':\\r\\n basename = f\\\"{basename}-\\\"\\r\\n\\r\\n prefix_length = len(basename)\\r\\n for p in os.listdir(path):\\r\\n if p.startswith(basename):\\r\\n parts = os.path.splitext(p[prefix_length:])[0].split('-') # splits the filename (removing the basename first if one is defined, so the sequence number is always the first element)\\r\\n try:\\r\\n result = max(int(parts[0]), result)\\r\\n except ValueError:\\r\\n pass\\r\\n\\r\\n return result + 1\\r\\n\\r\\n\\r\\ndef save_image_with_geninfo(image, geninfo, filename, extension=None, existing_pnginfo=None, pnginfo_section_name='parameters'):\\r\\n \\\"\\\"\\\"\\r\\n Saves image to filename, including geninfo as text information for generation info.\\r\\n For PNG images, geninfo is added to existing pnginfo dictionary using the pnginfo_section_name argument as key.\\r\\n For JPG images, there's no dictionary and geninfo just replaces the EXIF description.\\r\\n \\\"\\\"\\\"\\r\\n\\r\\n if extension is None:\\r\\n extension = os.path.splitext(filename)[1]\\r\\n\\r\\n image_format = Image.registered_extensions()[extension]\\r\\n\\r\\n if extension.lower() == '.png':\\r\\n existing_pnginfo = existing_pnginfo or {}\\r\\n if opts.enable_pnginfo:\\r\\n existing_pnginfo[pnginfo_section_name] = geninfo\\r\\n\\r\\n if opts.enable_pnginfo:\\r\\n pnginfo_data = PngImagePlugin.PngInfo()\\r\\n for k, v in (existing_pnginfo or {}).items():\\r\\n pnginfo_data.add_text(k, str(v))\\r\\n else:\\r\\n pnginfo_data = None\\r\\n\\r\\n image.save(filename, format=image_format, quality=opts.jpeg_quality, pnginfo=pnginfo_data)\\r\\n\\r\\n elif extension.lower() in (\\\".jpg\\\", \\\".jpeg\\\", \\\".webp\\\"):\\r\\n if image.mode == 'RGBA':\\r\\n image = image.convert(\\\"RGB\\\")\\r\\n elif image.mode == 'I;16':\\r\\n image = image.point(lambda p: p * 0.0038910505836576).convert(\\\"RGB\\\" if extension.lower() == \\\".webp\\\" else \\\"L\\\")\\r\\n\\r\\n image.save(filename, format=image_format, quality=opts.jpeg_quality, lossless=opts.webp_lossless)\\r\\n\\r\\n if opts.enable_pnginfo and geninfo is not None:\\r\\n exif_bytes = piexif.dump({\\r\\n \\\"Exif\\\": {\\r\\n piexif.ExifIFD.UserComment: piexif.helper.UserComment.dump(geninfo or \\\"\\\", encoding=\\\"unicode\\\")\\r\\n },\\r\\n })\\r\\n\\r\\n piexif.insert(exif_bytes, filename)\\r\\n else:\\r\\n image.save(filename, format=image_format, quality=opts.jpeg_quality)\\r\\n\\r\\n\\r\\ndef save_image(image, path, basename, seed=None, prompt=None, extension='png', info=None, short_filename=False, no_prompt=False, grid=False, pnginfo_section_name='parameters', p=None, existing_info=None, forced_filename=None, suffix=\\\"\\\", save_to_dirs=None):\\r\\n \\\"\\\"\\\"Save an image.\\r\\n\\r\\n Args:\\r\\n image (`PIL.Image`):\\r\\n The image to be saved.\\r\\n path (`str`):\\r\\n The directory to save the image. Note, the option `save_to_dirs` will make the image to be saved into a sub directory.\\r\\n basename (`str`):\\r\\n The base filename which will be applied to `filename pattern`.\\r\\n seed, prompt, short_filename,\\r\\n extension (`str`):\\r\\n Image file extension, default is `png`.\\r\\n pngsectionname (`str`):\\r\\n Specify the name of the section which `info` will be saved in.\\r\\n info (`str` or `PngImagePlugin.iTXt`):\\r\\n PNG info chunks.\\r\\n existing_info (`dict`):\\r\\n Additional PNG info. `existing_info == {pngsectionname: info, ...}`\\r\\n no_prompt:\\r\\n TODO I don't know its meaning.\\r\\n p (`StableDiffusionProcessing`)\\r\\n forced_filename (`str`):\\r\\n If specified, `basename` and filename pattern will be ignored.\\r\\n save_to_dirs (bool):\\r\\n If true, the image will be saved into a subdirectory of `path`.\\r\\n\\r\\n Returns: (fullfn, txt_fullfn)\\r\\n fullfn (`str`):\\r\\n The full path of the saved imaged.\\r\\n txt_fullfn (`str` or None):\\r\\n If a text file is saved for this image, this will be its full path. Otherwise None.\\r\\n \\\"\\\"\\\"\\r\\n namegen = FilenameGenerator(p, seed, prompt, image)\\r\\n\\r\\n if save_to_dirs is None:\\r\\n save_to_dirs = (grid and opts.grid_save_to_dirs) or (not grid and opts.save_to_dirs and not no_prompt)\\r\\n\\r\\n if save_to_dirs:\\r\\n dirname = namegen.apply(opts.directories_filename_pattern or \\\"[prompt_words]\\\").lstrip(' ').rstrip('\\\\\\\\ /')\\r\\n path = os.path.join(path, dirname)\\r\\n\\r\\n os.makedirs(path, exist_ok=True)\\r\\n\\r\\n if forced_filename is None:\\r\\n if short_filename or seed is None:\\r\\n file_decoration = \\\"\\\"\\r\\n elif opts.save_to_dirs:\\r\\n file_decoration = opts.samples_filename_pattern or \\\"[seed]\\\"\\r\\n else:\\r\\n file_decoration = opts.samples_filename_pattern or \\\"[seed]-[prompt_spaces]\\\"\\r\\n\\r\\n file_decoration = namegen.apply(file_decoration) + suffix\\r\\n\\r\\n add_number = opts.save_images_add_number or file_decoration == ''\\r\\n\\r\\n if file_decoration != \\\"\\\" and add_number:\\r\\n file_decoration = f\\\"-{file_decoration}\\\"\\r\\n\\r\\n if add_number:\\r\\n basecount = get_next_sequence_number(path, basename)\\r\\n fullfn = None\\r\\n for i in range(500):\\r\\n fn = f\\\"{basecount + i:05}\\\" if basename == '' else f\\\"{basename}-{basecount + i:04}\\\"\\r\\n fullfn = os.path.join(path, f\\\"{fn}{file_decoration}.{extension}\\\")\\r\\n if not os.path.exists(fullfn):\\r\\n break\\r\\n else:\\r\\n fullfn = os.path.join(path, f\\\"{file_decoration}.{extension}\\\")\\r\\n else:\\r\\n fullfn = os.path.join(path, f\\\"{forced_filename}.{extension}\\\")\\r\\n\\r\\n pnginfo = existing_info or {}\\r\\n if info is not None:\\r\\n pnginfo[pnginfo_section_name] = info\\r\\n\\r\\n params = script_callbacks.ImageSaveParams(image, p, fullfn, pnginfo)\\r\\n script_callbacks.before_image_saved_callback(params)\\r\\n\\r\\n image = params.image\\r\\n fullfn = params.filename\\r\\n info = params.pnginfo.get(pnginfo_section_name, None)\\r\\n\\r\\n def _atomically_save_image(image_to_save, filename_without_extension, extension):\\r\\n \\\"\\\"\\\"\\r\\n save image with .tmp extension to avoid race condition when another process detects new image in the directory\\r\\n \\\"\\\"\\\"\\r\\n temp_file_path = f\\\"{filename_without_extension}.tmp\\\"\\r\\n\\r\\n save_image_with_geninfo(image_to_save, info, temp_file_path, extension, existing_pnginfo=params.pnginfo, pnginfo_section_name=pnginfo_section_name)\\r\\n\\r\\n os.replace(temp_file_path, filename_without_extension + extension)\\r\\n\\r\\n fullfn_without_extension, extension = os.path.splitext(params.filename)\\r\\n if hasattr(os, 'statvfs'):\\r\\n max_name_len = os.statvfs(path).f_namemax\\r\\n fullfn_without_extension = fullfn_without_extension[:max_name_len - max(4, len(extension))]\\r\\n params.filename = fullfn_without_extension + extension\\r\\n fullfn = params.filename\\r\\n _atomically_save_image(image, fullfn_without_extension, extension)\\r\\n\\r\\n image.already_saved_as = fullfn\\r\\n\\r\\n oversize = image.width > opts.target_side_length or image.height > opts.target_side_length\\r\\n if opts.export_for_4chan and (oversize or os.stat(fullfn).st_size > opts.img_downscale_threshold * 1024 * 1024):\\r\\n ratio = image.width / image.height\\r\\n resize_to = None\\r\\n if oversize and ratio > 1:\\r\\n resize_to = round(opts.target_side_length), round(image.height * opts.target_side_length / image.width)\\r\\n elif oversize:\\r\\n resize_to = round(image.width * opts.target_side_length / image.height), round(opts.target_side_length)\\r\\n\\r\\n if resize_to is not None:\\r\\n try:\\r\\n # Resizing image with LANCZOS could throw an exception if e.g. image mode is I;16\\r\\n image = image.resize(resize_to, LANCZOS)\\r\\n except Exception:\\r\\n image = image.resize(resize_to)\\r\\n try:\\r\\n _atomically_save_image(image, fullfn_without_extension, \\\".jpg\\\")\\r\\n except Exception as e:\\r\\n errors.display(e, \\\"saving image as downscaled JPG\\\")\\r\\n\\r\\n if opts.save_txt and info is not None:\\r\\n txt_fullfn = f\\\"{fullfn_without_extension}.txt\\\"\\r\\n with open(txt_fullfn, \\\"w\\\", encoding=\\\"utf8\\\") as file:\\r\\n file.write(f\\\"{info}\\\\n\\\")\\r\\n else:\\r\\n txt_fullfn = None\\r\\n\\r\\n script_callbacks.image_saved_callback(params)\\r\\n\\r\\n return fullfn, txt_fullfn\\r\\n\\r\\n\\r\\nIGNORED_INFO_KEYS = {\\r\\n 'jfif', 'jfif_version', 'jfif_unit', 'jfif_density', 'dpi', 'exif',\\r\\n 'loop', 'background', 'timestamp', 'duration', 'progressive', 'progression',\\r\\n 'icc_profile', 'chromaticity', 'photoshop',\\r\\n}\\r\\n\\r\\n\\r\\ndef read_info_from_image(image: Image.Image) -> tuple[str | None, dict]:\\r\\n items = (image.info or {}).copy()\\r\\n\\r\\n geninfo = items.pop('parameters', None)\\r\\n\\r\\n if \\\"exif\\\" in items:\\r\\n exif = piexif.load(items[\\\"exif\\\"])\\r\\n exif_comment = (exif or {}).get(\\\"Exif\\\", {}).get(piexif.ExifIFD.UserComment, b'')\\r\\n try:\\r\\n exif_comment = piexif.helper.UserComment.load(exif_comment)\\r\\n except ValueError:\\r\\n exif_comment = exif_comment.decode('utf8', errors=\\\"ignore\\\")\\r\\n\\r\\n if exif_comment:\\r\\n items['exif comment'] = exif_comment\\r\\n geninfo = exif_comment\\r\\n\\r\\n for field in IGNORED_INFO_KEYS:\\r\\n items.pop(field, None)\\r\\n\\r\\n if items.get(\\\"Software\\\", None) == \\\"NovelAI\\\":\\r\\n try:\\r\\n json_info = json.loads(items[\\\"Comment\\\"])\\r\\n sampler = sd_samplers.samplers_map.get(json_info[\\\"sampler\\\"], \\\"Euler a\\\")\\r\\n\\r\\n geninfo = f\\\"\\\"\\\"{items[\\\"Description\\\"]}\\r\\nNegative prompt: {json_info[\\\"uc\\\"]}\\r\\nSteps: {json_info[\\\"steps\\\"]}, Sampler: {sampler}, CFG scale: {json_info[\\\"scale\\\"]}, Seed: {json_info[\\\"seed\\\"]}, Size: {image.width}x{image.height}, Clip skip: 2, ENSD: 31337\\\"\\\"\\\"\\r\\n except Exception:\\r\\n errors.report(\\\"Error parsing NovelAI image generation parameters\\\", exc_info=True)\\r\\n\\r\\n return geninfo, items\\r\\n\\r\\n\\r\\ndef image_data(data):\\r\\n import gradio as gr\\r\\n\\r\\n try:\\r\\n image = Image.open(io.BytesIO(data))\\r\\n textinfo, _ = read_info_from_image(image)\\r\\n return textinfo, None\\r\\n except Exception:\\r\\n pass\\r\\n\\r\\n try:\\r\\n text = data.decode('utf8')\\r\\n assert len(text) < 10000\\r\\n return text, None\\r\\n\\r\\n except Exception:\\r\\n pass\\r\\n\\r\\n return gr.update(), None\\r\\n\\r\\n\\r\\ndef flatten(img, bgcolor):\\r\\n \\\"\\\"\\\"replaces transparency with bgcolor (example: \\\"#ffffff\\\"), returning an RGB mode image with no transparency\\\"\\\"\\\"\\r\\n\\r\\n if img.mode == \\\"RGBA\\\":\\r\\n background = Image.new('RGBA', img.size, bgcolor)\\r\\n background.paste(img, mask=img)\\r\\n img = background\\r\\n\\r\\n return img.convert('RGB')\\r\\n\",\n \"path\": \"modules/images.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"from __future__ import annotations\r\n\r\nimport datetime\r\n\r\nimport pytz\r\nimport io\r\nimport math\r\nimport os\r\nfrom collections import namedtuple\r\nimport re\r\n\r\nimport numpy as np\r\nimport piexif\r\nimport piexif.helper\r\nfrom PIL import Image, ImageFont, ImageDraw, ImageColor, PngImagePlugin\r\nimport string\r\nimport json\r\nimport hashlib\r\n\r\nfrom modules import sd_samplers, shared, script_callbacks, errors\r\nfrom modules.paths_internal import roboto_ttf_file\r\nfrom modules.shared import opts\r\n\r\nimport modules.sd_vae as sd_vae\r\n\r\nLANCZOS = (Image.Resampling.LANCZOS if hasattr(Image, 'Resampling') else Image.LANCZOS)\r\n\r\n\r\ndef get_font(fontsize: int):\r\n try:\r\n return ImageFont.truetype(opts.font or roboto_ttf_file, fontsize)\r\n except Exception:\r\n return ImageFont.truetype(roboto_ttf_file, fontsize)\r\n\r\n\r\ndef image_grid(imgs, batch_size=1, rows=None):\r\n if rows is None:\r\n if opts.n_rows > 0:\r\n rows = opts.n_rows\r\n elif opts.n_rows == 0:\r\n rows = batch_size\r\n elif opts.grid_prevent_empty_spots:\r\n rows = math.floor(math.sqrt(len(imgs)))\r\n while len(imgs) % rows != 0:\r\n rows -= 1\r\n else:\r\n rows = math.sqrt(len(imgs))\r\n rows = round(rows)\r\n if rows > len(imgs):\r\n rows = len(imgs)\r\n\r\n cols = math.ceil(len(imgs) / rows)\r\n\r\n params = script_callbacks.ImageGridLoopParams(imgs, cols, rows)\r\n script_callbacks.image_grid_callback(params)\r\n\r\n w, h = imgs[0].size\r\n grid = Image.new('RGB', size=(params.cols * w, params.rows * h), color='black')\r\n\r\n for i, img in enumerate(params.imgs):\r\n grid.paste(img, box=(i % params.cols * w, i // params.cols * h))\r\n\r\n return grid\r\n\r\n\r\nGrid = namedtuple(\"Grid\", [\"tiles\", \"tile_w\", \"tile_h\", \"image_w\", \"image_h\", \"overlap\"])\r\n\r\n\r\ndef split_grid(image, tile_w=512, tile_h=512, overlap=64):\r\n w = image.width\r\n h = image.height\r\n\r\n non_overlap_width = tile_w - overlap\r\n non_overlap_height = tile_h - overlap\r\n\r\n cols = math.ceil((w - overlap) / non_overlap_width)\r\n rows = math.ceil((h - overlap) / non_overlap_height)\r\n\r\n dx = (w - tile_w) / (cols - 1) if cols > 1 else 0\r\n dy = (h - tile_h) / (rows - 1) if rows > 1 else 0\r\n\r\n grid = Grid([], tile_w, tile_h, w, h, overlap)\r\n for row in range(rows):\r\n row_images = []\r\n\r\n y = int(row * dy)\r\n\r\n if y + tile_h >= h:\r\n y = h - tile_h\r\n\r\n for col in range(cols):\r\n x = int(col * dx)\r\n\r\n if x + tile_w >= w:\r\n x = w - tile_w\r\n\r\n tile = image.crop((x, y, x + tile_w, y + tile_h))\r\n\r\n row_images.append([x, tile_w, tile])\r\n\r\n grid.tiles.append([y, tile_h, row_images])\r\n\r\n return grid\r\n\r\n\r\ndef combine_grid(grid):\r\n def make_mask_image(r):\r\n r = r * 255 / grid.overlap\r\n r = r.astype(np.uint8)\r\n return Image.fromarray(r, 'L')\r\n\r\n mask_w = make_mask_image(np.arange(grid.overlap, dtype=np.float32).reshape((1, grid.overlap)).repeat(grid.tile_h, axis=0))\r\n mask_h = make_mask_image(np.arange(grid.overlap, dtype=np.float32).reshape((grid.overlap, 1)).repeat(grid.image_w, axis=1))\r\n\r\n combined_image = Image.new(\"RGB\", (grid.image_w, grid.image_h))\r\n for y, h, row in grid.tiles:\r\n combined_row = Image.new(\"RGB\", (grid.image_w, h))\r\n for x, w, tile in row:\r\n if x == 0:\r\n combined_row.paste(tile, (0, 0))\r\n continue\r\n\r\n combined_row.paste(tile.crop((0, 0, grid.overlap, h)), (x, 0), mask=mask_w)\r\n combined_row.paste(tile.crop((grid.overlap, 0, w, h)), (x + grid.overlap, 0))\r\n\r\n if y == 0:\r\n combined_image.paste(combined_row, (0, 0))\r\n continue\r\n\r\n combined_image.paste(combined_row.crop((0, 0, combined_row.width, grid.overlap)), (0, y), mask=mask_h)\r\n combined_image.paste(combined_row.crop((0, grid.overlap, combined_row.width, h)), (0, y + grid.overlap))\r\n\r\n return combined_image\r\n\r\n\r\nclass GridAnnotation:\r\n def __init__(self, text='', is_active=True):\r\n self.text = text\r\n self.is_active = is_active\r\n self.size = None\r\n\r\n\r\ndef draw_grid_annotations(im, width, height, hor_texts, ver_texts, margin=0):\r\n\r\n color_active = ImageColor.getcolor(opts.grid_text_active_color, 'RGB')\r\n color_inactive = ImageColor.getcolor(opts.grid_text_inactive_color, 'RGB')\r\n color_background = ImageColor.getcolor(opts.grid_background_color, 'RGB')\r\n\r\n def wrap(drawing, text, font, line_length):\r\n lines = ['']\r\n for word in text.split():\r\n line = f'{lines[-1]} {word}'.strip()\r\n if drawing.textlength(line, font=font) <= line_length:\r\n lines[-1] = line\r\n else:\r\n lines.append(word)\r\n return lines\r\n\r\n def draw_texts(drawing, draw_x, draw_y, lines, initial_fnt, initial_fontsize):\r\n for line in lines:\r\n fnt = initial_fnt\r\n fontsize = initial_fontsize\r\n while drawing.multiline_textsize(line.text, font=fnt)[0] > line.allowed_width and fontsize > 0:\r\n fontsize -= 1\r\n fnt = get_font(fontsize)\r\n drawing.multiline_text((draw_x, draw_y + line.size[1] / 2), line.text, font=fnt, fill=color_active if line.is_active else color_inactive, anchor=\"mm\", align=\"center\")\r\n\r\n if not line.is_active:\r\n drawing.line((draw_x - line.size[0] // 2, draw_y + line.size[1] // 2, draw_x + line.size[0] // 2, draw_y + line.size[1] // 2), fill=color_inactive, width=4)\r\n\r\n draw_y += line.size[1] + line_spacing\r\n\r\n fontsize = (width + height) // 25\r\n line_spacing = fontsize // 2\r\n\r\n fnt = get_font(fontsize)\r\n\r\n pad_left = 0 if sum([sum([len(line.text) for line in lines]) for lines in ver_texts]) == 0 else width * 3 // 4\r\n\r\n cols = im.width // width\r\n rows = im.height // height\r\n\r\n assert cols == len(hor_texts), f'bad number of horizontal texts: {len(hor_texts)}; must be {cols}'\r\n assert rows == len(ver_texts), f'bad number of vertical texts: {len(ver_texts)}; must be {rows}'\r\n\r\n calc_img = Image.new(\"RGB\", (1, 1), color_background)\r\n calc_d = ImageDraw.Draw(calc_img)\r\n\r\n for texts, allowed_width in zip(hor_texts + ver_texts, [width] * len(hor_texts) + [pad_left] * len(ver_texts)):\r\n items = [] + texts\r\n texts.clear()\r\n\r\n for line in items:\r\n wrapped = wrap(calc_d, line.text, fnt, allowed_width)\r\n texts += [GridAnnotation(x, line.is_active) for x in wrapped]\r\n\r\n for line in texts:\r\n bbox = calc_d.multiline_textbbox((0, 0), line.text, font=fnt)\r\n line.size = (bbox[2] - bbox[0], bbox[3] - bbox[1])\r\n line.allowed_width = allowed_width\r\n\r\n hor_text_heights = [sum([line.size[1] + line_spacing for line in lines]) - line_spacing for lines in hor_texts]\r\n ver_text_heights = [sum([line.size[1] + line_spacing for line in lines]) - line_spacing * len(lines) for lines in ver_texts]\r\n\r\n pad_top = 0 if sum(hor_text_heights) == 0 else max(hor_text_heights) + line_spacing * 2\r\n\r\n result = Image.new(\"RGB\", (im.width + pad_left + margin * (cols-1), im.height + pad_top + margin * (rows-1)), color_background)\r\n\r\n for row in range(rows):\r\n for col in range(cols):\r\n cell = im.crop((width * col, height * row, width * (col+1), height * (row+1)))\r\n result.paste(cell, (pad_left + (width + margin) * col, pad_top + (height + margin) * row))\r\n\r\n d = ImageDraw.Draw(result)\r\n\r\n for col in range(cols):\r\n x = pad_left + (width + margin) * col + width / 2\r\n y = pad_top / 2 - hor_text_heights[col] / 2\r\n\r\n draw_texts(d, x, y, hor_texts[col], fnt, fontsize)\r\n\r\n for row in range(rows):\r\n x = pad_left / 2\r\n y = pad_top + (height + margin) * row + height / 2 - ver_text_heights[row] / 2\r\n\r\n draw_texts(d, x, y, ver_texts[row], fnt, fontsize)\r\n\r\n return result\r\n\r\n\r\ndef draw_prompt_matrix(im, width, height, all_prompts, margin=0):\r\n prompts = all_prompts[1:]\r\n boundary = math.ceil(len(prompts) / 2)\r\n\r\n prompts_horiz = prompts[:boundary]\r\n prompts_vert = prompts[boundary:]\r\n\r\n hor_texts = [[GridAnnotation(x, is_active=pos & (1 << i) != 0) for i, x in enumerate(prompts_horiz)] for pos in range(1 << len(prompts_horiz))]\r\n ver_texts = [[GridAnnotation(x, is_active=pos & (1 << i) != 0) for i, x in enumerate(prompts_vert)] for pos in range(1 << len(prompts_vert))]\r\n\r\n return draw_grid_annotations(im, width, height, hor_texts, ver_texts, margin)\r\n\r\n\r\ndef resize_image(resize_mode, im, width, height, upscaler_name=None):\r\n \"\"\"\r\n Resizes an image with the specified resize_mode, width, and height.\r\n\r\n Args:\r\n resize_mode: The mode to use when resizing the image.\r\n 0: Resize the image to the specified width and height.\r\n 1: Resize the image to fill the specified width and height, maintaining the aspect ratio, and then center the image within the dimensions, cropping the excess.\r\n 2: Resize the image to fit within the specified width and height, maintaining the aspect ratio, and then center the image within the dimensions, filling empty with data from image.\r\n im: The image to resize.\r\n width: The width to resize the image to.\r\n height: The height to resize the image to.\r\n upscaler_name: The name of the upscaler to use. If not provided, defaults to opts.upscaler_for_img2img.\r\n \"\"\"\r\n\r\n upscaler_name = upscaler_name or opts.upscaler_for_img2img\r\n\r\n def resize(im, w, h):\r\n if upscaler_name is None or upscaler_name == \"None\" or im.mode == 'L':\r\n return im.resize((w, h), resample=LANCZOS)\r\n\r\n scale = max(w / im.width, h / im.height)\r\n\r\n if scale > 1.0:\r\n upscalers = [x for x in shared.sd_upscalers if x.name == upscaler_name]\r\n if len(upscalers) == 0:\r\n upscaler = shared.sd_upscalers[0]\r\n print(f\"could not find upscaler named {upscaler_name or '<empty string>'}, using {upscaler.name} as a fallback\")\r\n else:\r\n upscaler = upscalers[0]\r\n\r\n im = upscaler.scaler.upscale(im, scale, upscaler.data_path)\r\n\r\n if im.width != w or im.height != h:\r\n im = im.resize((w, h), resample=LANCZOS)\r\n\r\n return im\r\n\r\n if resize_mode == 0:\r\n res = resize(im, width, height)\r\n\r\n elif resize_mode == 1:\r\n ratio = width / height\r\n src_ratio = im.width / im.height\r\n\r\n src_w = width if ratio > src_ratio else im.width * height // im.height\r\n src_h = height if ratio <= src_ratio else im.height * width // im.width\r\n\r\n resized = resize(im, src_w, src_h)\r\n res = Image.new(\"RGB\", (width, height))\r\n res.paste(resized, box=(width // 2 - src_w // 2, height // 2 - src_h // 2))\r\n\r\n else:\r\n ratio = width / height\r\n src_ratio = im.width / im.height\r\n\r\n src_w = width if ratio < src_ratio else im.width * height // im.height\r\n src_h = height if ratio >= src_ratio else im.height * width // im.width\r\n\r\n resized = resize(im, src_w, src_h)\r\n res = Image.new(\"RGB\", (width, height))\r\n res.paste(resized, box=(width // 2 - src_w // 2, height // 2 - src_h // 2))\r\n\r\n if ratio < src_ratio:\r\n fill_height = height // 2 - src_h // 2\r\n if fill_height > 0:\r\n res.paste(resized.resize((width, fill_height), box=(0, 0, width, 0)), box=(0, 0))\r\n res.paste(resized.resize((width, fill_height), box=(0, resized.height, width, resized.height)), box=(0, fill_height + src_h))\r\n elif ratio > src_ratio:\r\n fill_width = width // 2 - src_w // 2\r\n if fill_width > 0:\r\n res.paste(resized.resize((fill_width, height), box=(0, 0, 0, height)), box=(0, 0))\r\n res.paste(resized.resize((fill_width, height), box=(resized.width, 0, resized.width, height)), box=(fill_width + src_w, 0))\r\n\r\n return res\r\n\r\n\r\ninvalid_filename_chars = '<>:\"/\\\\|?*\\n\\r\\t'\r\ninvalid_filename_prefix = ' '\r\ninvalid_filename_postfix = ' .'\r\nre_nonletters = re.compile(r'[\\s' + string.punctuation + ']+')\r\nre_pattern = re.compile(r\"(.*?)(?:\\[([^\\[\\]]+)\\]|$)\")\r\nre_pattern_arg = re.compile(r\"(.*)<([^>]*)>$\")\r\nmax_filename_part_length = 128\r\nNOTHING_AND_SKIP_PREVIOUS_TEXT = object()\r\n\r\n\r\ndef sanitize_filename_part(text, replace_spaces=True):\r\n if text is None:\r\n return None\r\n\r\n if replace_spaces:\r\n text = text.replace(' ', '_')\r\n\r\n text = text.translate({ord(x): '_' for x in invalid_filename_chars})\r\n text = text.lstrip(invalid_filename_prefix)[:max_filename_part_length]\r\n text = text.rstrip(invalid_filename_postfix)\r\n return text\r\n\r\n\r\nclass FilenameGenerator:\r\n def get_vae_filename(self): #get the name of the VAE file.\r\n if sd_vae.loaded_vae_file is None:\r\n return \"NoneType\"\r\n file_name = os.path.basename(sd_vae.loaded_vae_file)\r\n split_file_name = file_name.split('.')\r\n if len(split_file_name) > 1 and split_file_name[0] == '':\r\n return split_file_name[1] # if the first character of the filename is \".\" then [1] is obtained.\r\n else:\r\n return split_file_name[0]\r\n\r\n replacements = {\r\n 'seed': lambda self: self.seed if self.seed is not None else '',\r\n 'seed_first': lambda self: self.seed if self.p.batch_size == 1 else self.p.all_seeds[0],\r\n 'seed_last': lambda self: NOTHING_AND_SKIP_PREVIOUS_TEXT if self.p.batch_size == 1 else self.p.all_seeds[-1],\r\n 'steps': lambda self: self.p and self.p.steps,\r\n 'cfg': lambda self: self.p and self.p.cfg_scale,\r\n 'width': lambda self: self.image.width,\r\n 'height': lambda self: self.image.height,\r\n 'styles': lambda self: self.p and sanitize_filename_part(\", \".join([style for style in self.p.styles if not style == \"None\"]) or \"None\", replace_spaces=False),\r\n 'sampler': lambda self: self.p and sanitize_filename_part(self.p.sampler_name, replace_spaces=False),\r\n 'model_hash': lambda self: getattr(self.p, \"sd_model_hash\", shared.sd_model.sd_model_hash),\r\n 'model_name': lambda self: sanitize_filename_part(shared.sd_model.sd_checkpoint_info.name_for_extra, replace_spaces=False),\r\n 'date': lambda self: datetime.datetime.now().strftime('%Y-%m-%d'),\r\n 'datetime': lambda self, *args: self.datetime(*args), # accepts formats: [datetime], [datetime<Format>], [datetime<Format><Time Zone>]\r\n 'job_timestamp': lambda self: getattr(self.p, \"job_timestamp\", shared.state.job_timestamp),\r\n 'prompt_hash': lambda self: hashlib.sha256(self.prompt.encode()).hexdigest()[0:8],\r\n 'prompt': lambda self: sanitize_filename_part(self.prompt),\r\n 'prompt_no_styles': lambda self: self.prompt_no_style(),\r\n 'prompt_spaces': lambda self: sanitize_filename_part(self.prompt, replace_spaces=False),\r\n 'prompt_words': lambda self: self.prompt_words(),\r\n 'batch_number': lambda self: NOTHING_AND_SKIP_PREVIOUS_TEXT if self.p.batch_size == 1 or self.zip else self.p.batch_index + 1,\r\n 'batch_size': lambda self: self.p.batch_size,\r\n 'generation_number': lambda self: NOTHING_AND_SKIP_PREVIOUS_TEXT if (self.p.n_iter == 1 and self.p.batch_size == 1) or self.zip else self.p.iteration * self.p.batch_size + self.p.batch_index + 1,\r\n 'hasprompt': lambda self, *args: self.hasprompt(*args), # accepts formats:[hasprompt<prompt1|default><prompt2>..]\r\n 'clip_skip': lambda self: opts.data[\"CLIP_stop_at_last_layers\"],\r\n 'denoising': lambda self: self.p.denoising_strength if self.p and self.p.denoising_strength else NOTHING_AND_SKIP_PREVIOUS_TEXT,\r\n 'user': lambda self: self.p.user,\r\n 'vae_filename': lambda self: self.get_vae_filename(),\r\n 'none': lambda self: '', # Overrides the default so you can get just the sequence number\r\n }\r\n default_time_format = '%Y%m%d%H%M%S'\r\n\r\n def __init__(self, p, seed, prompt, image, zip=False):\r\n self.p = p\r\n self.seed = seed\r\n self.prompt = prompt\r\n self.image = image\r\n self.zip = zip\r\n\r\n def hasprompt(self, *args):\r\n lower = self.prompt.lower()\r\n if self.p is None or self.prompt is None:\r\n return None\r\n outres = \"\"\r\n for arg in args:\r\n if arg != \"\":\r\n division = arg.split(\"|\")\r\n expected = division[0].lower()\r\n default = division[1] if len(division) > 1 else \"\"\r\n if lower.find(expected) >= 0:\r\n outres = f'{outres}{expected}'\r\n else:\r\n outres = outres if default == \"\" else f'{outres}{default}'\r\n return sanitize_filename_part(outres)\r\n\r\n def prompt_no_style(self):\r\n if self.p is None or self.prompt is None:\r\n return None\r\n\r\n prompt_no_style = self.prompt\r\n for style in shared.prompt_styles.get_style_prompts(self.p.styles):\r\n if style:\r\n for part in style.split(\"{prompt}\"):\r\n prompt_no_style = prompt_no_style.replace(part, \"\").replace(\", ,\", \",\").strip().strip(',')\r\n\r\n prompt_no_style = prompt_no_style.replace(style, \"\").strip().strip(',').strip()\r\n\r\n return sanitize_filename_part(prompt_no_style, replace_spaces=False)\r\n\r\n def prompt_words(self):\r\n words = [x for x in re_nonletters.split(self.prompt or \"\") if x]\r\n if len(words) == 0:\r\n words = [\"empty\"]\r\n return sanitize_filename_part(\" \".join(words[0:opts.directories_max_prompt_words]), replace_spaces=False)\r\n\r\n def datetime(self, *args):\r\n time_datetime = datetime.datetime.now()\r\n\r\n time_format = args[0] if (args and args[0] != \"\") else self.default_time_format\r\n try:\r\n time_zone = pytz.timezone(args[1]) if len(args) > 1 else None\r\n except pytz.exceptions.UnknownTimeZoneError:\r\n time_zone = None\r\n\r\n time_zone_time = time_datetime.astimezone(time_zone)\r\n try:\r\n formatted_time = time_zone_time.strftime(time_format)\r\n except (ValueError, TypeError):\r\n formatted_time = time_zone_time.strftime(self.default_time_format)\r\n\r\n return sanitize_filename_part(formatted_time, replace_spaces=False)\r\n\r\n def apply(self, x):\r\n res = ''\r\n\r\n for m in re_pattern.finditer(x):\r\n text, pattern = m.groups()\r\n\r\n if pattern is None:\r\n res += text\r\n continue\r\n\r\n pattern_args = []\r\n while True:\r\n m = re_pattern_arg.match(pattern)\r\n if m is None:\r\n break\r\n\r\n pattern, arg = m.groups()\r\n pattern_args.insert(0, arg)\r\n\r\n fun = self.replacements.get(pattern.lower())\r\n if fun is not None:\r\n try:\r\n replacement = fun(self, *pattern_args)\r\n except Exception:\r\n replacement = None\r\n errors.report(f\"Error adding [{pattern}] to filename\", exc_info=True)\r\n\r\n if replacement == NOTHING_AND_SKIP_PREVIOUS_TEXT:\r\n continue\r\n elif replacement is not None:\r\n res += text + str(replacement)\r\n continue\r\n\r\n res += f'{text}[{pattern}]'\r\n\r\n return res\r\n\r\n\r\ndef get_next_sequence_number(path, basename):\r\n \"\"\"\r\n Determines and returns the next sequence number to use when saving an image in the specified directory.\r\n\r\n The sequence starts at 0.\r\n \"\"\"\r\n result = -1\r\n if basename != '':\r\n basename = f\"{basename}-\"\r\n\r\n prefix_length = len(basename)\r\n for p in os.listdir(path):\r\n if p.startswith(basename):\r\n parts = os.path.splitext(p[prefix_length:])[0].split('-') # splits the filename (removing the basename first if one is defined, so the sequence number is always the first element)\r\n try:\r\n result = max(int(parts[0]), result)\r\n except ValueError:\r\n pass\r\n\r\n return result + 1\r\n\r\n\r\ndef save_image_with_geninfo(image, geninfo, filename, extension=None, existing_pnginfo=None, pnginfo_section_name='parameters'):\r\n \"\"\"\r\n Saves image to filename, including geninfo as text information for generation info.\r\n For PNG images, geninfo is added to existing pnginfo dictionary using the pnginfo_section_name argument as key.\r\n For JPG images, there's no dictionary and geninfo just replaces the EXIF description.\r\n \"\"\"\r\n\r\n if extension is None:\r\n extension = os.path.splitext(filename)[1]\r\n\r\n image_format = Image.registered_extensions()[extension]\r\n\r\n if extension.lower() == '.png':\r\n existing_pnginfo = existing_pnginfo or {}\r\n if opts.enable_pnginfo:\r\n existing_pnginfo[pnginfo_section_name] = geninfo\r\n\r\n if opts.enable_pnginfo:\r\n pnginfo_data = PngImagePlugin.PngInfo()\r\n for k, v in (existing_pnginfo or {}).items():\r\n pnginfo_data.add_text(k, str(v))\r\n else:\r\n pnginfo_data = None\r\n\r\n image.save(filename, format=image_format, quality=opts.jpeg_quality, pnginfo=pnginfo_data)\r\n\r\n elif extension.lower() in (\".jpg\", \".jpeg\", \".webp\"):\r\n if image.mode == 'RGBA':\r\n image = image.convert(\"RGB\")\r\n elif image.mode == 'I;16':\r\n image = image.point(lambda p: p * 0.0038910505836576).convert(\"RGB\" if extension.lower() == \".webp\" else \"L\")\r\n\r\n image.save(filename, format=image_format, quality=opts.jpeg_quality, lossless=opts.webp_lossless)\r\n\r\n if opts.enable_pnginfo and geninfo is not None:\r\n exif_bytes = piexif.dump({\r\n \"Exif\": {\r\n piexif.ExifIFD.UserComment: piexif.helper.UserComment.dump(geninfo or \"\", encoding=\"unicode\")\r\n },\r\n })\r\n\r\n piexif.insert(exif_bytes, filename)\r\n else:\r\n image.save(filename, format=image_format, quality=opts.jpeg_quality)\r\n\r\n\r\ndef save_image(image, path, basename, seed=None, prompt=None, extension='png', info=None, short_filename=False, no_prompt=False, grid=False, pnginfo_section_name='parameters', p=None, existing_info=None, forced_filename=None, suffix=\"\", save_to_dirs=None):\r\n \"\"\"Save an image.\r\n\r\n Args:\r\n image (`PIL.Image`):\r\n The image to be saved.\r\n path (`str`):\r\n The directory to save the image. Note, the option `save_to_dirs` will make the image to be saved into a sub directory.\r\n basename (`str`):\r\n The base filename which will be applied to `filename pattern`.\r\n seed, prompt, short_filename,\r\n extension (`str`):\r\n Image file extension, default is `png`.\r\n pngsectionname (`str`):\r\n Specify the name of the section which `info` will be saved in.\r\n info (`str` or `PngImagePlugin.iTXt`):\r\n PNG info chunks.\r\n existing_info (`dict`):\r\n Additional PNG info. `existing_info == {pngsectionname: info, ...}`\r\n no_prompt:\r\n TODO I don't know its meaning.\r\n p (`StableDiffusionProcessing`)\r\n forced_filename (`str`):\r\n If specified, `basename` and filename pattern will be ignored.\r\n save_to_dirs (bool):\r\n If true, the image will be saved into a subdirectory of `path`.\r\n\r\n Returns: (fullfn, txt_fullfn)\r\n fullfn (`str`):\r\n The full path of the saved imaged.\r\n txt_fullfn (`str` or None):\r\n If a text file is saved for this image, this will be its full path. Otherwise None.\r\n \"\"\"\r\n namegen = FilenameGenerator(p, seed, prompt, image)\r\n\r\n if save_to_dirs is None:\r\n save_to_dirs = (grid and opts.grid_save_to_dirs) or (not grid and opts.save_to_dirs and not no_prompt)\r\n\r\n if save_to_dirs:\r\n dirname = namegen.apply(opts.directories_filename_pattern or \"[prompt_words]\").lstrip(' ').rstrip('\\\\ /')\r\n path = os.path.join(path, dirname)\r\n\r\n os.makedirs(path, exist_ok=True)\r\n\r\n if forced_filename is None:\r\n if short_filename or seed is None:\r\n file_decoration = \"\"\r\n elif opts.save_to_dirs:\r\n file_decoration = opts.samples_filename_pattern or \"[seed]\"\r\n else:\r\n file_decoration = opts.samples_filename_pattern or \"[seed]-[prompt_spaces]\"\r\n\r\n file_decoration = namegen.apply(file_decoration) + suffix\r\n\r\n add_number = opts.save_images_add_number or file_decoration == ''\r\n\r\n if file_decoration != \"\" and add_number:\r\n file_decoration = f\"-{file_decoration}\"\r\n\r\n if add_number:\r\n basecount = get_next_sequence_number(path, basename)\r\n fullfn = None\r\n for i in range(500):\r\n fn = f\"{basecount + i:05}\" if basename == '' else f\"{basename}-{basecount + i:04}\"\r\n fullfn = os.path.join(path, f\"{fn}{file_decoration}.{extension}\")\r\n if not os.path.exists(fullfn):\r\n break\r\n else:\r\n fullfn = os.path.join(path, f\"{file_decoration}.{extension}\")\r\n else:\r\n fullfn = os.path.join(path, f\"{forced_filename}.{extension}\")\r\n\r\n pnginfo = existing_info or {}\r\n if info is not None:\r\n pnginfo[pnginfo_section_name] = info\r\n\r\n params = script_callbacks.ImageSaveParams(image, p, fullfn, pnginfo)\r\n script_callbacks.before_image_saved_callback(params)\r\n\r\n image = params.image\r\n fullfn = params.filename\r\n info = params.pnginfo.get(pnginfo_section_name, None)\r\n\r\n def _atomically_save_image(image_to_save, filename_without_extension, extension):\r\n \"\"\"\r\n save image with .tmp extension to avoid race condition when another process detects new image in the directory\r\n \"\"\"\r\n temp_file_path = f\"{filename_without_extension}.tmp\"\r\n\r\n save_image_with_geninfo(image_to_save, info, temp_file_path, extension, existing_pnginfo=params.pnginfo, pnginfo_section_name=pnginfo_section_name)\r\n\r\n os.replace(temp_file_path, filename_without_extension + extension)\r\n\r\n fullfn_without_extension, extension = os.path.splitext(params.filename)\r\n if hasattr(os, 'statvfs'):\r\n max_name_len = os.statvfs(path).f_namemax\r\n fullfn_without_extension = fullfn_without_extension[:max_name_len - max(4, len(extension))]\r\n params.filename = fullfn_without_extension + extension\r\n fullfn = params.filename\r\n _atomically_save_image(image, fullfn_without_extension, extension)\r\n\r\n image.already_saved_as = fullfn\r\n\r\n oversize = image.width > opts.target_side_length or image.height > opts.target_side_length\r\n if opts.export_for_4chan and (oversize or os.stat(fullfn).st_size > opts.img_downscale_threshold * 1024 * 1024):\r\n ratio = image.width / image.height\r\n resize_to = None\r\n if oversize and ratio > 1:\r\n resize_to = round(opts.target_side_length), round(image.height * opts.target_side_length / image.width)\r\n elif oversize:\r\n resize_to = round(image.width * opts.target_side_length / image.height), round(opts.target_side_length)\r\n\r\n if resize_to is not None:\r\n try:\r\n # Resizing image with LANCZOS could throw an exception if e.g. image mode is I;16\r\n image = image.resize(resize_to, LANCZOS)\r\n except Exception:\r\n image = image.resize(resize_to)\r\n try:\r\n _atomically_save_image(image, fullfn_without_extension, \".jpg\")\r\n except Exception as e:\r\n errors.display(e, \"saving image as downscaled JPG\")\r\n\r\n if opts.save_txt and info is not None:\r\n txt_fullfn = f\"{fullfn_without_extension}.txt\"\r\n with open(txt_fullfn, \"w\", encoding=\"utf8\") as file:\r\n file.write(f\"{info}\\n\")\r\n else:\r\n txt_fullfn = None\r\n\r\n script_callbacks.image_saved_callback(params)\r\n\r\n return fullfn, txt_fullfn\r\n\r\n\r\nIGNORED_INFO_KEYS = {\r\n 'jfif', 'jfif_version', 'jfif_unit', 'jfif_density', 'dpi', 'exif',\r\n 'loop', 'background', 'timestamp', 'duration', 'progressive', 'progression',\r\n 'icc_profile', 'chromaticity', 'photoshop',\r\n}\r\n\r\n\r\ndef read_info_from_image(image: Image.Image) -> tuple[str | None, dict]:\r\n items = (image.info or {}).copy()\r\n\r\n geninfo = items.pop('parameters', None)\r\n\r\n if \"exif\" in items:\r\n exif = piexif.load(items[\"exif\"])\r\n exif_comment = (exif or {}).get(\"Exif\", {}).get(piexif.ExifIFD.UserComment, b'')\r\n try:\r\n exif_comment = piexif.helper.UserComment.load(exif_comment)\r\n except ValueError:\r\n exif_comment = exif_comment.decode('utf8', errors=\"ignore\")\r\n\r\n if exif_comment:\r\n items['exif comment'] = exif_comment\r\n geninfo = exif_comment\r\n\r\n for field in IGNORED_INFO_KEYS:\r\n items.pop(field, None)\r\n\r\n if items.get(\"Software\", None) == \"NovelAI\":\r\n try:\r\n json_info = json.loads(items[\"Comment\"])\r\n sampler = sd_samplers.samplers_map.get(json_info[\"sampler\"], \"Euler a\")\r\n\r\n geninfo = f\"\"\"{items[\"Description\"]}\r\nNegative prompt: {json_info[\"uc\"]}\r\nSteps: {json_info[\"steps\"]}, Sampler: {sampler}, CFG scale: {json_info[\"scale\"]}, Seed: {json_info[\"seed\"]}, Size: {image.width}x{image.height}, Clip skip: 2, ENSD: 31337\"\"\"\r\n except Exception:\r\n errors.report(\"Error parsing NovelAI image generation parameters\", exc_info=True)\r\n\r\n return geninfo, items\r\n\r\n\r\ndef image_data(data):\r\n import gradio as gr\r\n\r\n try:\r\n image = Image.open(io.BytesIO(data))\r\n textinfo, _ = read_info_from_image(image)\r\n return textinfo, None\r\n except Exception:\r\n pass\r\n\r\n try:\r\n text = data.decode('utf8')\r\n assert len(text) < 10000\r\n return text, None\r\n\r\n except Exception:\r\n pass\r\n\r\n return gr.update(), None\r\n\r\n\r\ndef flatten(img, bgcolor):\r\n \"\"\"replaces transparency with bgcolor (example: \"#ffffff\"), returning an RGB mode image with no transparency\"\"\"\r\n\r\n if img.mode == \"RGBA\":\r\n background = Image.new('RGBA', img.size, bgcolor)\r\n background.paste(img, mask=img)\r\n img = background\r\n\r\n return img.convert('RGB')\r\n","path":"modules/images.py"}],"string":"[\n {\n \"content\": \"from __future__ import annotations\\r\\n\\r\\nimport datetime\\r\\n\\r\\nimport pytz\\r\\nimport io\\r\\nimport math\\r\\nimport os\\r\\nfrom collections import namedtuple\\r\\nimport re\\r\\n\\r\\nimport numpy as np\\r\\nimport piexif\\r\\nimport piexif.helper\\r\\nfrom PIL import Image, ImageFont, ImageDraw, ImageColor, PngImagePlugin\\r\\nimport string\\r\\nimport json\\r\\nimport hashlib\\r\\n\\r\\nfrom modules import sd_samplers, shared, script_callbacks, errors\\r\\nfrom modules.paths_internal import roboto_ttf_file\\r\\nfrom modules.shared import opts\\r\\n\\r\\nimport modules.sd_vae as sd_vae\\r\\n\\r\\nLANCZOS = (Image.Resampling.LANCZOS if hasattr(Image, 'Resampling') else Image.LANCZOS)\\r\\n\\r\\n\\r\\ndef get_font(fontsize: int):\\r\\n try:\\r\\n return ImageFont.truetype(opts.font or roboto_ttf_file, fontsize)\\r\\n except Exception:\\r\\n return ImageFont.truetype(roboto_ttf_file, fontsize)\\r\\n\\r\\n\\r\\ndef image_grid(imgs, batch_size=1, rows=None):\\r\\n if rows is None:\\r\\n if opts.n_rows > 0:\\r\\n rows = opts.n_rows\\r\\n elif opts.n_rows == 0:\\r\\n rows = batch_size\\r\\n elif opts.grid_prevent_empty_spots:\\r\\n rows = math.floor(math.sqrt(len(imgs)))\\r\\n while len(imgs) % rows != 0:\\r\\n rows -= 1\\r\\n else:\\r\\n rows = math.sqrt(len(imgs))\\r\\n rows = round(rows)\\r\\n if rows > len(imgs):\\r\\n rows = len(imgs)\\r\\n\\r\\n cols = math.ceil(len(imgs) / rows)\\r\\n\\r\\n params = script_callbacks.ImageGridLoopParams(imgs, cols, rows)\\r\\n script_callbacks.image_grid_callback(params)\\r\\n\\r\\n w, h = imgs[0].size\\r\\n grid = Image.new('RGB', size=(params.cols * w, params.rows * h), color='black')\\r\\n\\r\\n for i, img in enumerate(params.imgs):\\r\\n grid.paste(img, box=(i % params.cols * w, i // params.cols * h))\\r\\n\\r\\n return grid\\r\\n\\r\\n\\r\\nGrid = namedtuple(\\\"Grid\\\", [\\\"tiles\\\", \\\"tile_w\\\", \\\"tile_h\\\", \\\"image_w\\\", \\\"image_h\\\", \\\"overlap\\\"])\\r\\n\\r\\n\\r\\ndef split_grid(image, tile_w=512, tile_h=512, overlap=64):\\r\\n w = image.width\\r\\n h = image.height\\r\\n\\r\\n non_overlap_width = tile_w - overlap\\r\\n non_overlap_height = tile_h - overlap\\r\\n\\r\\n cols = math.ceil((w - overlap) / non_overlap_width)\\r\\n rows = math.ceil((h - overlap) / non_overlap_height)\\r\\n\\r\\n dx = (w - tile_w) / (cols - 1) if cols > 1 else 0\\r\\n dy = (h - tile_h) / (rows - 1) if rows > 1 else 0\\r\\n\\r\\n grid = Grid([], tile_w, tile_h, w, h, overlap)\\r\\n for row in range(rows):\\r\\n row_images = []\\r\\n\\r\\n y = int(row * dy)\\r\\n\\r\\n if y + tile_h >= h:\\r\\n y = h - tile_h\\r\\n\\r\\n for col in range(cols):\\r\\n x = int(col * dx)\\r\\n\\r\\n if x + tile_w >= w:\\r\\n x = w - tile_w\\r\\n\\r\\n tile = image.crop((x, y, x + tile_w, y + tile_h))\\r\\n\\r\\n row_images.append([x, tile_w, tile])\\r\\n\\r\\n grid.tiles.append([y, tile_h, row_images])\\r\\n\\r\\n return grid\\r\\n\\r\\n\\r\\ndef combine_grid(grid):\\r\\n def make_mask_image(r):\\r\\n r = r * 255 / grid.overlap\\r\\n r = r.astype(np.uint8)\\r\\n return Image.fromarray(r, 'L')\\r\\n\\r\\n mask_w = make_mask_image(np.arange(grid.overlap, dtype=np.float32).reshape((1, grid.overlap)).repeat(grid.tile_h, axis=0))\\r\\n mask_h = make_mask_image(np.arange(grid.overlap, dtype=np.float32).reshape((grid.overlap, 1)).repeat(grid.image_w, axis=1))\\r\\n\\r\\n combined_image = Image.new(\\\"RGB\\\", (grid.image_w, grid.image_h))\\r\\n for y, h, row in grid.tiles:\\r\\n combined_row = Image.new(\\\"RGB\\\", (grid.image_w, h))\\r\\n for x, w, tile in row:\\r\\n if x == 0:\\r\\n combined_row.paste(tile, (0, 0))\\r\\n continue\\r\\n\\r\\n combined_row.paste(tile.crop((0, 0, grid.overlap, h)), (x, 0), mask=mask_w)\\r\\n combined_row.paste(tile.crop((grid.overlap, 0, w, h)), (x + grid.overlap, 0))\\r\\n\\r\\n if y == 0:\\r\\n combined_image.paste(combined_row, (0, 0))\\r\\n continue\\r\\n\\r\\n combined_image.paste(combined_row.crop((0, 0, combined_row.width, grid.overlap)), (0, y), mask=mask_h)\\r\\n combined_image.paste(combined_row.crop((0, grid.overlap, combined_row.width, h)), (0, y + grid.overlap))\\r\\n\\r\\n return combined_image\\r\\n\\r\\n\\r\\nclass GridAnnotation:\\r\\n def __init__(self, text='', is_active=True):\\r\\n self.text = text\\r\\n self.is_active = is_active\\r\\n self.size = None\\r\\n\\r\\n\\r\\ndef draw_grid_annotations(im, width, height, hor_texts, ver_texts, margin=0):\\r\\n\\r\\n color_active = ImageColor.getcolor(opts.grid_text_active_color, 'RGB')\\r\\n color_inactive = ImageColor.getcolor(opts.grid_text_inactive_color, 'RGB')\\r\\n color_background = ImageColor.getcolor(opts.grid_background_color, 'RGB')\\r\\n\\r\\n def wrap(drawing, text, font, line_length):\\r\\n lines = ['']\\r\\n for word in text.split():\\r\\n line = f'{lines[-1]} {word}'.strip()\\r\\n if drawing.textlength(line, font=font) <= line_length:\\r\\n lines[-1] = line\\r\\n else:\\r\\n lines.append(word)\\r\\n return lines\\r\\n\\r\\n def draw_texts(drawing, draw_x, draw_y, lines, initial_fnt, initial_fontsize):\\r\\n for line in lines:\\r\\n fnt = initial_fnt\\r\\n fontsize = initial_fontsize\\r\\n while drawing.multiline_textsize(line.text, font=fnt)[0] > line.allowed_width and fontsize > 0:\\r\\n fontsize -= 1\\r\\n fnt = get_font(fontsize)\\r\\n drawing.multiline_text((draw_x, draw_y + line.size[1] / 2), line.text, font=fnt, fill=color_active if line.is_active else color_inactive, anchor=\\\"mm\\\", align=\\\"center\\\")\\r\\n\\r\\n if not line.is_active:\\r\\n drawing.line((draw_x - line.size[0] // 2, draw_y + line.size[1] // 2, draw_x + line.size[0] // 2, draw_y + line.size[1] // 2), fill=color_inactive, width=4)\\r\\n\\r\\n draw_y += line.size[1] + line_spacing\\r\\n\\r\\n fontsize = (width + height) // 25\\r\\n line_spacing = fontsize // 2\\r\\n\\r\\n fnt = get_font(fontsize)\\r\\n\\r\\n pad_left = 0 if sum([sum([len(line.text) for line in lines]) for lines in ver_texts]) == 0 else width * 3 // 4\\r\\n\\r\\n cols = im.width // width\\r\\n rows = im.height // height\\r\\n\\r\\n assert cols == len(hor_texts), f'bad number of horizontal texts: {len(hor_texts)}; must be {cols}'\\r\\n assert rows == len(ver_texts), f'bad number of vertical texts: {len(ver_texts)}; must be {rows}'\\r\\n\\r\\n calc_img = Image.new(\\\"RGB\\\", (1, 1), color_background)\\r\\n calc_d = ImageDraw.Draw(calc_img)\\r\\n\\r\\n for texts, allowed_width in zip(hor_texts + ver_texts, [width] * len(hor_texts) + [pad_left] * len(ver_texts)):\\r\\n items = [] + texts\\r\\n texts.clear()\\r\\n\\r\\n for line in items:\\r\\n wrapped = wrap(calc_d, line.text, fnt, allowed_width)\\r\\n texts += [GridAnnotation(x, line.is_active) for x in wrapped]\\r\\n\\r\\n for line in texts:\\r\\n bbox = calc_d.multiline_textbbox((0, 0), line.text, font=fnt)\\r\\n line.size = (bbox[2] - bbox[0], bbox[3] - bbox[1])\\r\\n line.allowed_width = allowed_width\\r\\n\\r\\n hor_text_heights = [sum([line.size[1] + line_spacing for line in lines]) - line_spacing for lines in hor_texts]\\r\\n ver_text_heights = [sum([line.size[1] + line_spacing for line in lines]) - line_spacing * len(lines) for lines in ver_texts]\\r\\n\\r\\n pad_top = 0 if sum(hor_text_heights) == 0 else max(hor_text_heights) + line_spacing * 2\\r\\n\\r\\n result = Image.new(\\\"RGB\\\", (im.width + pad_left + margin * (cols-1), im.height + pad_top + margin * (rows-1)), color_background)\\r\\n\\r\\n for row in range(rows):\\r\\n for col in range(cols):\\r\\n cell = im.crop((width * col, height * row, width * (col+1), height * (row+1)))\\r\\n result.paste(cell, (pad_left + (width + margin) * col, pad_top + (height + margin) * row))\\r\\n\\r\\n d = ImageDraw.Draw(result)\\r\\n\\r\\n for col in range(cols):\\r\\n x = pad_left + (width + margin) * col + width / 2\\r\\n y = pad_top / 2 - hor_text_heights[col] / 2\\r\\n\\r\\n draw_texts(d, x, y, hor_texts[col], fnt, fontsize)\\r\\n\\r\\n for row in range(rows):\\r\\n x = pad_left / 2\\r\\n y = pad_top + (height + margin) * row + height / 2 - ver_text_heights[row] / 2\\r\\n\\r\\n draw_texts(d, x, y, ver_texts[row], fnt, fontsize)\\r\\n\\r\\n return result\\r\\n\\r\\n\\r\\ndef draw_prompt_matrix(im, width, height, all_prompts, margin=0):\\r\\n prompts = all_prompts[1:]\\r\\n boundary = math.ceil(len(prompts) / 2)\\r\\n\\r\\n prompts_horiz = prompts[:boundary]\\r\\n prompts_vert = prompts[boundary:]\\r\\n\\r\\n hor_texts = [[GridAnnotation(x, is_active=pos & (1 << i) != 0) for i, x in enumerate(prompts_horiz)] for pos in range(1 << len(prompts_horiz))]\\r\\n ver_texts = [[GridAnnotation(x, is_active=pos & (1 << i) != 0) for i, x in enumerate(prompts_vert)] for pos in range(1 << len(prompts_vert))]\\r\\n\\r\\n return draw_grid_annotations(im, width, height, hor_texts, ver_texts, margin)\\r\\n\\r\\n\\r\\ndef resize_image(resize_mode, im, width, height, upscaler_name=None):\\r\\n \\\"\\\"\\\"\\r\\n Resizes an image with the specified resize_mode, width, and height.\\r\\n\\r\\n Args:\\r\\n resize_mode: The mode to use when resizing the image.\\r\\n 0: Resize the image to the specified width and height.\\r\\n 1: Resize the image to fill the specified width and height, maintaining the aspect ratio, and then center the image within the dimensions, cropping the excess.\\r\\n 2: Resize the image to fit within the specified width and height, maintaining the aspect ratio, and then center the image within the dimensions, filling empty with data from image.\\r\\n im: The image to resize.\\r\\n width: The width to resize the image to.\\r\\n height: The height to resize the image to.\\r\\n upscaler_name: The name of the upscaler to use. If not provided, defaults to opts.upscaler_for_img2img.\\r\\n \\\"\\\"\\\"\\r\\n\\r\\n upscaler_name = upscaler_name or opts.upscaler_for_img2img\\r\\n\\r\\n def resize(im, w, h):\\r\\n if upscaler_name is None or upscaler_name == \\\"None\\\" or im.mode == 'L':\\r\\n return im.resize((w, h), resample=LANCZOS)\\r\\n\\r\\n scale = max(w / im.width, h / im.height)\\r\\n\\r\\n if scale > 1.0:\\r\\n upscalers = [x for x in shared.sd_upscalers if x.name == upscaler_name]\\r\\n if len(upscalers) == 0:\\r\\n upscaler = shared.sd_upscalers[0]\\r\\n print(f\\\"could not find upscaler named {upscaler_name or '<empty string>'}, using {upscaler.name} as a fallback\\\")\\r\\n else:\\r\\n upscaler = upscalers[0]\\r\\n\\r\\n im = upscaler.scaler.upscale(im, scale, upscaler.data_path)\\r\\n\\r\\n if im.width != w or im.height != h:\\r\\n im = im.resize((w, h), resample=LANCZOS)\\r\\n\\r\\n return im\\r\\n\\r\\n if resize_mode == 0:\\r\\n res = resize(im, width, height)\\r\\n\\r\\n elif resize_mode == 1:\\r\\n ratio = width / height\\r\\n src_ratio = im.width / im.height\\r\\n\\r\\n src_w = width if ratio > src_ratio else im.width * height // im.height\\r\\n src_h = height if ratio <= src_ratio else im.height * width // im.width\\r\\n\\r\\n resized = resize(im, src_w, src_h)\\r\\n res = Image.new(\\\"RGB\\\", (width, height))\\r\\n res.paste(resized, box=(width // 2 - src_w // 2, height // 2 - src_h // 2))\\r\\n\\r\\n else:\\r\\n ratio = width / height\\r\\n src_ratio = im.width / im.height\\r\\n\\r\\n src_w = width if ratio < src_ratio else im.width * height // im.height\\r\\n src_h = height if ratio >= src_ratio else im.height * width // im.width\\r\\n\\r\\n resized = resize(im, src_w, src_h)\\r\\n res = Image.new(\\\"RGB\\\", (width, height))\\r\\n res.paste(resized, box=(width // 2 - src_w // 2, height // 2 - src_h // 2))\\r\\n\\r\\n if ratio < src_ratio:\\r\\n fill_height = height // 2 - src_h // 2\\r\\n if fill_height > 0:\\r\\n res.paste(resized.resize((width, fill_height), box=(0, 0, width, 0)), box=(0, 0))\\r\\n res.paste(resized.resize((width, fill_height), box=(0, resized.height, width, resized.height)), box=(0, fill_height + src_h))\\r\\n elif ratio > src_ratio:\\r\\n fill_width = width // 2 - src_w // 2\\r\\n if fill_width > 0:\\r\\n res.paste(resized.resize((fill_width, height), box=(0, 0, 0, height)), box=(0, 0))\\r\\n res.paste(resized.resize((fill_width, height), box=(resized.width, 0, resized.width, height)), box=(fill_width + src_w, 0))\\r\\n\\r\\n return res\\r\\n\\r\\n\\r\\ninvalid_filename_chars = '<>:\\\"/\\\\\\\\|?*\\\\n\\\\r\\\\t'\\r\\ninvalid_filename_prefix = ' '\\r\\ninvalid_filename_postfix = ' .'\\r\\nre_nonletters = re.compile(r'[\\\\s' + string.punctuation + ']+')\\r\\nre_pattern = re.compile(r\\\"(.*?)(?:\\\\[([^\\\\[\\\\]]+)\\\\]|$)\\\")\\r\\nre_pattern_arg = re.compile(r\\\"(.*)<([^>]*)>$\\\")\\r\\nmax_filename_part_length = 128\\r\\nNOTHING_AND_SKIP_PREVIOUS_TEXT = object()\\r\\n\\r\\n\\r\\ndef sanitize_filename_part(text, replace_spaces=True):\\r\\n if text is None:\\r\\n return None\\r\\n\\r\\n if replace_spaces:\\r\\n text = text.replace(' ', '_')\\r\\n\\r\\n text = text.translate({ord(x): '_' for x in invalid_filename_chars})\\r\\n text = text.lstrip(invalid_filename_prefix)[:max_filename_part_length]\\r\\n text = text.rstrip(invalid_filename_postfix)\\r\\n return text\\r\\n\\r\\n\\r\\nclass FilenameGenerator:\\r\\n def get_vae_filename(self): #get the name of the VAE file.\\r\\n if sd_vae.loaded_vae_file is None:\\r\\n return \\\"NoneType\\\"\\r\\n file_name = os.path.basename(sd_vae.loaded_vae_file)\\r\\n split_file_name = file_name.split('.')\\r\\n if len(split_file_name) > 1 and split_file_name[0] == '':\\r\\n return split_file_name[1] # if the first character of the filename is \\\".\\\" then [1] is obtained.\\r\\n else:\\r\\n return split_file_name[0]\\r\\n\\r\\n replacements = {\\r\\n 'seed': lambda self: self.seed if self.seed is not None else '',\\r\\n 'seed_first': lambda self: self.seed if self.p.batch_size == 1 else self.p.all_seeds[0],\\r\\n 'seed_last': lambda self: NOTHING_AND_SKIP_PREVIOUS_TEXT if self.p.batch_size == 1 else self.p.all_seeds[-1],\\r\\n 'steps': lambda self: self.p and self.p.steps,\\r\\n 'cfg': lambda self: self.p and self.p.cfg_scale,\\r\\n 'width': lambda self: self.image.width,\\r\\n 'height': lambda self: self.image.height,\\r\\n 'styles': lambda self: self.p and sanitize_filename_part(\\\", \\\".join([style for style in self.p.styles if not style == \\\"None\\\"]) or \\\"None\\\", replace_spaces=False),\\r\\n 'sampler': lambda self: self.p and sanitize_filename_part(self.p.sampler_name, replace_spaces=False),\\r\\n 'model_hash': lambda self: getattr(self.p, \\\"sd_model_hash\\\", shared.sd_model.sd_model_hash),\\r\\n 'model_name': lambda self: sanitize_filename_part(shared.sd_model.sd_checkpoint_info.name_for_extra, replace_spaces=False),\\r\\n 'date': lambda self: datetime.datetime.now().strftime('%Y-%m-%d'),\\r\\n 'datetime': lambda self, *args: self.datetime(*args), # accepts formats: [datetime], [datetime<Format>], [datetime<Format><Time Zone>]\\r\\n 'job_timestamp': lambda self: getattr(self.p, \\\"job_timestamp\\\", shared.state.job_timestamp),\\r\\n 'prompt_hash': lambda self: hashlib.sha256(self.prompt.encode()).hexdigest()[0:8],\\r\\n 'prompt': lambda self: sanitize_filename_part(self.prompt),\\r\\n 'prompt_no_styles': lambda self: self.prompt_no_style(),\\r\\n 'prompt_spaces': lambda self: sanitize_filename_part(self.prompt, replace_spaces=False),\\r\\n 'prompt_words': lambda self: self.prompt_words(),\\r\\n 'batch_number': lambda self: NOTHING_AND_SKIP_PREVIOUS_TEXT if self.p.batch_size == 1 or self.zip else self.p.batch_index + 1,\\r\\n 'batch_size': lambda self: self.p.batch_size,\\r\\n 'generation_number': lambda self: NOTHING_AND_SKIP_PREVIOUS_TEXT if (self.p.n_iter == 1 and self.p.batch_size == 1) or self.zip else self.p.iteration * self.p.batch_size + self.p.batch_index + 1,\\r\\n 'hasprompt': lambda self, *args: self.hasprompt(*args), # accepts formats:[hasprompt<prompt1|default><prompt2>..]\\r\\n 'clip_skip': lambda self: opts.data[\\\"CLIP_stop_at_last_layers\\\"],\\r\\n 'denoising': lambda self: self.p.denoising_strength if self.p and self.p.denoising_strength else NOTHING_AND_SKIP_PREVIOUS_TEXT,\\r\\n 'user': lambda self: self.p.user,\\r\\n 'vae_filename': lambda self: self.get_vae_filename(),\\r\\n 'none': lambda self: '', # Overrides the default so you can get just the sequence number\\r\\n }\\r\\n default_time_format = '%Y%m%d%H%M%S'\\r\\n\\r\\n def __init__(self, p, seed, prompt, image, zip=False):\\r\\n self.p = p\\r\\n self.seed = seed\\r\\n self.prompt = prompt\\r\\n self.image = image\\r\\n self.zip = zip\\r\\n\\r\\n def hasprompt(self, *args):\\r\\n lower = self.prompt.lower()\\r\\n if self.p is None or self.prompt is None:\\r\\n return None\\r\\n outres = \\\"\\\"\\r\\n for arg in args:\\r\\n if arg != \\\"\\\":\\r\\n division = arg.split(\\\"|\\\")\\r\\n expected = division[0].lower()\\r\\n default = division[1] if len(division) > 1 else \\\"\\\"\\r\\n if lower.find(expected) >= 0:\\r\\n outres = f'{outres}{expected}'\\r\\n else:\\r\\n outres = outres if default == \\\"\\\" else f'{outres}{default}'\\r\\n return sanitize_filename_part(outres)\\r\\n\\r\\n def prompt_no_style(self):\\r\\n if self.p is None or self.prompt is None:\\r\\n return None\\r\\n\\r\\n prompt_no_style = self.prompt\\r\\n for style in shared.prompt_styles.get_style_prompts(self.p.styles):\\r\\n if style:\\r\\n for part in style.split(\\\"{prompt}\\\"):\\r\\n prompt_no_style = prompt_no_style.replace(part, \\\"\\\").replace(\\\", ,\\\", \\\",\\\").strip().strip(',')\\r\\n\\r\\n prompt_no_style = prompt_no_style.replace(style, \\\"\\\").strip().strip(',').strip()\\r\\n\\r\\n return sanitize_filename_part(prompt_no_style, replace_spaces=False)\\r\\n\\r\\n def prompt_words(self):\\r\\n words = [x for x in re_nonletters.split(self.prompt or \\\"\\\") if x]\\r\\n if len(words) == 0:\\r\\n words = [\\\"empty\\\"]\\r\\n return sanitize_filename_part(\\\" \\\".join(words[0:opts.directories_max_prompt_words]), replace_spaces=False)\\r\\n\\r\\n def datetime(self, *args):\\r\\n time_datetime = datetime.datetime.now()\\r\\n\\r\\n time_format = args[0] if (args and args[0] != \\\"\\\") else self.default_time_format\\r\\n try:\\r\\n time_zone = pytz.timezone(args[1]) if len(args) > 1 else None\\r\\n except pytz.exceptions.UnknownTimeZoneError:\\r\\n time_zone = None\\r\\n\\r\\n time_zone_time = time_datetime.astimezone(time_zone)\\r\\n try:\\r\\n formatted_time = time_zone_time.strftime(time_format)\\r\\n except (ValueError, TypeError):\\r\\n formatted_time = time_zone_time.strftime(self.default_time_format)\\r\\n\\r\\n return sanitize_filename_part(formatted_time, replace_spaces=False)\\r\\n\\r\\n def apply(self, x):\\r\\n res = ''\\r\\n\\r\\n for m in re_pattern.finditer(x):\\r\\n text, pattern = m.groups()\\r\\n\\r\\n if pattern is None:\\r\\n res += text\\r\\n continue\\r\\n\\r\\n pattern_args = []\\r\\n while True:\\r\\n m = re_pattern_arg.match(pattern)\\r\\n if m is None:\\r\\n break\\r\\n\\r\\n pattern, arg = m.groups()\\r\\n pattern_args.insert(0, arg)\\r\\n\\r\\n fun = self.replacements.get(pattern.lower())\\r\\n if fun is not None:\\r\\n try:\\r\\n replacement = fun(self, *pattern_args)\\r\\n except Exception:\\r\\n replacement = None\\r\\n errors.report(f\\\"Error adding [{pattern}] to filename\\\", exc_info=True)\\r\\n\\r\\n if replacement == NOTHING_AND_SKIP_PREVIOUS_TEXT:\\r\\n continue\\r\\n elif replacement is not None:\\r\\n res += text + str(replacement)\\r\\n continue\\r\\n\\r\\n res += f'{text}[{pattern}]'\\r\\n\\r\\n return res\\r\\n\\r\\n\\r\\ndef get_next_sequence_number(path, basename):\\r\\n \\\"\\\"\\\"\\r\\n Determines and returns the next sequence number to use when saving an image in the specified directory.\\r\\n\\r\\n The sequence starts at 0.\\r\\n \\\"\\\"\\\"\\r\\n result = -1\\r\\n if basename != '':\\r\\n basename = f\\\"{basename}-\\\"\\r\\n\\r\\n prefix_length = len(basename)\\r\\n for p in os.listdir(path):\\r\\n if p.startswith(basename):\\r\\n parts = os.path.splitext(p[prefix_length:])[0].split('-') # splits the filename (removing the basename first if one is defined, so the sequence number is always the first element)\\r\\n try:\\r\\n result = max(int(parts[0]), result)\\r\\n except ValueError:\\r\\n pass\\r\\n\\r\\n return result + 1\\r\\n\\r\\n\\r\\ndef save_image_with_geninfo(image, geninfo, filename, extension=None, existing_pnginfo=None, pnginfo_section_name='parameters'):\\r\\n \\\"\\\"\\\"\\r\\n Saves image to filename, including geninfo as text information for generation info.\\r\\n For PNG images, geninfo is added to existing pnginfo dictionary using the pnginfo_section_name argument as key.\\r\\n For JPG images, there's no dictionary and geninfo just replaces the EXIF description.\\r\\n \\\"\\\"\\\"\\r\\n\\r\\n if extension is None:\\r\\n extension = os.path.splitext(filename)[1]\\r\\n\\r\\n image_format = Image.registered_extensions()[extension]\\r\\n\\r\\n if extension.lower() == '.png':\\r\\n existing_pnginfo = existing_pnginfo or {}\\r\\n if opts.enable_pnginfo:\\r\\n existing_pnginfo[pnginfo_section_name] = geninfo\\r\\n\\r\\n if opts.enable_pnginfo:\\r\\n pnginfo_data = PngImagePlugin.PngInfo()\\r\\n for k, v in (existing_pnginfo or {}).items():\\r\\n pnginfo_data.add_text(k, str(v))\\r\\n else:\\r\\n pnginfo_data = None\\r\\n\\r\\n image.save(filename, format=image_format, quality=opts.jpeg_quality, pnginfo=pnginfo_data)\\r\\n\\r\\n elif extension.lower() in (\\\".jpg\\\", \\\".jpeg\\\", \\\".webp\\\"):\\r\\n if image.mode == 'RGBA':\\r\\n image = image.convert(\\\"RGB\\\")\\r\\n elif image.mode == 'I;16':\\r\\n image = image.point(lambda p: p * 0.0038910505836576).convert(\\\"RGB\\\" if extension.lower() == \\\".webp\\\" else \\\"L\\\")\\r\\n\\r\\n image.save(filename, format=image_format, quality=opts.jpeg_quality, lossless=opts.webp_lossless)\\r\\n\\r\\n if opts.enable_pnginfo and geninfo is not None:\\r\\n exif_bytes = piexif.dump({\\r\\n \\\"Exif\\\": {\\r\\n piexif.ExifIFD.UserComment: piexif.helper.UserComment.dump(geninfo or \\\"\\\", encoding=\\\"unicode\\\")\\r\\n },\\r\\n })\\r\\n\\r\\n piexif.insert(exif_bytes, filename)\\r\\n else:\\r\\n image.save(filename, format=image_format, quality=opts.jpeg_quality)\\r\\n\\r\\n\\r\\ndef save_image(image, path, basename, seed=None, prompt=None, extension='png', info=None, short_filename=False, no_prompt=False, grid=False, pnginfo_section_name='parameters', p=None, existing_info=None, forced_filename=None, suffix=\\\"\\\", save_to_dirs=None):\\r\\n \\\"\\\"\\\"Save an image.\\r\\n\\r\\n Args:\\r\\n image (`PIL.Image`):\\r\\n The image to be saved.\\r\\n path (`str`):\\r\\n The directory to save the image. Note, the option `save_to_dirs` will make the image to be saved into a sub directory.\\r\\n basename (`str`):\\r\\n The base filename which will be applied to `filename pattern`.\\r\\n seed, prompt, short_filename,\\r\\n extension (`str`):\\r\\n Image file extension, default is `png`.\\r\\n pngsectionname (`str`):\\r\\n Specify the name of the section which `info` will be saved in.\\r\\n info (`str` or `PngImagePlugin.iTXt`):\\r\\n PNG info chunks.\\r\\n existing_info (`dict`):\\r\\n Additional PNG info. `existing_info == {pngsectionname: info, ...}`\\r\\n no_prompt:\\r\\n TODO I don't know its meaning.\\r\\n p (`StableDiffusionProcessing`)\\r\\n forced_filename (`str`):\\r\\n If specified, `basename` and filename pattern will be ignored.\\r\\n save_to_dirs (bool):\\r\\n If true, the image will be saved into a subdirectory of `path`.\\r\\n\\r\\n Returns: (fullfn, txt_fullfn)\\r\\n fullfn (`str`):\\r\\n The full path of the saved imaged.\\r\\n txt_fullfn (`str` or None):\\r\\n If a text file is saved for this image, this will be its full path. Otherwise None.\\r\\n \\\"\\\"\\\"\\r\\n namegen = FilenameGenerator(p, seed, prompt, image)\\r\\n\\r\\n if save_to_dirs is None:\\r\\n save_to_dirs = (grid and opts.grid_save_to_dirs) or (not grid and opts.save_to_dirs and not no_prompt)\\r\\n\\r\\n if save_to_dirs:\\r\\n dirname = namegen.apply(opts.directories_filename_pattern or \\\"[prompt_words]\\\").lstrip(' ').rstrip('\\\\\\\\ /')\\r\\n path = os.path.join(path, dirname)\\r\\n\\r\\n os.makedirs(path, exist_ok=True)\\r\\n\\r\\n if forced_filename is None:\\r\\n if short_filename or seed is None:\\r\\n file_decoration = \\\"\\\"\\r\\n elif opts.save_to_dirs:\\r\\n file_decoration = opts.samples_filename_pattern or \\\"[seed]\\\"\\r\\n else:\\r\\n file_decoration = opts.samples_filename_pattern or \\\"[seed]-[prompt_spaces]\\\"\\r\\n\\r\\n file_decoration = namegen.apply(file_decoration) + suffix\\r\\n\\r\\n add_number = opts.save_images_add_number or file_decoration == ''\\r\\n\\r\\n if file_decoration != \\\"\\\" and add_number:\\r\\n file_decoration = f\\\"-{file_decoration}\\\"\\r\\n\\r\\n if add_number:\\r\\n basecount = get_next_sequence_number(path, basename)\\r\\n fullfn = None\\r\\n for i in range(500):\\r\\n fn = f\\\"{basecount + i:05}\\\" if basename == '' else f\\\"{basename}-{basecount + i:04}\\\"\\r\\n fullfn = os.path.join(path, f\\\"{fn}{file_decoration}.{extension}\\\")\\r\\n if not os.path.exists(fullfn):\\r\\n break\\r\\n else:\\r\\n fullfn = os.path.join(path, f\\\"{file_decoration}.{extension}\\\")\\r\\n else:\\r\\n fullfn = os.path.join(path, f\\\"{forced_filename}.{extension}\\\")\\r\\n\\r\\n pnginfo = existing_info or {}\\r\\n if info is not None:\\r\\n pnginfo[pnginfo_section_name] = info\\r\\n\\r\\n params = script_callbacks.ImageSaveParams(image, p, fullfn, pnginfo)\\r\\n script_callbacks.before_image_saved_callback(params)\\r\\n\\r\\n image = params.image\\r\\n fullfn = params.filename\\r\\n info = params.pnginfo.get(pnginfo_section_name, None)\\r\\n\\r\\n def _atomically_save_image(image_to_save, filename_without_extension, extension):\\r\\n \\\"\\\"\\\"\\r\\n save image with .tmp extension to avoid race condition when another process detects new image in the directory\\r\\n \\\"\\\"\\\"\\r\\n temp_file_path = f\\\"{filename_without_extension}.tmp\\\"\\r\\n\\r\\n save_image_with_geninfo(image_to_save, info, temp_file_path, extension, existing_pnginfo=params.pnginfo, pnginfo_section_name=pnginfo_section_name)\\r\\n\\r\\n os.replace(temp_file_path, filename_without_extension + extension)\\r\\n\\r\\n fullfn_without_extension, extension = os.path.splitext(params.filename)\\r\\n if hasattr(os, 'statvfs'):\\r\\n max_name_len = os.statvfs(path).f_namemax\\r\\n fullfn_without_extension = fullfn_without_extension[:max_name_len - max(4, len(extension))]\\r\\n params.filename = fullfn_without_extension + extension\\r\\n fullfn = params.filename\\r\\n _atomically_save_image(image, fullfn_without_extension, extension)\\r\\n\\r\\n image.already_saved_as = fullfn\\r\\n\\r\\n oversize = image.width > opts.target_side_length or image.height > opts.target_side_length\\r\\n if opts.export_for_4chan and (oversize or os.stat(fullfn).st_size > opts.img_downscale_threshold * 1024 * 1024):\\r\\n ratio = image.width / image.height\\r\\n resize_to = None\\r\\n if oversize and ratio > 1:\\r\\n resize_to = round(opts.target_side_length), round(image.height * opts.target_side_length / image.width)\\r\\n elif oversize:\\r\\n resize_to = round(image.width * opts.target_side_length / image.height), round(opts.target_side_length)\\r\\n\\r\\n if resize_to is not None:\\r\\n try:\\r\\n # Resizing image with LANCZOS could throw an exception if e.g. image mode is I;16\\r\\n image = image.resize(resize_to, LANCZOS)\\r\\n except Exception:\\r\\n image = image.resize(resize_to)\\r\\n try:\\r\\n _atomically_save_image(image, fullfn_without_extension, \\\".jpg\\\")\\r\\n except Exception as e:\\r\\n errors.display(e, \\\"saving image as downscaled JPG\\\")\\r\\n\\r\\n if opts.save_txt and info is not None:\\r\\n txt_fullfn = f\\\"{fullfn_without_extension}.txt\\\"\\r\\n with open(txt_fullfn, \\\"w\\\", encoding=\\\"utf8\\\") as file:\\r\\n file.write(f\\\"{info}\\\\n\\\")\\r\\n else:\\r\\n txt_fullfn = None\\r\\n\\r\\n script_callbacks.image_saved_callback(params)\\r\\n\\r\\n return fullfn, txt_fullfn\\r\\n\\r\\n\\r\\nIGNORED_INFO_KEYS = {\\r\\n 'jfif', 'jfif_version', 'jfif_unit', 'jfif_density', 'dpi', 'exif',\\r\\n 'loop', 'background', 'timestamp', 'duration', 'progressive', 'progression',\\r\\n 'icc_profile', 'chromaticity', 'photoshop',\\r\\n}\\r\\n\\r\\n\\r\\ndef read_info_from_image(image: Image.Image) -> tuple[str | None, dict]:\\r\\n items = (image.info or {}).copy()\\r\\n\\r\\n geninfo = items.pop('parameters', None)\\r\\n\\r\\n if \\\"exif\\\" in items:\\r\\n exif = piexif.load(items[\\\"exif\\\"])\\r\\n exif_comment = (exif or {}).get(\\\"Exif\\\", {}).get(piexif.ExifIFD.UserComment, b'')\\r\\n try:\\r\\n exif_comment = piexif.helper.UserComment.load(exif_comment)\\r\\n except ValueError:\\r\\n exif_comment = exif_comment.decode('utf8', errors=\\\"ignore\\\")\\r\\n\\r\\n if exif_comment:\\r\\n items['exif comment'] = exif_comment\\r\\n geninfo = exif_comment\\r\\n\\r\\n for field in IGNORED_INFO_KEYS:\\r\\n items.pop(field, None)\\r\\n\\r\\n if items.get(\\\"Software\\\", None) == \\\"NovelAI\\\":\\r\\n try:\\r\\n json_info = json.loads(items[\\\"Comment\\\"])\\r\\n sampler = sd_samplers.samplers_map.get(json_info[\\\"sampler\\\"], \\\"Euler a\\\")\\r\\n\\r\\n geninfo = f\\\"\\\"\\\"{items[\\\"Description\\\"]}\\r\\nNegative prompt: {json_info[\\\"uc\\\"]}\\r\\nSteps: {json_info[\\\"steps\\\"]}, Sampler: {sampler}, CFG scale: {json_info[\\\"scale\\\"]}, Seed: {json_info[\\\"seed\\\"]}, Size: {image.width}x{image.height}, Clip skip: 2, ENSD: 31337\\\"\\\"\\\"\\r\\n except Exception:\\r\\n errors.report(\\\"Error parsing NovelAI image generation parameters\\\", exc_info=True)\\r\\n\\r\\n return geninfo, items\\r\\n\\r\\n\\r\\ndef image_data(data):\\r\\n import gradio as gr\\r\\n\\r\\n try:\\r\\n image = Image.open(io.BytesIO(data))\\r\\n textinfo, _ = read_info_from_image(image)\\r\\n return textinfo, None\\r\\n except Exception:\\r\\n pass\\r\\n\\r\\n try:\\r\\n text = data.decode('utf8')\\r\\n assert len(text) < 10000\\r\\n return text, None\\r\\n\\r\\n except Exception:\\r\\n pass\\r\\n\\r\\n return gr.update(), None\\r\\n\\r\\n\\r\\ndef flatten(img, bgcolor):\\r\\n \\\"\\\"\\\"replaces transparency with bgcolor (example: \\\"#ffffff\\\"), returning an RGB mode image with no transparency\\\"\\\"\\\"\\r\\n\\r\\n if img.mode == \\\"RGBA\\\":\\r\\n background = Image.new('RGBA', img.size, bgcolor)\\r\\n background.paste(img, mask=img)\\r\\n img = background\\r\\n\\r\\n return img.convert('RGB')\\r\\n\",\n \"path\": \"modules/images.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/modules/images.py b/modules/images.py\nindex 38aa933d6e5..ba3c43a4509 100644\n--- a/modules/images.py\n+++ b/modules/images.py\n@@ -318,7 +318,7 @@ def resize(im, w, h):\n return res\r\n \r\n \r\n-invalid_filename_chars = '<>:\"/\\\\|?*\\n'\r\n+invalid_filename_chars = '<>:\"/\\\\|?*\\n\\r\\t'\r\n invalid_filename_prefix = ' '\r\n invalid_filename_postfix = ' .'\r\n re_nonletters = re.compile(r'[\\s' + string.punctuation + ']+')\r\n"}}},{"rowIdx":2692,"cells":{"in_source_id":{"kind":"string","value":"python-poetry__poetry-1673"},"issue":{"kind":"string","value":"`poetry shell` with fish does not echo in python REPL\n- [x] I am on the [latest](https://github.com/sdispater/poetry/releases/latest) Poetry version.\r\n- [x] I have searched the [issues](https://github.com/sdispater/poetry/issues) of this repo and believe that this is not a duplicate.\r\n- [x] If an exception occurs when executing a command, I executed it again in debug mode (`-vvv` option).\r\n\r\n- **OS version and name**: MacOS Catalina 10.15.1\r\n- **Poetry version**: 1.0.0b8\r\n- **Link of a [Gist](https://gist.github.com/) with the contents of your pyproject.toml file**: N/A\r\n\r\n## Issue\r\nAs described by [L0stLink](https://github.com/sdispater/poetry/issues/1593#issuecomment-555132468) in a now-closed issue, `fish` still appears to have some issues when using `poetry shell`. Specifically, in the Python REPL \"typed text not visible, but pressing enter shows that the input was registered and whatever was typed, executes\".\r\n\r\nIt appears that the fix in #1621 only addressed the `bash` case.\n"},"before_files":{"kind":"list like","value":[{"content":"import os\nimport signal\nimport sys\n\nimport pexpect\n\nfrom clikit.utils.terminal import Terminal\nfrom shellingham import ShellDetectionFailure\nfrom shellingham import detect_shell\n\nfrom ._compat import WINDOWS\nfrom .env import VirtualEnv\n\n\nclass Shell:\n \"\"\"\n Represents the current shell.\n \"\"\"\n\n _shell = None\n\n def __init__(self, name, path): # type: (str, str) -> None\n self._name = name\n self._path = path\n\n @property\n def name(self): # type: () -> str\n return self._name\n\n @property\n def path(self): # type: () -> str\n return self._path\n\n @classmethod\n def get(cls): # type: () -> Shell\n \"\"\"\n Retrieve the current shell.\n \"\"\"\n if cls._shell is not None:\n return cls._shell\n\n try:\n name, path = detect_shell(os.getpid())\n except (RuntimeError, ShellDetectionFailure):\n raise RuntimeError(\"Unable to detect the current shell.\")\n\n cls._shell = cls(name, path)\n\n return cls._shell\n\n def activate(self, env): # type: (VirtualEnv) -> None\n if WINDOWS:\n return env.execute(self.path)\n\n terminal = Terminal()\n with env.temp_environ():\n c = pexpect.spawn(\n self._path, [\"-i\"], dimensions=(terminal.height, terminal.width)\n )\n\n if not self._name == \"bash\":\n c.setecho(False)\n\n activate_script = self._get_activate_script()\n bin_dir = \"Scripts\" if WINDOWS else \"bin\"\n activate_path = env.path / bin_dir / activate_script\n c.sendline(\"{} {}\".format(self._get_source_command(), activate_path))\n\n def resize(sig, data):\n terminal = Terminal()\n c.setwinsize(terminal.height, terminal.width)\n\n signal.signal(signal.SIGWINCH, resize)\n\n # Interact with the new shell.\n c.interact(escape_character=None)\n c.close()\n\n sys.exit(c.exitstatus)\n\n def _get_activate_script(self):\n if \"fish\" == self._name:\n suffix = \".fish\"\n elif \"csh\" == self._name:\n suffix = \".csh\"\n else:\n suffix = \"\"\n\n return \"activate\" + suffix\n\n def _get_source_command(self):\n if \"fish\" == self._name:\n return \"source\"\n elif \"csh\" == self._name:\n return \"source\"\n\n return \".\"\n\n def __repr__(self): # type: () -> str\n return '{}(\"{}\", \"{}\")'.format(self.__class__.__name__, self._name, self._path)\n","path":"poetry/utils/shell.py"}],"string":"[\n {\n \"content\": \"import os\\nimport signal\\nimport sys\\n\\nimport pexpect\\n\\nfrom clikit.utils.terminal import Terminal\\nfrom shellingham import ShellDetectionFailure\\nfrom shellingham import detect_shell\\n\\nfrom ._compat import WINDOWS\\nfrom .env import VirtualEnv\\n\\n\\nclass Shell:\\n \\\"\\\"\\\"\\n Represents the current shell.\\n \\\"\\\"\\\"\\n\\n _shell = None\\n\\n def __init__(self, name, path): # type: (str, str) -> None\\n self._name = name\\n self._path = path\\n\\n @property\\n def name(self): # type: () -> str\\n return self._name\\n\\n @property\\n def path(self): # type: () -> str\\n return self._path\\n\\n @classmethod\\n def get(cls): # type: () -> Shell\\n \\\"\\\"\\\"\\n Retrieve the current shell.\\n \\\"\\\"\\\"\\n if cls._shell is not None:\\n return cls._shell\\n\\n try:\\n name, path = detect_shell(os.getpid())\\n except (RuntimeError, ShellDetectionFailure):\\n raise RuntimeError(\\\"Unable to detect the current shell.\\\")\\n\\n cls._shell = cls(name, path)\\n\\n return cls._shell\\n\\n def activate(self, env): # type: (VirtualEnv) -> None\\n if WINDOWS:\\n return env.execute(self.path)\\n\\n terminal = Terminal()\\n with env.temp_environ():\\n c = pexpect.spawn(\\n self._path, [\\\"-i\\\"], dimensions=(terminal.height, terminal.width)\\n )\\n\\n if not self._name == \\\"bash\\\":\\n c.setecho(False)\\n\\n activate_script = self._get_activate_script()\\n bin_dir = \\\"Scripts\\\" if WINDOWS else \\\"bin\\\"\\n activate_path = env.path / bin_dir / activate_script\\n c.sendline(\\\"{} {}\\\".format(self._get_source_command(), activate_path))\\n\\n def resize(sig, data):\\n terminal = Terminal()\\n c.setwinsize(terminal.height, terminal.width)\\n\\n signal.signal(signal.SIGWINCH, resize)\\n\\n # Interact with the new shell.\\n c.interact(escape_character=None)\\n c.close()\\n\\n sys.exit(c.exitstatus)\\n\\n def _get_activate_script(self):\\n if \\\"fish\\\" == self._name:\\n suffix = \\\".fish\\\"\\n elif \\\"csh\\\" == self._name:\\n suffix = \\\".csh\\\"\\n else:\\n suffix = \\\"\\\"\\n\\n return \\\"activate\\\" + suffix\\n\\n def _get_source_command(self):\\n if \\\"fish\\\" == self._name:\\n return \\\"source\\\"\\n elif \\\"csh\\\" == self._name:\\n return \\\"source\\\"\\n\\n return \\\".\\\"\\n\\n def __repr__(self): # type: () -> str\\n return '{}(\\\"{}\\\", \\\"{}\\\")'.format(self.__class__.__name__, self._name, self._path)\\n\",\n \"path\": \"poetry/utils/shell.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import os\nimport signal\nimport sys\n\nimport pexpect\n\nfrom clikit.utils.terminal import Terminal\nfrom shellingham import ShellDetectionFailure\nfrom shellingham import detect_shell\n\nfrom ._compat import WINDOWS\nfrom .env import VirtualEnv\n\n\nclass Shell:\n \"\"\"\n Represents the current shell.\n \"\"\"\n\n _shell = None\n\n def __init__(self, name, path): # type: (str, str) -> None\n self._name = name\n self._path = path\n\n @property\n def name(self): # type: () -> str\n return self._name\n\n @property\n def path(self): # type: () -> str\n return self._path\n\n @classmethod\n def get(cls): # type: () -> Shell\n \"\"\"\n Retrieve the current shell.\n \"\"\"\n if cls._shell is not None:\n return cls._shell\n\n try:\n name, path = detect_shell(os.getpid())\n except (RuntimeError, ShellDetectionFailure):\n raise RuntimeError(\"Unable to detect the current shell.\")\n\n cls._shell = cls(name, path)\n\n return cls._shell\n\n def activate(self, env): # type: (VirtualEnv) -> None\n if WINDOWS:\n return env.execute(self.path)\n\n terminal = Terminal()\n with env.temp_environ():\n c = pexpect.spawn(\n self._path, [\"-i\"], dimensions=(terminal.height, terminal.width)\n )\n\n if self._name == \"zsh\":\n c.setecho(False)\n\n activate_script = self._get_activate_script()\n bin_dir = \"Scripts\" if WINDOWS else \"bin\"\n activate_path = env.path / bin_dir / activate_script\n c.sendline(\"{} {}\".format(self._get_source_command(), activate_path))\n\n def resize(sig, data):\n terminal = Terminal()\n c.setwinsize(terminal.height, terminal.width)\n\n signal.signal(signal.SIGWINCH, resize)\n\n # Interact with the new shell.\n c.interact(escape_character=None)\n c.close()\n\n sys.exit(c.exitstatus)\n\n def _get_activate_script(self):\n if \"fish\" == self._name:\n suffix = \".fish\"\n elif \"csh\" == self._name:\n suffix = \".csh\"\n else:\n suffix = \"\"\n\n return \"activate\" + suffix\n\n def _get_source_command(self):\n if \"fish\" == self._name:\n return \"source\"\n elif \"csh\" == self._name:\n return \"source\"\n\n return \".\"\n\n def __repr__(self): # type: () -> str\n return '{}(\"{}\", \"{}\")'.format(self.__class__.__name__, self._name, self._path)\n","path":"poetry/utils/shell.py"}],"string":"[\n {\n \"content\": \"import os\\nimport signal\\nimport sys\\n\\nimport pexpect\\n\\nfrom clikit.utils.terminal import Terminal\\nfrom shellingham import ShellDetectionFailure\\nfrom shellingham import detect_shell\\n\\nfrom ._compat import WINDOWS\\nfrom .env import VirtualEnv\\n\\n\\nclass Shell:\\n \\\"\\\"\\\"\\n Represents the current shell.\\n \\\"\\\"\\\"\\n\\n _shell = None\\n\\n def __init__(self, name, path): # type: (str, str) -> None\\n self._name = name\\n self._path = path\\n\\n @property\\n def name(self): # type: () -> str\\n return self._name\\n\\n @property\\n def path(self): # type: () -> str\\n return self._path\\n\\n @classmethod\\n def get(cls): # type: () -> Shell\\n \\\"\\\"\\\"\\n Retrieve the current shell.\\n \\\"\\\"\\\"\\n if cls._shell is not None:\\n return cls._shell\\n\\n try:\\n name, path = detect_shell(os.getpid())\\n except (RuntimeError, ShellDetectionFailure):\\n raise RuntimeError(\\\"Unable to detect the current shell.\\\")\\n\\n cls._shell = cls(name, path)\\n\\n return cls._shell\\n\\n def activate(self, env): # type: (VirtualEnv) -> None\\n if WINDOWS:\\n return env.execute(self.path)\\n\\n terminal = Terminal()\\n with env.temp_environ():\\n c = pexpect.spawn(\\n self._path, [\\\"-i\\\"], dimensions=(terminal.height, terminal.width)\\n )\\n\\n if self._name == \\\"zsh\\\":\\n c.setecho(False)\\n\\n activate_script = self._get_activate_script()\\n bin_dir = \\\"Scripts\\\" if WINDOWS else \\\"bin\\\"\\n activate_path = env.path / bin_dir / activate_script\\n c.sendline(\\\"{} {}\\\".format(self._get_source_command(), activate_path))\\n\\n def resize(sig, data):\\n terminal = Terminal()\\n c.setwinsize(terminal.height, terminal.width)\\n\\n signal.signal(signal.SIGWINCH, resize)\\n\\n # Interact with the new shell.\\n c.interact(escape_character=None)\\n c.close()\\n\\n sys.exit(c.exitstatus)\\n\\n def _get_activate_script(self):\\n if \\\"fish\\\" == self._name:\\n suffix = \\\".fish\\\"\\n elif \\\"csh\\\" == self._name:\\n suffix = \\\".csh\\\"\\n else:\\n suffix = \\\"\\\"\\n\\n return \\\"activate\\\" + suffix\\n\\n def _get_source_command(self):\\n if \\\"fish\\\" == self._name:\\n return \\\"source\\\"\\n elif \\\"csh\\\" == self._name:\\n return \\\"source\\\"\\n\\n return \\\".\\\"\\n\\n def __repr__(self): # type: () -> str\\n return '{}(\\\"{}\\\", \\\"{}\\\")'.format(self.__class__.__name__, self._name, self._path)\\n\",\n \"path\": \"poetry/utils/shell.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/poetry/utils/shell.py b/poetry/utils/shell.py\nindex 5a6afb650e1..e883c80fc6e 100644\n--- a/poetry/utils/shell.py\n+++ b/poetry/utils/shell.py\n@@ -58,7 +58,7 @@ def activate(self, env): # type: (VirtualEnv) -> None\n self._path, [\"-i\"], dimensions=(terminal.height, terminal.width)\n )\n \n- if not self._name == \"bash\":\n+ if self._name == \"zsh\":\n c.setecho(False)\n \n activate_script = self._get_activate_script()\n"}}},{"rowIdx":2693,"cells":{"in_source_id":{"kind":"string","value":"ManageIQ__integration_tests-7470"},"issue":{"kind":"string","value":"[BUG] get_mgmt blowing error if provider_key is a dict\nThis piece of code\r\nhttps://github.com/ManageIQ/integration_tests/blob/3ccb7ac459f98df2da3c6b522ee257c80ae29aba/cfme/utils/providers.py#L389-L393\r\nis causing `TypeError: unhashable type: 'AttrDict'` if `provider_key` is a unhashable type (dict).\r\nusing the first argument as a dict can be found in here\r\nhttps://github.com/ManageIQ/integration_tests/blob/4df0616bdea9cfb14974ab29d8b0590894189d92/cfme/utils/template/base.py#L141-L153\r\nand here\r\nhttps://github.com/ManageIQ/integration_tests/blob/ad10e312a53c5ac21c3a66fcb230de454f4850f9/cfme/cloud/provider/vcloud.py#L57-L65\n"},"before_files":{"kind":"list like","value":[{"content":"\"\"\" Helper functions related to the creation, listing, filtering and destruction of providers\n\nThe list_providers function in this module depend on a (by default global) dict of filters.\nIf you are writing tests or fixtures, you want to depend on this function as a de facto gateway.\n\nThe rest of the functions, such as get_mgmt, get_crud, get_provider_keys etc ignore this global\ndict and will provide you with whatever you ask for with no limitations.\n\nThe main clue to know what is limited by the filters and what isn't is the 'filters' parameter.\n\"\"\"\nimport operator\nimport six\nfrom collections import Mapping, OrderedDict\nfrom copy import copy\n\nfrom cfme.common.provider import all_types\n\nfrom cfme.exceptions import UnknownProviderType\nfrom cfme.utils import conf\nfrom cfme.utils.log import logger\n\nproviders_data = conf.cfme_data.get(\"management_systems\", {})\n# Dict of active provider filters {name: ProviderFilter}\nglobal_filters = {}\n\n# Store instances of provider mgmt classes that we have instantiated before,\n# so that we don't re-generate mgmt classes for the same exact provider\nPROVIDER_MGMT_CACHE = {}\n\n\ndef load_setuptools_entrypoints():\n \"\"\" Load modules from querying the specified setuptools entrypoint name.\"\"\"\n from pkg_resources import (iter_entry_points, DistributionNotFound,\n VersionConflict)\n for ep in iter_entry_points('manageiq_integration_tests'):\n # is the plugin registered or blocked?\n try:\n ep.load()\n except DistributionNotFound:\n continue\n except VersionConflict as e:\n raise Exception(\n \"Plugin {} could not be loaded: {}!\".format(ep.name, e))\n\n\nclass ProviderFilter(object):\n \"\"\" Filter used to obtain only providers matching given requirements\n\n Args:\n keys: List of acceptable provider keys, all if `None`\n categories: List of acceptable provider categories, all if `None`\n types: List of acceptable provider types, all if `None`\n required_fields: List of required fields, see :py:func:`providers_by_class`\n restrict_version: Checks provider version in yamls if `True`\n required_tags: List of tags that must be set in yamls\n inverted: Inclusive if `False`, exclusive otherwise\n conjunctive: If true, all subfilters are applied and all must match (default)\n If false (disjunctive), at least one of the subfilters must match\n \"\"\"\n _version_operator_map = OrderedDict([('>=', operator.ge),\n ('<=', operator.le),\n ('==', operator.eq),\n ('!=', operator.ne),\n ('>', operator.gt),\n ('<', operator.lt)])\n\n def __init__(self, keys=None, classes=None, required_fields=None, required_tags=None,\n required_flags=None, restrict_version=False, inverted=False, conjunctive=True):\n self.keys = keys\n self.classes = classes\n self.required_fields = required_fields\n self.required_tags = required_tags\n self.required_flags = required_flags\n self.restrict_version = restrict_version\n self.inverted = inverted\n self.conjunctive = conjunctive\n\n def _filter_keys(self, provider):\n \"\"\" Filters by provider keys \"\"\"\n if self.keys is None:\n return None\n return provider.key in self.keys\n\n def _filter_classes(self, provider):\n \"\"\" Filters by provider (base) classes \"\"\"\n if self.classes is None:\n return None\n return any(provider.one_of(prov_class) for prov_class in self.classes)\n\n def _filter_required_fields(self, provider):\n \"\"\" Filters by required yaml fields (specified usually during test parametrization) \"\"\"\n if self.required_fields is None:\n return None\n for field_or_fields in self.required_fields:\n if isinstance(field_or_fields, tuple):\n field_ident, field_value = field_or_fields\n else:\n field_ident, field_value = field_or_fields, None\n if isinstance(field_ident, six.string_types):\n if field_ident not in provider.data:\n return False\n else:\n if field_value:\n if provider.data[field_ident] != field_value:\n return False\n else:\n o = provider.data\n try:\n for field in field_ident:\n o = o[field]\n if field_value:\n if o != field_value:\n return False\n except (IndexError, KeyError):\n return False\n return True\n\n def _filter_required_tags(self, provider):\n \"\"\" Filters by required yaml tags \"\"\"\n prov_tags = provider.data.get('tags', [])\n if self.required_tags is None:\n return None\n if set(self.required_tags) & set(prov_tags):\n return True\n return False\n\n def _filter_required_flags(self, provider):\n \"\"\" Filters by required yaml flags \"\"\"\n if self.required_flags is None:\n return None\n if self.required_flags:\n test_flags = [flag.strip() for flag in self.required_flags]\n\n defined_flags = conf.cfme_data.get('test_flags', '')\n if isinstance(defined_flags, six.string_types):\n defined_flags = defined_flags.split(',')\n defined_flags = [flag.strip() for flag in defined_flags]\n\n excluded_flags = provider.data.get('excluded_test_flags', '')\n if isinstance(excluded_flags, six.string_types):\n excluded_flags = excluded_flags.split(',')\n excluded_flags = [flag.strip() for flag in excluded_flags]\n\n allowed_flags = set(defined_flags) - set(excluded_flags)\n\n if set(test_flags) - allowed_flags:\n logger.info(\"Filtering Provider %s out because it does not have the right flags, \"\n \"%s does not contain %s\",\n provider.name, list(allowed_flags),\n list(set(test_flags) - allowed_flags))\n return False\n return True\n\n def _filter_restricted_version(self, provider):\n \"\"\" Filters by yaml version restriction; not applied if SSH is not available \"\"\"\n if self.restrict_version:\n # TODO\n # get rid of this since_version hotfix by translating since_version\n # to restricted_version; in addition, restricted_version should turn into\n # \"version_restrictions\" and it should be a sequence of restrictions with operators\n # so that we can create ranges like \">= 5.6\" and \"<= 5.8\"\n version_restrictions = []\n since_version = provider.data.get('since_version')\n if since_version:\n version_restrictions.append('>= {}'.format(since_version))\n restricted_version = provider.data.get('restricted_version')\n if restricted_version:\n version_restrictions.append(restricted_version)\n for restriction in version_restrictions:\n for op, comparator in ProviderFilter._version_operator_map.items():\n # split string by op; if the split works, version won't be empty\n head, op, ver = restriction.partition(op)\n if not ver: # This means that the operator was not found\n continue\n try:\n curr_ver = provider.appliance.version\n except:\n return True\n ver = type(curr_ver)(ver)\n if not comparator(curr_ver, ver):\n return False\n break\n else:\n raise Exception('Operator not found in {}'.format(restriction))\n return None\n\n def __call__(self, provider):\n \"\"\" Applies this filter on a given provider\n\n Usage:\n pf = ProviderFilter('cloud_infra', categories=['cloud', 'infra'])\n providers = list_providers([pf])\n pf2 = ProviderFilter(\n classes=[GCEProvider, EC2Provider], required_fields=['small_template'])\n provider_keys = [prov.key for prov in list_providers([pf, pf2])]\n ^ this will list keys of all GCE and EC2 providers\n ...or...\n pf = ProviderFilter(required_tags=['openstack', 'complete'])\n pf_inverted = ProviderFilter(required_tags=['disabled'], inverted=True)\n providers = list_providers([pf, pf_inverted])\n ^ this will return providers that have both the \"openstack\" and \"complete\" tags set\n and at the same time don't have the \"disabled\" tag\n ...or...\n pf = ProviderFilter(keys=['rhevm34'], class=CloudProvider, conjunctive=False)\n providers = list_providers([pf])\n ^ this will list all providers that either have the 'rhevm34' key or are an instance\n of the CloudProvider class and therefore are a cloud provider\n\n Returns:\n `True` if provider passed all checks and was not filtered out, `False` otherwise.\n The result is opposite if the 'inverted' attribute is set to `True`.\n \"\"\"\n keys_l = self._filter_keys(provider)\n classes_l = self._filter_classes(provider)\n fields_l = self._filter_required_fields(provider)\n tags_l = self._filter_required_tags(provider)\n flags_l = self._filter_required_flags(provider)\n version_l = self._filter_restricted_version(provider)\n results = [keys_l, classes_l, fields_l, tags_l, flags_l, version_l]\n relevant_results = [res for res in results if res in [True, False]]\n compiling_fn = all if self.conjunctive else any\n # If all / any filters return true, the provider was not blocked (unless inverted)\n if compiling_fn(relevant_results):\n return not self.inverted\n return self.inverted\n\n def copy(self):\n return copy(self)\n\n\n# Only providers without the 'disabled' tag\nglobal_filters['enabled_only'] = ProviderFilter(required_tags=['disabled'], inverted=True)\n# Only providers relevant for current appliance version (requires SSH access when used)\nglobal_filters['restrict_version'] = ProviderFilter(restrict_version=True)\n\n\ndef list_providers(filters=None, use_global_filters=True):\n \"\"\" Lists provider crud objects, global filter optional\n\n Args:\n filters: List if :py:class:`ProviderFilter` or None\n use_global_filters: Will apply global filters as well if `True`, will not otherwise\n\n Note: Requires the framework to be pointed at an appliance to succeed.\n\n Returns: List of provider crud objects.\n \"\"\"\n if isinstance(filters, six.string_types):\n raise TypeError(\n 'You are probably using the old-style invocation of provider setup functions! '\n 'You need to change it appropriately.')\n filters = filters or []\n if use_global_filters:\n filters = filters + list(global_filters.values())\n providers = [get_crud(prov_key) for prov_key in providers_data]\n for prov_filter in filters:\n providers = list(filter(prov_filter, providers))\n return providers\n\n\ndef list_providers_by_class(prov_class, use_global_filters=True):\n \"\"\" Lists provider crud objects of a specific class (or its subclasses), global filter optional\n\n Args:\n prov_class: Provider class to apply for filtering\n use_global_filters: See :py:func:`list_providers`\n appliance: Optional :py:class:`utils.appliance.IPAppliance` to be passed to provider CRUD\n objects\n\n Note: Requires the framework to be pointed at an appliance to succeed.\n\n Returns: List of provider crud objects.\n \"\"\"\n pf = ProviderFilter(classes=[prov_class])\n return list_providers(filters=[pf], use_global_filters=use_global_filters)\n\n\ndef list_provider_keys(provider_type=None):\n \"\"\" Lists provider keys from conf (yamls)\n\n Args:\n provider_type: Optional filtering by 'type' string (from yaml); disabled by default\n\n Note: Doesn't require the framework to be pointed at an appliance to succeed.\n\n Returns: List of provider keys (strings).\n \"\"\"\n try:\n all_keys = conf.cfme_data.management_systems.keys()\n except:\n all_keys = []\n\n if provider_type:\n filtered_keys = []\n for key in all_keys:\n if conf.cfme_data.management_systems[key].type == provider_type:\n filtered_keys.append(key)\n return filtered_keys\n else:\n return all_keys\n\n\ndef get_class_from_type(prov_type):\n try:\n return all_types()[prov_type]\n except KeyError:\n raise UnknownProviderType(\"Unknown provider type: {}!\".format(prov_type))\n\n\ndef get_crud(provider_key):\n \"\"\" Creates a Provider object given a management_system key in cfme_data.\n\n Usage:\n get_crud('ec2east')\n\n Returns: A Provider object that has methods that operate on CFME\n \"\"\"\n # TODO: note, get_crud will be enturely removed shortly and replaced with collections methods\n\n prov_config = providers_data[provider_key]\n prov_type = prov_config.get('type')\n\n return get_class_from_type(prov_type).from_config(\n prov_config, provider_key)\n\n\ndef get_crud_by_name(provider_name):\n \"\"\" Creates a Provider object given a management_system name in cfme_data.\n\n Usage:\n get_crud_by_name('My RHEV 3.6 Provider')\n\n Returns: A Provider object that has methods that operate on CFME\n \"\"\"\n for provider_key, provider_data in providers_data.items():\n if provider_data.get(\"name\") == provider_name:\n return get_crud(provider_key)\n raise NameError(\"Could not find provider {}\".format(provider_name))\n\n\ndef get_mgmt(provider_key, providers=None, credentials=None):\n \"\"\" Provides a ``wrapanapi`` object, based on the request.\n\n Args:\n provider_key: The name of a provider, as supplied in the yaml configuration files.\n You can also use the dictionary if you want to pass the provider data directly.\n providers: A set of data in the same format as the ``management_systems`` section in the\n configuration yamls. If ``None`` then the configuration is loaded from the default\n locations. Expects a dict.\n credentials: A set of credentials in the same format as the ``credentials`` yamls files.\n If ``None`` then credentials are loaded from the default locations. Expects a dict.\n Return: A provider instance of the appropriate ``wrapanapi.WrapanapiAPIBase``\n subclass\n \"\"\"\n if providers is None:\n providers = providers_data\n # provider_key can also be provider_data for some reason\n # TODO rename the parameter; might break things\n if isinstance(provider_key, Mapping):\n provider_data = provider_key\n else:\n provider_data = providers[provider_key]\n\n if credentials is None:\n # We need to handle the in-place credentials\n\n if provider_data.get('endpoints'):\n credentials = provider_data['endpoints']['default']['credentials']\n else:\n credentials = provider_data['credentials']\n # If it is not a mapping, it most likely points to a credentials yaml (as by default)\n if not isinstance(credentials, Mapping):\n credentials = conf.credentials[credentials]\n # Otherwise it is a mapping and therefore we consider it credentials\n\n # Munge together provider dict and creds,\n # Let the provider do whatever they need with them\n provider_kwargs = provider_data.copy()\n provider_kwargs.update(credentials)\n\n if not provider_kwargs.get('username') and provider_kwargs.get('principal'):\n provider_kwargs['username'] = provider_kwargs['principal']\n provider_kwargs['password'] = provider_kwargs['secret']\n\n if isinstance(provider_key, six.string_types):\n provider_kwargs['provider_key'] = provider_key\n provider_kwargs['logger'] = logger\n\n if provider_key not in PROVIDER_MGMT_CACHE:\n mgmt_instance = get_class_from_type(provider_data['type']).mgmt_class(**provider_kwargs)\n PROVIDER_MGMT_CACHE[provider_key] = mgmt_instance\n else:\n logger.debug(\"returning cached mgmt class for '%s'\", provider_key)\n return PROVIDER_MGMT_CACHE[provider_key]\n\n\nclass UnknownProvider(Exception):\n def __init__(self, provider_key, *args, **kwargs):\n super(UnknownProvider, self).__init__(provider_key, *args, **kwargs)\n self.provider_key = provider_key\n\n def __str__(self):\n return ('Unknown provider: \"{}\"'.format(self.provider_key))\n","path":"cfme/utils/providers.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\" Helper functions related to the creation, listing, filtering and destruction of providers\\n\\nThe list_providers function in this module depend on a (by default global) dict of filters.\\nIf you are writing tests or fixtures, you want to depend on this function as a de facto gateway.\\n\\nThe rest of the functions, such as get_mgmt, get_crud, get_provider_keys etc ignore this global\\ndict and will provide you with whatever you ask for with no limitations.\\n\\nThe main clue to know what is limited by the filters and what isn't is the 'filters' parameter.\\n\\\"\\\"\\\"\\nimport operator\\nimport six\\nfrom collections import Mapping, OrderedDict\\nfrom copy import copy\\n\\nfrom cfme.common.provider import all_types\\n\\nfrom cfme.exceptions import UnknownProviderType\\nfrom cfme.utils import conf\\nfrom cfme.utils.log import logger\\n\\nproviders_data = conf.cfme_data.get(\\\"management_systems\\\", {})\\n# Dict of active provider filters {name: ProviderFilter}\\nglobal_filters = {}\\n\\n# Store instances of provider mgmt classes that we have instantiated before,\\n# so that we don't re-generate mgmt classes for the same exact provider\\nPROVIDER_MGMT_CACHE = {}\\n\\n\\ndef load_setuptools_entrypoints():\\n \\\"\\\"\\\" Load modules from querying the specified setuptools entrypoint name.\\\"\\\"\\\"\\n from pkg_resources import (iter_entry_points, DistributionNotFound,\\n VersionConflict)\\n for ep in iter_entry_points('manageiq_integration_tests'):\\n # is the plugin registered or blocked?\\n try:\\n ep.load()\\n except DistributionNotFound:\\n continue\\n except VersionConflict as e:\\n raise Exception(\\n \\\"Plugin {} could not be loaded: {}!\\\".format(ep.name, e))\\n\\n\\nclass ProviderFilter(object):\\n \\\"\\\"\\\" Filter used to obtain only providers matching given requirements\\n\\n Args:\\n keys: List of acceptable provider keys, all if `None`\\n categories: List of acceptable provider categories, all if `None`\\n types: List of acceptable provider types, all if `None`\\n required_fields: List of required fields, see :py:func:`providers_by_class`\\n restrict_version: Checks provider version in yamls if `True`\\n required_tags: List of tags that must be set in yamls\\n inverted: Inclusive if `False`, exclusive otherwise\\n conjunctive: If true, all subfilters are applied and all must match (default)\\n If false (disjunctive), at least one of the subfilters must match\\n \\\"\\\"\\\"\\n _version_operator_map = OrderedDict([('>=', operator.ge),\\n ('<=', operator.le),\\n ('==', operator.eq),\\n ('!=', operator.ne),\\n ('>', operator.gt),\\n ('<', operator.lt)])\\n\\n def __init__(self, keys=None, classes=None, required_fields=None, required_tags=None,\\n required_flags=None, restrict_version=False, inverted=False, conjunctive=True):\\n self.keys = keys\\n self.classes = classes\\n self.required_fields = required_fields\\n self.required_tags = required_tags\\n self.required_flags = required_flags\\n self.restrict_version = restrict_version\\n self.inverted = inverted\\n self.conjunctive = conjunctive\\n\\n def _filter_keys(self, provider):\\n \\\"\\\"\\\" Filters by provider keys \\\"\\\"\\\"\\n if self.keys is None:\\n return None\\n return provider.key in self.keys\\n\\n def _filter_classes(self, provider):\\n \\\"\\\"\\\" Filters by provider (base) classes \\\"\\\"\\\"\\n if self.classes is None:\\n return None\\n return any(provider.one_of(prov_class) for prov_class in self.classes)\\n\\n def _filter_required_fields(self, provider):\\n \\\"\\\"\\\" Filters by required yaml fields (specified usually during test parametrization) \\\"\\\"\\\"\\n if self.required_fields is None:\\n return None\\n for field_or_fields in self.required_fields:\\n if isinstance(field_or_fields, tuple):\\n field_ident, field_value = field_or_fields\\n else:\\n field_ident, field_value = field_or_fields, None\\n if isinstance(field_ident, six.string_types):\\n if field_ident not in provider.data:\\n return False\\n else:\\n if field_value:\\n if provider.data[field_ident] != field_value:\\n return False\\n else:\\n o = provider.data\\n try:\\n for field in field_ident:\\n o = o[field]\\n if field_value:\\n if o != field_value:\\n return False\\n except (IndexError, KeyError):\\n return False\\n return True\\n\\n def _filter_required_tags(self, provider):\\n \\\"\\\"\\\" Filters by required yaml tags \\\"\\\"\\\"\\n prov_tags = provider.data.get('tags', [])\\n if self.required_tags is None:\\n return None\\n if set(self.required_tags) & set(prov_tags):\\n return True\\n return False\\n\\n def _filter_required_flags(self, provider):\\n \\\"\\\"\\\" Filters by required yaml flags \\\"\\\"\\\"\\n if self.required_flags is None:\\n return None\\n if self.required_flags:\\n test_flags = [flag.strip() for flag in self.required_flags]\\n\\n defined_flags = conf.cfme_data.get('test_flags', '')\\n if isinstance(defined_flags, six.string_types):\\n defined_flags = defined_flags.split(',')\\n defined_flags = [flag.strip() for flag in defined_flags]\\n\\n excluded_flags = provider.data.get('excluded_test_flags', '')\\n if isinstance(excluded_flags, six.string_types):\\n excluded_flags = excluded_flags.split(',')\\n excluded_flags = [flag.strip() for flag in excluded_flags]\\n\\n allowed_flags = set(defined_flags) - set(excluded_flags)\\n\\n if set(test_flags) - allowed_flags:\\n logger.info(\\\"Filtering Provider %s out because it does not have the right flags, \\\"\\n \\\"%s does not contain %s\\\",\\n provider.name, list(allowed_flags),\\n list(set(test_flags) - allowed_flags))\\n return False\\n return True\\n\\n def _filter_restricted_version(self, provider):\\n \\\"\\\"\\\" Filters by yaml version restriction; not applied if SSH is not available \\\"\\\"\\\"\\n if self.restrict_version:\\n # TODO\\n # get rid of this since_version hotfix by translating since_version\\n # to restricted_version; in addition, restricted_version should turn into\\n # \\\"version_restrictions\\\" and it should be a sequence of restrictions with operators\\n # so that we can create ranges like \\\">= 5.6\\\" and \\\"<= 5.8\\\"\\n version_restrictions = []\\n since_version = provider.data.get('since_version')\\n if since_version:\\n version_restrictions.append('>= {}'.format(since_version))\\n restricted_version = provider.data.get('restricted_version')\\n if restricted_version:\\n version_restrictions.append(restricted_version)\\n for restriction in version_restrictions:\\n for op, comparator in ProviderFilter._version_operator_map.items():\\n # split string by op; if the split works, version won't be empty\\n head, op, ver = restriction.partition(op)\\n if not ver: # This means that the operator was not found\\n continue\\n try:\\n curr_ver = provider.appliance.version\\n except:\\n return True\\n ver = type(curr_ver)(ver)\\n if not comparator(curr_ver, ver):\\n return False\\n break\\n else:\\n raise Exception('Operator not found in {}'.format(restriction))\\n return None\\n\\n def __call__(self, provider):\\n \\\"\\\"\\\" Applies this filter on a given provider\\n\\n Usage:\\n pf = ProviderFilter('cloud_infra', categories=['cloud', 'infra'])\\n providers = list_providers([pf])\\n pf2 = ProviderFilter(\\n classes=[GCEProvider, EC2Provider], required_fields=['small_template'])\\n provider_keys = [prov.key for prov in list_providers([pf, pf2])]\\n ^ this will list keys of all GCE and EC2 providers\\n ...or...\\n pf = ProviderFilter(required_tags=['openstack', 'complete'])\\n pf_inverted = ProviderFilter(required_tags=['disabled'], inverted=True)\\n providers = list_providers([pf, pf_inverted])\\n ^ this will return providers that have both the \\\"openstack\\\" and \\\"complete\\\" tags set\\n and at the same time don't have the \\\"disabled\\\" tag\\n ...or...\\n pf = ProviderFilter(keys=['rhevm34'], class=CloudProvider, conjunctive=False)\\n providers = list_providers([pf])\\n ^ this will list all providers that either have the 'rhevm34' key or are an instance\\n of the CloudProvider class and therefore are a cloud provider\\n\\n Returns:\\n `True` if provider passed all checks and was not filtered out, `False` otherwise.\\n The result is opposite if the 'inverted' attribute is set to `True`.\\n \\\"\\\"\\\"\\n keys_l = self._filter_keys(provider)\\n classes_l = self._filter_classes(provider)\\n fields_l = self._filter_required_fields(provider)\\n tags_l = self._filter_required_tags(provider)\\n flags_l = self._filter_required_flags(provider)\\n version_l = self._filter_restricted_version(provider)\\n results = [keys_l, classes_l, fields_l, tags_l, flags_l, version_l]\\n relevant_results = [res for res in results if res in [True, False]]\\n compiling_fn = all if self.conjunctive else any\\n # If all / any filters return true, the provider was not blocked (unless inverted)\\n if compiling_fn(relevant_results):\\n return not self.inverted\\n return self.inverted\\n\\n def copy(self):\\n return copy(self)\\n\\n\\n# Only providers without the 'disabled' tag\\nglobal_filters['enabled_only'] = ProviderFilter(required_tags=['disabled'], inverted=True)\\n# Only providers relevant for current appliance version (requires SSH access when used)\\nglobal_filters['restrict_version'] = ProviderFilter(restrict_version=True)\\n\\n\\ndef list_providers(filters=None, use_global_filters=True):\\n \\\"\\\"\\\" Lists provider crud objects, global filter optional\\n\\n Args:\\n filters: List if :py:class:`ProviderFilter` or None\\n use_global_filters: Will apply global filters as well if `True`, will not otherwise\\n\\n Note: Requires the framework to be pointed at an appliance to succeed.\\n\\n Returns: List of provider crud objects.\\n \\\"\\\"\\\"\\n if isinstance(filters, six.string_types):\\n raise TypeError(\\n 'You are probably using the old-style invocation of provider setup functions! '\\n 'You need to change it appropriately.')\\n filters = filters or []\\n if use_global_filters:\\n filters = filters + list(global_filters.values())\\n providers = [get_crud(prov_key) for prov_key in providers_data]\\n for prov_filter in filters:\\n providers = list(filter(prov_filter, providers))\\n return providers\\n\\n\\ndef list_providers_by_class(prov_class, use_global_filters=True):\\n \\\"\\\"\\\" Lists provider crud objects of a specific class (or its subclasses), global filter optional\\n\\n Args:\\n prov_class: Provider class to apply for filtering\\n use_global_filters: See :py:func:`list_providers`\\n appliance: Optional :py:class:`utils.appliance.IPAppliance` to be passed to provider CRUD\\n objects\\n\\n Note: Requires the framework to be pointed at an appliance to succeed.\\n\\n Returns: List of provider crud objects.\\n \\\"\\\"\\\"\\n pf = ProviderFilter(classes=[prov_class])\\n return list_providers(filters=[pf], use_global_filters=use_global_filters)\\n\\n\\ndef list_provider_keys(provider_type=None):\\n \\\"\\\"\\\" Lists provider keys from conf (yamls)\\n\\n Args:\\n provider_type: Optional filtering by 'type' string (from yaml); disabled by default\\n\\n Note: Doesn't require the framework to be pointed at an appliance to succeed.\\n\\n Returns: List of provider keys (strings).\\n \\\"\\\"\\\"\\n try:\\n all_keys = conf.cfme_data.management_systems.keys()\\n except:\\n all_keys = []\\n\\n if provider_type:\\n filtered_keys = []\\n for key in all_keys:\\n if conf.cfme_data.management_systems[key].type == provider_type:\\n filtered_keys.append(key)\\n return filtered_keys\\n else:\\n return all_keys\\n\\n\\ndef get_class_from_type(prov_type):\\n try:\\n return all_types()[prov_type]\\n except KeyError:\\n raise UnknownProviderType(\\\"Unknown provider type: {}!\\\".format(prov_type))\\n\\n\\ndef get_crud(provider_key):\\n \\\"\\\"\\\" Creates a Provider object given a management_system key in cfme_data.\\n\\n Usage:\\n get_crud('ec2east')\\n\\n Returns: A Provider object that has methods that operate on CFME\\n \\\"\\\"\\\"\\n # TODO: note, get_crud will be enturely removed shortly and replaced with collections methods\\n\\n prov_config = providers_data[provider_key]\\n prov_type = prov_config.get('type')\\n\\n return get_class_from_type(prov_type).from_config(\\n prov_config, provider_key)\\n\\n\\ndef get_crud_by_name(provider_name):\\n \\\"\\\"\\\" Creates a Provider object given a management_system name in cfme_data.\\n\\n Usage:\\n get_crud_by_name('My RHEV 3.6 Provider')\\n\\n Returns: A Provider object that has methods that operate on CFME\\n \\\"\\\"\\\"\\n for provider_key, provider_data in providers_data.items():\\n if provider_data.get(\\\"name\\\") == provider_name:\\n return get_crud(provider_key)\\n raise NameError(\\\"Could not find provider {}\\\".format(provider_name))\\n\\n\\ndef get_mgmt(provider_key, providers=None, credentials=None):\\n \\\"\\\"\\\" Provides a ``wrapanapi`` object, based on the request.\\n\\n Args:\\n provider_key: The name of a provider, as supplied in the yaml configuration files.\\n You can also use the dictionary if you want to pass the provider data directly.\\n providers: A set of data in the same format as the ``management_systems`` section in the\\n configuration yamls. If ``None`` then the configuration is loaded from the default\\n locations. Expects a dict.\\n credentials: A set of credentials in the same format as the ``credentials`` yamls files.\\n If ``None`` then credentials are loaded from the default locations. Expects a dict.\\n Return: A provider instance of the appropriate ``wrapanapi.WrapanapiAPIBase``\\n subclass\\n \\\"\\\"\\\"\\n if providers is None:\\n providers = providers_data\\n # provider_key can also be provider_data for some reason\\n # TODO rename the parameter; might break things\\n if isinstance(provider_key, Mapping):\\n provider_data = provider_key\\n else:\\n provider_data = providers[provider_key]\\n\\n if credentials is None:\\n # We need to handle the in-place credentials\\n\\n if provider_data.get('endpoints'):\\n credentials = provider_data['endpoints']['default']['credentials']\\n else:\\n credentials = provider_data['credentials']\\n # If it is not a mapping, it most likely points to a credentials yaml (as by default)\\n if not isinstance(credentials, Mapping):\\n credentials = conf.credentials[credentials]\\n # Otherwise it is a mapping and therefore we consider it credentials\\n\\n # Munge together provider dict and creds,\\n # Let the provider do whatever they need with them\\n provider_kwargs = provider_data.copy()\\n provider_kwargs.update(credentials)\\n\\n if not provider_kwargs.get('username') and provider_kwargs.get('principal'):\\n provider_kwargs['username'] = provider_kwargs['principal']\\n provider_kwargs['password'] = provider_kwargs['secret']\\n\\n if isinstance(provider_key, six.string_types):\\n provider_kwargs['provider_key'] = provider_key\\n provider_kwargs['logger'] = logger\\n\\n if provider_key not in PROVIDER_MGMT_CACHE:\\n mgmt_instance = get_class_from_type(provider_data['type']).mgmt_class(**provider_kwargs)\\n PROVIDER_MGMT_CACHE[provider_key] = mgmt_instance\\n else:\\n logger.debug(\\\"returning cached mgmt class for '%s'\\\", provider_key)\\n return PROVIDER_MGMT_CACHE[provider_key]\\n\\n\\nclass UnknownProvider(Exception):\\n def __init__(self, provider_key, *args, **kwargs):\\n super(UnknownProvider, self).__init__(provider_key, *args, **kwargs)\\n self.provider_key = provider_key\\n\\n def __str__(self):\\n return ('Unknown provider: \\\"{}\\\"'.format(self.provider_key))\\n\",\n \"path\": \"cfme/utils/providers.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"\"\"\" Helper functions related to the creation, listing, filtering and destruction of providers\n\nThe list_providers function in this module depend on a (by default global) dict of filters.\nIf you are writing tests or fixtures, you want to depend on this function as a de facto gateway.\n\nThe rest of the functions, such as get_mgmt, get_crud, get_provider_keys etc ignore this global\ndict and will provide you with whatever you ask for with no limitations.\n\nThe main clue to know what is limited by the filters and what isn't is the 'filters' parameter.\n\"\"\"\nimport operator\nimport six\nfrom collections import Mapping, OrderedDict\nfrom copy import copy\n\nfrom cfme.common.provider import all_types\n\nfrom cfme.exceptions import UnknownProviderType\nfrom cfme.utils import conf\nfrom cfme.utils.log import logger\n\nproviders_data = conf.cfme_data.get(\"management_systems\", {})\n# Dict of active provider filters {name: ProviderFilter}\nglobal_filters = {}\n\n# Store instances of provider mgmt classes that we have instantiated before,\n# so that we don't re-generate mgmt classes for the same exact provider\nPROVIDER_MGMT_CACHE = {}\n\n\ndef load_setuptools_entrypoints():\n \"\"\" Load modules from querying the specified setuptools entrypoint name.\"\"\"\n from pkg_resources import (iter_entry_points, DistributionNotFound,\n VersionConflict)\n for ep in iter_entry_points('manageiq_integration_tests'):\n # is the plugin registered or blocked?\n try:\n ep.load()\n except DistributionNotFound:\n continue\n except VersionConflict as e:\n raise Exception(\n \"Plugin {} could not be loaded: {}!\".format(ep.name, e))\n\n\nclass ProviderFilter(object):\n \"\"\" Filter used to obtain only providers matching given requirements\n\n Args:\n keys: List of acceptable provider keys, all if `None`\n categories: List of acceptable provider categories, all if `None`\n types: List of acceptable provider types, all if `None`\n required_fields: List of required fields, see :py:func:`providers_by_class`\n restrict_version: Checks provider version in yamls if `True`\n required_tags: List of tags that must be set in yamls\n inverted: Inclusive if `False`, exclusive otherwise\n conjunctive: If true, all subfilters are applied and all must match (default)\n If false (disjunctive), at least one of the subfilters must match\n \"\"\"\n _version_operator_map = OrderedDict([('>=', operator.ge),\n ('<=', operator.le),\n ('==', operator.eq),\n ('!=', operator.ne),\n ('>', operator.gt),\n ('<', operator.lt)])\n\n def __init__(self, keys=None, classes=None, required_fields=None, required_tags=None,\n required_flags=None, restrict_version=False, inverted=False, conjunctive=True):\n self.keys = keys\n self.classes = classes\n self.required_fields = required_fields\n self.required_tags = required_tags\n self.required_flags = required_flags\n self.restrict_version = restrict_version\n self.inverted = inverted\n self.conjunctive = conjunctive\n\n def _filter_keys(self, provider):\n \"\"\" Filters by provider keys \"\"\"\n if self.keys is None:\n return None\n return provider.key in self.keys\n\n def _filter_classes(self, provider):\n \"\"\" Filters by provider (base) classes \"\"\"\n if self.classes is None:\n return None\n return any(provider.one_of(prov_class) for prov_class in self.classes)\n\n def _filter_required_fields(self, provider):\n \"\"\" Filters by required yaml fields (specified usually during test parametrization) \"\"\"\n if self.required_fields is None:\n return None\n for field_or_fields in self.required_fields:\n if isinstance(field_or_fields, tuple):\n field_ident, field_value = field_or_fields\n else:\n field_ident, field_value = field_or_fields, None\n if isinstance(field_ident, six.string_types):\n if field_ident not in provider.data:\n return False\n else:\n if field_value:\n if provider.data[field_ident] != field_value:\n return False\n else:\n o = provider.data\n try:\n for field in field_ident:\n o = o[field]\n if field_value:\n if o != field_value:\n return False\n except (IndexError, KeyError):\n return False\n return True\n\n def _filter_required_tags(self, provider):\n \"\"\" Filters by required yaml tags \"\"\"\n prov_tags = provider.data.get('tags', [])\n if self.required_tags is None:\n return None\n if set(self.required_tags) & set(prov_tags):\n return True\n return False\n\n def _filter_required_flags(self, provider):\n \"\"\" Filters by required yaml flags \"\"\"\n if self.required_flags is None:\n return None\n if self.required_flags:\n test_flags = [flag.strip() for flag in self.required_flags]\n\n defined_flags = conf.cfme_data.get('test_flags', '')\n if isinstance(defined_flags, six.string_types):\n defined_flags = defined_flags.split(',')\n defined_flags = [flag.strip() for flag in defined_flags]\n\n excluded_flags = provider.data.get('excluded_test_flags', '')\n if isinstance(excluded_flags, six.string_types):\n excluded_flags = excluded_flags.split(',')\n excluded_flags = [flag.strip() for flag in excluded_flags]\n\n allowed_flags = set(defined_flags) - set(excluded_flags)\n\n if set(test_flags) - allowed_flags:\n logger.info(\"Filtering Provider %s out because it does not have the right flags, \"\n \"%s does not contain %s\",\n provider.name, list(allowed_flags),\n list(set(test_flags) - allowed_flags))\n return False\n return True\n\n def _filter_restricted_version(self, provider):\n \"\"\" Filters by yaml version restriction; not applied if SSH is not available \"\"\"\n if self.restrict_version:\n # TODO\n # get rid of this since_version hotfix by translating since_version\n # to restricted_version; in addition, restricted_version should turn into\n # \"version_restrictions\" and it should be a sequence of restrictions with operators\n # so that we can create ranges like \">= 5.6\" and \"<= 5.8\"\n version_restrictions = []\n since_version = provider.data.get('since_version')\n if since_version:\n version_restrictions.append('>= {}'.format(since_version))\n restricted_version = provider.data.get('restricted_version')\n if restricted_version:\n version_restrictions.append(restricted_version)\n for restriction in version_restrictions:\n for op, comparator in ProviderFilter._version_operator_map.items():\n # split string by op; if the split works, version won't be empty\n head, op, ver = restriction.partition(op)\n if not ver: # This means that the operator was not found\n continue\n try:\n curr_ver = provider.appliance.version\n except:\n return True\n ver = type(curr_ver)(ver)\n if not comparator(curr_ver, ver):\n return False\n break\n else:\n raise Exception('Operator not found in {}'.format(restriction))\n return None\n\n def __call__(self, provider):\n \"\"\" Applies this filter on a given provider\n\n Usage:\n pf = ProviderFilter('cloud_infra', categories=['cloud', 'infra'])\n providers = list_providers([pf])\n pf2 = ProviderFilter(\n classes=[GCEProvider, EC2Provider], required_fields=['small_template'])\n provider_keys = [prov.key for prov in list_providers([pf, pf2])]\n ^ this will list keys of all GCE and EC2 providers\n ...or...\n pf = ProviderFilter(required_tags=['openstack', 'complete'])\n pf_inverted = ProviderFilter(required_tags=['disabled'], inverted=True)\n providers = list_providers([pf, pf_inverted])\n ^ this will return providers that have both the \"openstack\" and \"complete\" tags set\n and at the same time don't have the \"disabled\" tag\n ...or...\n pf = ProviderFilter(keys=['rhevm34'], class=CloudProvider, conjunctive=False)\n providers = list_providers([pf])\n ^ this will list all providers that either have the 'rhevm34' key or are an instance\n of the CloudProvider class and therefore are a cloud provider\n\n Returns:\n `True` if provider passed all checks and was not filtered out, `False` otherwise.\n The result is opposite if the 'inverted' attribute is set to `True`.\n \"\"\"\n keys_l = self._filter_keys(provider)\n classes_l = self._filter_classes(provider)\n fields_l = self._filter_required_fields(provider)\n tags_l = self._filter_required_tags(provider)\n flags_l = self._filter_required_flags(provider)\n version_l = self._filter_restricted_version(provider)\n results = [keys_l, classes_l, fields_l, tags_l, flags_l, version_l]\n relevant_results = [res for res in results if res in [True, False]]\n compiling_fn = all if self.conjunctive else any\n # If all / any filters return true, the provider was not blocked (unless inverted)\n if compiling_fn(relevant_results):\n return not self.inverted\n return self.inverted\n\n def copy(self):\n return copy(self)\n\n\n# Only providers without the 'disabled' tag\nglobal_filters['enabled_only'] = ProviderFilter(required_tags=['disabled'], inverted=True)\n# Only providers relevant for current appliance version (requires SSH access when used)\nglobal_filters['restrict_version'] = ProviderFilter(restrict_version=True)\n\n\ndef list_providers(filters=None, use_global_filters=True):\n \"\"\" Lists provider crud objects, global filter optional\n\n Args:\n filters: List if :py:class:`ProviderFilter` or None\n use_global_filters: Will apply global filters as well if `True`, will not otherwise\n\n Note: Requires the framework to be pointed at an appliance to succeed.\n\n Returns: List of provider crud objects.\n \"\"\"\n if isinstance(filters, six.string_types):\n raise TypeError(\n 'You are probably using the old-style invocation of provider setup functions! '\n 'You need to change it appropriately.')\n filters = filters or []\n if use_global_filters:\n filters = filters + list(global_filters.values())\n providers = [get_crud(prov_key) for prov_key in providers_data]\n for prov_filter in filters:\n providers = list(filter(prov_filter, providers))\n return providers\n\n\ndef list_providers_by_class(prov_class, use_global_filters=True):\n \"\"\" Lists provider crud objects of a specific class (or its subclasses), global filter optional\n\n Args:\n prov_class: Provider class to apply for filtering\n use_global_filters: See :py:func:`list_providers`\n appliance: Optional :py:class:`utils.appliance.IPAppliance` to be passed to provider CRUD\n objects\n\n Note: Requires the framework to be pointed at an appliance to succeed.\n\n Returns: List of provider crud objects.\n \"\"\"\n pf = ProviderFilter(classes=[prov_class])\n return list_providers(filters=[pf], use_global_filters=use_global_filters)\n\n\ndef list_provider_keys(provider_type=None):\n \"\"\" Lists provider keys from conf (yamls)\n\n Args:\n provider_type: Optional filtering by 'type' string (from yaml); disabled by default\n\n Note: Doesn't require the framework to be pointed at an appliance to succeed.\n\n Returns: List of provider keys (strings).\n \"\"\"\n try:\n all_keys = conf.cfme_data.management_systems.keys()\n except:\n all_keys = []\n\n if provider_type:\n filtered_keys = []\n for key in all_keys:\n if conf.cfme_data.management_systems[key].type == provider_type:\n filtered_keys.append(key)\n return filtered_keys\n else:\n return all_keys\n\n\ndef get_class_from_type(prov_type):\n try:\n return all_types()[prov_type]\n except KeyError:\n raise UnknownProviderType(\"Unknown provider type: {}!\".format(prov_type))\n\n\ndef get_crud(provider_key):\n \"\"\" Creates a Provider object given a management_system key in cfme_data.\n\n Usage:\n get_crud('ec2east')\n\n Returns: A Provider object that has methods that operate on CFME\n \"\"\"\n # TODO: note, get_crud will be enturely removed shortly and replaced with collections methods\n\n prov_config = providers_data[provider_key]\n prov_type = prov_config.get('type')\n\n return get_class_from_type(prov_type).from_config(\n prov_config, provider_key)\n\n\ndef get_crud_by_name(provider_name):\n \"\"\" Creates a Provider object given a management_system name in cfme_data.\n\n Usage:\n get_crud_by_name('My RHEV 3.6 Provider')\n\n Returns: A Provider object that has methods that operate on CFME\n \"\"\"\n for provider_key, provider_data in providers_data.items():\n if provider_data.get(\"name\") == provider_name:\n return get_crud(provider_key)\n raise NameError(\"Could not find provider {}\".format(provider_name))\n\n\ndef get_mgmt(provider_key, providers=None, credentials=None):\n \"\"\" Provides a ``wrapanapi`` object, based on the request.\n\n Args:\n provider_key: The name of a provider, as supplied in the yaml configuration files.\n You can also use the dictionary if you want to pass the provider data directly.\n providers: A set of data in the same format as the ``management_systems`` section in the\n configuration yamls. If ``None`` then the configuration is loaded from the default\n locations. Expects a dict.\n credentials: A set of credentials in the same format as the ``credentials`` yamls files.\n If ``None`` then credentials are loaded from the default locations. Expects a dict.\n Return: A provider instance of the appropriate ``wrapanapi.WrapanapiAPIBase``\n subclass\n \"\"\"\n if providers is None:\n providers = providers_data\n # provider_key can also be provider_data for some reason\n # TODO rename the parameter; might break things\n if isinstance(provider_key, Mapping):\n provider_data = provider_key\n provider_key = provider_data['name']\n else:\n provider_data = providers[provider_key]\n\n if credentials is None:\n # We need to handle the in-place credentials\n\n if provider_data.get('endpoints'):\n credentials = provider_data['endpoints']['default']['credentials']\n else:\n credentials = provider_data['credentials']\n # If it is not a mapping, it most likely points to a credentials yaml (as by default)\n if not isinstance(credentials, Mapping):\n credentials = conf.credentials[credentials]\n # Otherwise it is a mapping and therefore we consider it credentials\n\n # Munge together provider dict and creds,\n # Let the provider do whatever they need with them\n provider_kwargs = provider_data.copy()\n provider_kwargs.update(credentials)\n\n if not provider_kwargs.get('username') and provider_kwargs.get('principal'):\n provider_kwargs['username'] = provider_kwargs['principal']\n provider_kwargs['password'] = provider_kwargs['secret']\n\n if isinstance(provider_key, six.string_types):\n provider_kwargs['provider_key'] = provider_key\n provider_kwargs['logger'] = logger\n\n if provider_key not in PROVIDER_MGMT_CACHE:\n mgmt_instance = get_class_from_type(provider_data['type']).mgmt_class(**provider_kwargs)\n PROVIDER_MGMT_CACHE[provider_key] = mgmt_instance\n else:\n logger.debug(\"returning cached mgmt class for '%s'\", provider_key)\n return PROVIDER_MGMT_CACHE[provider_key]\n\n\nclass UnknownProvider(Exception):\n def __init__(self, provider_key, *args, **kwargs):\n super(UnknownProvider, self).__init__(provider_key, *args, **kwargs)\n self.provider_key = provider_key\n\n def __str__(self):\n return ('Unknown provider: \"{}\"'.format(self.provider_key))\n","path":"cfme/utils/providers.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\" Helper functions related to the creation, listing, filtering and destruction of providers\\n\\nThe list_providers function in this module depend on a (by default global) dict of filters.\\nIf you are writing tests or fixtures, you want to depend on this function as a de facto gateway.\\n\\nThe rest of the functions, such as get_mgmt, get_crud, get_provider_keys etc ignore this global\\ndict and will provide you with whatever you ask for with no limitations.\\n\\nThe main clue to know what is limited by the filters and what isn't is the 'filters' parameter.\\n\\\"\\\"\\\"\\nimport operator\\nimport six\\nfrom collections import Mapping, OrderedDict\\nfrom copy import copy\\n\\nfrom cfme.common.provider import all_types\\n\\nfrom cfme.exceptions import UnknownProviderType\\nfrom cfme.utils import conf\\nfrom cfme.utils.log import logger\\n\\nproviders_data = conf.cfme_data.get(\\\"management_systems\\\", {})\\n# Dict of active provider filters {name: ProviderFilter}\\nglobal_filters = {}\\n\\n# Store instances of provider mgmt classes that we have instantiated before,\\n# so that we don't re-generate mgmt classes for the same exact provider\\nPROVIDER_MGMT_CACHE = {}\\n\\n\\ndef load_setuptools_entrypoints():\\n \\\"\\\"\\\" Load modules from querying the specified setuptools entrypoint name.\\\"\\\"\\\"\\n from pkg_resources import (iter_entry_points, DistributionNotFound,\\n VersionConflict)\\n for ep in iter_entry_points('manageiq_integration_tests'):\\n # is the plugin registered or blocked?\\n try:\\n ep.load()\\n except DistributionNotFound:\\n continue\\n except VersionConflict as e:\\n raise Exception(\\n \\\"Plugin {} could not be loaded: {}!\\\".format(ep.name, e))\\n\\n\\nclass ProviderFilter(object):\\n \\\"\\\"\\\" Filter used to obtain only providers matching given requirements\\n\\n Args:\\n keys: List of acceptable provider keys, all if `None`\\n categories: List of acceptable provider categories, all if `None`\\n types: List of acceptable provider types, all if `None`\\n required_fields: List of required fields, see :py:func:`providers_by_class`\\n restrict_version: Checks provider version in yamls if `True`\\n required_tags: List of tags that must be set in yamls\\n inverted: Inclusive if `False`, exclusive otherwise\\n conjunctive: If true, all subfilters are applied and all must match (default)\\n If false (disjunctive), at least one of the subfilters must match\\n \\\"\\\"\\\"\\n _version_operator_map = OrderedDict([('>=', operator.ge),\\n ('<=', operator.le),\\n ('==', operator.eq),\\n ('!=', operator.ne),\\n ('>', operator.gt),\\n ('<', operator.lt)])\\n\\n def __init__(self, keys=None, classes=None, required_fields=None, required_tags=None,\\n required_flags=None, restrict_version=False, inverted=False, conjunctive=True):\\n self.keys = keys\\n self.classes = classes\\n self.required_fields = required_fields\\n self.required_tags = required_tags\\n self.required_flags = required_flags\\n self.restrict_version = restrict_version\\n self.inverted = inverted\\n self.conjunctive = conjunctive\\n\\n def _filter_keys(self, provider):\\n \\\"\\\"\\\" Filters by provider keys \\\"\\\"\\\"\\n if self.keys is None:\\n return None\\n return provider.key in self.keys\\n\\n def _filter_classes(self, provider):\\n \\\"\\\"\\\" Filters by provider (base) classes \\\"\\\"\\\"\\n if self.classes is None:\\n return None\\n return any(provider.one_of(prov_class) for prov_class in self.classes)\\n\\n def _filter_required_fields(self, provider):\\n \\\"\\\"\\\" Filters by required yaml fields (specified usually during test parametrization) \\\"\\\"\\\"\\n if self.required_fields is None:\\n return None\\n for field_or_fields in self.required_fields:\\n if isinstance(field_or_fields, tuple):\\n field_ident, field_value = field_or_fields\\n else:\\n field_ident, field_value = field_or_fields, None\\n if isinstance(field_ident, six.string_types):\\n if field_ident not in provider.data:\\n return False\\n else:\\n if field_value:\\n if provider.data[field_ident] != field_value:\\n return False\\n else:\\n o = provider.data\\n try:\\n for field in field_ident:\\n o = o[field]\\n if field_value:\\n if o != field_value:\\n return False\\n except (IndexError, KeyError):\\n return False\\n return True\\n\\n def _filter_required_tags(self, provider):\\n \\\"\\\"\\\" Filters by required yaml tags \\\"\\\"\\\"\\n prov_tags = provider.data.get('tags', [])\\n if self.required_tags is None:\\n return None\\n if set(self.required_tags) & set(prov_tags):\\n return True\\n return False\\n\\n def _filter_required_flags(self, provider):\\n \\\"\\\"\\\" Filters by required yaml flags \\\"\\\"\\\"\\n if self.required_flags is None:\\n return None\\n if self.required_flags:\\n test_flags = [flag.strip() for flag in self.required_flags]\\n\\n defined_flags = conf.cfme_data.get('test_flags', '')\\n if isinstance(defined_flags, six.string_types):\\n defined_flags = defined_flags.split(',')\\n defined_flags = [flag.strip() for flag in defined_flags]\\n\\n excluded_flags = provider.data.get('excluded_test_flags', '')\\n if isinstance(excluded_flags, six.string_types):\\n excluded_flags = excluded_flags.split(',')\\n excluded_flags = [flag.strip() for flag in excluded_flags]\\n\\n allowed_flags = set(defined_flags) - set(excluded_flags)\\n\\n if set(test_flags) - allowed_flags:\\n logger.info(\\\"Filtering Provider %s out because it does not have the right flags, \\\"\\n \\\"%s does not contain %s\\\",\\n provider.name, list(allowed_flags),\\n list(set(test_flags) - allowed_flags))\\n return False\\n return True\\n\\n def _filter_restricted_version(self, provider):\\n \\\"\\\"\\\" Filters by yaml version restriction; not applied if SSH is not available \\\"\\\"\\\"\\n if self.restrict_version:\\n # TODO\\n # get rid of this since_version hotfix by translating since_version\\n # to restricted_version; in addition, restricted_version should turn into\\n # \\\"version_restrictions\\\" and it should be a sequence of restrictions with operators\\n # so that we can create ranges like \\\">= 5.6\\\" and \\\"<= 5.8\\\"\\n version_restrictions = []\\n since_version = provider.data.get('since_version')\\n if since_version:\\n version_restrictions.append('>= {}'.format(since_version))\\n restricted_version = provider.data.get('restricted_version')\\n if restricted_version:\\n version_restrictions.append(restricted_version)\\n for restriction in version_restrictions:\\n for op, comparator in ProviderFilter._version_operator_map.items():\\n # split string by op; if the split works, version won't be empty\\n head, op, ver = restriction.partition(op)\\n if not ver: # This means that the operator was not found\\n continue\\n try:\\n curr_ver = provider.appliance.version\\n except:\\n return True\\n ver = type(curr_ver)(ver)\\n if not comparator(curr_ver, ver):\\n return False\\n break\\n else:\\n raise Exception('Operator not found in {}'.format(restriction))\\n return None\\n\\n def __call__(self, provider):\\n \\\"\\\"\\\" Applies this filter on a given provider\\n\\n Usage:\\n pf = ProviderFilter('cloud_infra', categories=['cloud', 'infra'])\\n providers = list_providers([pf])\\n pf2 = ProviderFilter(\\n classes=[GCEProvider, EC2Provider], required_fields=['small_template'])\\n provider_keys = [prov.key for prov in list_providers([pf, pf2])]\\n ^ this will list keys of all GCE and EC2 providers\\n ...or...\\n pf = ProviderFilter(required_tags=['openstack', 'complete'])\\n pf_inverted = ProviderFilter(required_tags=['disabled'], inverted=True)\\n providers = list_providers([pf, pf_inverted])\\n ^ this will return providers that have both the \\\"openstack\\\" and \\\"complete\\\" tags set\\n and at the same time don't have the \\\"disabled\\\" tag\\n ...or...\\n pf = ProviderFilter(keys=['rhevm34'], class=CloudProvider, conjunctive=False)\\n providers = list_providers([pf])\\n ^ this will list all providers that either have the 'rhevm34' key or are an instance\\n of the CloudProvider class and therefore are a cloud provider\\n\\n Returns:\\n `True` if provider passed all checks and was not filtered out, `False` otherwise.\\n The result is opposite if the 'inverted' attribute is set to `True`.\\n \\\"\\\"\\\"\\n keys_l = self._filter_keys(provider)\\n classes_l = self._filter_classes(provider)\\n fields_l = self._filter_required_fields(provider)\\n tags_l = self._filter_required_tags(provider)\\n flags_l = self._filter_required_flags(provider)\\n version_l = self._filter_restricted_version(provider)\\n results = [keys_l, classes_l, fields_l, tags_l, flags_l, version_l]\\n relevant_results = [res for res in results if res in [True, False]]\\n compiling_fn = all if self.conjunctive else any\\n # If all / any filters return true, the provider was not blocked (unless inverted)\\n if compiling_fn(relevant_results):\\n return not self.inverted\\n return self.inverted\\n\\n def copy(self):\\n return copy(self)\\n\\n\\n# Only providers without the 'disabled' tag\\nglobal_filters['enabled_only'] = ProviderFilter(required_tags=['disabled'], inverted=True)\\n# Only providers relevant for current appliance version (requires SSH access when used)\\nglobal_filters['restrict_version'] = ProviderFilter(restrict_version=True)\\n\\n\\ndef list_providers(filters=None, use_global_filters=True):\\n \\\"\\\"\\\" Lists provider crud objects, global filter optional\\n\\n Args:\\n filters: List if :py:class:`ProviderFilter` or None\\n use_global_filters: Will apply global filters as well if `True`, will not otherwise\\n\\n Note: Requires the framework to be pointed at an appliance to succeed.\\n\\n Returns: List of provider crud objects.\\n \\\"\\\"\\\"\\n if isinstance(filters, six.string_types):\\n raise TypeError(\\n 'You are probably using the old-style invocation of provider setup functions! '\\n 'You need to change it appropriately.')\\n filters = filters or []\\n if use_global_filters:\\n filters = filters + list(global_filters.values())\\n providers = [get_crud(prov_key) for prov_key in providers_data]\\n for prov_filter in filters:\\n providers = list(filter(prov_filter, providers))\\n return providers\\n\\n\\ndef list_providers_by_class(prov_class, use_global_filters=True):\\n \\\"\\\"\\\" Lists provider crud objects of a specific class (or its subclasses), global filter optional\\n\\n Args:\\n prov_class: Provider class to apply for filtering\\n use_global_filters: See :py:func:`list_providers`\\n appliance: Optional :py:class:`utils.appliance.IPAppliance` to be passed to provider CRUD\\n objects\\n\\n Note: Requires the framework to be pointed at an appliance to succeed.\\n\\n Returns: List of provider crud objects.\\n \\\"\\\"\\\"\\n pf = ProviderFilter(classes=[prov_class])\\n return list_providers(filters=[pf], use_global_filters=use_global_filters)\\n\\n\\ndef list_provider_keys(provider_type=None):\\n \\\"\\\"\\\" Lists provider keys from conf (yamls)\\n\\n Args:\\n provider_type: Optional filtering by 'type' string (from yaml); disabled by default\\n\\n Note: Doesn't require the framework to be pointed at an appliance to succeed.\\n\\n Returns: List of provider keys (strings).\\n \\\"\\\"\\\"\\n try:\\n all_keys = conf.cfme_data.management_systems.keys()\\n except:\\n all_keys = []\\n\\n if provider_type:\\n filtered_keys = []\\n for key in all_keys:\\n if conf.cfme_data.management_systems[key].type == provider_type:\\n filtered_keys.append(key)\\n return filtered_keys\\n else:\\n return all_keys\\n\\n\\ndef get_class_from_type(prov_type):\\n try:\\n return all_types()[prov_type]\\n except KeyError:\\n raise UnknownProviderType(\\\"Unknown provider type: {}!\\\".format(prov_type))\\n\\n\\ndef get_crud(provider_key):\\n \\\"\\\"\\\" Creates a Provider object given a management_system key in cfme_data.\\n\\n Usage:\\n get_crud('ec2east')\\n\\n Returns: A Provider object that has methods that operate on CFME\\n \\\"\\\"\\\"\\n # TODO: note, get_crud will be enturely removed shortly and replaced with collections methods\\n\\n prov_config = providers_data[provider_key]\\n prov_type = prov_config.get('type')\\n\\n return get_class_from_type(prov_type).from_config(\\n prov_config, provider_key)\\n\\n\\ndef get_crud_by_name(provider_name):\\n \\\"\\\"\\\" Creates a Provider object given a management_system name in cfme_data.\\n\\n Usage:\\n get_crud_by_name('My RHEV 3.6 Provider')\\n\\n Returns: A Provider object that has methods that operate on CFME\\n \\\"\\\"\\\"\\n for provider_key, provider_data in providers_data.items():\\n if provider_data.get(\\\"name\\\") == provider_name:\\n return get_crud(provider_key)\\n raise NameError(\\\"Could not find provider {}\\\".format(provider_name))\\n\\n\\ndef get_mgmt(provider_key, providers=None, credentials=None):\\n \\\"\\\"\\\" Provides a ``wrapanapi`` object, based on the request.\\n\\n Args:\\n provider_key: The name of a provider, as supplied in the yaml configuration files.\\n You can also use the dictionary if you want to pass the provider data directly.\\n providers: A set of data in the same format as the ``management_systems`` section in the\\n configuration yamls. If ``None`` then the configuration is loaded from the default\\n locations. Expects a dict.\\n credentials: A set of credentials in the same format as the ``credentials`` yamls files.\\n If ``None`` then credentials are loaded from the default locations. Expects a dict.\\n Return: A provider instance of the appropriate ``wrapanapi.WrapanapiAPIBase``\\n subclass\\n \\\"\\\"\\\"\\n if providers is None:\\n providers = providers_data\\n # provider_key can also be provider_data for some reason\\n # TODO rename the parameter; might break things\\n if isinstance(provider_key, Mapping):\\n provider_data = provider_key\\n provider_key = provider_data['name']\\n else:\\n provider_data = providers[provider_key]\\n\\n if credentials is None:\\n # We need to handle the in-place credentials\\n\\n if provider_data.get('endpoints'):\\n credentials = provider_data['endpoints']['default']['credentials']\\n else:\\n credentials = provider_data['credentials']\\n # If it is not a mapping, it most likely points to a credentials yaml (as by default)\\n if not isinstance(credentials, Mapping):\\n credentials = conf.credentials[credentials]\\n # Otherwise it is a mapping and therefore we consider it credentials\\n\\n # Munge together provider dict and creds,\\n # Let the provider do whatever they need with them\\n provider_kwargs = provider_data.copy()\\n provider_kwargs.update(credentials)\\n\\n if not provider_kwargs.get('username') and provider_kwargs.get('principal'):\\n provider_kwargs['username'] = provider_kwargs['principal']\\n provider_kwargs['password'] = provider_kwargs['secret']\\n\\n if isinstance(provider_key, six.string_types):\\n provider_kwargs['provider_key'] = provider_key\\n provider_kwargs['logger'] = logger\\n\\n if provider_key not in PROVIDER_MGMT_CACHE:\\n mgmt_instance = get_class_from_type(provider_data['type']).mgmt_class(**provider_kwargs)\\n PROVIDER_MGMT_CACHE[provider_key] = mgmt_instance\\n else:\\n logger.debug(\\\"returning cached mgmt class for '%s'\\\", provider_key)\\n return PROVIDER_MGMT_CACHE[provider_key]\\n\\n\\nclass UnknownProvider(Exception):\\n def __init__(self, provider_key, *args, **kwargs):\\n super(UnknownProvider, self).__init__(provider_key, *args, **kwargs)\\n self.provider_key = provider_key\\n\\n def __str__(self):\\n return ('Unknown provider: \\\"{}\\\"'.format(self.provider_key))\\n\",\n \"path\": \"cfme/utils/providers.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/cfme/utils/providers.py b/cfme/utils/providers.py\nindex 5c5844b579..7231eb7847 100644\n--- a/cfme/utils/providers.py\n+++ b/cfme/utils/providers.py\n@@ -358,6 +358,7 @@ def get_mgmt(provider_key, providers=None, credentials=None):\n # TODO rename the parameter; might break things\n if isinstance(provider_key, Mapping):\n provider_data = provider_key\n+ provider_key = provider_data['name']\n else:\n provider_data = providers[provider_key]\n \n"}}},{"rowIdx":2694,"cells":{"in_source_id":{"kind":"string","value":"saulpw__visidata-1887"},"issue":{"kind":"string","value":"resize-cols-input missing from Column -> Resize menu\n**Small description**\r\nresize-cols-input is missing from the Column -> Resize menu\r\n\r\n**Expected result**\r\nwhen I go to the menu under Column -> Resize, I expect resize-cols-input (gz_) to be given as an option\r\n\r\n**Additional context**\r\nchecked against v2.11\r\n\r\n(Submitting pull request to fix this now.)\r\n\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"from visidata import VisiData, vd, Column, Sheet, Fanout\n\n@Column.api\ndef setWidth(self, w):\n if self.width != w:\n if self.width == 0 or w == 0: # hide/unhide\n vd.addUndo(setattr, self, '_width', self.width)\n self._width = w\n\n\n@Column.api\ndef toggleWidth(self, width):\n 'Change column width to either given `width` or default value.'\n if self.width != width:\n self.width = width\n else:\n self.width = int(self.sheet.options.default_width)\n\n\n@Column.api\ndef toggleVisibility(self):\n if self.height == 1:\n self.height = self.sheet.options.default_height\n else:\n self.height = 1\n\n@VisiData.api\ndef unhide_cols(vd, cols, rows):\n 'sets appropriate width if column was either hidden (0) or unseen (None)'\n for c in cols:\n c.setWidth(abs(c.width or 0) or c.getMaxWidth(rows))\n\n\nSheet.addCommand('_', 'resize-col-max', 'cursorCol.toggleWidth(cursorCol.getMaxWidth(visibleRows))', 'toggle width of current column between full and default width'),\nSheet.addCommand('z_', 'resize-col-input', 'width = int(input(\"set width= \", value=cursorCol.width)); cursorCol.setWidth(width)', 'adjust width of current column to N')\nSheet.addCommand('g_', 'resize-cols-max', 'for c in visibleCols: c.setWidth(c.getMaxWidth(visibleRows))', 'toggle widths of all visible columns between full and default width'),\nSheet.addCommand('gz_', 'resize-cols-input', 'width = int(input(\"set width= \", value=cursorCol.width)); Fanout(visibleCols).setWidth(width)', 'adjust widths of all visible columns to N')\n\nSheet.addCommand('-', 'hide-col', 'cursorCol.hide()', 'Hide current column')\nSheet.addCommand('z-', 'resize-col-half', 'cursorCol.setWidth(cursorCol.width//2)', 'reduce width of current column by half'),\n\nSheet.addCommand('gv', 'unhide-cols', 'unhide_cols(columns, visibleRows)', 'Show all columns')\nSheet.addCommand('v', 'visibility-sheet', 'for c in visibleCols: c.toggleVisibility()')\nSheet.addCommand('zv', 'visibility-col', 'cursorCol.toggleVisibility()')\n\nvd.addMenuItems('''\n Column > Hide > hide-col\n Column > Unhide all > unhide-cols\n Column > Resize > half > resize-col-half\n Column > Resize > current column to max > resize-col-max\n Column > Resize > current column to input > resize-col-input\n Column > Resize > all columns max > resize-cols-max\n''')\n","path":"visidata/features/layout.py"}],"string":"[\n {\n \"content\": \"from visidata import VisiData, vd, Column, Sheet, Fanout\\n\\n@Column.api\\ndef setWidth(self, w):\\n if self.width != w:\\n if self.width == 0 or w == 0: # hide/unhide\\n vd.addUndo(setattr, self, '_width', self.width)\\n self._width = w\\n\\n\\n@Column.api\\ndef toggleWidth(self, width):\\n 'Change column width to either given `width` or default value.'\\n if self.width != width:\\n self.width = width\\n else:\\n self.width = int(self.sheet.options.default_width)\\n\\n\\n@Column.api\\ndef toggleVisibility(self):\\n if self.height == 1:\\n self.height = self.sheet.options.default_height\\n else:\\n self.height = 1\\n\\n@VisiData.api\\ndef unhide_cols(vd, cols, rows):\\n 'sets appropriate width if column was either hidden (0) or unseen (None)'\\n for c in cols:\\n c.setWidth(abs(c.width or 0) or c.getMaxWidth(rows))\\n\\n\\nSheet.addCommand('_', 'resize-col-max', 'cursorCol.toggleWidth(cursorCol.getMaxWidth(visibleRows))', 'toggle width of current column between full and default width'),\\nSheet.addCommand('z_', 'resize-col-input', 'width = int(input(\\\"set width= \\\", value=cursorCol.width)); cursorCol.setWidth(width)', 'adjust width of current column to N')\\nSheet.addCommand('g_', 'resize-cols-max', 'for c in visibleCols: c.setWidth(c.getMaxWidth(visibleRows))', 'toggle widths of all visible columns between full and default width'),\\nSheet.addCommand('gz_', 'resize-cols-input', 'width = int(input(\\\"set width= \\\", value=cursorCol.width)); Fanout(visibleCols).setWidth(width)', 'adjust widths of all visible columns to N')\\n\\nSheet.addCommand('-', 'hide-col', 'cursorCol.hide()', 'Hide current column')\\nSheet.addCommand('z-', 'resize-col-half', 'cursorCol.setWidth(cursorCol.width//2)', 'reduce width of current column by half'),\\n\\nSheet.addCommand('gv', 'unhide-cols', 'unhide_cols(columns, visibleRows)', 'Show all columns')\\nSheet.addCommand('v', 'visibility-sheet', 'for c in visibleCols: c.toggleVisibility()')\\nSheet.addCommand('zv', 'visibility-col', 'cursorCol.toggleVisibility()')\\n\\nvd.addMenuItems('''\\n Column > Hide > hide-col\\n Column > Unhide all > unhide-cols\\n Column > Resize > half > resize-col-half\\n Column > Resize > current column to max > resize-col-max\\n Column > Resize > current column to input > resize-col-input\\n Column > Resize > all columns max > resize-cols-max\\n''')\\n\",\n \"path\": \"visidata/features/layout.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"from visidata import VisiData, vd, Column, Sheet, Fanout\n\n@Column.api\ndef setWidth(self, w):\n if self.width != w:\n if self.width == 0 or w == 0: # hide/unhide\n vd.addUndo(setattr, self, '_width', self.width)\n self._width = w\n\n\n@Column.api\ndef toggleWidth(self, width):\n 'Change column width to either given `width` or default value.'\n if self.width != width:\n self.width = width\n else:\n self.width = int(self.sheet.options.default_width)\n\n\n@Column.api\ndef toggleVisibility(self):\n if self.height == 1:\n self.height = self.sheet.options.default_height\n else:\n self.height = 1\n\n@VisiData.api\ndef unhide_cols(vd, cols, rows):\n 'sets appropriate width if column was either hidden (0) or unseen (None)'\n for c in cols:\n c.setWidth(abs(c.width or 0) or c.getMaxWidth(rows))\n\n\nSheet.addCommand('_', 'resize-col-max', 'cursorCol.toggleWidth(cursorCol.getMaxWidth(visibleRows))', 'toggle width of current column between full and default width'),\nSheet.addCommand('z_', 'resize-col-input', 'width = int(input(\"set width= \", value=cursorCol.width)); cursorCol.setWidth(width)', 'adjust width of current column to N')\nSheet.addCommand('g_', 'resize-cols-max', 'for c in visibleCols: c.setWidth(c.getMaxWidth(visibleRows))', 'toggle widths of all visible columns between full and default width'),\nSheet.addCommand('gz_', 'resize-cols-input', 'width = int(input(\"set width= \", value=cursorCol.width)); Fanout(visibleCols).setWidth(width)', 'adjust widths of all visible columns to N')\n\nSheet.addCommand('-', 'hide-col', 'cursorCol.hide()', 'Hide current column')\nSheet.addCommand('z-', 'resize-col-half', 'cursorCol.setWidth(cursorCol.width//2)', 'reduce width of current column by half'),\n\nSheet.addCommand('gv', 'unhide-cols', 'unhide_cols(columns, visibleRows)', 'Show all columns')\nSheet.addCommand('v', 'visibility-sheet', 'for c in visibleCols: c.toggleVisibility()')\nSheet.addCommand('zv', 'visibility-col', 'cursorCol.toggleVisibility()')\n\nvd.addMenuItems('''\n Column > Hide > hide-col\n Column > Unhide all > unhide-cols\n Column > Resize > half > resize-col-half\n Column > Resize > current column to max > resize-col-max\n Column > Resize > current column to input > resize-col-input\n Column > Resize > all columns max > resize-cols-max\n Column > Resize > all columns to input > resize-cols-input\n''')\n","path":"visidata/features/layout.py"}],"string":"[\n {\n \"content\": \"from visidata import VisiData, vd, Column, Sheet, Fanout\\n\\n@Column.api\\ndef setWidth(self, w):\\n if self.width != w:\\n if self.width == 0 or w == 0: # hide/unhide\\n vd.addUndo(setattr, self, '_width', self.width)\\n self._width = w\\n\\n\\n@Column.api\\ndef toggleWidth(self, width):\\n 'Change column width to either given `width` or default value.'\\n if self.width != width:\\n self.width = width\\n else:\\n self.width = int(self.sheet.options.default_width)\\n\\n\\n@Column.api\\ndef toggleVisibility(self):\\n if self.height == 1:\\n self.height = self.sheet.options.default_height\\n else:\\n self.height = 1\\n\\n@VisiData.api\\ndef unhide_cols(vd, cols, rows):\\n 'sets appropriate width if column was either hidden (0) or unseen (None)'\\n for c in cols:\\n c.setWidth(abs(c.width or 0) or c.getMaxWidth(rows))\\n\\n\\nSheet.addCommand('_', 'resize-col-max', 'cursorCol.toggleWidth(cursorCol.getMaxWidth(visibleRows))', 'toggle width of current column between full and default width'),\\nSheet.addCommand('z_', 'resize-col-input', 'width = int(input(\\\"set width= \\\", value=cursorCol.width)); cursorCol.setWidth(width)', 'adjust width of current column to N')\\nSheet.addCommand('g_', 'resize-cols-max', 'for c in visibleCols: c.setWidth(c.getMaxWidth(visibleRows))', 'toggle widths of all visible columns between full and default width'),\\nSheet.addCommand('gz_', 'resize-cols-input', 'width = int(input(\\\"set width= \\\", value=cursorCol.width)); Fanout(visibleCols).setWidth(width)', 'adjust widths of all visible columns to N')\\n\\nSheet.addCommand('-', 'hide-col', 'cursorCol.hide()', 'Hide current column')\\nSheet.addCommand('z-', 'resize-col-half', 'cursorCol.setWidth(cursorCol.width//2)', 'reduce width of current column by half'),\\n\\nSheet.addCommand('gv', 'unhide-cols', 'unhide_cols(columns, visibleRows)', 'Show all columns')\\nSheet.addCommand('v', 'visibility-sheet', 'for c in visibleCols: c.toggleVisibility()')\\nSheet.addCommand('zv', 'visibility-col', 'cursorCol.toggleVisibility()')\\n\\nvd.addMenuItems('''\\n Column > Hide > hide-col\\n Column > Unhide all > unhide-cols\\n Column > Resize > half > resize-col-half\\n Column > Resize > current column to max > resize-col-max\\n Column > Resize > current column to input > resize-col-input\\n Column > Resize > all columns max > resize-cols-max\\n Column > Resize > all columns to input > resize-cols-input\\n''')\\n\",\n \"path\": \"visidata/features/layout.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/visidata/features/layout.py b/visidata/features/layout.py\nindex 32b29e5d5..eed59737f 100644\n--- a/visidata/features/layout.py\n+++ b/visidata/features/layout.py\n@@ -50,4 +50,5 @@ def unhide_cols(vd, cols, rows):\n Column > Resize > current column to max > resize-col-max\n Column > Resize > current column to input > resize-col-input\n Column > Resize > all columns max > resize-cols-max\n+ Column > Resize > all columns to input > resize-cols-input\n ''')\n"}}},{"rowIdx":2695,"cells":{"in_source_id":{"kind":"string","value":"microsoft__ptvsd-297"},"issue":{"kind":"string","value":"Unable to launch the debugger\nGetting the following error in master when debugging in VSC:\r\n```\r\nCould not connect to None: 60857\r\nTraceback (most recent call last):\r\n File \"/Users/donjayamanne/Desktop/Development/vscode/ptvsd/ptvsd/pydevd/pydevd.py\", line 1620, in main\r\n debugger.connect(host, port)\r\n File \"/Users/donjayamanne/Desktop/Development/vscode/ptvsd/ptvsd/pydevd/pydevd.py\", line 326, in connect\r\n s = start_server(port)\r\n File \"/Users/donjayamanne/Desktop/Development/vscode/ptvsd/ptvsd/wrapper.py\", line 1766, in start_server\r\n server = _create_server(port)\r\n File \"/Users/donjayamanne/Desktop/Development/vscode/ptvsd/ptvsd/wrapper.py\", line 1701, in _create_server\r\n server.bind(('127.0.0.1', port))\r\nOSError: [Errno 48] Address already in u\r\n```\n"},"before_files":{"kind":"list like","value":[{"content":"# Copyright (c) Microsoft Corporation. All rights reserved.\n# Licensed under the MIT License. See LICENSE in the project root\n# for license information.\n\nfrom ptvsd.__main__ import run_module, run_file\n\n\n__author__ = \"Microsoft Corporation <ptvshelp@microsoft.com>\"\n__version__ = \"4.0.0a5\"\n\n# TODO: not needed?\nDONT_DEBUG = []\n\n\ndef debug(filename, port_num, debug_id, debug_options, run_as, **kwargs):\n # TODO: docstring\n address = (None, port_num)\n if run_as == 'module':\n run_module(address, filename, **kwargs)\n else:\n run_file(address, filename, **kwargs)\n","path":"ptvsd/debugger.py"}],"string":"[\n {\n \"content\": \"# Copyright (c) Microsoft Corporation. All rights reserved.\\n# Licensed under the MIT License. See LICENSE in the project root\\n# for license information.\\n\\nfrom ptvsd.__main__ import run_module, run_file\\n\\n\\n__author__ = \\\"Microsoft Corporation <ptvshelp@microsoft.com>\\\"\\n__version__ = \\\"4.0.0a5\\\"\\n\\n# TODO: not needed?\\nDONT_DEBUG = []\\n\\n\\ndef debug(filename, port_num, debug_id, debug_options, run_as, **kwargs):\\n # TODO: docstring\\n address = (None, port_num)\\n if run_as == 'module':\\n run_module(address, filename, **kwargs)\\n else:\\n run_file(address, filename, **kwargs)\\n\",\n \"path\": \"ptvsd/debugger.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# Copyright (c) Microsoft Corporation. All rights reserved.\n# Licensed under the MIT License. See LICENSE in the project root\n# for license information.\n\nfrom ptvsd.__main__ import run_module, run_file\n\n\n__author__ = \"Microsoft Corporation <ptvshelp@microsoft.com>\"\n__version__ = \"4.0.0a5\"\n\n# TODO: not needed?\nDONT_DEBUG = []\n\n\ndef debug(filename, port_num, debug_id, debug_options, run_as, **kwargs):\n # TODO: docstring\n address = ('localhost', port_num)\n if run_as == 'module':\n run_module(address, filename, **kwargs)\n else:\n run_file(address, filename, **kwargs)\n","path":"ptvsd/debugger.py"}],"string":"[\n {\n \"content\": \"# Copyright (c) Microsoft Corporation. All rights reserved.\\n# Licensed under the MIT License. See LICENSE in the project root\\n# for license information.\\n\\nfrom ptvsd.__main__ import run_module, run_file\\n\\n\\n__author__ = \\\"Microsoft Corporation <ptvshelp@microsoft.com>\\\"\\n__version__ = \\\"4.0.0a5\\\"\\n\\n# TODO: not needed?\\nDONT_DEBUG = []\\n\\n\\ndef debug(filename, port_num, debug_id, debug_options, run_as, **kwargs):\\n # TODO: docstring\\n address = ('localhost', port_num)\\n if run_as == 'module':\\n run_module(address, filename, **kwargs)\\n else:\\n run_file(address, filename, **kwargs)\\n\",\n \"path\": \"ptvsd/debugger.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/ptvsd/debugger.py b/ptvsd/debugger.py\nindex 00175be89..ec6717868 100644\n--- a/ptvsd/debugger.py\n+++ b/ptvsd/debugger.py\n@@ -14,7 +14,7 @@\n \n def debug(filename, port_num, debug_id, debug_options, run_as, **kwargs):\n # TODO: docstring\n- address = (None, port_num)\n+ address = ('localhost', port_num)\n if run_as == 'module':\n run_module(address, filename, **kwargs)\n else:\n"}}},{"rowIdx":2696,"cells":{"in_source_id":{"kind":"string","value":"pypa__pipenv-3338"},"issue":{"kind":"string","value":"package in a namespace from pip fails to lock\n\r\nI checked the diagnose.\r\n\r\n### Issue description\r\n\r\ninstalling a package from pip with a namespace, i.e. fsc.export results in locking-failure, since (I assume) pipenv looks for `fsc-export` on https://pypi.org/simple and not for `fsc.export` (which is available). This package is not a pre-release.\r\n\r\n### Expected result\r\n\r\nThat it would work just fine, like `pip install fsc.export`\r\n\r\n### Actual result\r\n\r\n```\r\nCreating a Pipfile for this project…\r\nInstalling fsc.export…\r\n⠋ Installing...Installing 'fsc.export'\r\n$ ['/Users/mskoenz/.virtualenvs/hello-vT9ljSkH/bin/pip', 'install', '--verbose', '--upgrade', '\"fsc.export\"', '-i', 'https://pypi.org/simple']\r\n\r\nAdding fsc.export to Pipfile's [packages]…\r\n✔ Installation Succeeded\r\nPipfile.lock not found, creating…\r\nLocking [dev-packages] dependencies…\r\nLocking [packages] dependencies…\r\n✘ Locking Failed!\r\nUsing pip: -i https://pypi.org/simple\r\nUsing pip: -i https://pypi.org/simple\r\nUsing pip: -i https://pypi.org/simple\r\n\r\n ROUND 1\r\nCurrent constraints:\r\n fsc-export\r\n\r\nFinding the best candidates:\r\nTraceback (most recent call last):\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/utils.py\", line 385, in resolve\r\n results = self.resolver.resolve(max_rounds=environments.PIPENV_MAX_ROUNDS)\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/patched/piptools/resolver.py\", line 102, in resolve\r\n has_changed, best_matches = self._resolve_one_round()\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/patched/piptools/resolver.py\", line 198, in _resolve_one_round\r\n best_matches = {self.get_best_match(ireq) for ireq in constraints}\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/patched/piptools/resolver.py\", line 198, in <setcomp>\r\n best_matches = {self.get_best_match(ireq) for ireq in constraints}\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/patched/piptools/resolver.py\", line 263, in get_best_match\r\n best_match = self.repository.find_best_match(ireq, prereleases=self.prereleases)\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/patched/piptools/repositories/pypi.py\", line 175, in find_best_match\r\n raise NoCandidateFound(ireq, all_candidates, self.finder)\r\npipenv.patched.piptools.exceptions.NoCandidateFound: Could not find a version that matches fsc-export\r\nNo versions found\r\nWas https://pypi.org/simple reachable?\r\n\r\nDuring handling of the above exception, another exception occurred:\r\n\r\nTraceback (most recent call last):\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/resolver.py\", line 126, in <module>\r\n main()\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/resolver.py\", line 119, in main\r\n\r\n parsed.requirements_dir, parsed.packages)\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/resolver.py\", line 85, in _main\r\n requirements_dir=requirements_dir,\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/resolver.py\", line 69, in resolve\r\n req_dir=requirements_dir\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/utils.py\", line 726, in resolve_deps\r\n req_dir=req_dir,\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/utils.py\", line 480, in actually_resolve_deps\r\n resolved_tree = resolver.resolve()\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/utils.py\", line 395, in resolve\r\n raise ResolutionFailure(message=str(e))\r\npipenv.exceptions.ResolutionFailure: ERROR: ERROR: Could not find a version that matches fsc-export\r\nNo versions found\r\nWas https://pypi.org/simple reachable?\r\nUsing pip: -i https://pypi.org/simple\r\nUsing pip: -i https://pypi.org/simple\r\n\r\n ROUND 1\r\nCurrent constraints:\r\n fsc-export\r\nFinding the best candidates:\r\nTraceback (most recent call last):\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/utils.py\", line 385, in resolve\r\n results = self.resolver.resolve(max_rounds=environments.PIPENV_MAX_ROUNDS)\r\n\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/patched/piptools/resolver.py\", line 102, in resolve\r\n has_changed, best_matches = self._resolve_one_round()\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/patched/piptools/resolver.py\", line 198, in _resolve_one_round\r\n best_matches = {self.get_best_match(ireq) for ireq in constraints}\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/patched/piptools/resolver.py\", line 198, in <setcomp>\r\n best_matches = {self.get_best_match(ireq) for ireq in constraints}\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/patched/piptools/resolver.py\", line 263, in get_best_match\r\n best_match = self.repository.find_best_match(ireq, prereleases=self.prereleases)\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/patched/piptools/repositories/pypi.py\", line 175, in find_best_match\r\n raise NoCandidateFound(ireq, all_candidates, self.finder)\r\npipenv.patched.piptools.exceptions.NoCandidateFound: Could not find a version that matches fsc-export\r\nNo versions found\r\nWas https://pypi.org/simple reachable?\r\n\r\nDuring handling of the above exception, another exception occurred:\r\n\r\nTraceback (most recent call last):\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/resolver.py\", line 126, in <module>\r\n main()\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/resolver.py\", line 119, in main\r\n parsed.requirements_dir, parsed.packages)\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/resolver.py\", line 85, in _main\r\n requirements_dir=requirements_dir,\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/resolver.py\", line 69, in resolve\r\n req_dir=requirements_dir\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/utils.py\", line 726, in resolve_deps\r\n req_dir=req_dir,\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/utils.py\", line 480, in actually_resolve_deps\r\n resolved_tree = resolver.resolve()\r\n File \"/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv/utils.py\", line 395, in resolve\r\n raise ResolutionFailure(message=str(e))\r\npipenv.exceptions.ResolutionFailure: ERROR: ERROR: Could not find a version that matches fsc-export\r\nNo versions found\r\nWas https://pypi.org/simple reachable?\r\n```\r\n\r\n### Steps to replicate\r\n\r\nin a completely fresh folder (no Pipfile), run:\r\n`pipenv install fsc.export`\r\n\r\n-------------------------------------------------------------------------------\r\n<details><summary>$ pipenv --support</summary>\r\n\r\nPipenv version: `'2018.11.26'`\r\n\r\nPipenv location: `'/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/lib/python3.7/site-packages/pipenv'`\r\n\r\nPython location: `'/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/bin/python3.7'`\r\n\r\nPython installations found:\r\n\r\n - `3.7.0`: `/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/bin/python3`\r\n - `3.7.0`: `/Users/mskoenz/.pyenv/versions/3.7.0/bin/python3`\r\n - `3.7.0`: `/Users/mskoenz/.pyenv/versions/3.7.0/bin/python3.7m`\r\n - `3.7.0`: `/usr/local/bin/python3`\r\n - `3.7.0`: `/usr/local/bin/python3.7m`\r\n - `3.6.6`: `/Users/mskoenz/.pyenv/versions/3.6.6/bin/python3`\r\n - `3.6.6`: `/Users/mskoenz/.pyenv/versions/3.6.6/bin/python3.6m`\r\n - `3.5.6`: `/Users/mskoenz/.pyenv/versions/3.5.6/bin/python3`\r\n - `3.5.6`: `/Users/mskoenz/.pyenv/versions/3.5.6/bin/python3.5m`\r\n - `3.4.9`: `/Users/mskoenz/.pyenv/versions/3.4.9/bin/python3`\r\n - `3.4.9`: `/Users/mskoenz/.pyenv/versions/3.4.9/bin/python3.4m`\r\n - `2.7.15`: `/Users/mskoenz/.pyenv/versions/2.7.15/bin/python`\r\n - `2.7.15`: `/usr/local/bin/python`\r\n - `2.7.15`: `/usr/local/bin/pythonw`\r\n - `2.7.10`: `/Users/mskoenz/.pyenv/versions/2.7.10/bin/python`\r\n - `2.7.10`: `/usr/bin/python`\r\n - `2.7.10`: `/usr/bin/pythonw`\r\n - `2.7.10`: `/usr/bin/python2.7`\r\n\r\nPEP 508 Information:\r\n\r\n```\r\n{'implementation_name': 'cpython',\r\n 'implementation_version': '3.7.0',\r\n 'os_name': 'posix',\r\n 'platform_machine': 'x86_64',\r\n 'platform_python_implementation': 'CPython',\r\n 'platform_release': '18.2.0',\r\n 'platform_system': 'Darwin',\r\n 'platform_version': 'Darwin Kernel Version 18.2.0: Fri Oct 5 19:41:49 PDT '\r\n '2018; root:xnu-4903.221.2~2/RELEASE_X86_64',\r\n 'python_full_version': '3.7.0',\r\n 'python_version': '3.7',\r\n 'sys_platform': 'darwin'}\r\n```\r\n\r\nSystem environment variables:\r\n\r\n - `CPLUS_INCLUDE_PATH`\r\n - `LDFLAGS`\r\n - `SSH_AGENT_PID`\r\n - `TERM_PROGRAM`\r\n - `VIRTUALENVWRAPPER_PROJECT_FILENAME`\r\n - `VIRTUALENVWRAPPER_SCRIPT`\r\n - `PYENV_ROOT`\r\n - `PIP_PYTHON_PATH`\r\n - `TERM`\r\n - `SHELL`\r\n - `TMPDIR`\r\n - `CPPFLAGS`\r\n - `Apple_PubSub_Socket_Render`\r\n - `PERL5LIB`\r\n - `OLDPWD`\r\n - `PERL_MB_OPT`\r\n - `PYENV_VERSION`\r\n - `USER`\r\n - `COMMAND_MODE`\r\n - `PYENV_DIR`\r\n - `SSH_AUTH_SOCK`\r\n - `__CF_USER_TEXT_ENCODING`\r\n - `VIRTUAL_ENV`\r\n - `WORKON_HOME`\r\n - `VIRTUALENVWRAPPER_PYTHON`\r\n - `PIPENV_ACTIVE`\r\n - `PATH`\r\n - `VIRTUALENVWRAPPER_HOOK_DIR`\r\n - `C_INCLUDE_PATH`\r\n - `PWD`\r\n - `LANG`\r\n - `PYENV_HOOK_PATH`\r\n - `XPC_FLAGS`\r\n - `PS1`\r\n - `PYTHONDONTWRITEBYTECODE`\r\n - `XPC_SERVICE_NAME`\r\n - `HOME`\r\n - `SHLVL`\r\n - `PYENV_SHELL`\r\n - `PERL_LOCAL_LIB_ROOT`\r\n - `PIP_SHIMS_BASE_MODULE`\r\n - `LOGNAME`\r\n - `VIRTUALENVWRAPPER_WORKON_CD`\r\n - `SECURITYSESSIONID`\r\n - `PYENV_VIRTUALENVWRAPPER_PREFER_PYVENV`\r\n - `PERL_MM_OPT`\r\n - `_`\r\n - `PIP_DISABLE_PIP_VERSION_CHECK`\r\n - `PYTHONFINDER_IGNORE_UNSUPPORTED`\r\n\r\nPipenv–specific environment variables:\r\n\r\n - `PIPENV_ACTIVE`: `1`\r\n\r\nDebug–specific environment variables:\r\n\r\n - `PATH`: `/Users/mskoenz/.virtualenvs/tmp-92509552f3b388/bin:/Users/mskoenz/perl5/bin:/Users/mskoenz/.pyenv/shims:/usr/local/opt/sqlite/bin:/usr/local/opt/coreutils/libexec/gnubin:/Users/mskoenz/.pyenv/versions/3.7.0/bin:/usr/local/Cellar/pyenv/1.2.7/libexec:/Users/mskoenz/.pyenv/plugins/pyenv-install-latest/bin:/Users/mskoenz/perl5/bin:/Users/mskoenz/.pyenv/shims:/usr/local/opt/sqlite/bin:/usr/local/opt/coreutils/libexec/gnubin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Library/TeX/texbin:/Users/mskoenz/perl5/bin:/Users/mskoenz/.pyenv/shims:/usr/local/opt/sqlite/bin:/usr/local/opt/coreutils/libexec/gnubin`\r\n - `SHELL`: `/bin/bash`\r\n - `LANG`: `en_US.UTF-8`\r\n - `PWD`: `/Users/mskoenz/hello`\r\n - `VIRTUAL_ENV`: `/Users/mskoenz/.virtualenvs/tmp-92509552f3b388`\r\n\r\n\r\n---------------------------\r\n\r\nContents of `Pipfile` ('/Users/mskoenz/hello/Pipfile'):\r\n\r\n```toml\r\n[[source]]\r\nname = \"pypi\"\r\nurl = \"https://pypi.org/simple\"\r\nverify_ssl = true\r\n\r\n[dev-packages]\r\n\r\n[packages]\r\nfsc-export = \"*\"\r\n\r\n[requires]\r\npython_version = \"3.7\"\r\n\r\n[pipenv]\r\nallow_prereleases = true\r\n\r\n```\r\n\r\n</details>\n"},"before_files":{"kind":"list like","value":[{"content":"# -*- coding: utf-8 -*-\nimport base64\nimport fnmatch\nimport glob\nimport hashlib\nimport io\nimport json\nimport operator\nimport os\nimport re\nimport sys\n\nimport six\nimport toml\nimport tomlkit\nimport vistir\n\nfrom first import first\n\nimport pipfile\nimport pipfile.api\n\nfrom cached_property import cached_property\n\nfrom .cmdparse import Script\nfrom .environment import Environment\nfrom .environments import (\n PIPENV_DEFAULT_PYTHON_VERSION, PIPENV_IGNORE_VIRTUALENVS, PIPENV_MAX_DEPTH,\n PIPENV_PIPFILE, PIPENV_PYTHON, PIPENV_TEST_INDEX, PIPENV_VENV_IN_PROJECT,\n is_in_virtualenv\n)\nfrom .utils import (\n cleanup_toml, convert_toml_outline_tables, find_requirements,\n get_canonical_names, get_url_name, get_workon_home, is_editable,\n is_installable_file, is_star, is_valid_url, is_virtual_environment,\n looks_like_dir, normalize_drive, pep423_name, proper_case, python_version,\n safe_expandvars\n)\n\n\ndef _normalized(p):\n if p is None:\n return None\n loc = vistir.compat.Path(p)\n if not loc.is_absolute():\n try:\n loc = loc.resolve()\n except OSError:\n loc = loc.absolute()\n # Recase the path properly on Windows. From https://stackoverflow.com/a/35229734/5043728\n if os.name == 'nt':\n matches = glob.glob(re.sub(r'([^:/\\\\])(?=[/\\\\]|$)', r'[\\1]', str(loc)))\n path_str = matches and matches[0] or str(loc)\n else:\n path_str = str(loc)\n return normalize_drive(path_str)\n\n\nDEFAULT_NEWLINES = u\"\\n\"\n\n\nclass _LockFileEncoder(json.JSONEncoder):\n \"\"\"A specilized JSON encoder to convert loaded TOML data into a lock file.\n\n This adds a few characteristics to the encoder:\n\n * The JSON is always prettified with indents and spaces.\n * TOMLKit's container elements are seamlessly encodable.\n * The output is always UTF-8-encoded text, never binary, even on Python 2.\n \"\"\"\n\n def __init__(self):\n super(_LockFileEncoder, self).__init__(\n indent=4, separators=(\",\", \": \"), sort_keys=True\n )\n\n def default(self, obj):\n if isinstance(obj, vistir.compat.Path):\n obj = obj.as_posix()\n return super(_LockFileEncoder, self).default(obj)\n\n def encode(self, obj):\n content = super(_LockFileEncoder, self).encode(obj)\n if not isinstance(content, six.text_type):\n content = content.decode(\"utf-8\")\n return content\n\n\ndef preferred_newlines(f):\n if isinstance(f.newlines, six.text_type):\n return f.newlines\n return DEFAULT_NEWLINES\n\n\nif PIPENV_PIPFILE:\n if not os.path.isfile(PIPENV_PIPFILE):\n raise RuntimeError(\"Given PIPENV_PIPFILE is not found!\")\n\n else:\n PIPENV_PIPFILE = _normalized(PIPENV_PIPFILE)\n# (path, file contents) => TOMLFile\n# keeps track of pipfiles that we've seen so we do not need to re-parse 'em\n_pipfile_cache = {}\n\n\nif PIPENV_TEST_INDEX:\n DEFAULT_SOURCE = {\n u\"url\": PIPENV_TEST_INDEX,\n u\"verify_ssl\": True,\n u\"name\": u\"custom\",\n }\nelse:\n DEFAULT_SOURCE = {\n u\"url\": u\"https://pypi.org/simple\",\n u\"verify_ssl\": True,\n u\"name\": u\"pypi\",\n }\n\npipfile.api.DEFAULT_SOURCE = DEFAULT_SOURCE\n\n\nclass SourceNotFound(KeyError):\n pass\n\n\nclass Project(object):\n \"\"\"docstring for Project\"\"\"\n\n _lockfile_encoder = _LockFileEncoder()\n\n def __init__(self, which=None, python_version=None, chdir=True):\n super(Project, self).__init__()\n self._name = None\n self._virtualenv_location = None\n self._download_location = None\n self._proper_names_db_path = None\n self._pipfile_location = None\n self._pipfile_newlines = DEFAULT_NEWLINES\n self._lockfile_newlines = DEFAULT_NEWLINES\n self._requirements_location = None\n self._original_dir = os.path.abspath(os.curdir)\n self._environment = None\n self._which = which\n self._build_system = {\n \"requires\": [\"setuptools\", \"wheel\"]\n }\n self.python_version = python_version\n # Hack to skip this during pipenv run, or -r.\n if (\"run\" not in sys.argv) and chdir:\n try:\n os.chdir(self.project_directory)\n except (TypeError, AttributeError):\n pass\n\n def path_to(self, p):\n \"\"\"Returns the absolute path to a given relative path.\"\"\"\n if os.path.isabs(p):\n return p\n\n return os.sep.join([self._original_dir, p])\n\n def _build_package_list(self, package_section):\n \"\"\"Returns a list of packages for pip-tools to consume.\"\"\"\n from pipenv.vendor.requirementslib.utils import is_vcs\n ps = {}\n # TODO: Separate the logic for showing packages from the filters for supplying pip-tools\n for k, v in self.parsed_pipfile.get(package_section, {}).items():\n # Skip editable VCS deps.\n if hasattr(v, \"keys\"):\n # When a vcs url is gven without editable it only appears as a key\n # Eliminate any vcs, path, or url entries which are not editable\n # Since pip-tools can't do deep resolution on them, even setuptools-installable ones\n if (\n is_vcs(v)\n or is_vcs(k)\n or (is_installable_file(k) or is_installable_file(v))\n or any(\n (\n prefix in v\n and (os.path.isfile(v[prefix]) or is_valid_url(v[prefix]))\n )\n for prefix in [\"path\", \"file\"]\n )\n ):\n # If they are editable, do resolve them\n if \"editable\" not in v:\n # allow wheels to be passed through\n if not (\n hasattr(v, \"keys\")\n and v.get(\"path\", v.get(\"file\", \"\")).endswith(\".whl\")\n ):\n continue\n ps.update({k: v})\n\n else:\n ps.update({k: v})\n else:\n ps.update({k: v})\n else:\n # Since these entries have no attributes we know they are not editable\n # So we can safely exclude things that need to be editable in order to be resolved\n # First exclude anything that is a vcs entry either in the key or value\n if not (\n any(is_vcs(i) for i in [k, v])\n or\n # Then exclude any installable files that are not directories\n # Because pip-tools can resolve setup.py for example\n any(is_installable_file(i) for i in [k, v])\n or\n # Then exclude any URLs because they need to be editable also\n # Things that are excluded can only be 'shallow resolved'\n any(is_valid_url(i) for i in [k, v])\n ):\n ps.update({k: v})\n return ps\n\n @property\n def name(self):\n if self._name is None:\n self._name = self.pipfile_location.split(os.sep)[-2]\n return self._name\n\n @property\n def pipfile_exists(self):\n return bool(self.pipfile_location)\n\n @property\n def required_python_version(self):\n if self.pipfile_exists:\n required = self.parsed_pipfile.get(\"requires\", {}).get(\n \"python_full_version\"\n )\n if not required:\n required = self.parsed_pipfile.get(\"requires\", {}).get(\"python_version\")\n if required != \"*\":\n return required\n\n @property\n def project_directory(self):\n if self.pipfile_location is not None:\n return os.path.abspath(os.path.join(self.pipfile_location, os.pardir))\n\n else:\n return None\n\n @property\n def requirements_exists(self):\n return bool(self.requirements_location)\n\n def is_venv_in_project(self):\n return PIPENV_VENV_IN_PROJECT or (\n self.project_directory\n and os.path.isdir(os.path.join(self.project_directory, \".venv\"))\n )\n\n @property\n def virtualenv_exists(self):\n # TODO: Decouple project from existence of Pipfile.\n if self.pipfile_exists and os.path.exists(self.virtualenv_location):\n if os.name == \"nt\":\n extra = [\"Scripts\", \"activate.bat\"]\n else:\n extra = [\"bin\", \"activate\"]\n return os.path.isfile(os.sep.join([self.virtualenv_location] + extra))\n\n return False\n\n def get_location_for_virtualenv(self):\n # If there's no project yet, set location based on config.\n if not self.project_directory:\n if self.is_venv_in_project():\n return os.path.abspath(\".venv\")\n return str(get_workon_home().joinpath(self.virtualenv_name))\n\n dot_venv = os.path.join(self.project_directory, \".venv\")\n\n # If there's no .venv in project root, set location based on config.\n if not os.path.exists(dot_venv):\n if self.is_venv_in_project():\n return dot_venv\n return str(get_workon_home().joinpath(self.virtualenv_name))\n\n # If .venv in project root is a directory, use it.\n if os.path.isdir(dot_venv):\n return dot_venv\n\n # Now we assume .venv in project root is a file. Use its content.\n with io.open(dot_venv) as f:\n name = f.read().strip()\n\n # If content looks like a path, use it as a relative path.\n # Otherwise use directory named after content in WORKON_HOME.\n if looks_like_dir(name):\n path = vistir.compat.Path(self.project_directory, name)\n return path.absolute().as_posix()\n return str(get_workon_home().joinpath(name))\n\n @property\n def working_set(self):\n from .utils import load_path\n sys_path = load_path(self.which(\"python\"))\n import pkg_resources\n return pkg_resources.WorkingSet(sys_path)\n\n @property\n def installed_packages(self):\n return self.environment.get_installed_packages()\n\n @property\n def installed_package_names(self):\n return get_canonical_names([pkg.key for pkg in self.installed_packages])\n\n @property\n def lockfile_package_names(self):\n dev_keys = get_canonical_names(self.lockfile_content[\"develop\"].keys())\n default_keys = get_canonical_names(self.lockfile_content[\"default\"].keys())\n return {\n \"dev\": dev_keys,\n \"default\": default_keys,\n \"combined\": dev_keys | default_keys\n }\n\n @property\n def pipfile_package_names(self):\n dev_keys = get_canonical_names(self.dev_packages.keys())\n default_keys = get_canonical_names(self.packages.keys())\n return {\n \"dev\": dev_keys,\n \"default\": default_keys,\n \"combined\": dev_keys | default_keys\n }\n\n @property\n def environment(self):\n if not self._environment:\n prefix = self.virtualenv_location\n is_venv = is_in_virtualenv()\n sources = self.sources if self.sources else [DEFAULT_SOURCE,]\n self._environment = Environment(\n prefix=prefix, is_venv=is_venv, sources=sources, pipfile=self.parsed_pipfile,\n project=self\n )\n self._environment.add_dist(\"pipenv\")\n return self._environment\n\n def get_outdated_packages(self):\n return self.environment.get_outdated_packages(pre=self.pipfile.get(\"pre\", False))\n\n @classmethod\n def _sanitize(cls, name):\n # Replace dangerous characters into '_'. The length of the sanitized\n # project name is limited as 42 because of the limit of linux kernel\n #\n # 42 = 127 - len('/home//.local/share/virtualenvs//bin/python2') - 32 - len('-HASHHASH')\n #\n # 127 : BINPRM_BUF_SIZE - 1\n # 32 : Maximum length of username\n #\n # References:\n # https://www.gnu.org/software/bash/manual/html_node/Double-Quotes.html\n # http://www.tldp.org/LDP/abs/html/special-chars.html#FIELDREF\n # https://github.com/torvalds/linux/blob/2bfe01ef/include/uapi/linux/binfmts.h#L18\n return re.sub(r'[ $`!*@\"\\\\\\r\\n\\t]', \"_\", name)[0:42]\n\n def _get_virtualenv_hash(self, name):\n \"\"\"Get the name of the virtualenv adjusted for windows if needed\n\n Returns (name, encoded_hash)\n \"\"\"\n\n def get_name(name, location):\n name = self._sanitize(name)\n hash = hashlib.sha256(location.encode()).digest()[:6]\n encoded_hash = base64.urlsafe_b64encode(hash).decode()\n return name, encoded_hash[:8]\n\n clean_name, encoded_hash = get_name(name, self.pipfile_location)\n venv_name = \"{0}-{1}\".format(clean_name, encoded_hash)\n\n # This should work most of the time for\n # Case-sensitive filesystems,\n # In-project venv\n # \"Proper\" path casing (on non-case-sensitive filesystems).\n if (\n not fnmatch.fnmatch(\"A\", \"a\")\n or self.is_venv_in_project()\n or get_workon_home().joinpath(venv_name).exists()\n ):\n return clean_name, encoded_hash\n\n # Check for different capitalization of the same project.\n for path in get_workon_home().iterdir():\n if not is_virtual_environment(path):\n continue\n try:\n env_name, hash_ = path.name.rsplit(\"-\", 1)\n except ValueError:\n continue\n if len(hash_) != 8 or env_name.lower() != name.lower():\n continue\n return get_name(env_name, self.pipfile_location.replace(name, env_name))\n\n # Use the default if no matching env exists.\n return clean_name, encoded_hash\n\n @property\n def virtualenv_name(self):\n sanitized, encoded_hash = self._get_virtualenv_hash(self.name)\n suffix = \"-{0}\".format(PIPENV_PYTHON) if PIPENV_PYTHON else \"\"\n # If the pipfile was located at '/home/user/MY_PROJECT/Pipfile',\n # the name of its virtualenv will be 'my-project-wyUfYPqE'\n return sanitized + \"-\" + encoded_hash + suffix\n\n @property\n def virtualenv_location(self):\n # if VIRTUAL_ENV is set, use that.\n virtualenv_env = os.getenv(\"VIRTUAL_ENV\")\n if (\"PIPENV_ACTIVE\" not in os.environ and\n not PIPENV_IGNORE_VIRTUALENVS and virtualenv_env):\n return virtualenv_env\n\n if not self._virtualenv_location: # Use cached version, if available.\n assert self.project_directory, \"project not created\"\n self._virtualenv_location = self.get_location_for_virtualenv()\n return self._virtualenv_location\n\n @property\n def virtualenv_src_location(self):\n if self.virtualenv_location:\n loc = os.sep.join([self.virtualenv_location, \"src\"])\n else:\n loc = os.sep.join([self.project_directory, \"src\"])\n vistir.path.mkdir_p(loc)\n return loc\n\n @property\n def download_location(self):\n if self._download_location is None:\n loc = os.sep.join([self.virtualenv_location, \"downloads\"])\n self._download_location = loc\n # Create the directory, if it doesn't exist.\n vistir.path.mkdir_p(self._download_location)\n return self._download_location\n\n @property\n def proper_names_db_path(self):\n if self._proper_names_db_path is None:\n self._proper_names_db_path = vistir.compat.Path(\n self.virtualenv_location, \"pipenv-proper-names.txt\"\n )\n self._proper_names_db_path.touch() # Ensure the file exists.\n return self._proper_names_db_path\n\n @property\n def proper_names(self):\n with self.proper_names_db_path.open() as f:\n return f.read().splitlines()\n\n def register_proper_name(self, name):\n \"\"\"Registers a proper name to the database.\"\"\"\n with self.proper_names_db_path.open(\"a\") as f:\n f.write(u\"{0}\\n\".format(name))\n\n @property\n def pipfile_location(self):\n if PIPENV_PIPFILE:\n return PIPENV_PIPFILE\n\n if self._pipfile_location is None:\n try:\n loc = pipfile.Pipfile.find(max_depth=PIPENV_MAX_DEPTH)\n except RuntimeError:\n loc = None\n self._pipfile_location = _normalized(loc)\n return self._pipfile_location\n\n @property\n def requirements_location(self):\n if self._requirements_location is None:\n try:\n loc = find_requirements(max_depth=PIPENV_MAX_DEPTH)\n except RuntimeError:\n loc = None\n self._requirements_location = loc\n return self._requirements_location\n\n @property\n def parsed_pipfile(self):\n \"\"\"Parse Pipfile into a TOMLFile and cache it\n\n (call clear_pipfile_cache() afterwards if mutating)\"\"\"\n contents = self.read_pipfile()\n # use full contents to get around str/bytes 2/3 issues\n cache_key = (self.pipfile_location, contents)\n if cache_key not in _pipfile_cache:\n parsed = self._parse_pipfile(contents)\n _pipfile_cache[cache_key] = parsed\n return _pipfile_cache[cache_key]\n\n def read_pipfile(self):\n # Open the pipfile, read it into memory.\n with io.open(self.pipfile_location) as f:\n contents = f.read()\n self._pipfile_newlines = preferred_newlines(f)\n\n return contents\n\n def clear_pipfile_cache(self):\n \"\"\"Clear pipfile cache (e.g., so we can mutate parsed pipfile)\"\"\"\n _pipfile_cache.clear()\n\n def _parse_pipfile(self, contents):\n try:\n return tomlkit.parse(contents)\n except Exception:\n # We lose comments here, but it's for the best.)\n # Fallback to toml parser, for large files.\n return toml.loads(contents)\n\n def _read_pyproject(self):\n pyproject = self.path_to(\"pyproject.toml\")\n if os.path.exists(pyproject):\n self._pyproject = toml.load(pyproject)\n build_system = self._pyproject.get(\"build-system\", None)\n if not os.path.exists(self.path_to(\"setup.py\")):\n if not build_system or not build_system.get(\"requires\"):\n build_system = {\n \"requires\": [\"setuptools>=38.2.5\", \"wheel\"],\n \"build-backend\": \"setuptools.build_meta\",\n }\n self._build_system = build_system\n\n @property\n def build_requires(self):\n return self._build_system.get(\"requires\", [])\n\n @property\n def build_backend(self):\n return self._build_system.get(\"build-backend\", None)\n\n @property\n def settings(self):\n \"\"\"A dictionary of the settings added to the Pipfile.\"\"\"\n return self.parsed_pipfile.get(\"pipenv\", {})\n\n def has_script(self, name):\n try:\n return name in self.parsed_pipfile[\"scripts\"]\n except KeyError:\n return False\n\n def build_script(self, name, extra_args=None):\n try:\n script = Script.parse(self.parsed_pipfile[\"scripts\"][name])\n except KeyError:\n script = Script(name)\n if extra_args:\n script.extend(extra_args)\n return script\n\n def update_settings(self, d):\n settings = self.settings\n changed = False\n for new in d:\n if new not in settings:\n settings[new] = d[new]\n changed = True\n if changed:\n p = self.parsed_pipfile\n p[\"pipenv\"] = settings\n # Write the changes to disk.\n self.write_toml(p)\n\n @property\n def _lockfile(self):\n \"\"\"Pipfile.lock divided by PyPI and external dependencies.\"\"\"\n pfile = pipfile.load(self.pipfile_location, inject_env=False)\n lockfile = json.loads(pfile.lock())\n for section in (\"default\", \"develop\"):\n lock_section = lockfile.get(section, {})\n for key in list(lock_section.keys()):\n norm_key = pep423_name(key)\n lockfile[section][norm_key] = lock_section.pop(key)\n return lockfile\n\n @property\n def _pipfile(self):\n from .vendor.requirementslib.models.pipfile import Pipfile as ReqLibPipfile\n pf = ReqLibPipfile.load(self.pipfile_location)\n return pf\n\n @property\n def lockfile_location(self):\n return \"{0}.lock\".format(self.pipfile_location)\n\n @property\n def lockfile_exists(self):\n return os.path.isfile(self.lockfile_location)\n\n @property\n def lockfile_content(self):\n return self.load_lockfile()\n\n def _get_editable_packages(self, dev=False):\n section = \"dev-packages\" if dev else \"packages\"\n # section = \"{0}-editable\".format(section)\n packages = {\n k: v\n # for k, v in self._pipfile[section].items()\n for k, v in self.parsed_pipfile.get(section, {}).items()\n if is_editable(k) or is_editable(v)\n }\n return packages\n\n def _get_vcs_packages(self, dev=False):\n from pipenv.vendor.requirementslib.utils import is_vcs\n section = \"dev-packages\" if dev else \"packages\"\n # section = \"{0}-vcs\".format(section)\n packages = {\n k: v\n # for k, v in self._pipfile[section].items()\n for k, v in self.parsed_pipfile.get(section, {}).items()\n if is_vcs(v) or is_vcs(k)\n }\n return packages or {}\n\n @property\n def editable_packages(self):\n return self._get_editable_packages(dev=False)\n\n @property\n def editable_dev_packages(self):\n return self._get_editable_packages(dev=True)\n\n @property\n def vcs_packages(self):\n \"\"\"Returns a list of VCS packages, for not pip-tools to consume.\"\"\"\n return self._get_vcs_packages(dev=False)\n\n @property\n def vcs_dev_packages(self):\n \"\"\"Returns a list of VCS packages, for not pip-tools to consume.\"\"\"\n return self._get_vcs_packages(dev=True)\n\n @property\n def all_packages(self):\n \"\"\"Returns a list of all packages.\"\"\"\n p = dict(self.parsed_pipfile.get(\"dev-packages\", {}))\n p.update(self.parsed_pipfile.get(\"packages\", {}))\n return p\n\n @property\n def packages(self):\n \"\"\"Returns a list of packages, for pip-tools to consume.\"\"\"\n return self._build_package_list(\"packages\")\n\n @property\n def dev_packages(self):\n \"\"\"Returns a list of dev-packages, for pip-tools to consume.\"\"\"\n return self._build_package_list(\"dev-packages\")\n\n def touch_pipfile(self):\n \"\"\"Simply touches the Pipfile, for later use.\"\"\"\n with open(\"Pipfile\", \"a\"):\n os.utime(\"Pipfile\", None)\n\n @property\n def pipfile_is_empty(self):\n if not self.pipfile_exists:\n return True\n\n if not len(self.read_pipfile()):\n return True\n\n return False\n\n def create_pipfile(self, python=None):\n \"\"\"Creates the Pipfile, filled with juicy defaults.\"\"\"\n from .vendor.pip_shims.shims import (\n ConfigOptionParser, make_option_group, index_group\n )\n\n name = self.name if self.name is not None else \"Pipfile\"\n config_parser = ConfigOptionParser(name=self.name)\n config_parser.add_option_group(make_option_group(index_group, config_parser))\n install = config_parser.option_groups[0]\n indexes = (\n \" \".join(install.get_option(\"--extra-index-url\").default)\n .lstrip(\"\\n\")\n .split(\"\\n\")\n )\n sources = [DEFAULT_SOURCE,]\n for i, index in enumerate(indexes):\n if not index:\n continue\n\n source_name = \"pip_index_{}\".format(i)\n verify_ssl = index.startswith(\"https\")\n sources.append(\n {u\"url\": index, u\"verify_ssl\": verify_ssl, u\"name\": source_name}\n )\n\n data = {\n u\"source\": sources,\n # Default packages.\n u\"packages\": {},\n u\"dev-packages\": {},\n }\n # Default requires.\n required_python = python\n if not python:\n if self.virtualenv_location:\n required_python = self.which(\"python\", self.virtualenv_location)\n else:\n required_python = self.which(\"python\")\n version = python_version(required_python) or PIPENV_DEFAULT_PYTHON_VERSION\n if version and len(version) >= 3:\n data[u\"requires\"] = {\"python_version\": version[: len(\"2.7\")]}\n self.write_toml(data)\n\n @classmethod\n def populate_source(cls, source):\n \"\"\"Derive missing values of source from the existing fields.\"\"\"\n # Only URL pararemter is mandatory, let the KeyError be thrown.\n if \"name\" not in source:\n source[\"name\"] = get_url_name(source[\"url\"])\n if \"verify_ssl\" not in source:\n source[\"verify_ssl\"] = \"https://\" in source[\"url\"]\n if not isinstance(source[\"verify_ssl\"], bool):\n source[\"verify_ssl\"] = source[\"verify_ssl\"].lower() == \"true\"\n return source\n\n def get_or_create_lockfile(self, from_pipfile=False):\n from pipenv.vendor.requirementslib.models.lockfile import Lockfile as Req_Lockfile\n lockfile = None\n if from_pipfile and self.pipfile_exists:\n lockfile_dict = {\n \"default\": self._lockfile[\"default\"].copy(),\n \"develop\": self._lockfile[\"develop\"].copy()\n }\n lockfile_dict.update({\"_meta\": self.get_lockfile_meta()})\n lockfile = Req_Lockfile.from_data(\n path=self.lockfile_location, data=lockfile_dict, meta_from_project=False\n )\n elif self.lockfile_exists:\n try:\n lockfile = Req_Lockfile.load(self.lockfile_location)\n except OSError:\n lockfile = Req_Lockfile.from_data(self.lockfile_location, self.lockfile_content)\n else:\n lockfile = Req_Lockfile.from_data(path=self.lockfile_location, data=self._lockfile, meta_from_project=False)\n if lockfile._lockfile is not None:\n return lockfile\n if self.lockfile_exists and self.lockfile_content:\n lockfile_dict = self.lockfile_content.copy()\n sources = lockfile_dict.get(\"_meta\", {}).get(\"sources\", [])\n if not sources:\n sources = self.pipfile_sources\n elif not isinstance(sources, list):\n sources = [sources,]\n lockfile_dict[\"_meta\"][\"sources\"] = [\n self.populate_source(s) for s in sources\n ]\n _created_lockfile = Req_Lockfile.from_data(\n path=self.lockfile_location, data=lockfile_dict, meta_from_project=False\n )\n lockfile._lockfile = lockfile.projectfile.model = _created_lockfile\n return lockfile\n else:\n return self.get_or_create_lockfile(from_pipfile=True)\n\n def get_lockfile_meta(self):\n from .vendor.plette.lockfiles import PIPFILE_SPEC_CURRENT\n if self.lockfile_exists:\n sources = self.lockfile_content.get(\"_meta\", {}).get(\"sources\", [])\n else:\n sources = [dict(source) for source in self.parsed_pipfile[\"source\"]]\n if not isinstance(sources, list):\n sources = [sources,]\n return {\n \"hash\": {\"sha256\": self.calculate_pipfile_hash()},\n \"pipfile-spec\": PIPFILE_SPEC_CURRENT,\n \"sources\": sources,\n \"requires\": self.parsed_pipfile.get(\"requires\", {})\n }\n\n def write_toml(self, data, path=None):\n \"\"\"Writes the given data structure out as TOML.\"\"\"\n if path is None:\n path = self.pipfile_location\n data = convert_toml_outline_tables(data)\n try:\n formatted_data = tomlkit.dumps(data).rstrip()\n except Exception:\n document = tomlkit.document()\n for section in (\"packages\", \"dev-packages\"):\n document[section] = tomlkit.container.Table()\n # Convert things to inline tables — fancy :)\n for package in data.get(section, {}):\n if hasattr(data[section][package], \"keys\"):\n table = tomlkit.inline_table()\n table.update(data[section][package])\n document[section][package] = table\n else:\n document[section][package] = tomlkit.string(data[section][package])\n formatted_data = tomlkit.dumps(document).rstrip()\n\n if (\n vistir.compat.Path(path).absolute()\n == vistir.compat.Path(self.pipfile_location).absolute()\n ):\n newlines = self._pipfile_newlines\n else:\n newlines = DEFAULT_NEWLINES\n formatted_data = cleanup_toml(formatted_data)\n with io.open(path, \"w\", newline=newlines) as f:\n f.write(formatted_data)\n # pipfile is mutated!\n self.clear_pipfile_cache()\n\n def write_lockfile(self, content):\n \"\"\"Write out the lockfile.\n \"\"\"\n s = self._lockfile_encoder.encode(content)\n open_kwargs = {\"newline\": self._lockfile_newlines, \"encoding\": \"utf-8\"}\n with vistir.contextmanagers.atomic_open_for_write(\n self.lockfile_location, **open_kwargs\n ) as f:\n f.write(s)\n # Write newline at end of document. GH-319.\n # Only need '\\n' here; the file object handles the rest.\n if not s.endswith(u\"\\n\"):\n f.write(u\"\\n\")\n\n @property\n def pipfile_sources(self):\n if \"source\" not in self.parsed_pipfile:\n return [DEFAULT_SOURCE]\n # We need to make copies of the source info so we don't\n # accidentally modify the cache. See #2100 where values are\n # written after the os.path.expandvars() call.\n return [\n {k: safe_expandvars(v) for k, v in source.items()}\n for source in self.parsed_pipfile[\"source\"]\n ]\n\n @property\n def sources(self):\n if self.lockfile_exists and hasattr(self.lockfile_content, \"keys\"):\n meta_ = self.lockfile_content.get(\"_meta\", {})\n sources_ = meta_.get(\"sources\")\n if sources_:\n return sources_\n\n else:\n return self.pipfile_sources\n\n def find_source(self, source):\n \"\"\"given a source, find it.\n\n source can be a url or an index name.\n \"\"\"\n if not is_valid_url(source):\n try:\n source = self.get_source(name=source)\n except SourceNotFound:\n source = self.get_source(url=source)\n else:\n source = self.get_source(url=source)\n return source\n\n def get_source(self, name=None, url=None):\n def find_source(sources, name=None, url=None):\n source = None\n if name:\n source = [s for s in sources if s.get(\"name\") == name]\n elif url:\n source = [s for s in sources if url.startswith(s.get(\"url\"))]\n if source:\n return first(source)\n\n found_source = find_source(self.sources, name=name, url=url)\n if found_source:\n return found_source\n found_source = find_source(self.pipfile_sources, name=name, url=url)\n if found_source:\n return found_source\n raise SourceNotFound(name or url)\n\n def get_package_name_in_pipfile(self, package_name, dev=False):\n \"\"\"Get the equivalent package name in pipfile\"\"\"\n key = \"dev-packages\" if dev else \"packages\"\n section = self.parsed_pipfile.get(key, {})\n package_name = pep423_name(package_name)\n for name in section.keys():\n if pep423_name(name) == package_name:\n return name\n return None\n\n def remove_package_from_pipfile(self, package_name, dev=False):\n # Read and append Pipfile.\n name = self.get_package_name_in_pipfile(package_name, dev)\n key = \"dev-packages\" if dev else \"packages\"\n p = self.parsed_pipfile\n if name:\n del p[key][name]\n self.write_toml(p)\n\n def remove_packages_from_pipfile(self, packages):\n parsed = self.parsed_pipfile\n packages = set([pep423_name(pkg) for pkg in packages])\n for section in (\"dev-packages\", \"packages\"):\n pipfile_section = parsed.get(section, {})\n pipfile_packages = set([\n pep423_name(pkg_name) for pkg_name in pipfile_section.keys()\n ])\n to_remove = packages & pipfile_packages\n # The normal toml parser can't handle deleting packages with preceding newlines\n is_dev = section == \"dev-packages\"\n for pkg in to_remove:\n pkg_name = self.get_package_name_in_pipfile(pkg, dev=is_dev)\n del parsed[section][pkg_name]\n self.write_toml(parsed)\n\n def add_package_to_pipfile(self, package, dev=False):\n from .vendor.requirementslib import Requirement\n\n # Read and append Pipfile.\n p = self.parsed_pipfile\n # Don't re-capitalize file URLs or VCSs.\n if not isinstance(package, Requirement):\n package = Requirement.from_line(package.strip())\n _, converted = package.pipfile_entry\n key = \"dev-packages\" if dev else \"packages\"\n # Set empty group if it doesn't exist yet.\n if key not in p:\n p[key] = {}\n name = self.get_package_name_in_pipfile(package.name, dev)\n if name and is_star(converted):\n # Skip for wildcard version\n return\n # Add the package to the group.\n p[key][name or package.normalized_name] = converted\n # Write Pipfile.\n self.write_toml(p)\n\n def src_name_from_url(self, index_url):\n name, _, tld_guess = six.moves.urllib.parse.urlsplit(index_url).netloc.rpartition(\n \".\"\n )\n src_name = name.replace(\".\", \"\")\n try:\n self.get_source(name=src_name)\n except SourceNotFound:\n name = src_name\n else:\n from random import randint\n name = \"{0}-{1}\".format(src_name, randint(1, 1000))\n return name\n\n def add_index_to_pipfile(self, index, verify_ssl=True):\n \"\"\"Adds a given index to the Pipfile.\"\"\"\n # Read and append Pipfile.\n p = self.parsed_pipfile\n try:\n self.get_source(url=index)\n except SourceNotFound:\n source = {\"url\": index, \"verify_ssl\": verify_ssl}\n else:\n return\n source[\"name\"] = self.src_name_from_url(index)\n # Add the package to the group.\n if \"source\" not in p:\n p[\"source\"] = [source]\n else:\n p[\"source\"].append(source)\n # Write Pipfile.\n self.write_toml(p)\n\n def recase_pipfile(self):\n if self.ensure_proper_casing():\n self.write_toml(self.parsed_pipfile)\n\n def load_lockfile(self, expand_env_vars=True):\n with io.open(self.lockfile_location, encoding=\"utf-8\") as lock:\n j = json.load(lock)\n self._lockfile_newlines = preferred_newlines(lock)\n # lockfile is just a string\n if not j or not hasattr(j, \"keys\"):\n return j\n\n if expand_env_vars:\n # Expand environment variables in Pipfile.lock at runtime.\n for i, source in enumerate(j[\"_meta\"][\"sources\"][:]):\n j[\"_meta\"][\"sources\"][i][\"url\"] = os.path.expandvars(\n j[\"_meta\"][\"sources\"][i][\"url\"]\n )\n\n return j\n\n def get_lockfile_hash(self):\n if not os.path.exists(self.lockfile_location):\n return\n\n try:\n lockfile = self.load_lockfile(expand_env_vars=False)\n except ValueError:\n # Lockfile corrupted\n return \"\"\n if \"_meta\" in lockfile and hasattr(lockfile, \"keys\"):\n return lockfile[\"_meta\"].get(\"hash\", {}).get(\"sha256\")\n # Lockfile exists but has no hash at all\n return \"\"\n\n def calculate_pipfile_hash(self):\n # Update the lockfile if it is out-of-date.\n p = pipfile.load(self.pipfile_location, inject_env=False)\n return p.hash\n\n def ensure_proper_casing(self):\n \"\"\"Ensures proper casing of Pipfile packages\"\"\"\n pfile = self.parsed_pipfile\n casing_changed = self.proper_case_section(pfile.get(\"packages\", {}))\n casing_changed |= self.proper_case_section(pfile.get(\"dev-packages\", {}))\n return casing_changed\n\n def proper_case_section(self, section):\n \"\"\"Verify proper casing is retrieved, when available, for each\n dependency in the section.\n \"\"\"\n # Casing for section.\n changed_values = False\n unknown_names = [k for k in section.keys() if k not in set(self.proper_names)]\n # Replace each package with proper casing.\n for dep in unknown_names:\n try:\n # Get new casing for package name.\n new_casing = proper_case(dep)\n except IOError:\n # Unable to normalize package name.\n continue\n\n if new_casing != dep:\n changed_values = True\n self.register_proper_name(new_casing)\n # Replace old value with new value.\n old_value = section[dep]\n section[new_casing] = old_value\n del section[dep]\n # Return whether or not values have been changed.\n return changed_values\n\n @cached_property\n def finders(self):\n from .vendor.pythonfinder import Finder\n scripts_dirname = \"Scripts\" if os.name == \"nt\" else \"bin\"\n scripts_dir = os.path.join(self.virtualenv_location, scripts_dirname)\n finders = [\n Finder(path=scripts_dir, global_search=gs, system=False)\n for gs in (False, True)\n ]\n return finders\n\n @property\n def finder(self):\n return next(iter(self.finders), None)\n\n def which(self, search, as_path=True):\n find = operator.methodcaller(\"which\", search)\n result = next(iter(filter(None, (find(finder) for finder in self.finders))), None)\n if not result:\n result = self._which(search)\n else:\n if as_path:\n result = str(result.path)\n return result\n","path":"pipenv/project.py"}],"string":"[\n {\n \"content\": \"# -*- coding: utf-8 -*-\\nimport base64\\nimport fnmatch\\nimport glob\\nimport hashlib\\nimport io\\nimport json\\nimport operator\\nimport os\\nimport re\\nimport sys\\n\\nimport six\\nimport toml\\nimport tomlkit\\nimport vistir\\n\\nfrom first import first\\n\\nimport pipfile\\nimport pipfile.api\\n\\nfrom cached_property import cached_property\\n\\nfrom .cmdparse import Script\\nfrom .environment import Environment\\nfrom .environments import (\\n PIPENV_DEFAULT_PYTHON_VERSION, PIPENV_IGNORE_VIRTUALENVS, PIPENV_MAX_DEPTH,\\n PIPENV_PIPFILE, PIPENV_PYTHON, PIPENV_TEST_INDEX, PIPENV_VENV_IN_PROJECT,\\n is_in_virtualenv\\n)\\nfrom .utils import (\\n cleanup_toml, convert_toml_outline_tables, find_requirements,\\n get_canonical_names, get_url_name, get_workon_home, is_editable,\\n is_installable_file, is_star, is_valid_url, is_virtual_environment,\\n looks_like_dir, normalize_drive, pep423_name, proper_case, python_version,\\n safe_expandvars\\n)\\n\\n\\ndef _normalized(p):\\n if p is None:\\n return None\\n loc = vistir.compat.Path(p)\\n if not loc.is_absolute():\\n try:\\n loc = loc.resolve()\\n except OSError:\\n loc = loc.absolute()\\n # Recase the path properly on Windows. From https://stackoverflow.com/a/35229734/5043728\\n if os.name == 'nt':\\n matches = glob.glob(re.sub(r'([^:/\\\\\\\\])(?=[/\\\\\\\\]|$)', r'[\\\\1]', str(loc)))\\n path_str = matches and matches[0] or str(loc)\\n else:\\n path_str = str(loc)\\n return normalize_drive(path_str)\\n\\n\\nDEFAULT_NEWLINES = u\\\"\\\\n\\\"\\n\\n\\nclass _LockFileEncoder(json.JSONEncoder):\\n \\\"\\\"\\\"A specilized JSON encoder to convert loaded TOML data into a lock file.\\n\\n This adds a few characteristics to the encoder:\\n\\n * The JSON is always prettified with indents and spaces.\\n * TOMLKit's container elements are seamlessly encodable.\\n * The output is always UTF-8-encoded text, never binary, even on Python 2.\\n \\\"\\\"\\\"\\n\\n def __init__(self):\\n super(_LockFileEncoder, self).__init__(\\n indent=4, separators=(\\\",\\\", \\\": \\\"), sort_keys=True\\n )\\n\\n def default(self, obj):\\n if isinstance(obj, vistir.compat.Path):\\n obj = obj.as_posix()\\n return super(_LockFileEncoder, self).default(obj)\\n\\n def encode(self, obj):\\n content = super(_LockFileEncoder, self).encode(obj)\\n if not isinstance(content, six.text_type):\\n content = content.decode(\\\"utf-8\\\")\\n return content\\n\\n\\ndef preferred_newlines(f):\\n if isinstance(f.newlines, six.text_type):\\n return f.newlines\\n return DEFAULT_NEWLINES\\n\\n\\nif PIPENV_PIPFILE:\\n if not os.path.isfile(PIPENV_PIPFILE):\\n raise RuntimeError(\\\"Given PIPENV_PIPFILE is not found!\\\")\\n\\n else:\\n PIPENV_PIPFILE = _normalized(PIPENV_PIPFILE)\\n# (path, file contents) => TOMLFile\\n# keeps track of pipfiles that we've seen so we do not need to re-parse 'em\\n_pipfile_cache = {}\\n\\n\\nif PIPENV_TEST_INDEX:\\n DEFAULT_SOURCE = {\\n u\\\"url\\\": PIPENV_TEST_INDEX,\\n u\\\"verify_ssl\\\": True,\\n u\\\"name\\\": u\\\"custom\\\",\\n }\\nelse:\\n DEFAULT_SOURCE = {\\n u\\\"url\\\": u\\\"https://pypi.org/simple\\\",\\n u\\\"verify_ssl\\\": True,\\n u\\\"name\\\": u\\\"pypi\\\",\\n }\\n\\npipfile.api.DEFAULT_SOURCE = DEFAULT_SOURCE\\n\\n\\nclass SourceNotFound(KeyError):\\n pass\\n\\n\\nclass Project(object):\\n \\\"\\\"\\\"docstring for Project\\\"\\\"\\\"\\n\\n _lockfile_encoder = _LockFileEncoder()\\n\\n def __init__(self, which=None, python_version=None, chdir=True):\\n super(Project, self).__init__()\\n self._name = None\\n self._virtualenv_location = None\\n self._download_location = None\\n self._proper_names_db_path = None\\n self._pipfile_location = None\\n self._pipfile_newlines = DEFAULT_NEWLINES\\n self._lockfile_newlines = DEFAULT_NEWLINES\\n self._requirements_location = None\\n self._original_dir = os.path.abspath(os.curdir)\\n self._environment = None\\n self._which = which\\n self._build_system = {\\n \\\"requires\\\": [\\\"setuptools\\\", \\\"wheel\\\"]\\n }\\n self.python_version = python_version\\n # Hack to skip this during pipenv run, or -r.\\n if (\\\"run\\\" not in sys.argv) and chdir:\\n try:\\n os.chdir(self.project_directory)\\n except (TypeError, AttributeError):\\n pass\\n\\n def path_to(self, p):\\n \\\"\\\"\\\"Returns the absolute path to a given relative path.\\\"\\\"\\\"\\n if os.path.isabs(p):\\n return p\\n\\n return os.sep.join([self._original_dir, p])\\n\\n def _build_package_list(self, package_section):\\n \\\"\\\"\\\"Returns a list of packages for pip-tools to consume.\\\"\\\"\\\"\\n from pipenv.vendor.requirementslib.utils import is_vcs\\n ps = {}\\n # TODO: Separate the logic for showing packages from the filters for supplying pip-tools\\n for k, v in self.parsed_pipfile.get(package_section, {}).items():\\n # Skip editable VCS deps.\\n if hasattr(v, \\\"keys\\\"):\\n # When a vcs url is gven without editable it only appears as a key\\n # Eliminate any vcs, path, or url entries which are not editable\\n # Since pip-tools can't do deep resolution on them, even setuptools-installable ones\\n if (\\n is_vcs(v)\\n or is_vcs(k)\\n or (is_installable_file(k) or is_installable_file(v))\\n or any(\\n (\\n prefix in v\\n and (os.path.isfile(v[prefix]) or is_valid_url(v[prefix]))\\n )\\n for prefix in [\\\"path\\\", \\\"file\\\"]\\n )\\n ):\\n # If they are editable, do resolve them\\n if \\\"editable\\\" not in v:\\n # allow wheels to be passed through\\n if not (\\n hasattr(v, \\\"keys\\\")\\n and v.get(\\\"path\\\", v.get(\\\"file\\\", \\\"\\\")).endswith(\\\".whl\\\")\\n ):\\n continue\\n ps.update({k: v})\\n\\n else:\\n ps.update({k: v})\\n else:\\n ps.update({k: v})\\n else:\\n # Since these entries have no attributes we know they are not editable\\n # So we can safely exclude things that need to be editable in order to be resolved\\n # First exclude anything that is a vcs entry either in the key or value\\n if not (\\n any(is_vcs(i) for i in [k, v])\\n or\\n # Then exclude any installable files that are not directories\\n # Because pip-tools can resolve setup.py for example\\n any(is_installable_file(i) for i in [k, v])\\n or\\n # Then exclude any URLs because they need to be editable also\\n # Things that are excluded can only be 'shallow resolved'\\n any(is_valid_url(i) for i in [k, v])\\n ):\\n ps.update({k: v})\\n return ps\\n\\n @property\\n def name(self):\\n if self._name is None:\\n self._name = self.pipfile_location.split(os.sep)[-2]\\n return self._name\\n\\n @property\\n def pipfile_exists(self):\\n return bool(self.pipfile_location)\\n\\n @property\\n def required_python_version(self):\\n if self.pipfile_exists:\\n required = self.parsed_pipfile.get(\\\"requires\\\", {}).get(\\n \\\"python_full_version\\\"\\n )\\n if not required:\\n required = self.parsed_pipfile.get(\\\"requires\\\", {}).get(\\\"python_version\\\")\\n if required != \\\"*\\\":\\n return required\\n\\n @property\\n def project_directory(self):\\n if self.pipfile_location is not None:\\n return os.path.abspath(os.path.join(self.pipfile_location, os.pardir))\\n\\n else:\\n return None\\n\\n @property\\n def requirements_exists(self):\\n return bool(self.requirements_location)\\n\\n def is_venv_in_project(self):\\n return PIPENV_VENV_IN_PROJECT or (\\n self.project_directory\\n and os.path.isdir(os.path.join(self.project_directory, \\\".venv\\\"))\\n )\\n\\n @property\\n def virtualenv_exists(self):\\n # TODO: Decouple project from existence of Pipfile.\\n if self.pipfile_exists and os.path.exists(self.virtualenv_location):\\n if os.name == \\\"nt\\\":\\n extra = [\\\"Scripts\\\", \\\"activate.bat\\\"]\\n else:\\n extra = [\\\"bin\\\", \\\"activate\\\"]\\n return os.path.isfile(os.sep.join([self.virtualenv_location] + extra))\\n\\n return False\\n\\n def get_location_for_virtualenv(self):\\n # If there's no project yet, set location based on config.\\n if not self.project_directory:\\n if self.is_venv_in_project():\\n return os.path.abspath(\\\".venv\\\")\\n return str(get_workon_home().joinpath(self.virtualenv_name))\\n\\n dot_venv = os.path.join(self.project_directory, \\\".venv\\\")\\n\\n # If there's no .venv in project root, set location based on config.\\n if not os.path.exists(dot_venv):\\n if self.is_venv_in_project():\\n return dot_venv\\n return str(get_workon_home().joinpath(self.virtualenv_name))\\n\\n # If .venv in project root is a directory, use it.\\n if os.path.isdir(dot_venv):\\n return dot_venv\\n\\n # Now we assume .venv in project root is a file. Use its content.\\n with io.open(dot_venv) as f:\\n name = f.read().strip()\\n\\n # If content looks like a path, use it as a relative path.\\n # Otherwise use directory named after content in WORKON_HOME.\\n if looks_like_dir(name):\\n path = vistir.compat.Path(self.project_directory, name)\\n return path.absolute().as_posix()\\n return str(get_workon_home().joinpath(name))\\n\\n @property\\n def working_set(self):\\n from .utils import load_path\\n sys_path = load_path(self.which(\\\"python\\\"))\\n import pkg_resources\\n return pkg_resources.WorkingSet(sys_path)\\n\\n @property\\n def installed_packages(self):\\n return self.environment.get_installed_packages()\\n\\n @property\\n def installed_package_names(self):\\n return get_canonical_names([pkg.key for pkg in self.installed_packages])\\n\\n @property\\n def lockfile_package_names(self):\\n dev_keys = get_canonical_names(self.lockfile_content[\\\"develop\\\"].keys())\\n default_keys = get_canonical_names(self.lockfile_content[\\\"default\\\"].keys())\\n return {\\n \\\"dev\\\": dev_keys,\\n \\\"default\\\": default_keys,\\n \\\"combined\\\": dev_keys | default_keys\\n }\\n\\n @property\\n def pipfile_package_names(self):\\n dev_keys = get_canonical_names(self.dev_packages.keys())\\n default_keys = get_canonical_names(self.packages.keys())\\n return {\\n \\\"dev\\\": dev_keys,\\n \\\"default\\\": default_keys,\\n \\\"combined\\\": dev_keys | default_keys\\n }\\n\\n @property\\n def environment(self):\\n if not self._environment:\\n prefix = self.virtualenv_location\\n is_venv = is_in_virtualenv()\\n sources = self.sources if self.sources else [DEFAULT_SOURCE,]\\n self._environment = Environment(\\n prefix=prefix, is_venv=is_venv, sources=sources, pipfile=self.parsed_pipfile,\\n project=self\\n )\\n self._environment.add_dist(\\\"pipenv\\\")\\n return self._environment\\n\\n def get_outdated_packages(self):\\n return self.environment.get_outdated_packages(pre=self.pipfile.get(\\\"pre\\\", False))\\n\\n @classmethod\\n def _sanitize(cls, name):\\n # Replace dangerous characters into '_'. The length of the sanitized\\n # project name is limited as 42 because of the limit of linux kernel\\n #\\n # 42 = 127 - len('/home//.local/share/virtualenvs//bin/python2') - 32 - len('-HASHHASH')\\n #\\n # 127 : BINPRM_BUF_SIZE - 1\\n # 32 : Maximum length of username\\n #\\n # References:\\n # https://www.gnu.org/software/bash/manual/html_node/Double-Quotes.html\\n # http://www.tldp.org/LDP/abs/html/special-chars.html#FIELDREF\\n # https://github.com/torvalds/linux/blob/2bfe01ef/include/uapi/linux/binfmts.h#L18\\n return re.sub(r'[ $`!*@\\\"\\\\\\\\\\\\r\\\\n\\\\t]', \\\"_\\\", name)[0:42]\\n\\n def _get_virtualenv_hash(self, name):\\n \\\"\\\"\\\"Get the name of the virtualenv adjusted for windows if needed\\n\\n Returns (name, encoded_hash)\\n \\\"\\\"\\\"\\n\\n def get_name(name, location):\\n name = self._sanitize(name)\\n hash = hashlib.sha256(location.encode()).digest()[:6]\\n encoded_hash = base64.urlsafe_b64encode(hash).decode()\\n return name, encoded_hash[:8]\\n\\n clean_name, encoded_hash = get_name(name, self.pipfile_location)\\n venv_name = \\\"{0}-{1}\\\".format(clean_name, encoded_hash)\\n\\n # This should work most of the time for\\n # Case-sensitive filesystems,\\n # In-project venv\\n # \\\"Proper\\\" path casing (on non-case-sensitive filesystems).\\n if (\\n not fnmatch.fnmatch(\\\"A\\\", \\\"a\\\")\\n or self.is_venv_in_project()\\n or get_workon_home().joinpath(venv_name).exists()\\n ):\\n return clean_name, encoded_hash\\n\\n # Check for different capitalization of the same project.\\n for path in get_workon_home().iterdir():\\n if not is_virtual_environment(path):\\n continue\\n try:\\n env_name, hash_ = path.name.rsplit(\\\"-\\\", 1)\\n except ValueError:\\n continue\\n if len(hash_) != 8 or env_name.lower() != name.lower():\\n continue\\n return get_name(env_name, self.pipfile_location.replace(name, env_name))\\n\\n # Use the default if no matching env exists.\\n return clean_name, encoded_hash\\n\\n @property\\n def virtualenv_name(self):\\n sanitized, encoded_hash = self._get_virtualenv_hash(self.name)\\n suffix = \\\"-{0}\\\".format(PIPENV_PYTHON) if PIPENV_PYTHON else \\\"\\\"\\n # If the pipfile was located at '/home/user/MY_PROJECT/Pipfile',\\n # the name of its virtualenv will be 'my-project-wyUfYPqE'\\n return sanitized + \\\"-\\\" + encoded_hash + suffix\\n\\n @property\\n def virtualenv_location(self):\\n # if VIRTUAL_ENV is set, use that.\\n virtualenv_env = os.getenv(\\\"VIRTUAL_ENV\\\")\\n if (\\\"PIPENV_ACTIVE\\\" not in os.environ and\\n not PIPENV_IGNORE_VIRTUALENVS and virtualenv_env):\\n return virtualenv_env\\n\\n if not self._virtualenv_location: # Use cached version, if available.\\n assert self.project_directory, \\\"project not created\\\"\\n self._virtualenv_location = self.get_location_for_virtualenv()\\n return self._virtualenv_location\\n\\n @property\\n def virtualenv_src_location(self):\\n if self.virtualenv_location:\\n loc = os.sep.join([self.virtualenv_location, \\\"src\\\"])\\n else:\\n loc = os.sep.join([self.project_directory, \\\"src\\\"])\\n vistir.path.mkdir_p(loc)\\n return loc\\n\\n @property\\n def download_location(self):\\n if self._download_location is None:\\n loc = os.sep.join([self.virtualenv_location, \\\"downloads\\\"])\\n self._download_location = loc\\n # Create the directory, if it doesn't exist.\\n vistir.path.mkdir_p(self._download_location)\\n return self._download_location\\n\\n @property\\n def proper_names_db_path(self):\\n if self._proper_names_db_path is None:\\n self._proper_names_db_path = vistir.compat.Path(\\n self.virtualenv_location, \\\"pipenv-proper-names.txt\\\"\\n )\\n self._proper_names_db_path.touch() # Ensure the file exists.\\n return self._proper_names_db_path\\n\\n @property\\n def proper_names(self):\\n with self.proper_names_db_path.open() as f:\\n return f.read().splitlines()\\n\\n def register_proper_name(self, name):\\n \\\"\\\"\\\"Registers a proper name to the database.\\\"\\\"\\\"\\n with self.proper_names_db_path.open(\\\"a\\\") as f:\\n f.write(u\\\"{0}\\\\n\\\".format(name))\\n\\n @property\\n def pipfile_location(self):\\n if PIPENV_PIPFILE:\\n return PIPENV_PIPFILE\\n\\n if self._pipfile_location is None:\\n try:\\n loc = pipfile.Pipfile.find(max_depth=PIPENV_MAX_DEPTH)\\n except RuntimeError:\\n loc = None\\n self._pipfile_location = _normalized(loc)\\n return self._pipfile_location\\n\\n @property\\n def requirements_location(self):\\n if self._requirements_location is None:\\n try:\\n loc = find_requirements(max_depth=PIPENV_MAX_DEPTH)\\n except RuntimeError:\\n loc = None\\n self._requirements_location = loc\\n return self._requirements_location\\n\\n @property\\n def parsed_pipfile(self):\\n \\\"\\\"\\\"Parse Pipfile into a TOMLFile and cache it\\n\\n (call clear_pipfile_cache() afterwards if mutating)\\\"\\\"\\\"\\n contents = self.read_pipfile()\\n # use full contents to get around str/bytes 2/3 issues\\n cache_key = (self.pipfile_location, contents)\\n if cache_key not in _pipfile_cache:\\n parsed = self._parse_pipfile(contents)\\n _pipfile_cache[cache_key] = parsed\\n return _pipfile_cache[cache_key]\\n\\n def read_pipfile(self):\\n # Open the pipfile, read it into memory.\\n with io.open(self.pipfile_location) as f:\\n contents = f.read()\\n self._pipfile_newlines = preferred_newlines(f)\\n\\n return contents\\n\\n def clear_pipfile_cache(self):\\n \\\"\\\"\\\"Clear pipfile cache (e.g., so we can mutate parsed pipfile)\\\"\\\"\\\"\\n _pipfile_cache.clear()\\n\\n def _parse_pipfile(self, contents):\\n try:\\n return tomlkit.parse(contents)\\n except Exception:\\n # We lose comments here, but it's for the best.)\\n # Fallback to toml parser, for large files.\\n return toml.loads(contents)\\n\\n def _read_pyproject(self):\\n pyproject = self.path_to(\\\"pyproject.toml\\\")\\n if os.path.exists(pyproject):\\n self._pyproject = toml.load(pyproject)\\n build_system = self._pyproject.get(\\\"build-system\\\", None)\\n if not os.path.exists(self.path_to(\\\"setup.py\\\")):\\n if not build_system or not build_system.get(\\\"requires\\\"):\\n build_system = {\\n \\\"requires\\\": [\\\"setuptools>=38.2.5\\\", \\\"wheel\\\"],\\n \\\"build-backend\\\": \\\"setuptools.build_meta\\\",\\n }\\n self._build_system = build_system\\n\\n @property\\n def build_requires(self):\\n return self._build_system.get(\\\"requires\\\", [])\\n\\n @property\\n def build_backend(self):\\n return self._build_system.get(\\\"build-backend\\\", None)\\n\\n @property\\n def settings(self):\\n \\\"\\\"\\\"A dictionary of the settings added to the Pipfile.\\\"\\\"\\\"\\n return self.parsed_pipfile.get(\\\"pipenv\\\", {})\\n\\n def has_script(self, name):\\n try:\\n return name in self.parsed_pipfile[\\\"scripts\\\"]\\n except KeyError:\\n return False\\n\\n def build_script(self, name, extra_args=None):\\n try:\\n script = Script.parse(self.parsed_pipfile[\\\"scripts\\\"][name])\\n except KeyError:\\n script = Script(name)\\n if extra_args:\\n script.extend(extra_args)\\n return script\\n\\n def update_settings(self, d):\\n settings = self.settings\\n changed = False\\n for new in d:\\n if new not in settings:\\n settings[new] = d[new]\\n changed = True\\n if changed:\\n p = self.parsed_pipfile\\n p[\\\"pipenv\\\"] = settings\\n # Write the changes to disk.\\n self.write_toml(p)\\n\\n @property\\n def _lockfile(self):\\n \\\"\\\"\\\"Pipfile.lock divided by PyPI and external dependencies.\\\"\\\"\\\"\\n pfile = pipfile.load(self.pipfile_location, inject_env=False)\\n lockfile = json.loads(pfile.lock())\\n for section in (\\\"default\\\", \\\"develop\\\"):\\n lock_section = lockfile.get(section, {})\\n for key in list(lock_section.keys()):\\n norm_key = pep423_name(key)\\n lockfile[section][norm_key] = lock_section.pop(key)\\n return lockfile\\n\\n @property\\n def _pipfile(self):\\n from .vendor.requirementslib.models.pipfile import Pipfile as ReqLibPipfile\\n pf = ReqLibPipfile.load(self.pipfile_location)\\n return pf\\n\\n @property\\n def lockfile_location(self):\\n return \\\"{0}.lock\\\".format(self.pipfile_location)\\n\\n @property\\n def lockfile_exists(self):\\n return os.path.isfile(self.lockfile_location)\\n\\n @property\\n def lockfile_content(self):\\n return self.load_lockfile()\\n\\n def _get_editable_packages(self, dev=False):\\n section = \\\"dev-packages\\\" if dev else \\\"packages\\\"\\n # section = \\\"{0}-editable\\\".format(section)\\n packages = {\\n k: v\\n # for k, v in self._pipfile[section].items()\\n for k, v in self.parsed_pipfile.get(section, {}).items()\\n if is_editable(k) or is_editable(v)\\n }\\n return packages\\n\\n def _get_vcs_packages(self, dev=False):\\n from pipenv.vendor.requirementslib.utils import is_vcs\\n section = \\\"dev-packages\\\" if dev else \\\"packages\\\"\\n # section = \\\"{0}-vcs\\\".format(section)\\n packages = {\\n k: v\\n # for k, v in self._pipfile[section].items()\\n for k, v in self.parsed_pipfile.get(section, {}).items()\\n if is_vcs(v) or is_vcs(k)\\n }\\n return packages or {}\\n\\n @property\\n def editable_packages(self):\\n return self._get_editable_packages(dev=False)\\n\\n @property\\n def editable_dev_packages(self):\\n return self._get_editable_packages(dev=True)\\n\\n @property\\n def vcs_packages(self):\\n \\\"\\\"\\\"Returns a list of VCS packages, for not pip-tools to consume.\\\"\\\"\\\"\\n return self._get_vcs_packages(dev=False)\\n\\n @property\\n def vcs_dev_packages(self):\\n \\\"\\\"\\\"Returns a list of VCS packages, for not pip-tools to consume.\\\"\\\"\\\"\\n return self._get_vcs_packages(dev=True)\\n\\n @property\\n def all_packages(self):\\n \\\"\\\"\\\"Returns a list of all packages.\\\"\\\"\\\"\\n p = dict(self.parsed_pipfile.get(\\\"dev-packages\\\", {}))\\n p.update(self.parsed_pipfile.get(\\\"packages\\\", {}))\\n return p\\n\\n @property\\n def packages(self):\\n \\\"\\\"\\\"Returns a list of packages, for pip-tools to consume.\\\"\\\"\\\"\\n return self._build_package_list(\\\"packages\\\")\\n\\n @property\\n def dev_packages(self):\\n \\\"\\\"\\\"Returns a list of dev-packages, for pip-tools to consume.\\\"\\\"\\\"\\n return self._build_package_list(\\\"dev-packages\\\")\\n\\n def touch_pipfile(self):\\n \\\"\\\"\\\"Simply touches the Pipfile, for later use.\\\"\\\"\\\"\\n with open(\\\"Pipfile\\\", \\\"a\\\"):\\n os.utime(\\\"Pipfile\\\", None)\\n\\n @property\\n def pipfile_is_empty(self):\\n if not self.pipfile_exists:\\n return True\\n\\n if not len(self.read_pipfile()):\\n return True\\n\\n return False\\n\\n def create_pipfile(self, python=None):\\n \\\"\\\"\\\"Creates the Pipfile, filled with juicy defaults.\\\"\\\"\\\"\\n from .vendor.pip_shims.shims import (\\n ConfigOptionParser, make_option_group, index_group\\n )\\n\\n name = self.name if self.name is not None else \\\"Pipfile\\\"\\n config_parser = ConfigOptionParser(name=self.name)\\n config_parser.add_option_group(make_option_group(index_group, config_parser))\\n install = config_parser.option_groups[0]\\n indexes = (\\n \\\" \\\".join(install.get_option(\\\"--extra-index-url\\\").default)\\n .lstrip(\\\"\\\\n\\\")\\n .split(\\\"\\\\n\\\")\\n )\\n sources = [DEFAULT_SOURCE,]\\n for i, index in enumerate(indexes):\\n if not index:\\n continue\\n\\n source_name = \\\"pip_index_{}\\\".format(i)\\n verify_ssl = index.startswith(\\\"https\\\")\\n sources.append(\\n {u\\\"url\\\": index, u\\\"verify_ssl\\\": verify_ssl, u\\\"name\\\": source_name}\\n )\\n\\n data = {\\n u\\\"source\\\": sources,\\n # Default packages.\\n u\\\"packages\\\": {},\\n u\\\"dev-packages\\\": {},\\n }\\n # Default requires.\\n required_python = python\\n if not python:\\n if self.virtualenv_location:\\n required_python = self.which(\\\"python\\\", self.virtualenv_location)\\n else:\\n required_python = self.which(\\\"python\\\")\\n version = python_version(required_python) or PIPENV_DEFAULT_PYTHON_VERSION\\n if version and len(version) >= 3:\\n data[u\\\"requires\\\"] = {\\\"python_version\\\": version[: len(\\\"2.7\\\")]}\\n self.write_toml(data)\\n\\n @classmethod\\n def populate_source(cls, source):\\n \\\"\\\"\\\"Derive missing values of source from the existing fields.\\\"\\\"\\\"\\n # Only URL pararemter is mandatory, let the KeyError be thrown.\\n if \\\"name\\\" not in source:\\n source[\\\"name\\\"] = get_url_name(source[\\\"url\\\"])\\n if \\\"verify_ssl\\\" not in source:\\n source[\\\"verify_ssl\\\"] = \\\"https://\\\" in source[\\\"url\\\"]\\n if not isinstance(source[\\\"verify_ssl\\\"], bool):\\n source[\\\"verify_ssl\\\"] = source[\\\"verify_ssl\\\"].lower() == \\\"true\\\"\\n return source\\n\\n def get_or_create_lockfile(self, from_pipfile=False):\\n from pipenv.vendor.requirementslib.models.lockfile import Lockfile as Req_Lockfile\\n lockfile = None\\n if from_pipfile and self.pipfile_exists:\\n lockfile_dict = {\\n \\\"default\\\": self._lockfile[\\\"default\\\"].copy(),\\n \\\"develop\\\": self._lockfile[\\\"develop\\\"].copy()\\n }\\n lockfile_dict.update({\\\"_meta\\\": self.get_lockfile_meta()})\\n lockfile = Req_Lockfile.from_data(\\n path=self.lockfile_location, data=lockfile_dict, meta_from_project=False\\n )\\n elif self.lockfile_exists:\\n try:\\n lockfile = Req_Lockfile.load(self.lockfile_location)\\n except OSError:\\n lockfile = Req_Lockfile.from_data(self.lockfile_location, self.lockfile_content)\\n else:\\n lockfile = Req_Lockfile.from_data(path=self.lockfile_location, data=self._lockfile, meta_from_project=False)\\n if lockfile._lockfile is not None:\\n return lockfile\\n if self.lockfile_exists and self.lockfile_content:\\n lockfile_dict = self.lockfile_content.copy()\\n sources = lockfile_dict.get(\\\"_meta\\\", {}).get(\\\"sources\\\", [])\\n if not sources:\\n sources = self.pipfile_sources\\n elif not isinstance(sources, list):\\n sources = [sources,]\\n lockfile_dict[\\\"_meta\\\"][\\\"sources\\\"] = [\\n self.populate_source(s) for s in sources\\n ]\\n _created_lockfile = Req_Lockfile.from_data(\\n path=self.lockfile_location, data=lockfile_dict, meta_from_project=False\\n )\\n lockfile._lockfile = lockfile.projectfile.model = _created_lockfile\\n return lockfile\\n else:\\n return self.get_or_create_lockfile(from_pipfile=True)\\n\\n def get_lockfile_meta(self):\\n from .vendor.plette.lockfiles import PIPFILE_SPEC_CURRENT\\n if self.lockfile_exists:\\n sources = self.lockfile_content.get(\\\"_meta\\\", {}).get(\\\"sources\\\", [])\\n else:\\n sources = [dict(source) for source in self.parsed_pipfile[\\\"source\\\"]]\\n if not isinstance(sources, list):\\n sources = [sources,]\\n return {\\n \\\"hash\\\": {\\\"sha256\\\": self.calculate_pipfile_hash()},\\n \\\"pipfile-spec\\\": PIPFILE_SPEC_CURRENT,\\n \\\"sources\\\": sources,\\n \\\"requires\\\": self.parsed_pipfile.get(\\\"requires\\\", {})\\n }\\n\\n def write_toml(self, data, path=None):\\n \\\"\\\"\\\"Writes the given data structure out as TOML.\\\"\\\"\\\"\\n if path is None:\\n path = self.pipfile_location\\n data = convert_toml_outline_tables(data)\\n try:\\n formatted_data = tomlkit.dumps(data).rstrip()\\n except Exception:\\n document = tomlkit.document()\\n for section in (\\\"packages\\\", \\\"dev-packages\\\"):\\n document[section] = tomlkit.container.Table()\\n # Convert things to inline tables — fancy :)\\n for package in data.get(section, {}):\\n if hasattr(data[section][package], \\\"keys\\\"):\\n table = tomlkit.inline_table()\\n table.update(data[section][package])\\n document[section][package] = table\\n else:\\n document[section][package] = tomlkit.string(data[section][package])\\n formatted_data = tomlkit.dumps(document).rstrip()\\n\\n if (\\n vistir.compat.Path(path).absolute()\\n == vistir.compat.Path(self.pipfile_location).absolute()\\n ):\\n newlines = self._pipfile_newlines\\n else:\\n newlines = DEFAULT_NEWLINES\\n formatted_data = cleanup_toml(formatted_data)\\n with io.open(path, \\\"w\\\", newline=newlines) as f:\\n f.write(formatted_data)\\n # pipfile is mutated!\\n self.clear_pipfile_cache()\\n\\n def write_lockfile(self, content):\\n \\\"\\\"\\\"Write out the lockfile.\\n \\\"\\\"\\\"\\n s = self._lockfile_encoder.encode(content)\\n open_kwargs = {\\\"newline\\\": self._lockfile_newlines, \\\"encoding\\\": \\\"utf-8\\\"}\\n with vistir.contextmanagers.atomic_open_for_write(\\n self.lockfile_location, **open_kwargs\\n ) as f:\\n f.write(s)\\n # Write newline at end of document. GH-319.\\n # Only need '\\\\n' here; the file object handles the rest.\\n if not s.endswith(u\\\"\\\\n\\\"):\\n f.write(u\\\"\\\\n\\\")\\n\\n @property\\n def pipfile_sources(self):\\n if \\\"source\\\" not in self.parsed_pipfile:\\n return [DEFAULT_SOURCE]\\n # We need to make copies of the source info so we don't\\n # accidentally modify the cache. See #2100 where values are\\n # written after the os.path.expandvars() call.\\n return [\\n {k: safe_expandvars(v) for k, v in source.items()}\\n for source in self.parsed_pipfile[\\\"source\\\"]\\n ]\\n\\n @property\\n def sources(self):\\n if self.lockfile_exists and hasattr(self.lockfile_content, \\\"keys\\\"):\\n meta_ = self.lockfile_content.get(\\\"_meta\\\", {})\\n sources_ = meta_.get(\\\"sources\\\")\\n if sources_:\\n return sources_\\n\\n else:\\n return self.pipfile_sources\\n\\n def find_source(self, source):\\n \\\"\\\"\\\"given a source, find it.\\n\\n source can be a url or an index name.\\n \\\"\\\"\\\"\\n if not is_valid_url(source):\\n try:\\n source = self.get_source(name=source)\\n except SourceNotFound:\\n source = self.get_source(url=source)\\n else:\\n source = self.get_source(url=source)\\n return source\\n\\n def get_source(self, name=None, url=None):\\n def find_source(sources, name=None, url=None):\\n source = None\\n if name:\\n source = [s for s in sources if s.get(\\\"name\\\") == name]\\n elif url:\\n source = [s for s in sources if url.startswith(s.get(\\\"url\\\"))]\\n if source:\\n return first(source)\\n\\n found_source = find_source(self.sources, name=name, url=url)\\n if found_source:\\n return found_source\\n found_source = find_source(self.pipfile_sources, name=name, url=url)\\n if found_source:\\n return found_source\\n raise SourceNotFound(name or url)\\n\\n def get_package_name_in_pipfile(self, package_name, dev=False):\\n \\\"\\\"\\\"Get the equivalent package name in pipfile\\\"\\\"\\\"\\n key = \\\"dev-packages\\\" if dev else \\\"packages\\\"\\n section = self.parsed_pipfile.get(key, {})\\n package_name = pep423_name(package_name)\\n for name in section.keys():\\n if pep423_name(name) == package_name:\\n return name\\n return None\\n\\n def remove_package_from_pipfile(self, package_name, dev=False):\\n # Read and append Pipfile.\\n name = self.get_package_name_in_pipfile(package_name, dev)\\n key = \\\"dev-packages\\\" if dev else \\\"packages\\\"\\n p = self.parsed_pipfile\\n if name:\\n del p[key][name]\\n self.write_toml(p)\\n\\n def remove_packages_from_pipfile(self, packages):\\n parsed = self.parsed_pipfile\\n packages = set([pep423_name(pkg) for pkg in packages])\\n for section in (\\\"dev-packages\\\", \\\"packages\\\"):\\n pipfile_section = parsed.get(section, {})\\n pipfile_packages = set([\\n pep423_name(pkg_name) for pkg_name in pipfile_section.keys()\\n ])\\n to_remove = packages & pipfile_packages\\n # The normal toml parser can't handle deleting packages with preceding newlines\\n is_dev = section == \\\"dev-packages\\\"\\n for pkg in to_remove:\\n pkg_name = self.get_package_name_in_pipfile(pkg, dev=is_dev)\\n del parsed[section][pkg_name]\\n self.write_toml(parsed)\\n\\n def add_package_to_pipfile(self, package, dev=False):\\n from .vendor.requirementslib import Requirement\\n\\n # Read and append Pipfile.\\n p = self.parsed_pipfile\\n # Don't re-capitalize file URLs or VCSs.\\n if not isinstance(package, Requirement):\\n package = Requirement.from_line(package.strip())\\n _, converted = package.pipfile_entry\\n key = \\\"dev-packages\\\" if dev else \\\"packages\\\"\\n # Set empty group if it doesn't exist yet.\\n if key not in p:\\n p[key] = {}\\n name = self.get_package_name_in_pipfile(package.name, dev)\\n if name and is_star(converted):\\n # Skip for wildcard version\\n return\\n # Add the package to the group.\\n p[key][name or package.normalized_name] = converted\\n # Write Pipfile.\\n self.write_toml(p)\\n\\n def src_name_from_url(self, index_url):\\n name, _, tld_guess = six.moves.urllib.parse.urlsplit(index_url).netloc.rpartition(\\n \\\".\\\"\\n )\\n src_name = name.replace(\\\".\\\", \\\"\\\")\\n try:\\n self.get_source(name=src_name)\\n except SourceNotFound:\\n name = src_name\\n else:\\n from random import randint\\n name = \\\"{0}-{1}\\\".format(src_name, randint(1, 1000))\\n return name\\n\\n def add_index_to_pipfile(self, index, verify_ssl=True):\\n \\\"\\\"\\\"Adds a given index to the Pipfile.\\\"\\\"\\\"\\n # Read and append Pipfile.\\n p = self.parsed_pipfile\\n try:\\n self.get_source(url=index)\\n except SourceNotFound:\\n source = {\\\"url\\\": index, \\\"verify_ssl\\\": verify_ssl}\\n else:\\n return\\n source[\\\"name\\\"] = self.src_name_from_url(index)\\n # Add the package to the group.\\n if \\\"source\\\" not in p:\\n p[\\\"source\\\"] = [source]\\n else:\\n p[\\\"source\\\"].append(source)\\n # Write Pipfile.\\n self.write_toml(p)\\n\\n def recase_pipfile(self):\\n if self.ensure_proper_casing():\\n self.write_toml(self.parsed_pipfile)\\n\\n def load_lockfile(self, expand_env_vars=True):\\n with io.open(self.lockfile_location, encoding=\\\"utf-8\\\") as lock:\\n j = json.load(lock)\\n self._lockfile_newlines = preferred_newlines(lock)\\n # lockfile is just a string\\n if not j or not hasattr(j, \\\"keys\\\"):\\n return j\\n\\n if expand_env_vars:\\n # Expand environment variables in Pipfile.lock at runtime.\\n for i, source in enumerate(j[\\\"_meta\\\"][\\\"sources\\\"][:]):\\n j[\\\"_meta\\\"][\\\"sources\\\"][i][\\\"url\\\"] = os.path.expandvars(\\n j[\\\"_meta\\\"][\\\"sources\\\"][i][\\\"url\\\"]\\n )\\n\\n return j\\n\\n def get_lockfile_hash(self):\\n if not os.path.exists(self.lockfile_location):\\n return\\n\\n try:\\n lockfile = self.load_lockfile(expand_env_vars=False)\\n except ValueError:\\n # Lockfile corrupted\\n return \\\"\\\"\\n if \\\"_meta\\\" in lockfile and hasattr(lockfile, \\\"keys\\\"):\\n return lockfile[\\\"_meta\\\"].get(\\\"hash\\\", {}).get(\\\"sha256\\\")\\n # Lockfile exists but has no hash at all\\n return \\\"\\\"\\n\\n def calculate_pipfile_hash(self):\\n # Update the lockfile if it is out-of-date.\\n p = pipfile.load(self.pipfile_location, inject_env=False)\\n return p.hash\\n\\n def ensure_proper_casing(self):\\n \\\"\\\"\\\"Ensures proper casing of Pipfile packages\\\"\\\"\\\"\\n pfile = self.parsed_pipfile\\n casing_changed = self.proper_case_section(pfile.get(\\\"packages\\\", {}))\\n casing_changed |= self.proper_case_section(pfile.get(\\\"dev-packages\\\", {}))\\n return casing_changed\\n\\n def proper_case_section(self, section):\\n \\\"\\\"\\\"Verify proper casing is retrieved, when available, for each\\n dependency in the section.\\n \\\"\\\"\\\"\\n # Casing for section.\\n changed_values = False\\n unknown_names = [k for k in section.keys() if k not in set(self.proper_names)]\\n # Replace each package with proper casing.\\n for dep in unknown_names:\\n try:\\n # Get new casing for package name.\\n new_casing = proper_case(dep)\\n except IOError:\\n # Unable to normalize package name.\\n continue\\n\\n if new_casing != dep:\\n changed_values = True\\n self.register_proper_name(new_casing)\\n # Replace old value with new value.\\n old_value = section[dep]\\n section[new_casing] = old_value\\n del section[dep]\\n # Return whether or not values have been changed.\\n return changed_values\\n\\n @cached_property\\n def finders(self):\\n from .vendor.pythonfinder import Finder\\n scripts_dirname = \\\"Scripts\\\" if os.name == \\\"nt\\\" else \\\"bin\\\"\\n scripts_dir = os.path.join(self.virtualenv_location, scripts_dirname)\\n finders = [\\n Finder(path=scripts_dir, global_search=gs, system=False)\\n for gs in (False, True)\\n ]\\n return finders\\n\\n @property\\n def finder(self):\\n return next(iter(self.finders), None)\\n\\n def which(self, search, as_path=True):\\n find = operator.methodcaller(\\\"which\\\", search)\\n result = next(iter(filter(None, (find(finder) for finder in self.finders))), None)\\n if not result:\\n result = self._which(search)\\n else:\\n if as_path:\\n result = str(result.path)\\n return result\\n\",\n \"path\": \"pipenv/project.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# -*- coding: utf-8 -*-\nimport base64\nimport fnmatch\nimport glob\nimport hashlib\nimport io\nimport json\nimport operator\nimport os\nimport re\nimport sys\n\nimport six\nimport toml\nimport tomlkit\nimport vistir\n\nfrom first import first\n\nimport pipfile\nimport pipfile.api\n\nfrom cached_property import cached_property\n\nfrom .cmdparse import Script\nfrom .environment import Environment\nfrom .environments import (\n PIPENV_DEFAULT_PYTHON_VERSION, PIPENV_IGNORE_VIRTUALENVS, PIPENV_MAX_DEPTH,\n PIPENV_PIPFILE, PIPENV_PYTHON, PIPENV_TEST_INDEX, PIPENV_VENV_IN_PROJECT,\n is_in_virtualenv\n)\nfrom .utils import (\n cleanup_toml, convert_toml_outline_tables, find_requirements,\n get_canonical_names, get_url_name, get_workon_home, is_editable,\n is_installable_file, is_star, is_valid_url, is_virtual_environment,\n looks_like_dir, normalize_drive, pep423_name, proper_case, python_version,\n safe_expandvars\n)\n\n\ndef _normalized(p):\n if p is None:\n return None\n loc = vistir.compat.Path(p)\n if not loc.is_absolute():\n try:\n loc = loc.resolve()\n except OSError:\n loc = loc.absolute()\n # Recase the path properly on Windows. From https://stackoverflow.com/a/35229734/5043728\n if os.name == 'nt':\n matches = glob.glob(re.sub(r'([^:/\\\\])(?=[/\\\\]|$)', r'[\\1]', str(loc)))\n path_str = matches and matches[0] or str(loc)\n else:\n path_str = str(loc)\n return normalize_drive(path_str)\n\n\nDEFAULT_NEWLINES = u\"\\n\"\n\n\nclass _LockFileEncoder(json.JSONEncoder):\n \"\"\"A specilized JSON encoder to convert loaded TOML data into a lock file.\n\n This adds a few characteristics to the encoder:\n\n * The JSON is always prettified with indents and spaces.\n * TOMLKit's container elements are seamlessly encodable.\n * The output is always UTF-8-encoded text, never binary, even on Python 2.\n \"\"\"\n\n def __init__(self):\n super(_LockFileEncoder, self).__init__(\n indent=4, separators=(\",\", \": \"), sort_keys=True\n )\n\n def default(self, obj):\n if isinstance(obj, vistir.compat.Path):\n obj = obj.as_posix()\n return super(_LockFileEncoder, self).default(obj)\n\n def encode(self, obj):\n content = super(_LockFileEncoder, self).encode(obj)\n if not isinstance(content, six.text_type):\n content = content.decode(\"utf-8\")\n return content\n\n\ndef preferred_newlines(f):\n if isinstance(f.newlines, six.text_type):\n return f.newlines\n return DEFAULT_NEWLINES\n\n\nif PIPENV_PIPFILE:\n if not os.path.isfile(PIPENV_PIPFILE):\n raise RuntimeError(\"Given PIPENV_PIPFILE is not found!\")\n\n else:\n PIPENV_PIPFILE = _normalized(PIPENV_PIPFILE)\n# (path, file contents) => TOMLFile\n# keeps track of pipfiles that we've seen so we do not need to re-parse 'em\n_pipfile_cache = {}\n\n\nif PIPENV_TEST_INDEX:\n DEFAULT_SOURCE = {\n u\"url\": PIPENV_TEST_INDEX,\n u\"verify_ssl\": True,\n u\"name\": u\"custom\",\n }\nelse:\n DEFAULT_SOURCE = {\n u\"url\": u\"https://pypi.org/simple\",\n u\"verify_ssl\": True,\n u\"name\": u\"pypi\",\n }\n\npipfile.api.DEFAULT_SOURCE = DEFAULT_SOURCE\n\n\nclass SourceNotFound(KeyError):\n pass\n\n\nclass Project(object):\n \"\"\"docstring for Project\"\"\"\n\n _lockfile_encoder = _LockFileEncoder()\n\n def __init__(self, which=None, python_version=None, chdir=True):\n super(Project, self).__init__()\n self._name = None\n self._virtualenv_location = None\n self._download_location = None\n self._proper_names_db_path = None\n self._pipfile_location = None\n self._pipfile_newlines = DEFAULT_NEWLINES\n self._lockfile_newlines = DEFAULT_NEWLINES\n self._requirements_location = None\n self._original_dir = os.path.abspath(os.curdir)\n self._environment = None\n self._which = which\n self._build_system = {\n \"requires\": [\"setuptools\", \"wheel\"]\n }\n self.python_version = python_version\n # Hack to skip this during pipenv run, or -r.\n if (\"run\" not in sys.argv) and chdir:\n try:\n os.chdir(self.project_directory)\n except (TypeError, AttributeError):\n pass\n\n def path_to(self, p):\n \"\"\"Returns the absolute path to a given relative path.\"\"\"\n if os.path.isabs(p):\n return p\n\n return os.sep.join([self._original_dir, p])\n\n def _build_package_list(self, package_section):\n \"\"\"Returns a list of packages for pip-tools to consume.\"\"\"\n from pipenv.vendor.requirementslib.utils import is_vcs\n ps = {}\n # TODO: Separate the logic for showing packages from the filters for supplying pip-tools\n for k, v in self.parsed_pipfile.get(package_section, {}).items():\n # Skip editable VCS deps.\n if hasattr(v, \"keys\"):\n # When a vcs url is gven without editable it only appears as a key\n # Eliminate any vcs, path, or url entries which are not editable\n # Since pip-tools can't do deep resolution on them, even setuptools-installable ones\n if (\n is_vcs(v)\n or is_vcs(k)\n or (is_installable_file(k) or is_installable_file(v))\n or any(\n (\n prefix in v\n and (os.path.isfile(v[prefix]) or is_valid_url(v[prefix]))\n )\n for prefix in [\"path\", \"file\"]\n )\n ):\n # If they are editable, do resolve them\n if \"editable\" not in v:\n # allow wheels to be passed through\n if not (\n hasattr(v, \"keys\")\n and v.get(\"path\", v.get(\"file\", \"\")).endswith(\".whl\")\n ):\n continue\n ps.update({k: v})\n\n else:\n ps.update({k: v})\n else:\n ps.update({k: v})\n else:\n # Since these entries have no attributes we know they are not editable\n # So we can safely exclude things that need to be editable in order to be resolved\n # First exclude anything that is a vcs entry either in the key or value\n if not (\n any(is_vcs(i) for i in [k, v])\n or\n # Then exclude any installable files that are not directories\n # Because pip-tools can resolve setup.py for example\n any(is_installable_file(i) for i in [k, v])\n or\n # Then exclude any URLs because they need to be editable also\n # Things that are excluded can only be 'shallow resolved'\n any(is_valid_url(i) for i in [k, v])\n ):\n ps.update({k: v})\n return ps\n\n @property\n def name(self):\n if self._name is None:\n self._name = self.pipfile_location.split(os.sep)[-2]\n return self._name\n\n @property\n def pipfile_exists(self):\n return bool(self.pipfile_location)\n\n @property\n def required_python_version(self):\n if self.pipfile_exists:\n required = self.parsed_pipfile.get(\"requires\", {}).get(\n \"python_full_version\"\n )\n if not required:\n required = self.parsed_pipfile.get(\"requires\", {}).get(\"python_version\")\n if required != \"*\":\n return required\n\n @property\n def project_directory(self):\n if self.pipfile_location is not None:\n return os.path.abspath(os.path.join(self.pipfile_location, os.pardir))\n\n else:\n return None\n\n @property\n def requirements_exists(self):\n return bool(self.requirements_location)\n\n def is_venv_in_project(self):\n return PIPENV_VENV_IN_PROJECT or (\n self.project_directory\n and os.path.isdir(os.path.join(self.project_directory, \".venv\"))\n )\n\n @property\n def virtualenv_exists(self):\n # TODO: Decouple project from existence of Pipfile.\n if self.pipfile_exists and os.path.exists(self.virtualenv_location):\n if os.name == \"nt\":\n extra = [\"Scripts\", \"activate.bat\"]\n else:\n extra = [\"bin\", \"activate\"]\n return os.path.isfile(os.sep.join([self.virtualenv_location] + extra))\n\n return False\n\n def get_location_for_virtualenv(self):\n # If there's no project yet, set location based on config.\n if not self.project_directory:\n if self.is_venv_in_project():\n return os.path.abspath(\".venv\")\n return str(get_workon_home().joinpath(self.virtualenv_name))\n\n dot_venv = os.path.join(self.project_directory, \".venv\")\n\n # If there's no .venv in project root, set location based on config.\n if not os.path.exists(dot_venv):\n if self.is_venv_in_project():\n return dot_venv\n return str(get_workon_home().joinpath(self.virtualenv_name))\n\n # If .venv in project root is a directory, use it.\n if os.path.isdir(dot_venv):\n return dot_venv\n\n # Now we assume .venv in project root is a file. Use its content.\n with io.open(dot_venv) as f:\n name = f.read().strip()\n\n # If content looks like a path, use it as a relative path.\n # Otherwise use directory named after content in WORKON_HOME.\n if looks_like_dir(name):\n path = vistir.compat.Path(self.project_directory, name)\n return path.absolute().as_posix()\n return str(get_workon_home().joinpath(name))\n\n @property\n def working_set(self):\n from .utils import load_path\n sys_path = load_path(self.which(\"python\"))\n import pkg_resources\n return pkg_resources.WorkingSet(sys_path)\n\n @property\n def installed_packages(self):\n return self.environment.get_installed_packages()\n\n @property\n def installed_package_names(self):\n return get_canonical_names([pkg.key for pkg in self.installed_packages])\n\n @property\n def lockfile_package_names(self):\n dev_keys = get_canonical_names(self.lockfile_content[\"develop\"].keys())\n default_keys = get_canonical_names(self.lockfile_content[\"default\"].keys())\n return {\n \"dev\": dev_keys,\n \"default\": default_keys,\n \"combined\": dev_keys | default_keys\n }\n\n @property\n def pipfile_package_names(self):\n dev_keys = get_canonical_names(self.dev_packages.keys())\n default_keys = get_canonical_names(self.packages.keys())\n return {\n \"dev\": dev_keys,\n \"default\": default_keys,\n \"combined\": dev_keys | default_keys\n }\n\n @property\n def environment(self):\n if not self._environment:\n prefix = self.virtualenv_location\n is_venv = is_in_virtualenv()\n sources = self.sources if self.sources else [DEFAULT_SOURCE,]\n self._environment = Environment(\n prefix=prefix, is_venv=is_venv, sources=sources, pipfile=self.parsed_pipfile,\n project=self\n )\n self._environment.add_dist(\"pipenv\")\n return self._environment\n\n def get_outdated_packages(self):\n return self.environment.get_outdated_packages(pre=self.pipfile.get(\"pre\", False))\n\n @classmethod\n def _sanitize(cls, name):\n # Replace dangerous characters into '_'. The length of the sanitized\n # project name is limited as 42 because of the limit of linux kernel\n #\n # 42 = 127 - len('/home//.local/share/virtualenvs//bin/python2') - 32 - len('-HASHHASH')\n #\n # 127 : BINPRM_BUF_SIZE - 1\n # 32 : Maximum length of username\n #\n # References:\n # https://www.gnu.org/software/bash/manual/html_node/Double-Quotes.html\n # http://www.tldp.org/LDP/abs/html/special-chars.html#FIELDREF\n # https://github.com/torvalds/linux/blob/2bfe01ef/include/uapi/linux/binfmts.h#L18\n return re.sub(r'[ $`!*@\"\\\\\\r\\n\\t]', \"_\", name)[0:42]\n\n def _get_virtualenv_hash(self, name):\n \"\"\"Get the name of the virtualenv adjusted for windows if needed\n\n Returns (name, encoded_hash)\n \"\"\"\n\n def get_name(name, location):\n name = self._sanitize(name)\n hash = hashlib.sha256(location.encode()).digest()[:6]\n encoded_hash = base64.urlsafe_b64encode(hash).decode()\n return name, encoded_hash[:8]\n\n clean_name, encoded_hash = get_name(name, self.pipfile_location)\n venv_name = \"{0}-{1}\".format(clean_name, encoded_hash)\n\n # This should work most of the time for\n # Case-sensitive filesystems,\n # In-project venv\n # \"Proper\" path casing (on non-case-sensitive filesystems).\n if (\n not fnmatch.fnmatch(\"A\", \"a\")\n or self.is_venv_in_project()\n or get_workon_home().joinpath(venv_name).exists()\n ):\n return clean_name, encoded_hash\n\n # Check for different capitalization of the same project.\n for path in get_workon_home().iterdir():\n if not is_virtual_environment(path):\n continue\n try:\n env_name, hash_ = path.name.rsplit(\"-\", 1)\n except ValueError:\n continue\n if len(hash_) != 8 or env_name.lower() != name.lower():\n continue\n return get_name(env_name, self.pipfile_location.replace(name, env_name))\n\n # Use the default if no matching env exists.\n return clean_name, encoded_hash\n\n @property\n def virtualenv_name(self):\n sanitized, encoded_hash = self._get_virtualenv_hash(self.name)\n suffix = \"-{0}\".format(PIPENV_PYTHON) if PIPENV_PYTHON else \"\"\n # If the pipfile was located at '/home/user/MY_PROJECT/Pipfile',\n # the name of its virtualenv will be 'my-project-wyUfYPqE'\n return sanitized + \"-\" + encoded_hash + suffix\n\n @property\n def virtualenv_location(self):\n # if VIRTUAL_ENV is set, use that.\n virtualenv_env = os.getenv(\"VIRTUAL_ENV\")\n if (\"PIPENV_ACTIVE\" not in os.environ and\n not PIPENV_IGNORE_VIRTUALENVS and virtualenv_env):\n return virtualenv_env\n\n if not self._virtualenv_location: # Use cached version, if available.\n assert self.project_directory, \"project not created\"\n self._virtualenv_location = self.get_location_for_virtualenv()\n return self._virtualenv_location\n\n @property\n def virtualenv_src_location(self):\n if self.virtualenv_location:\n loc = os.sep.join([self.virtualenv_location, \"src\"])\n else:\n loc = os.sep.join([self.project_directory, \"src\"])\n vistir.path.mkdir_p(loc)\n return loc\n\n @property\n def download_location(self):\n if self._download_location is None:\n loc = os.sep.join([self.virtualenv_location, \"downloads\"])\n self._download_location = loc\n # Create the directory, if it doesn't exist.\n vistir.path.mkdir_p(self._download_location)\n return self._download_location\n\n @property\n def proper_names_db_path(self):\n if self._proper_names_db_path is None:\n self._proper_names_db_path = vistir.compat.Path(\n self.virtualenv_location, \"pipenv-proper-names.txt\"\n )\n self._proper_names_db_path.touch() # Ensure the file exists.\n return self._proper_names_db_path\n\n @property\n def proper_names(self):\n with self.proper_names_db_path.open() as f:\n return f.read().splitlines()\n\n def register_proper_name(self, name):\n \"\"\"Registers a proper name to the database.\"\"\"\n with self.proper_names_db_path.open(\"a\") as f:\n f.write(u\"{0}\\n\".format(name))\n\n @property\n def pipfile_location(self):\n if PIPENV_PIPFILE:\n return PIPENV_PIPFILE\n\n if self._pipfile_location is None:\n try:\n loc = pipfile.Pipfile.find(max_depth=PIPENV_MAX_DEPTH)\n except RuntimeError:\n loc = None\n self._pipfile_location = _normalized(loc)\n return self._pipfile_location\n\n @property\n def requirements_location(self):\n if self._requirements_location is None:\n try:\n loc = find_requirements(max_depth=PIPENV_MAX_DEPTH)\n except RuntimeError:\n loc = None\n self._requirements_location = loc\n return self._requirements_location\n\n @property\n def parsed_pipfile(self):\n \"\"\"Parse Pipfile into a TOMLFile and cache it\n\n (call clear_pipfile_cache() afterwards if mutating)\"\"\"\n contents = self.read_pipfile()\n # use full contents to get around str/bytes 2/3 issues\n cache_key = (self.pipfile_location, contents)\n if cache_key not in _pipfile_cache:\n parsed = self._parse_pipfile(contents)\n _pipfile_cache[cache_key] = parsed\n return _pipfile_cache[cache_key]\n\n def read_pipfile(self):\n # Open the pipfile, read it into memory.\n with io.open(self.pipfile_location) as f:\n contents = f.read()\n self._pipfile_newlines = preferred_newlines(f)\n\n return contents\n\n def clear_pipfile_cache(self):\n \"\"\"Clear pipfile cache (e.g., so we can mutate parsed pipfile)\"\"\"\n _pipfile_cache.clear()\n\n def _parse_pipfile(self, contents):\n try:\n return tomlkit.parse(contents)\n except Exception:\n # We lose comments here, but it's for the best.)\n # Fallback to toml parser, for large files.\n return toml.loads(contents)\n\n def _read_pyproject(self):\n pyproject = self.path_to(\"pyproject.toml\")\n if os.path.exists(pyproject):\n self._pyproject = toml.load(pyproject)\n build_system = self._pyproject.get(\"build-system\", None)\n if not os.path.exists(self.path_to(\"setup.py\")):\n if not build_system or not build_system.get(\"requires\"):\n build_system = {\n \"requires\": [\"setuptools>=38.2.5\", \"wheel\"],\n \"build-backend\": \"setuptools.build_meta\",\n }\n self._build_system = build_system\n\n @property\n def build_requires(self):\n return self._build_system.get(\"requires\", [])\n\n @property\n def build_backend(self):\n return self._build_system.get(\"build-backend\", None)\n\n @property\n def settings(self):\n \"\"\"A dictionary of the settings added to the Pipfile.\"\"\"\n return self.parsed_pipfile.get(\"pipenv\", {})\n\n def has_script(self, name):\n try:\n return name in self.parsed_pipfile[\"scripts\"]\n except KeyError:\n return False\n\n def build_script(self, name, extra_args=None):\n try:\n script = Script.parse(self.parsed_pipfile[\"scripts\"][name])\n except KeyError:\n script = Script(name)\n if extra_args:\n script.extend(extra_args)\n return script\n\n def update_settings(self, d):\n settings = self.settings\n changed = False\n for new in d:\n if new not in settings:\n settings[new] = d[new]\n changed = True\n if changed:\n p = self.parsed_pipfile\n p[\"pipenv\"] = settings\n # Write the changes to disk.\n self.write_toml(p)\n\n @property\n def _lockfile(self):\n \"\"\"Pipfile.lock divided by PyPI and external dependencies.\"\"\"\n pfile = pipfile.load(self.pipfile_location, inject_env=False)\n lockfile = json.loads(pfile.lock())\n for section in (\"default\", \"develop\"):\n lock_section = lockfile.get(section, {})\n for key in list(lock_section.keys()):\n norm_key = pep423_name(key)\n lockfile[section][norm_key] = lock_section.pop(key)\n return lockfile\n\n @property\n def _pipfile(self):\n from .vendor.requirementslib.models.pipfile import Pipfile as ReqLibPipfile\n pf = ReqLibPipfile.load(self.pipfile_location)\n return pf\n\n @property\n def lockfile_location(self):\n return \"{0}.lock\".format(self.pipfile_location)\n\n @property\n def lockfile_exists(self):\n return os.path.isfile(self.lockfile_location)\n\n @property\n def lockfile_content(self):\n return self.load_lockfile()\n\n def _get_editable_packages(self, dev=False):\n section = \"dev-packages\" if dev else \"packages\"\n # section = \"{0}-editable\".format(section)\n packages = {\n k: v\n # for k, v in self._pipfile[section].items()\n for k, v in self.parsed_pipfile.get(section, {}).items()\n if is_editable(k) or is_editable(v)\n }\n return packages\n\n def _get_vcs_packages(self, dev=False):\n from pipenv.vendor.requirementslib.utils import is_vcs\n section = \"dev-packages\" if dev else \"packages\"\n # section = \"{0}-vcs\".format(section)\n packages = {\n k: v\n # for k, v in self._pipfile[section].items()\n for k, v in self.parsed_pipfile.get(section, {}).items()\n if is_vcs(v) or is_vcs(k)\n }\n return packages or {}\n\n @property\n def editable_packages(self):\n return self._get_editable_packages(dev=False)\n\n @property\n def editable_dev_packages(self):\n return self._get_editable_packages(dev=True)\n\n @property\n def vcs_packages(self):\n \"\"\"Returns a list of VCS packages, for not pip-tools to consume.\"\"\"\n return self._get_vcs_packages(dev=False)\n\n @property\n def vcs_dev_packages(self):\n \"\"\"Returns a list of VCS packages, for not pip-tools to consume.\"\"\"\n return self._get_vcs_packages(dev=True)\n\n @property\n def all_packages(self):\n \"\"\"Returns a list of all packages.\"\"\"\n p = dict(self.parsed_pipfile.get(\"dev-packages\", {}))\n p.update(self.parsed_pipfile.get(\"packages\", {}))\n return p\n\n @property\n def packages(self):\n \"\"\"Returns a list of packages, for pip-tools to consume.\"\"\"\n return self._build_package_list(\"packages\")\n\n @property\n def dev_packages(self):\n \"\"\"Returns a list of dev-packages, for pip-tools to consume.\"\"\"\n return self._build_package_list(\"dev-packages\")\n\n def touch_pipfile(self):\n \"\"\"Simply touches the Pipfile, for later use.\"\"\"\n with open(\"Pipfile\", \"a\"):\n os.utime(\"Pipfile\", None)\n\n @property\n def pipfile_is_empty(self):\n if not self.pipfile_exists:\n return True\n\n if not len(self.read_pipfile()):\n return True\n\n return False\n\n def create_pipfile(self, python=None):\n \"\"\"Creates the Pipfile, filled with juicy defaults.\"\"\"\n from .vendor.pip_shims.shims import (\n ConfigOptionParser, make_option_group, index_group\n )\n\n name = self.name if self.name is not None else \"Pipfile\"\n config_parser = ConfigOptionParser(name=self.name)\n config_parser.add_option_group(make_option_group(index_group, config_parser))\n install = config_parser.option_groups[0]\n indexes = (\n \" \".join(install.get_option(\"--extra-index-url\").default)\n .lstrip(\"\\n\")\n .split(\"\\n\")\n )\n sources = [DEFAULT_SOURCE,]\n for i, index in enumerate(indexes):\n if not index:\n continue\n\n source_name = \"pip_index_{}\".format(i)\n verify_ssl = index.startswith(\"https\")\n sources.append(\n {u\"url\": index, u\"verify_ssl\": verify_ssl, u\"name\": source_name}\n )\n\n data = {\n u\"source\": sources,\n # Default packages.\n u\"packages\": {},\n u\"dev-packages\": {},\n }\n # Default requires.\n required_python = python\n if not python:\n if self.virtualenv_location:\n required_python = self.which(\"python\", self.virtualenv_location)\n else:\n required_python = self.which(\"python\")\n version = python_version(required_python) or PIPENV_DEFAULT_PYTHON_VERSION\n if version and len(version) >= 3:\n data[u\"requires\"] = {\"python_version\": version[: len(\"2.7\")]}\n self.write_toml(data)\n\n @classmethod\n def populate_source(cls, source):\n \"\"\"Derive missing values of source from the existing fields.\"\"\"\n # Only URL pararemter is mandatory, let the KeyError be thrown.\n if \"name\" not in source:\n source[\"name\"] = get_url_name(source[\"url\"])\n if \"verify_ssl\" not in source:\n source[\"verify_ssl\"] = \"https://\" in source[\"url\"]\n if not isinstance(source[\"verify_ssl\"], bool):\n source[\"verify_ssl\"] = source[\"verify_ssl\"].lower() == \"true\"\n return source\n\n def get_or_create_lockfile(self, from_pipfile=False):\n from pipenv.vendor.requirementslib.models.lockfile import Lockfile as Req_Lockfile\n lockfile = None\n if from_pipfile and self.pipfile_exists:\n lockfile_dict = {\n \"default\": self._lockfile[\"default\"].copy(),\n \"develop\": self._lockfile[\"develop\"].copy()\n }\n lockfile_dict.update({\"_meta\": self.get_lockfile_meta()})\n lockfile = Req_Lockfile.from_data(\n path=self.lockfile_location, data=lockfile_dict, meta_from_project=False\n )\n elif self.lockfile_exists:\n try:\n lockfile = Req_Lockfile.load(self.lockfile_location)\n except OSError:\n lockfile = Req_Lockfile.from_data(self.lockfile_location, self.lockfile_content)\n else:\n lockfile = Req_Lockfile.from_data(path=self.lockfile_location, data=self._lockfile, meta_from_project=False)\n if lockfile._lockfile is not None:\n return lockfile\n if self.lockfile_exists and self.lockfile_content:\n lockfile_dict = self.lockfile_content.copy()\n sources = lockfile_dict.get(\"_meta\", {}).get(\"sources\", [])\n if not sources:\n sources = self.pipfile_sources\n elif not isinstance(sources, list):\n sources = [sources,]\n lockfile_dict[\"_meta\"][\"sources\"] = [\n self.populate_source(s) for s in sources\n ]\n _created_lockfile = Req_Lockfile.from_data(\n path=self.lockfile_location, data=lockfile_dict, meta_from_project=False\n )\n lockfile._lockfile = lockfile.projectfile.model = _created_lockfile\n return lockfile\n else:\n return self.get_or_create_lockfile(from_pipfile=True)\n\n def get_lockfile_meta(self):\n from .vendor.plette.lockfiles import PIPFILE_SPEC_CURRENT\n if self.lockfile_exists:\n sources = self.lockfile_content.get(\"_meta\", {}).get(\"sources\", [])\n else:\n sources = [dict(source) for source in self.parsed_pipfile[\"source\"]]\n if not isinstance(sources, list):\n sources = [sources,]\n return {\n \"hash\": {\"sha256\": self.calculate_pipfile_hash()},\n \"pipfile-spec\": PIPFILE_SPEC_CURRENT,\n \"sources\": sources,\n \"requires\": self.parsed_pipfile.get(\"requires\", {})\n }\n\n def write_toml(self, data, path=None):\n \"\"\"Writes the given data structure out as TOML.\"\"\"\n if path is None:\n path = self.pipfile_location\n data = convert_toml_outline_tables(data)\n try:\n formatted_data = tomlkit.dumps(data).rstrip()\n except Exception:\n document = tomlkit.document()\n for section in (\"packages\", \"dev-packages\"):\n document[section] = tomlkit.container.Table()\n # Convert things to inline tables — fancy :)\n for package in data.get(section, {}):\n if hasattr(data[section][package], \"keys\"):\n table = tomlkit.inline_table()\n table.update(data[section][package])\n document[section][package] = table\n else:\n document[section][package] = tomlkit.string(data[section][package])\n formatted_data = tomlkit.dumps(document).rstrip()\n\n if (\n vistir.compat.Path(path).absolute()\n == vistir.compat.Path(self.pipfile_location).absolute()\n ):\n newlines = self._pipfile_newlines\n else:\n newlines = DEFAULT_NEWLINES\n formatted_data = cleanup_toml(formatted_data)\n with io.open(path, \"w\", newline=newlines) as f:\n f.write(formatted_data)\n # pipfile is mutated!\n self.clear_pipfile_cache()\n\n def write_lockfile(self, content):\n \"\"\"Write out the lockfile.\n \"\"\"\n s = self._lockfile_encoder.encode(content)\n open_kwargs = {\"newline\": self._lockfile_newlines, \"encoding\": \"utf-8\"}\n with vistir.contextmanagers.atomic_open_for_write(\n self.lockfile_location, **open_kwargs\n ) as f:\n f.write(s)\n # Write newline at end of document. GH-319.\n # Only need '\\n' here; the file object handles the rest.\n if not s.endswith(u\"\\n\"):\n f.write(u\"\\n\")\n\n @property\n def pipfile_sources(self):\n if \"source\" not in self.parsed_pipfile:\n return [DEFAULT_SOURCE]\n # We need to make copies of the source info so we don't\n # accidentally modify the cache. See #2100 where values are\n # written after the os.path.expandvars() call.\n return [\n {k: safe_expandvars(v) for k, v in source.items()}\n for source in self.parsed_pipfile[\"source\"]\n ]\n\n @property\n def sources(self):\n if self.lockfile_exists and hasattr(self.lockfile_content, \"keys\"):\n meta_ = self.lockfile_content.get(\"_meta\", {})\n sources_ = meta_.get(\"sources\")\n if sources_:\n return sources_\n\n else:\n return self.pipfile_sources\n\n def find_source(self, source):\n \"\"\"given a source, find it.\n\n source can be a url or an index name.\n \"\"\"\n if not is_valid_url(source):\n try:\n source = self.get_source(name=source)\n except SourceNotFound:\n source = self.get_source(url=source)\n else:\n source = self.get_source(url=source)\n return source\n\n def get_source(self, name=None, url=None):\n def find_source(sources, name=None, url=None):\n source = None\n if name:\n source = [s for s in sources if s.get(\"name\") == name]\n elif url:\n source = [s for s in sources if url.startswith(s.get(\"url\"))]\n if source:\n return first(source)\n\n found_source = find_source(self.sources, name=name, url=url)\n if found_source:\n return found_source\n found_source = find_source(self.pipfile_sources, name=name, url=url)\n if found_source:\n return found_source\n raise SourceNotFound(name or url)\n\n def get_package_name_in_pipfile(self, package_name, dev=False):\n \"\"\"Get the equivalent package name in pipfile\"\"\"\n key = \"dev-packages\" if dev else \"packages\"\n section = self.parsed_pipfile.get(key, {})\n package_name = pep423_name(package_name)\n for name in section.keys():\n if pep423_name(name) == package_name:\n return name\n return None\n\n def remove_package_from_pipfile(self, package_name, dev=False):\n # Read and append Pipfile.\n name = self.get_package_name_in_pipfile(package_name, dev)\n key = \"dev-packages\" if dev else \"packages\"\n p = self.parsed_pipfile\n if name:\n del p[key][name]\n self.write_toml(p)\n\n def remove_packages_from_pipfile(self, packages):\n parsed = self.parsed_pipfile\n packages = set([pep423_name(pkg) for pkg in packages])\n for section in (\"dev-packages\", \"packages\"):\n pipfile_section = parsed.get(section, {})\n pipfile_packages = set([\n pep423_name(pkg_name) for pkg_name in pipfile_section.keys()\n ])\n to_remove = packages & pipfile_packages\n # The normal toml parser can't handle deleting packages with preceding newlines\n is_dev = section == \"dev-packages\"\n for pkg in to_remove:\n pkg_name = self.get_package_name_in_pipfile(pkg, dev=is_dev)\n del parsed[section][pkg_name]\n self.write_toml(parsed)\n\n def add_package_to_pipfile(self, package, dev=False):\n from .vendor.requirementslib import Requirement\n\n # Read and append Pipfile.\n p = self.parsed_pipfile\n # Don't re-capitalize file URLs or VCSs.\n if not isinstance(package, Requirement):\n package = Requirement.from_line(package.strip())\n _, converted = package.pipfile_entry\n key = \"dev-packages\" if dev else \"packages\"\n # Set empty group if it doesn't exist yet.\n if key not in p:\n p[key] = {}\n name = self.get_package_name_in_pipfile(package.name, dev)\n if name and is_star(converted):\n # Skip for wildcard version\n return\n # Add the package to the group.\n p[key][name or pep423_name(package.name)] = converted\n # Write Pipfile.\n self.write_toml(p)\n\n def src_name_from_url(self, index_url):\n name, _, tld_guess = six.moves.urllib.parse.urlsplit(index_url).netloc.rpartition(\n \".\"\n )\n src_name = name.replace(\".\", \"\")\n try:\n self.get_source(name=src_name)\n except SourceNotFound:\n name = src_name\n else:\n from random import randint\n name = \"{0}-{1}\".format(src_name, randint(1, 1000))\n return name\n\n def add_index_to_pipfile(self, index, verify_ssl=True):\n \"\"\"Adds a given index to the Pipfile.\"\"\"\n # Read and append Pipfile.\n p = self.parsed_pipfile\n try:\n self.get_source(url=index)\n except SourceNotFound:\n source = {\"url\": index, \"verify_ssl\": verify_ssl}\n else:\n return\n source[\"name\"] = self.src_name_from_url(index)\n # Add the package to the group.\n if \"source\" not in p:\n p[\"source\"] = [source]\n else:\n p[\"source\"].append(source)\n # Write Pipfile.\n self.write_toml(p)\n\n def recase_pipfile(self):\n if self.ensure_proper_casing():\n self.write_toml(self.parsed_pipfile)\n\n def load_lockfile(self, expand_env_vars=True):\n with io.open(self.lockfile_location, encoding=\"utf-8\") as lock:\n j = json.load(lock)\n self._lockfile_newlines = preferred_newlines(lock)\n # lockfile is just a string\n if not j or not hasattr(j, \"keys\"):\n return j\n\n if expand_env_vars:\n # Expand environment variables in Pipfile.lock at runtime.\n for i, source in enumerate(j[\"_meta\"][\"sources\"][:]):\n j[\"_meta\"][\"sources\"][i][\"url\"] = os.path.expandvars(\n j[\"_meta\"][\"sources\"][i][\"url\"]\n )\n\n return j\n\n def get_lockfile_hash(self):\n if not os.path.exists(self.lockfile_location):\n return\n\n try:\n lockfile = self.load_lockfile(expand_env_vars=False)\n except ValueError:\n # Lockfile corrupted\n return \"\"\n if \"_meta\" in lockfile and hasattr(lockfile, \"keys\"):\n return lockfile[\"_meta\"].get(\"hash\", {}).get(\"sha256\")\n # Lockfile exists but has no hash at all\n return \"\"\n\n def calculate_pipfile_hash(self):\n # Update the lockfile if it is out-of-date.\n p = pipfile.load(self.pipfile_location, inject_env=False)\n return p.hash\n\n def ensure_proper_casing(self):\n \"\"\"Ensures proper casing of Pipfile packages\"\"\"\n pfile = self.parsed_pipfile\n casing_changed = self.proper_case_section(pfile.get(\"packages\", {}))\n casing_changed |= self.proper_case_section(pfile.get(\"dev-packages\", {}))\n return casing_changed\n\n def proper_case_section(self, section):\n \"\"\"Verify proper casing is retrieved, when available, for each\n dependency in the section.\n \"\"\"\n # Casing for section.\n changed_values = False\n unknown_names = [k for k in section.keys() if k not in set(self.proper_names)]\n # Replace each package with proper casing.\n for dep in unknown_names:\n try:\n # Get new casing for package name.\n new_casing = proper_case(dep)\n except IOError:\n # Unable to normalize package name.\n continue\n\n if new_casing != dep:\n changed_values = True\n self.register_proper_name(new_casing)\n # Replace old value with new value.\n old_value = section[dep]\n section[new_casing] = old_value\n del section[dep]\n # Return whether or not values have been changed.\n return changed_values\n\n @cached_property\n def finders(self):\n from .vendor.pythonfinder import Finder\n scripts_dirname = \"Scripts\" if os.name == \"nt\" else \"bin\"\n scripts_dir = os.path.join(self.virtualenv_location, scripts_dirname)\n finders = [\n Finder(path=scripts_dir, global_search=gs, system=False)\n for gs in (False, True)\n ]\n return finders\n\n @property\n def finder(self):\n return next(iter(self.finders), None)\n\n def which(self, search, as_path=True):\n find = operator.methodcaller(\"which\", search)\n result = next(iter(filter(None, (find(finder) for finder in self.finders))), None)\n if not result:\n result = self._which(search)\n else:\n if as_path:\n result = str(result.path)\n return result\n","path":"pipenv/project.py"}],"string":"[\n {\n \"content\": \"# -*- coding: utf-8 -*-\\nimport base64\\nimport fnmatch\\nimport glob\\nimport hashlib\\nimport io\\nimport json\\nimport operator\\nimport os\\nimport re\\nimport sys\\n\\nimport six\\nimport toml\\nimport tomlkit\\nimport vistir\\n\\nfrom first import first\\n\\nimport pipfile\\nimport pipfile.api\\n\\nfrom cached_property import cached_property\\n\\nfrom .cmdparse import Script\\nfrom .environment import Environment\\nfrom .environments import (\\n PIPENV_DEFAULT_PYTHON_VERSION, PIPENV_IGNORE_VIRTUALENVS, PIPENV_MAX_DEPTH,\\n PIPENV_PIPFILE, PIPENV_PYTHON, PIPENV_TEST_INDEX, PIPENV_VENV_IN_PROJECT,\\n is_in_virtualenv\\n)\\nfrom .utils import (\\n cleanup_toml, convert_toml_outline_tables, find_requirements,\\n get_canonical_names, get_url_name, get_workon_home, is_editable,\\n is_installable_file, is_star, is_valid_url, is_virtual_environment,\\n looks_like_dir, normalize_drive, pep423_name, proper_case, python_version,\\n safe_expandvars\\n)\\n\\n\\ndef _normalized(p):\\n if p is None:\\n return None\\n loc = vistir.compat.Path(p)\\n if not loc.is_absolute():\\n try:\\n loc = loc.resolve()\\n except OSError:\\n loc = loc.absolute()\\n # Recase the path properly on Windows. From https://stackoverflow.com/a/35229734/5043728\\n if os.name == 'nt':\\n matches = glob.glob(re.sub(r'([^:/\\\\\\\\])(?=[/\\\\\\\\]|$)', r'[\\\\1]', str(loc)))\\n path_str = matches and matches[0] or str(loc)\\n else:\\n path_str = str(loc)\\n return normalize_drive(path_str)\\n\\n\\nDEFAULT_NEWLINES = u\\\"\\\\n\\\"\\n\\n\\nclass _LockFileEncoder(json.JSONEncoder):\\n \\\"\\\"\\\"A specilized JSON encoder to convert loaded TOML data into a lock file.\\n\\n This adds a few characteristics to the encoder:\\n\\n * The JSON is always prettified with indents and spaces.\\n * TOMLKit's container elements are seamlessly encodable.\\n * The output is always UTF-8-encoded text, never binary, even on Python 2.\\n \\\"\\\"\\\"\\n\\n def __init__(self):\\n super(_LockFileEncoder, self).__init__(\\n indent=4, separators=(\\\",\\\", \\\": \\\"), sort_keys=True\\n )\\n\\n def default(self, obj):\\n if isinstance(obj, vistir.compat.Path):\\n obj = obj.as_posix()\\n return super(_LockFileEncoder, self).default(obj)\\n\\n def encode(self, obj):\\n content = super(_LockFileEncoder, self).encode(obj)\\n if not isinstance(content, six.text_type):\\n content = content.decode(\\\"utf-8\\\")\\n return content\\n\\n\\ndef preferred_newlines(f):\\n if isinstance(f.newlines, six.text_type):\\n return f.newlines\\n return DEFAULT_NEWLINES\\n\\n\\nif PIPENV_PIPFILE:\\n if not os.path.isfile(PIPENV_PIPFILE):\\n raise RuntimeError(\\\"Given PIPENV_PIPFILE is not found!\\\")\\n\\n else:\\n PIPENV_PIPFILE = _normalized(PIPENV_PIPFILE)\\n# (path, file contents) => TOMLFile\\n# keeps track of pipfiles that we've seen so we do not need to re-parse 'em\\n_pipfile_cache = {}\\n\\n\\nif PIPENV_TEST_INDEX:\\n DEFAULT_SOURCE = {\\n u\\\"url\\\": PIPENV_TEST_INDEX,\\n u\\\"verify_ssl\\\": True,\\n u\\\"name\\\": u\\\"custom\\\",\\n }\\nelse:\\n DEFAULT_SOURCE = {\\n u\\\"url\\\": u\\\"https://pypi.org/simple\\\",\\n u\\\"verify_ssl\\\": True,\\n u\\\"name\\\": u\\\"pypi\\\",\\n }\\n\\npipfile.api.DEFAULT_SOURCE = DEFAULT_SOURCE\\n\\n\\nclass SourceNotFound(KeyError):\\n pass\\n\\n\\nclass Project(object):\\n \\\"\\\"\\\"docstring for Project\\\"\\\"\\\"\\n\\n _lockfile_encoder = _LockFileEncoder()\\n\\n def __init__(self, which=None, python_version=None, chdir=True):\\n super(Project, self).__init__()\\n self._name = None\\n self._virtualenv_location = None\\n self._download_location = None\\n self._proper_names_db_path = None\\n self._pipfile_location = None\\n self._pipfile_newlines = DEFAULT_NEWLINES\\n self._lockfile_newlines = DEFAULT_NEWLINES\\n self._requirements_location = None\\n self._original_dir = os.path.abspath(os.curdir)\\n self._environment = None\\n self._which = which\\n self._build_system = {\\n \\\"requires\\\": [\\\"setuptools\\\", \\\"wheel\\\"]\\n }\\n self.python_version = python_version\\n # Hack to skip this during pipenv run, or -r.\\n if (\\\"run\\\" not in sys.argv) and chdir:\\n try:\\n os.chdir(self.project_directory)\\n except (TypeError, AttributeError):\\n pass\\n\\n def path_to(self, p):\\n \\\"\\\"\\\"Returns the absolute path to a given relative path.\\\"\\\"\\\"\\n if os.path.isabs(p):\\n return p\\n\\n return os.sep.join([self._original_dir, p])\\n\\n def _build_package_list(self, package_section):\\n \\\"\\\"\\\"Returns a list of packages for pip-tools to consume.\\\"\\\"\\\"\\n from pipenv.vendor.requirementslib.utils import is_vcs\\n ps = {}\\n # TODO: Separate the logic for showing packages from the filters for supplying pip-tools\\n for k, v in self.parsed_pipfile.get(package_section, {}).items():\\n # Skip editable VCS deps.\\n if hasattr(v, \\\"keys\\\"):\\n # When a vcs url is gven without editable it only appears as a key\\n # Eliminate any vcs, path, or url entries which are not editable\\n # Since pip-tools can't do deep resolution on them, even setuptools-installable ones\\n if (\\n is_vcs(v)\\n or is_vcs(k)\\n or (is_installable_file(k) or is_installable_file(v))\\n or any(\\n (\\n prefix in v\\n and (os.path.isfile(v[prefix]) or is_valid_url(v[prefix]))\\n )\\n for prefix in [\\\"path\\\", \\\"file\\\"]\\n )\\n ):\\n # If they are editable, do resolve them\\n if \\\"editable\\\" not in v:\\n # allow wheels to be passed through\\n if not (\\n hasattr(v, \\\"keys\\\")\\n and v.get(\\\"path\\\", v.get(\\\"file\\\", \\\"\\\")).endswith(\\\".whl\\\")\\n ):\\n continue\\n ps.update({k: v})\\n\\n else:\\n ps.update({k: v})\\n else:\\n ps.update({k: v})\\n else:\\n # Since these entries have no attributes we know they are not editable\\n # So we can safely exclude things that need to be editable in order to be resolved\\n # First exclude anything that is a vcs entry either in the key or value\\n if not (\\n any(is_vcs(i) for i in [k, v])\\n or\\n # Then exclude any installable files that are not directories\\n # Because pip-tools can resolve setup.py for example\\n any(is_installable_file(i) for i in [k, v])\\n or\\n # Then exclude any URLs because they need to be editable also\\n # Things that are excluded can only be 'shallow resolved'\\n any(is_valid_url(i) for i in [k, v])\\n ):\\n ps.update({k: v})\\n return ps\\n\\n @property\\n def name(self):\\n if self._name is None:\\n self._name = self.pipfile_location.split(os.sep)[-2]\\n return self._name\\n\\n @property\\n def pipfile_exists(self):\\n return bool(self.pipfile_location)\\n\\n @property\\n def required_python_version(self):\\n if self.pipfile_exists:\\n required = self.parsed_pipfile.get(\\\"requires\\\", {}).get(\\n \\\"python_full_version\\\"\\n )\\n if not required:\\n required = self.parsed_pipfile.get(\\\"requires\\\", {}).get(\\\"python_version\\\")\\n if required != \\\"*\\\":\\n return required\\n\\n @property\\n def project_directory(self):\\n if self.pipfile_location is not None:\\n return os.path.abspath(os.path.join(self.pipfile_location, os.pardir))\\n\\n else:\\n return None\\n\\n @property\\n def requirements_exists(self):\\n return bool(self.requirements_location)\\n\\n def is_venv_in_project(self):\\n return PIPENV_VENV_IN_PROJECT or (\\n self.project_directory\\n and os.path.isdir(os.path.join(self.project_directory, \\\".venv\\\"))\\n )\\n\\n @property\\n def virtualenv_exists(self):\\n # TODO: Decouple project from existence of Pipfile.\\n if self.pipfile_exists and os.path.exists(self.virtualenv_location):\\n if os.name == \\\"nt\\\":\\n extra = [\\\"Scripts\\\", \\\"activate.bat\\\"]\\n else:\\n extra = [\\\"bin\\\", \\\"activate\\\"]\\n return os.path.isfile(os.sep.join([self.virtualenv_location] + extra))\\n\\n return False\\n\\n def get_location_for_virtualenv(self):\\n # If there's no project yet, set location based on config.\\n if not self.project_directory:\\n if self.is_venv_in_project():\\n return os.path.abspath(\\\".venv\\\")\\n return str(get_workon_home().joinpath(self.virtualenv_name))\\n\\n dot_venv = os.path.join(self.project_directory, \\\".venv\\\")\\n\\n # If there's no .venv in project root, set location based on config.\\n if not os.path.exists(dot_venv):\\n if self.is_venv_in_project():\\n return dot_venv\\n return str(get_workon_home().joinpath(self.virtualenv_name))\\n\\n # If .venv in project root is a directory, use it.\\n if os.path.isdir(dot_venv):\\n return dot_venv\\n\\n # Now we assume .venv in project root is a file. Use its content.\\n with io.open(dot_venv) as f:\\n name = f.read().strip()\\n\\n # If content looks like a path, use it as a relative path.\\n # Otherwise use directory named after content in WORKON_HOME.\\n if looks_like_dir(name):\\n path = vistir.compat.Path(self.project_directory, name)\\n return path.absolute().as_posix()\\n return str(get_workon_home().joinpath(name))\\n\\n @property\\n def working_set(self):\\n from .utils import load_path\\n sys_path = load_path(self.which(\\\"python\\\"))\\n import pkg_resources\\n return pkg_resources.WorkingSet(sys_path)\\n\\n @property\\n def installed_packages(self):\\n return self.environment.get_installed_packages()\\n\\n @property\\n def installed_package_names(self):\\n return get_canonical_names([pkg.key for pkg in self.installed_packages])\\n\\n @property\\n def lockfile_package_names(self):\\n dev_keys = get_canonical_names(self.lockfile_content[\\\"develop\\\"].keys())\\n default_keys = get_canonical_names(self.lockfile_content[\\\"default\\\"].keys())\\n return {\\n \\\"dev\\\": dev_keys,\\n \\\"default\\\": default_keys,\\n \\\"combined\\\": dev_keys | default_keys\\n }\\n\\n @property\\n def pipfile_package_names(self):\\n dev_keys = get_canonical_names(self.dev_packages.keys())\\n default_keys = get_canonical_names(self.packages.keys())\\n return {\\n \\\"dev\\\": dev_keys,\\n \\\"default\\\": default_keys,\\n \\\"combined\\\": dev_keys | default_keys\\n }\\n\\n @property\\n def environment(self):\\n if not self._environment:\\n prefix = self.virtualenv_location\\n is_venv = is_in_virtualenv()\\n sources = self.sources if self.sources else [DEFAULT_SOURCE,]\\n self._environment = Environment(\\n prefix=prefix, is_venv=is_venv, sources=sources, pipfile=self.parsed_pipfile,\\n project=self\\n )\\n self._environment.add_dist(\\\"pipenv\\\")\\n return self._environment\\n\\n def get_outdated_packages(self):\\n return self.environment.get_outdated_packages(pre=self.pipfile.get(\\\"pre\\\", False))\\n\\n @classmethod\\n def _sanitize(cls, name):\\n # Replace dangerous characters into '_'. The length of the sanitized\\n # project name is limited as 42 because of the limit of linux kernel\\n #\\n # 42 = 127 - len('/home//.local/share/virtualenvs//bin/python2') - 32 - len('-HASHHASH')\\n #\\n # 127 : BINPRM_BUF_SIZE - 1\\n # 32 : Maximum length of username\\n #\\n # References:\\n # https://www.gnu.org/software/bash/manual/html_node/Double-Quotes.html\\n # http://www.tldp.org/LDP/abs/html/special-chars.html#FIELDREF\\n # https://github.com/torvalds/linux/blob/2bfe01ef/include/uapi/linux/binfmts.h#L18\\n return re.sub(r'[ $`!*@\\\"\\\\\\\\\\\\r\\\\n\\\\t]', \\\"_\\\", name)[0:42]\\n\\n def _get_virtualenv_hash(self, name):\\n \\\"\\\"\\\"Get the name of the virtualenv adjusted for windows if needed\\n\\n Returns (name, encoded_hash)\\n \\\"\\\"\\\"\\n\\n def get_name(name, location):\\n name = self._sanitize(name)\\n hash = hashlib.sha256(location.encode()).digest()[:6]\\n encoded_hash = base64.urlsafe_b64encode(hash).decode()\\n return name, encoded_hash[:8]\\n\\n clean_name, encoded_hash = get_name(name, self.pipfile_location)\\n venv_name = \\\"{0}-{1}\\\".format(clean_name, encoded_hash)\\n\\n # This should work most of the time for\\n # Case-sensitive filesystems,\\n # In-project venv\\n # \\\"Proper\\\" path casing (on non-case-sensitive filesystems).\\n if (\\n not fnmatch.fnmatch(\\\"A\\\", \\\"a\\\")\\n or self.is_venv_in_project()\\n or get_workon_home().joinpath(venv_name).exists()\\n ):\\n return clean_name, encoded_hash\\n\\n # Check for different capitalization of the same project.\\n for path in get_workon_home().iterdir():\\n if not is_virtual_environment(path):\\n continue\\n try:\\n env_name, hash_ = path.name.rsplit(\\\"-\\\", 1)\\n except ValueError:\\n continue\\n if len(hash_) != 8 or env_name.lower() != name.lower():\\n continue\\n return get_name(env_name, self.pipfile_location.replace(name, env_name))\\n\\n # Use the default if no matching env exists.\\n return clean_name, encoded_hash\\n\\n @property\\n def virtualenv_name(self):\\n sanitized, encoded_hash = self._get_virtualenv_hash(self.name)\\n suffix = \\\"-{0}\\\".format(PIPENV_PYTHON) if PIPENV_PYTHON else \\\"\\\"\\n # If the pipfile was located at '/home/user/MY_PROJECT/Pipfile',\\n # the name of its virtualenv will be 'my-project-wyUfYPqE'\\n return sanitized + \\\"-\\\" + encoded_hash + suffix\\n\\n @property\\n def virtualenv_location(self):\\n # if VIRTUAL_ENV is set, use that.\\n virtualenv_env = os.getenv(\\\"VIRTUAL_ENV\\\")\\n if (\\\"PIPENV_ACTIVE\\\" not in os.environ and\\n not PIPENV_IGNORE_VIRTUALENVS and virtualenv_env):\\n return virtualenv_env\\n\\n if not self._virtualenv_location: # Use cached version, if available.\\n assert self.project_directory, \\\"project not created\\\"\\n self._virtualenv_location = self.get_location_for_virtualenv()\\n return self._virtualenv_location\\n\\n @property\\n def virtualenv_src_location(self):\\n if self.virtualenv_location:\\n loc = os.sep.join([self.virtualenv_location, \\\"src\\\"])\\n else:\\n loc = os.sep.join([self.project_directory, \\\"src\\\"])\\n vistir.path.mkdir_p(loc)\\n return loc\\n\\n @property\\n def download_location(self):\\n if self._download_location is None:\\n loc = os.sep.join([self.virtualenv_location, \\\"downloads\\\"])\\n self._download_location = loc\\n # Create the directory, if it doesn't exist.\\n vistir.path.mkdir_p(self._download_location)\\n return self._download_location\\n\\n @property\\n def proper_names_db_path(self):\\n if self._proper_names_db_path is None:\\n self._proper_names_db_path = vistir.compat.Path(\\n self.virtualenv_location, \\\"pipenv-proper-names.txt\\\"\\n )\\n self._proper_names_db_path.touch() # Ensure the file exists.\\n return self._proper_names_db_path\\n\\n @property\\n def proper_names(self):\\n with self.proper_names_db_path.open() as f:\\n return f.read().splitlines()\\n\\n def register_proper_name(self, name):\\n \\\"\\\"\\\"Registers a proper name to the database.\\\"\\\"\\\"\\n with self.proper_names_db_path.open(\\\"a\\\") as f:\\n f.write(u\\\"{0}\\\\n\\\".format(name))\\n\\n @property\\n def pipfile_location(self):\\n if PIPENV_PIPFILE:\\n return PIPENV_PIPFILE\\n\\n if self._pipfile_location is None:\\n try:\\n loc = pipfile.Pipfile.find(max_depth=PIPENV_MAX_DEPTH)\\n except RuntimeError:\\n loc = None\\n self._pipfile_location = _normalized(loc)\\n return self._pipfile_location\\n\\n @property\\n def requirements_location(self):\\n if self._requirements_location is None:\\n try:\\n loc = find_requirements(max_depth=PIPENV_MAX_DEPTH)\\n except RuntimeError:\\n loc = None\\n self._requirements_location = loc\\n return self._requirements_location\\n\\n @property\\n def parsed_pipfile(self):\\n \\\"\\\"\\\"Parse Pipfile into a TOMLFile and cache it\\n\\n (call clear_pipfile_cache() afterwards if mutating)\\\"\\\"\\\"\\n contents = self.read_pipfile()\\n # use full contents to get around str/bytes 2/3 issues\\n cache_key = (self.pipfile_location, contents)\\n if cache_key not in _pipfile_cache:\\n parsed = self._parse_pipfile(contents)\\n _pipfile_cache[cache_key] = parsed\\n return _pipfile_cache[cache_key]\\n\\n def read_pipfile(self):\\n # Open the pipfile, read it into memory.\\n with io.open(self.pipfile_location) as f:\\n contents = f.read()\\n self._pipfile_newlines = preferred_newlines(f)\\n\\n return contents\\n\\n def clear_pipfile_cache(self):\\n \\\"\\\"\\\"Clear pipfile cache (e.g., so we can mutate parsed pipfile)\\\"\\\"\\\"\\n _pipfile_cache.clear()\\n\\n def _parse_pipfile(self, contents):\\n try:\\n return tomlkit.parse(contents)\\n except Exception:\\n # We lose comments here, but it's for the best.)\\n # Fallback to toml parser, for large files.\\n return toml.loads(contents)\\n\\n def _read_pyproject(self):\\n pyproject = self.path_to(\\\"pyproject.toml\\\")\\n if os.path.exists(pyproject):\\n self._pyproject = toml.load(pyproject)\\n build_system = self._pyproject.get(\\\"build-system\\\", None)\\n if not os.path.exists(self.path_to(\\\"setup.py\\\")):\\n if not build_system or not build_system.get(\\\"requires\\\"):\\n build_system = {\\n \\\"requires\\\": [\\\"setuptools>=38.2.5\\\", \\\"wheel\\\"],\\n \\\"build-backend\\\": \\\"setuptools.build_meta\\\",\\n }\\n self._build_system = build_system\\n\\n @property\\n def build_requires(self):\\n return self._build_system.get(\\\"requires\\\", [])\\n\\n @property\\n def build_backend(self):\\n return self._build_system.get(\\\"build-backend\\\", None)\\n\\n @property\\n def settings(self):\\n \\\"\\\"\\\"A dictionary of the settings added to the Pipfile.\\\"\\\"\\\"\\n return self.parsed_pipfile.get(\\\"pipenv\\\", {})\\n\\n def has_script(self, name):\\n try:\\n return name in self.parsed_pipfile[\\\"scripts\\\"]\\n except KeyError:\\n return False\\n\\n def build_script(self, name, extra_args=None):\\n try:\\n script = Script.parse(self.parsed_pipfile[\\\"scripts\\\"][name])\\n except KeyError:\\n script = Script(name)\\n if extra_args:\\n script.extend(extra_args)\\n return script\\n\\n def update_settings(self, d):\\n settings = self.settings\\n changed = False\\n for new in d:\\n if new not in settings:\\n settings[new] = d[new]\\n changed = True\\n if changed:\\n p = self.parsed_pipfile\\n p[\\\"pipenv\\\"] = settings\\n # Write the changes to disk.\\n self.write_toml(p)\\n\\n @property\\n def _lockfile(self):\\n \\\"\\\"\\\"Pipfile.lock divided by PyPI and external dependencies.\\\"\\\"\\\"\\n pfile = pipfile.load(self.pipfile_location, inject_env=False)\\n lockfile = json.loads(pfile.lock())\\n for section in (\\\"default\\\", \\\"develop\\\"):\\n lock_section = lockfile.get(section, {})\\n for key in list(lock_section.keys()):\\n norm_key = pep423_name(key)\\n lockfile[section][norm_key] = lock_section.pop(key)\\n return lockfile\\n\\n @property\\n def _pipfile(self):\\n from .vendor.requirementslib.models.pipfile import Pipfile as ReqLibPipfile\\n pf = ReqLibPipfile.load(self.pipfile_location)\\n return pf\\n\\n @property\\n def lockfile_location(self):\\n return \\\"{0}.lock\\\".format(self.pipfile_location)\\n\\n @property\\n def lockfile_exists(self):\\n return os.path.isfile(self.lockfile_location)\\n\\n @property\\n def lockfile_content(self):\\n return self.load_lockfile()\\n\\n def _get_editable_packages(self, dev=False):\\n section = \\\"dev-packages\\\" if dev else \\\"packages\\\"\\n # section = \\\"{0}-editable\\\".format(section)\\n packages = {\\n k: v\\n # for k, v in self._pipfile[section].items()\\n for k, v in self.parsed_pipfile.get(section, {}).items()\\n if is_editable(k) or is_editable(v)\\n }\\n return packages\\n\\n def _get_vcs_packages(self, dev=False):\\n from pipenv.vendor.requirementslib.utils import is_vcs\\n section = \\\"dev-packages\\\" if dev else \\\"packages\\\"\\n # section = \\\"{0}-vcs\\\".format(section)\\n packages = {\\n k: v\\n # for k, v in self._pipfile[section].items()\\n for k, v in self.parsed_pipfile.get(section, {}).items()\\n if is_vcs(v) or is_vcs(k)\\n }\\n return packages or {}\\n\\n @property\\n def editable_packages(self):\\n return self._get_editable_packages(dev=False)\\n\\n @property\\n def editable_dev_packages(self):\\n return self._get_editable_packages(dev=True)\\n\\n @property\\n def vcs_packages(self):\\n \\\"\\\"\\\"Returns a list of VCS packages, for not pip-tools to consume.\\\"\\\"\\\"\\n return self._get_vcs_packages(dev=False)\\n\\n @property\\n def vcs_dev_packages(self):\\n \\\"\\\"\\\"Returns a list of VCS packages, for not pip-tools to consume.\\\"\\\"\\\"\\n return self._get_vcs_packages(dev=True)\\n\\n @property\\n def all_packages(self):\\n \\\"\\\"\\\"Returns a list of all packages.\\\"\\\"\\\"\\n p = dict(self.parsed_pipfile.get(\\\"dev-packages\\\", {}))\\n p.update(self.parsed_pipfile.get(\\\"packages\\\", {}))\\n return p\\n\\n @property\\n def packages(self):\\n \\\"\\\"\\\"Returns a list of packages, for pip-tools to consume.\\\"\\\"\\\"\\n return self._build_package_list(\\\"packages\\\")\\n\\n @property\\n def dev_packages(self):\\n \\\"\\\"\\\"Returns a list of dev-packages, for pip-tools to consume.\\\"\\\"\\\"\\n return self._build_package_list(\\\"dev-packages\\\")\\n\\n def touch_pipfile(self):\\n \\\"\\\"\\\"Simply touches the Pipfile, for later use.\\\"\\\"\\\"\\n with open(\\\"Pipfile\\\", \\\"a\\\"):\\n os.utime(\\\"Pipfile\\\", None)\\n\\n @property\\n def pipfile_is_empty(self):\\n if not self.pipfile_exists:\\n return True\\n\\n if not len(self.read_pipfile()):\\n return True\\n\\n return False\\n\\n def create_pipfile(self, python=None):\\n \\\"\\\"\\\"Creates the Pipfile, filled with juicy defaults.\\\"\\\"\\\"\\n from .vendor.pip_shims.shims import (\\n ConfigOptionParser, make_option_group, index_group\\n )\\n\\n name = self.name if self.name is not None else \\\"Pipfile\\\"\\n config_parser = ConfigOptionParser(name=self.name)\\n config_parser.add_option_group(make_option_group(index_group, config_parser))\\n install = config_parser.option_groups[0]\\n indexes = (\\n \\\" \\\".join(install.get_option(\\\"--extra-index-url\\\").default)\\n .lstrip(\\\"\\\\n\\\")\\n .split(\\\"\\\\n\\\")\\n )\\n sources = [DEFAULT_SOURCE,]\\n for i, index in enumerate(indexes):\\n if not index:\\n continue\\n\\n source_name = \\\"pip_index_{}\\\".format(i)\\n verify_ssl = index.startswith(\\\"https\\\")\\n sources.append(\\n {u\\\"url\\\": index, u\\\"verify_ssl\\\": verify_ssl, u\\\"name\\\": source_name}\\n )\\n\\n data = {\\n u\\\"source\\\": sources,\\n # Default packages.\\n u\\\"packages\\\": {},\\n u\\\"dev-packages\\\": {},\\n }\\n # Default requires.\\n required_python = python\\n if not python:\\n if self.virtualenv_location:\\n required_python = self.which(\\\"python\\\", self.virtualenv_location)\\n else:\\n required_python = self.which(\\\"python\\\")\\n version = python_version(required_python) or PIPENV_DEFAULT_PYTHON_VERSION\\n if version and len(version) >= 3:\\n data[u\\\"requires\\\"] = {\\\"python_version\\\": version[: len(\\\"2.7\\\")]}\\n self.write_toml(data)\\n\\n @classmethod\\n def populate_source(cls, source):\\n \\\"\\\"\\\"Derive missing values of source from the existing fields.\\\"\\\"\\\"\\n # Only URL pararemter is mandatory, let the KeyError be thrown.\\n if \\\"name\\\" not in source:\\n source[\\\"name\\\"] = get_url_name(source[\\\"url\\\"])\\n if \\\"verify_ssl\\\" not in source:\\n source[\\\"verify_ssl\\\"] = \\\"https://\\\" in source[\\\"url\\\"]\\n if not isinstance(source[\\\"verify_ssl\\\"], bool):\\n source[\\\"verify_ssl\\\"] = source[\\\"verify_ssl\\\"].lower() == \\\"true\\\"\\n return source\\n\\n def get_or_create_lockfile(self, from_pipfile=False):\\n from pipenv.vendor.requirementslib.models.lockfile import Lockfile as Req_Lockfile\\n lockfile = None\\n if from_pipfile and self.pipfile_exists:\\n lockfile_dict = {\\n \\\"default\\\": self._lockfile[\\\"default\\\"].copy(),\\n \\\"develop\\\": self._lockfile[\\\"develop\\\"].copy()\\n }\\n lockfile_dict.update({\\\"_meta\\\": self.get_lockfile_meta()})\\n lockfile = Req_Lockfile.from_data(\\n path=self.lockfile_location, data=lockfile_dict, meta_from_project=False\\n )\\n elif self.lockfile_exists:\\n try:\\n lockfile = Req_Lockfile.load(self.lockfile_location)\\n except OSError:\\n lockfile = Req_Lockfile.from_data(self.lockfile_location, self.lockfile_content)\\n else:\\n lockfile = Req_Lockfile.from_data(path=self.lockfile_location, data=self._lockfile, meta_from_project=False)\\n if lockfile._lockfile is not None:\\n return lockfile\\n if self.lockfile_exists and self.lockfile_content:\\n lockfile_dict = self.lockfile_content.copy()\\n sources = lockfile_dict.get(\\\"_meta\\\", {}).get(\\\"sources\\\", [])\\n if not sources:\\n sources = self.pipfile_sources\\n elif not isinstance(sources, list):\\n sources = [sources,]\\n lockfile_dict[\\\"_meta\\\"][\\\"sources\\\"] = [\\n self.populate_source(s) for s in sources\\n ]\\n _created_lockfile = Req_Lockfile.from_data(\\n path=self.lockfile_location, data=lockfile_dict, meta_from_project=False\\n )\\n lockfile._lockfile = lockfile.projectfile.model = _created_lockfile\\n return lockfile\\n else:\\n return self.get_or_create_lockfile(from_pipfile=True)\\n\\n def get_lockfile_meta(self):\\n from .vendor.plette.lockfiles import PIPFILE_SPEC_CURRENT\\n if self.lockfile_exists:\\n sources = self.lockfile_content.get(\\\"_meta\\\", {}).get(\\\"sources\\\", [])\\n else:\\n sources = [dict(source) for source in self.parsed_pipfile[\\\"source\\\"]]\\n if not isinstance(sources, list):\\n sources = [sources,]\\n return {\\n \\\"hash\\\": {\\\"sha256\\\": self.calculate_pipfile_hash()},\\n \\\"pipfile-spec\\\": PIPFILE_SPEC_CURRENT,\\n \\\"sources\\\": sources,\\n \\\"requires\\\": self.parsed_pipfile.get(\\\"requires\\\", {})\\n }\\n\\n def write_toml(self, data, path=None):\\n \\\"\\\"\\\"Writes the given data structure out as TOML.\\\"\\\"\\\"\\n if path is None:\\n path = self.pipfile_location\\n data = convert_toml_outline_tables(data)\\n try:\\n formatted_data = tomlkit.dumps(data).rstrip()\\n except Exception:\\n document = tomlkit.document()\\n for section in (\\\"packages\\\", \\\"dev-packages\\\"):\\n document[section] = tomlkit.container.Table()\\n # Convert things to inline tables — fancy :)\\n for package in data.get(section, {}):\\n if hasattr(data[section][package], \\\"keys\\\"):\\n table = tomlkit.inline_table()\\n table.update(data[section][package])\\n document[section][package] = table\\n else:\\n document[section][package] = tomlkit.string(data[section][package])\\n formatted_data = tomlkit.dumps(document).rstrip()\\n\\n if (\\n vistir.compat.Path(path).absolute()\\n == vistir.compat.Path(self.pipfile_location).absolute()\\n ):\\n newlines = self._pipfile_newlines\\n else:\\n newlines = DEFAULT_NEWLINES\\n formatted_data = cleanup_toml(formatted_data)\\n with io.open(path, \\\"w\\\", newline=newlines) as f:\\n f.write(formatted_data)\\n # pipfile is mutated!\\n self.clear_pipfile_cache()\\n\\n def write_lockfile(self, content):\\n \\\"\\\"\\\"Write out the lockfile.\\n \\\"\\\"\\\"\\n s = self._lockfile_encoder.encode(content)\\n open_kwargs = {\\\"newline\\\": self._lockfile_newlines, \\\"encoding\\\": \\\"utf-8\\\"}\\n with vistir.contextmanagers.atomic_open_for_write(\\n self.lockfile_location, **open_kwargs\\n ) as f:\\n f.write(s)\\n # Write newline at end of document. GH-319.\\n # Only need '\\\\n' here; the file object handles the rest.\\n if not s.endswith(u\\\"\\\\n\\\"):\\n f.write(u\\\"\\\\n\\\")\\n\\n @property\\n def pipfile_sources(self):\\n if \\\"source\\\" not in self.parsed_pipfile:\\n return [DEFAULT_SOURCE]\\n # We need to make copies of the source info so we don't\\n # accidentally modify the cache. See #2100 where values are\\n # written after the os.path.expandvars() call.\\n return [\\n {k: safe_expandvars(v) for k, v in source.items()}\\n for source in self.parsed_pipfile[\\\"source\\\"]\\n ]\\n\\n @property\\n def sources(self):\\n if self.lockfile_exists and hasattr(self.lockfile_content, \\\"keys\\\"):\\n meta_ = self.lockfile_content.get(\\\"_meta\\\", {})\\n sources_ = meta_.get(\\\"sources\\\")\\n if sources_:\\n return sources_\\n\\n else:\\n return self.pipfile_sources\\n\\n def find_source(self, source):\\n \\\"\\\"\\\"given a source, find it.\\n\\n source can be a url or an index name.\\n \\\"\\\"\\\"\\n if not is_valid_url(source):\\n try:\\n source = self.get_source(name=source)\\n except SourceNotFound:\\n source = self.get_source(url=source)\\n else:\\n source = self.get_source(url=source)\\n return source\\n\\n def get_source(self, name=None, url=None):\\n def find_source(sources, name=None, url=None):\\n source = None\\n if name:\\n source = [s for s in sources if s.get(\\\"name\\\") == name]\\n elif url:\\n source = [s for s in sources if url.startswith(s.get(\\\"url\\\"))]\\n if source:\\n return first(source)\\n\\n found_source = find_source(self.sources, name=name, url=url)\\n if found_source:\\n return found_source\\n found_source = find_source(self.pipfile_sources, name=name, url=url)\\n if found_source:\\n return found_source\\n raise SourceNotFound(name or url)\\n\\n def get_package_name_in_pipfile(self, package_name, dev=False):\\n \\\"\\\"\\\"Get the equivalent package name in pipfile\\\"\\\"\\\"\\n key = \\\"dev-packages\\\" if dev else \\\"packages\\\"\\n section = self.parsed_pipfile.get(key, {})\\n package_name = pep423_name(package_name)\\n for name in section.keys():\\n if pep423_name(name) == package_name:\\n return name\\n return None\\n\\n def remove_package_from_pipfile(self, package_name, dev=False):\\n # Read and append Pipfile.\\n name = self.get_package_name_in_pipfile(package_name, dev)\\n key = \\\"dev-packages\\\" if dev else \\\"packages\\\"\\n p = self.parsed_pipfile\\n if name:\\n del p[key][name]\\n self.write_toml(p)\\n\\n def remove_packages_from_pipfile(self, packages):\\n parsed = self.parsed_pipfile\\n packages = set([pep423_name(pkg) for pkg in packages])\\n for section in (\\\"dev-packages\\\", \\\"packages\\\"):\\n pipfile_section = parsed.get(section, {})\\n pipfile_packages = set([\\n pep423_name(pkg_name) for pkg_name in pipfile_section.keys()\\n ])\\n to_remove = packages & pipfile_packages\\n # The normal toml parser can't handle deleting packages with preceding newlines\\n is_dev = section == \\\"dev-packages\\\"\\n for pkg in to_remove:\\n pkg_name = self.get_package_name_in_pipfile(pkg, dev=is_dev)\\n del parsed[section][pkg_name]\\n self.write_toml(parsed)\\n\\n def add_package_to_pipfile(self, package, dev=False):\\n from .vendor.requirementslib import Requirement\\n\\n # Read and append Pipfile.\\n p = self.parsed_pipfile\\n # Don't re-capitalize file URLs or VCSs.\\n if not isinstance(package, Requirement):\\n package = Requirement.from_line(package.strip())\\n _, converted = package.pipfile_entry\\n key = \\\"dev-packages\\\" if dev else \\\"packages\\\"\\n # Set empty group if it doesn't exist yet.\\n if key not in p:\\n p[key] = {}\\n name = self.get_package_name_in_pipfile(package.name, dev)\\n if name and is_star(converted):\\n # Skip for wildcard version\\n return\\n # Add the package to the group.\\n p[key][name or pep423_name(package.name)] = converted\\n # Write Pipfile.\\n self.write_toml(p)\\n\\n def src_name_from_url(self, index_url):\\n name, _, tld_guess = six.moves.urllib.parse.urlsplit(index_url).netloc.rpartition(\\n \\\".\\\"\\n )\\n src_name = name.replace(\\\".\\\", \\\"\\\")\\n try:\\n self.get_source(name=src_name)\\n except SourceNotFound:\\n name = src_name\\n else:\\n from random import randint\\n name = \\\"{0}-{1}\\\".format(src_name, randint(1, 1000))\\n return name\\n\\n def add_index_to_pipfile(self, index, verify_ssl=True):\\n \\\"\\\"\\\"Adds a given index to the Pipfile.\\\"\\\"\\\"\\n # Read and append Pipfile.\\n p = self.parsed_pipfile\\n try:\\n self.get_source(url=index)\\n except SourceNotFound:\\n source = {\\\"url\\\": index, \\\"verify_ssl\\\": verify_ssl}\\n else:\\n return\\n source[\\\"name\\\"] = self.src_name_from_url(index)\\n # Add the package to the group.\\n if \\\"source\\\" not in p:\\n p[\\\"source\\\"] = [source]\\n else:\\n p[\\\"source\\\"].append(source)\\n # Write Pipfile.\\n self.write_toml(p)\\n\\n def recase_pipfile(self):\\n if self.ensure_proper_casing():\\n self.write_toml(self.parsed_pipfile)\\n\\n def load_lockfile(self, expand_env_vars=True):\\n with io.open(self.lockfile_location, encoding=\\\"utf-8\\\") as lock:\\n j = json.load(lock)\\n self._lockfile_newlines = preferred_newlines(lock)\\n # lockfile is just a string\\n if not j or not hasattr(j, \\\"keys\\\"):\\n return j\\n\\n if expand_env_vars:\\n # Expand environment variables in Pipfile.lock at runtime.\\n for i, source in enumerate(j[\\\"_meta\\\"][\\\"sources\\\"][:]):\\n j[\\\"_meta\\\"][\\\"sources\\\"][i][\\\"url\\\"] = os.path.expandvars(\\n j[\\\"_meta\\\"][\\\"sources\\\"][i][\\\"url\\\"]\\n )\\n\\n return j\\n\\n def get_lockfile_hash(self):\\n if not os.path.exists(self.lockfile_location):\\n return\\n\\n try:\\n lockfile = self.load_lockfile(expand_env_vars=False)\\n except ValueError:\\n # Lockfile corrupted\\n return \\\"\\\"\\n if \\\"_meta\\\" in lockfile and hasattr(lockfile, \\\"keys\\\"):\\n return lockfile[\\\"_meta\\\"].get(\\\"hash\\\", {}).get(\\\"sha256\\\")\\n # Lockfile exists but has no hash at all\\n return \\\"\\\"\\n\\n def calculate_pipfile_hash(self):\\n # Update the lockfile if it is out-of-date.\\n p = pipfile.load(self.pipfile_location, inject_env=False)\\n return p.hash\\n\\n def ensure_proper_casing(self):\\n \\\"\\\"\\\"Ensures proper casing of Pipfile packages\\\"\\\"\\\"\\n pfile = self.parsed_pipfile\\n casing_changed = self.proper_case_section(pfile.get(\\\"packages\\\", {}))\\n casing_changed |= self.proper_case_section(pfile.get(\\\"dev-packages\\\", {}))\\n return casing_changed\\n\\n def proper_case_section(self, section):\\n \\\"\\\"\\\"Verify proper casing is retrieved, when available, for each\\n dependency in the section.\\n \\\"\\\"\\\"\\n # Casing for section.\\n changed_values = False\\n unknown_names = [k for k in section.keys() if k not in set(self.proper_names)]\\n # Replace each package with proper casing.\\n for dep in unknown_names:\\n try:\\n # Get new casing for package name.\\n new_casing = proper_case(dep)\\n except IOError:\\n # Unable to normalize package name.\\n continue\\n\\n if new_casing != dep:\\n changed_values = True\\n self.register_proper_name(new_casing)\\n # Replace old value with new value.\\n old_value = section[dep]\\n section[new_casing] = old_value\\n del section[dep]\\n # Return whether or not values have been changed.\\n return changed_values\\n\\n @cached_property\\n def finders(self):\\n from .vendor.pythonfinder import Finder\\n scripts_dirname = \\\"Scripts\\\" if os.name == \\\"nt\\\" else \\\"bin\\\"\\n scripts_dir = os.path.join(self.virtualenv_location, scripts_dirname)\\n finders = [\\n Finder(path=scripts_dir, global_search=gs, system=False)\\n for gs in (False, True)\\n ]\\n return finders\\n\\n @property\\n def finder(self):\\n return next(iter(self.finders), None)\\n\\n def which(self, search, as_path=True):\\n find = operator.methodcaller(\\\"which\\\", search)\\n result = next(iter(filter(None, (find(finder) for finder in self.finders))), None)\\n if not result:\\n result = self._which(search)\\n else:\\n if as_path:\\n result = str(result.path)\\n return result\\n\",\n \"path\": \"pipenv/project.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/news/3324.bugfix.rst b/news/3324.bugfix.rst\nnew file mode 100644\nindex 0000000000..d13a8d468f\n--- /dev/null\n+++ b/news/3324.bugfix.rst\n@@ -0,0 +1 @@\n+Don't normalize the package name user passes in.\ndiff --git a/pipenv/project.py b/pipenv/project.py\nindex 46f82cf34c..e8550a041a 100644\n--- a/pipenv/project.py\n+++ b/pipenv/project.py\n@@ -940,7 +940,7 @@ def add_package_to_pipfile(self, package, dev=False):\n # Skip for wildcard version\n return\n # Add the package to the group.\n- p[key][name or package.normalized_name] = converted\n+ p[key][name or pep423_name(package.name)] = converted\n # Write Pipfile.\n self.write_toml(p)\n \ndiff --git a/tests/integration/test_install_basic.py b/tests/integration/test_install_basic.py\nindex b5b261171e..317351a0b3 100644\n--- a/tests/integration/test_install_basic.py\n+++ b/tests/integration/test_install_basic.py\n@@ -438,3 +438,11 @@ def test_install_non_exist_dep(PipenvInstance, pypi):\n c = p.pipenv(\"install dateutil\")\n assert not c.ok\n assert \"dateutil\" not in p.pipfile[\"packages\"]\n+\n+\n+@pytest.mark.install\n+def test_install_package_with_dots(PipenvInstance, pypi):\n+ with PipenvInstance(pypi=pypi, chdir=True) as p:\n+ c = p.pipenv(\"install backports.html\")\n+ assert c.ok\n+ assert \"backports.html\" in p.pipfile[\"packages\"]\ndiff --git a/tests/pypi/backports-html/backports.html-1.1.0.tar.gz b/tests/pypi/backports-html/backports.html-1.1.0.tar.gz\nnew file mode 100644\nindex 0000000000..de553ebace\nBinary files /dev/null and b/tests/pypi/backports-html/backports.html-1.1.0.tar.gz differ\n"}}},{"rowIdx":2697,"cells":{"in_source_id":{"kind":"string","value":"ibis-project__ibis-1951"},"issue":{"kind":"string","value":"Implement Interval arithmetic on one or more backends\nAfter subtraction is in from #1489, we'll want to implement this on at least one backend.\n"},"before_files":{"kind":"list like","value":[{"content":"import datetime\n\nimport numpy as np\nimport pandas as pd\nfrom pandas.core.groupby import SeriesGroupBy\n\nimport ibis\nimport ibis.expr.datatypes as dt\nimport ibis.expr.operations as ops\nfrom ibis.pandas.core import (\n date_types,\n integer_types,\n numeric_types,\n timedelta_types,\n timestamp_types,\n)\nfrom ibis.pandas.dispatch import execute_node, pre_execute\n\n\n@execute_node.register(ops.Strftime, pd.Timestamp, str)\ndef execute_strftime_timestamp_str(op, data, format_string, **kwargs):\n return data.strftime(format_string)\n\n\n@execute_node.register(ops.Strftime, pd.Series, str)\ndef execute_strftime_series_str(op, data, format_string, **kwargs):\n return data.dt.strftime(format_string)\n\n\n@execute_node.register(ops.ExtractTemporalField, pd.Timestamp)\ndef execute_extract_timestamp_field_timestamp(op, data, **kwargs):\n field_name = type(op).__name__.lower().replace('extract', '')\n return getattr(data, field_name)\n\n\n@execute_node.register(ops.ExtractMillisecond, pd.Timestamp)\ndef execute_extract_millisecond_timestamp(op, data, **kwargs):\n return int(data.microsecond // 1000.0)\n\n\n@execute_node.register(ops.ExtractTemporalField, pd.Series)\ndef execute_extract_timestamp_field_series(op, data, **kwargs):\n field_name = type(op).__name__.lower().replace('extract', '')\n return getattr(data.dt, field_name).astype(np.int32)\n\n\n@execute_node.register(\n ops.BetweenTime,\n pd.Series,\n (pd.Series, str, datetime.time),\n (pd.Series, str, datetime.time),\n)\ndef execute_between_time(op, data, lower, upper, **kwargs):\n indexer = pd.DatetimeIndex(data).indexer_between_time(lower, upper)\n result = np.zeros(len(data), dtype=np.bool_)\n result[indexer] = True\n return pd.Series(result)\n\n\n@execute_node.register(ops.Date, pd.Series)\ndef execute_timestamp_date(op, data, **kwargs):\n return data.dt.floor('d')\n\n\n@execute_node.register((ops.TimestampTruncate, ops.DateTruncate), pd.Series)\ndef execute_timestamp_truncate(op, data, **kwargs):\n dtype = 'datetime64[{}]'.format(op.unit)\n array = data.values.astype(dtype)\n return pd.Series(array, name=data.name)\n\n\nOFFSET_CLASS = {\n \"Y\": pd.offsets.DateOffset,\n \"Q\": pd.offsets.DateOffset,\n \"M\": pd.offsets.DateOffset,\n \"W\": pd.offsets.DateOffset,\n # all other units are timedelta64s\n}\n\n\n@execute_node.register(ops.IntervalFromInteger, pd.Series)\ndef execute_interval_from_integer_series(op, data, **kwargs):\n unit = op.unit\n resolution = \"{}s\".format(op.resolution)\n cls = OFFSET_CLASS.get(unit, None)\n\n # fast path for timedelta conversion\n if cls is None:\n return data.astype(\"timedelta64[{}]\".format(unit))\n return data.apply(\n lambda n, cls=cls, resolution=resolution: cls(**{resolution: n})\n )\n\n\n@execute_node.register(ops.IntervalFromInteger, integer_types)\ndef execute_interval_from_integer_integer_types(op, data, **kwargs):\n unit = op.unit\n resolution = \"{}s\".format(op.resolution)\n cls = OFFSET_CLASS.get(unit, None)\n\n if cls is None:\n return pd.Timedelta(data, unit=unit)\n return cls(**{resolution: data})\n\n\n@execute_node.register(ops.Cast, pd.Series, dt.Interval)\ndef execute_cast_integer_to_interval_series(op, data, type, **kwargs):\n to = op.to\n unit = to.unit\n resolution = \"{}s\".format(to.resolution)\n cls = OFFSET_CLASS.get(unit, None)\n\n if cls is None:\n return data.astype(\"timedelta64[{}]\".format(unit))\n return data.apply(\n lambda n, cls=cls, resolution=resolution: cls(**{resolution: n})\n )\n\n\n@execute_node.register(ops.Cast, integer_types, dt.Interval)\ndef execute_cast_integer_to_interval_integer_types(op, data, type, **kwargs):\n to = op.to\n unit = to.unit\n resolution = \"{}s\".format(to.resolution)\n cls = OFFSET_CLASS.get(unit, None)\n\n if cls is None:\n return pd.Timedelta(data, unit=unit)\n return cls(**{resolution: data})\n\n\n@execute_node.register(ops.TimestampAdd, timestamp_types, timedelta_types)\ndef execute_timestamp_add_datetime_timedelta(op, left, right, **kwargs):\n return pd.Timestamp(left) + pd.Timedelta(right)\n\n\n@execute_node.register(ops.TimestampAdd, timestamp_types, pd.Series)\ndef execute_timestamp_add_datetime_series(op, left, right, **kwargs):\n return pd.Timestamp(left) + right\n\n\n@execute_node.register(ops.IntervalAdd, timedelta_types, timedelta_types)\ndef execute_interval_add_delta_delta(op, left, right, **kwargs):\n return op.op(pd.Timedelta(left), pd.Timedelta(right))\n\n\n@execute_node.register(ops.IntervalAdd, timedelta_types, pd.Series)\n@execute_node.register(\n ops.IntervalMultiply, timedelta_types, numeric_types + (pd.Series,)\n)\ndef execute_interval_add_multiply_delta_series(op, left, right, **kwargs):\n return op.op(pd.Timedelta(left), right)\n\n\n@execute_node.register(\n (ops.TimestampAdd, ops.IntervalAdd), pd.Series, timedelta_types\n)\ndef execute_timestamp_interval_add_series_delta(op, left, right, **kwargs):\n return left + pd.Timedelta(right)\n\n\n@execute_node.register(\n (ops.TimestampAdd, ops.IntervalAdd), pd.Series, pd.Series\n)\ndef execute_timestamp_interval_add_series_series(op, left, right, **kwargs):\n return left + right\n\n\n@execute_node.register(ops.TimestampSub, timestamp_types, timedelta_types)\ndef execute_timestamp_sub_datetime_timedelta(op, left, right, **kwargs):\n return pd.Timestamp(left) - pd.Timedelta(right)\n\n\n@execute_node.register(\n (ops.TimestampDiff, ops.TimestampSub), timestamp_types, pd.Series\n)\ndef execute_timestamp_diff_sub_datetime_series(op, left, right, **kwargs):\n return pd.Timestamp(left) - right\n\n\n@execute_node.register(ops.TimestampSub, pd.Series, timedelta_types)\ndef execute_timestamp_sub_series_timedelta(op, left, right, **kwargs):\n return left - pd.Timedelta(right)\n\n\n@execute_node.register(\n (ops.TimestampDiff, ops.TimestampSub), pd.Series, pd.Series\n)\ndef execute_timestamp_diff_sub_series_series(op, left, right, **kwargs):\n return left - right\n\n\n@execute_node.register(ops.TimestampDiff, timestamp_types, timestamp_types)\ndef execute_timestamp_diff_datetime_datetime(op, left, right, **kwargs):\n return pd.Timestamp(left) - pd.Timestamp(right)\n\n\n@execute_node.register(ops.TimestampDiff, pd.Series, timestamp_types)\ndef execute_timestamp_diff_series_datetime(op, left, right, **kwargs):\n return left - pd.Timestamp(right)\n\n\n@execute_node.register(\n ops.IntervalMultiply, pd.Series, numeric_types + (pd.Series,)\n)\n@execute_node.register(\n ops.IntervalFloorDivide,\n (pd.Timedelta, pd.Series),\n numeric_types + (pd.Series,),\n)\ndef execute_interval_multiply_fdiv_series_numeric(op, left, right, **kwargs):\n return op.op(left, right)\n\n\n@execute_node.register(ops.TimestampFromUNIX, (pd.Series,) + integer_types)\ndef execute_timestamp_from_unix(op, data, **kwargs):\n return pd.to_datetime(data, unit=op.unit)\n\n\n@pre_execute.register(ops.TimestampNow)\n@pre_execute.register(ops.TimestampNow, ibis.client.Client)\ndef pre_execute_timestamp_now(op, *args, **kwargs):\n return {op: pd.Timestamp('now')}\n\n\n@execute_node.register(ops.DayOfWeekIndex, (str, datetime.date))\ndef execute_day_of_week_index_any(op, value, **kwargs):\n return pd.Timestamp(value).dayofweek\n\n\n@execute_node.register(ops.DayOfWeekIndex, pd.Series)\ndef execute_day_of_week_index_series(op, data, **kwargs):\n return data.dt.dayofweek.astype(np.int16)\n\n\n@execute_node.register(ops.DayOfWeekIndex, SeriesGroupBy)\ndef execute_day_of_week_index_series_group_by(op, data, **kwargs):\n groupings = data.grouper.groupings\n return data.obj.dt.dayofweek.astype(np.int16).groupby(groupings)\n\n\ndef day_name(obj):\n \"\"\"Backwards compatible name of day getting function.\n\n Parameters\n ----------\n obj : Union[Series, pd.Timestamp]\n\n Returns\n -------\n str\n The name of the day corresponding to `obj`\n \"\"\"\n try:\n return obj.day_name()\n except AttributeError:\n return obj.weekday_name\n\n\n@execute_node.register(ops.DayOfWeekName, (str, datetime.date))\ndef execute_day_of_week_name_any(op, value, **kwargs):\n return day_name(pd.Timestamp(value))\n\n\n@execute_node.register(ops.DayOfWeekName, pd.Series)\ndef execute_day_of_week_name_series(op, data, **kwargs):\n return day_name(data.dt)\n\n\n@execute_node.register(ops.DayOfWeekName, SeriesGroupBy)\ndef execute_day_of_week_name_series_group_by(op, data, **kwargs):\n return day_name(data.obj.dt).groupby(data.grouper.groupings)\n\n\n@execute_node.register(ops.DateSub, date_types, timedelta_types)\n@execute_node.register((ops.DateDiff, ops.DateSub), date_types, pd.Series)\n@execute_node.register(ops.DateSub, pd.Series, timedelta_types)\n@execute_node.register((ops.DateDiff, ops.DateSub), pd.Series, pd.Series)\n@execute_node.register(ops.DateDiff, date_types, date_types)\n@execute_node.register(ops.DateDiff, pd.Series, date_types)\ndef execute_date_sub_diff(op, left, right, **kwargs):\n return left - right\n\n\n@execute_node.register(ops.DateAdd, pd.Series, timedelta_types)\n@execute_node.register(ops.DateAdd, timedelta_types, pd.Series)\n@execute_node.register(ops.DateAdd, pd.Series, pd.Series)\n@execute_node.register(ops.DateAdd, date_types, timedelta_types)\n@execute_node.register(ops.DateAdd, timedelta_types, date_types)\n@execute_node.register(ops.DateAdd, date_types, pd.Series)\n@execute_node.register(ops.DateAdd, pd.Series, date_types)\ndef execute_date_add(op, left, right, **kwargs):\n return left + right\n","path":"ibis/pandas/execution/temporal.py"}],"string":"[\n {\n \"content\": \"import datetime\\n\\nimport numpy as np\\nimport pandas as pd\\nfrom pandas.core.groupby import SeriesGroupBy\\n\\nimport ibis\\nimport ibis.expr.datatypes as dt\\nimport ibis.expr.operations as ops\\nfrom ibis.pandas.core import (\\n date_types,\\n integer_types,\\n numeric_types,\\n timedelta_types,\\n timestamp_types,\\n)\\nfrom ibis.pandas.dispatch import execute_node, pre_execute\\n\\n\\n@execute_node.register(ops.Strftime, pd.Timestamp, str)\\ndef execute_strftime_timestamp_str(op, data, format_string, **kwargs):\\n return data.strftime(format_string)\\n\\n\\n@execute_node.register(ops.Strftime, pd.Series, str)\\ndef execute_strftime_series_str(op, data, format_string, **kwargs):\\n return data.dt.strftime(format_string)\\n\\n\\n@execute_node.register(ops.ExtractTemporalField, pd.Timestamp)\\ndef execute_extract_timestamp_field_timestamp(op, data, **kwargs):\\n field_name = type(op).__name__.lower().replace('extract', '')\\n return getattr(data, field_name)\\n\\n\\n@execute_node.register(ops.ExtractMillisecond, pd.Timestamp)\\ndef execute_extract_millisecond_timestamp(op, data, **kwargs):\\n return int(data.microsecond // 1000.0)\\n\\n\\n@execute_node.register(ops.ExtractTemporalField, pd.Series)\\ndef execute_extract_timestamp_field_series(op, data, **kwargs):\\n field_name = type(op).__name__.lower().replace('extract', '')\\n return getattr(data.dt, field_name).astype(np.int32)\\n\\n\\n@execute_node.register(\\n ops.BetweenTime,\\n pd.Series,\\n (pd.Series, str, datetime.time),\\n (pd.Series, str, datetime.time),\\n)\\ndef execute_between_time(op, data, lower, upper, **kwargs):\\n indexer = pd.DatetimeIndex(data).indexer_between_time(lower, upper)\\n result = np.zeros(len(data), dtype=np.bool_)\\n result[indexer] = True\\n return pd.Series(result)\\n\\n\\n@execute_node.register(ops.Date, pd.Series)\\ndef execute_timestamp_date(op, data, **kwargs):\\n return data.dt.floor('d')\\n\\n\\n@execute_node.register((ops.TimestampTruncate, ops.DateTruncate), pd.Series)\\ndef execute_timestamp_truncate(op, data, **kwargs):\\n dtype = 'datetime64[{}]'.format(op.unit)\\n array = data.values.astype(dtype)\\n return pd.Series(array, name=data.name)\\n\\n\\nOFFSET_CLASS = {\\n \\\"Y\\\": pd.offsets.DateOffset,\\n \\\"Q\\\": pd.offsets.DateOffset,\\n \\\"M\\\": pd.offsets.DateOffset,\\n \\\"W\\\": pd.offsets.DateOffset,\\n # all other units are timedelta64s\\n}\\n\\n\\n@execute_node.register(ops.IntervalFromInteger, pd.Series)\\ndef execute_interval_from_integer_series(op, data, **kwargs):\\n unit = op.unit\\n resolution = \\\"{}s\\\".format(op.resolution)\\n cls = OFFSET_CLASS.get(unit, None)\\n\\n # fast path for timedelta conversion\\n if cls is None:\\n return data.astype(\\\"timedelta64[{}]\\\".format(unit))\\n return data.apply(\\n lambda n, cls=cls, resolution=resolution: cls(**{resolution: n})\\n )\\n\\n\\n@execute_node.register(ops.IntervalFromInteger, integer_types)\\ndef execute_interval_from_integer_integer_types(op, data, **kwargs):\\n unit = op.unit\\n resolution = \\\"{}s\\\".format(op.resolution)\\n cls = OFFSET_CLASS.get(unit, None)\\n\\n if cls is None:\\n return pd.Timedelta(data, unit=unit)\\n return cls(**{resolution: data})\\n\\n\\n@execute_node.register(ops.Cast, pd.Series, dt.Interval)\\ndef execute_cast_integer_to_interval_series(op, data, type, **kwargs):\\n to = op.to\\n unit = to.unit\\n resolution = \\\"{}s\\\".format(to.resolution)\\n cls = OFFSET_CLASS.get(unit, None)\\n\\n if cls is None:\\n return data.astype(\\\"timedelta64[{}]\\\".format(unit))\\n return data.apply(\\n lambda n, cls=cls, resolution=resolution: cls(**{resolution: n})\\n )\\n\\n\\n@execute_node.register(ops.Cast, integer_types, dt.Interval)\\ndef execute_cast_integer_to_interval_integer_types(op, data, type, **kwargs):\\n to = op.to\\n unit = to.unit\\n resolution = \\\"{}s\\\".format(to.resolution)\\n cls = OFFSET_CLASS.get(unit, None)\\n\\n if cls is None:\\n return pd.Timedelta(data, unit=unit)\\n return cls(**{resolution: data})\\n\\n\\n@execute_node.register(ops.TimestampAdd, timestamp_types, timedelta_types)\\ndef execute_timestamp_add_datetime_timedelta(op, left, right, **kwargs):\\n return pd.Timestamp(left) + pd.Timedelta(right)\\n\\n\\n@execute_node.register(ops.TimestampAdd, timestamp_types, pd.Series)\\ndef execute_timestamp_add_datetime_series(op, left, right, **kwargs):\\n return pd.Timestamp(left) + right\\n\\n\\n@execute_node.register(ops.IntervalAdd, timedelta_types, timedelta_types)\\ndef execute_interval_add_delta_delta(op, left, right, **kwargs):\\n return op.op(pd.Timedelta(left), pd.Timedelta(right))\\n\\n\\n@execute_node.register(ops.IntervalAdd, timedelta_types, pd.Series)\\n@execute_node.register(\\n ops.IntervalMultiply, timedelta_types, numeric_types + (pd.Series,)\\n)\\ndef execute_interval_add_multiply_delta_series(op, left, right, **kwargs):\\n return op.op(pd.Timedelta(left), right)\\n\\n\\n@execute_node.register(\\n (ops.TimestampAdd, ops.IntervalAdd), pd.Series, timedelta_types\\n)\\ndef execute_timestamp_interval_add_series_delta(op, left, right, **kwargs):\\n return left + pd.Timedelta(right)\\n\\n\\n@execute_node.register(\\n (ops.TimestampAdd, ops.IntervalAdd), pd.Series, pd.Series\\n)\\ndef execute_timestamp_interval_add_series_series(op, left, right, **kwargs):\\n return left + right\\n\\n\\n@execute_node.register(ops.TimestampSub, timestamp_types, timedelta_types)\\ndef execute_timestamp_sub_datetime_timedelta(op, left, right, **kwargs):\\n return pd.Timestamp(left) - pd.Timedelta(right)\\n\\n\\n@execute_node.register(\\n (ops.TimestampDiff, ops.TimestampSub), timestamp_types, pd.Series\\n)\\ndef execute_timestamp_diff_sub_datetime_series(op, left, right, **kwargs):\\n return pd.Timestamp(left) - right\\n\\n\\n@execute_node.register(ops.TimestampSub, pd.Series, timedelta_types)\\ndef execute_timestamp_sub_series_timedelta(op, left, right, **kwargs):\\n return left - pd.Timedelta(right)\\n\\n\\n@execute_node.register(\\n (ops.TimestampDiff, ops.TimestampSub), pd.Series, pd.Series\\n)\\ndef execute_timestamp_diff_sub_series_series(op, left, right, **kwargs):\\n return left - right\\n\\n\\n@execute_node.register(ops.TimestampDiff, timestamp_types, timestamp_types)\\ndef execute_timestamp_diff_datetime_datetime(op, left, right, **kwargs):\\n return pd.Timestamp(left) - pd.Timestamp(right)\\n\\n\\n@execute_node.register(ops.TimestampDiff, pd.Series, timestamp_types)\\ndef execute_timestamp_diff_series_datetime(op, left, right, **kwargs):\\n return left - pd.Timestamp(right)\\n\\n\\n@execute_node.register(\\n ops.IntervalMultiply, pd.Series, numeric_types + (pd.Series,)\\n)\\n@execute_node.register(\\n ops.IntervalFloorDivide,\\n (pd.Timedelta, pd.Series),\\n numeric_types + (pd.Series,),\\n)\\ndef execute_interval_multiply_fdiv_series_numeric(op, left, right, **kwargs):\\n return op.op(left, right)\\n\\n\\n@execute_node.register(ops.TimestampFromUNIX, (pd.Series,) + integer_types)\\ndef execute_timestamp_from_unix(op, data, **kwargs):\\n return pd.to_datetime(data, unit=op.unit)\\n\\n\\n@pre_execute.register(ops.TimestampNow)\\n@pre_execute.register(ops.TimestampNow, ibis.client.Client)\\ndef pre_execute_timestamp_now(op, *args, **kwargs):\\n return {op: pd.Timestamp('now')}\\n\\n\\n@execute_node.register(ops.DayOfWeekIndex, (str, datetime.date))\\ndef execute_day_of_week_index_any(op, value, **kwargs):\\n return pd.Timestamp(value).dayofweek\\n\\n\\n@execute_node.register(ops.DayOfWeekIndex, pd.Series)\\ndef execute_day_of_week_index_series(op, data, **kwargs):\\n return data.dt.dayofweek.astype(np.int16)\\n\\n\\n@execute_node.register(ops.DayOfWeekIndex, SeriesGroupBy)\\ndef execute_day_of_week_index_series_group_by(op, data, **kwargs):\\n groupings = data.grouper.groupings\\n return data.obj.dt.dayofweek.astype(np.int16).groupby(groupings)\\n\\n\\ndef day_name(obj):\\n \\\"\\\"\\\"Backwards compatible name of day getting function.\\n\\n Parameters\\n ----------\\n obj : Union[Series, pd.Timestamp]\\n\\n Returns\\n -------\\n str\\n The name of the day corresponding to `obj`\\n \\\"\\\"\\\"\\n try:\\n return obj.day_name()\\n except AttributeError:\\n return obj.weekday_name\\n\\n\\n@execute_node.register(ops.DayOfWeekName, (str, datetime.date))\\ndef execute_day_of_week_name_any(op, value, **kwargs):\\n return day_name(pd.Timestamp(value))\\n\\n\\n@execute_node.register(ops.DayOfWeekName, pd.Series)\\ndef execute_day_of_week_name_series(op, data, **kwargs):\\n return day_name(data.dt)\\n\\n\\n@execute_node.register(ops.DayOfWeekName, SeriesGroupBy)\\ndef execute_day_of_week_name_series_group_by(op, data, **kwargs):\\n return day_name(data.obj.dt).groupby(data.grouper.groupings)\\n\\n\\n@execute_node.register(ops.DateSub, date_types, timedelta_types)\\n@execute_node.register((ops.DateDiff, ops.DateSub), date_types, pd.Series)\\n@execute_node.register(ops.DateSub, pd.Series, timedelta_types)\\n@execute_node.register((ops.DateDiff, ops.DateSub), pd.Series, pd.Series)\\n@execute_node.register(ops.DateDiff, date_types, date_types)\\n@execute_node.register(ops.DateDiff, pd.Series, date_types)\\ndef execute_date_sub_diff(op, left, right, **kwargs):\\n return left - right\\n\\n\\n@execute_node.register(ops.DateAdd, pd.Series, timedelta_types)\\n@execute_node.register(ops.DateAdd, timedelta_types, pd.Series)\\n@execute_node.register(ops.DateAdd, pd.Series, pd.Series)\\n@execute_node.register(ops.DateAdd, date_types, timedelta_types)\\n@execute_node.register(ops.DateAdd, timedelta_types, date_types)\\n@execute_node.register(ops.DateAdd, date_types, pd.Series)\\n@execute_node.register(ops.DateAdd, pd.Series, date_types)\\ndef execute_date_add(op, left, right, **kwargs):\\n return left + right\\n\",\n \"path\": \"ibis/pandas/execution/temporal.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import datetime\n\nimport numpy as np\nimport pandas as pd\nfrom pandas.core.groupby import SeriesGroupBy\n\nimport ibis\nimport ibis.expr.datatypes as dt\nimport ibis.expr.operations as ops\nfrom ibis.pandas.core import (\n date_types,\n integer_types,\n numeric_types,\n timedelta_types,\n timestamp_types,\n)\nfrom ibis.pandas.dispatch import execute_node, pre_execute\n\n\n@execute_node.register(ops.Strftime, pd.Timestamp, str)\ndef execute_strftime_timestamp_str(op, data, format_string, **kwargs):\n return data.strftime(format_string)\n\n\n@execute_node.register(ops.Strftime, pd.Series, str)\ndef execute_strftime_series_str(op, data, format_string, **kwargs):\n return data.dt.strftime(format_string)\n\n\n@execute_node.register(ops.ExtractTemporalField, pd.Timestamp)\ndef execute_extract_timestamp_field_timestamp(op, data, **kwargs):\n field_name = type(op).__name__.lower().replace('extract', '')\n return getattr(data, field_name)\n\n\n@execute_node.register(ops.ExtractMillisecond, pd.Timestamp)\ndef execute_extract_millisecond_timestamp(op, data, **kwargs):\n return int(data.microsecond // 1000.0)\n\n\n@execute_node.register(ops.ExtractTemporalField, pd.Series)\ndef execute_extract_timestamp_field_series(op, data, **kwargs):\n field_name = type(op).__name__.lower().replace('extract', '')\n return getattr(data.dt, field_name).astype(np.int32)\n\n\n@execute_node.register(\n ops.BetweenTime,\n pd.Series,\n (pd.Series, str, datetime.time),\n (pd.Series, str, datetime.time),\n)\ndef execute_between_time(op, data, lower, upper, **kwargs):\n indexer = pd.DatetimeIndex(data).indexer_between_time(lower, upper)\n result = np.zeros(len(data), dtype=np.bool_)\n result[indexer] = True\n return pd.Series(result)\n\n\n@execute_node.register(ops.Date, pd.Series)\ndef execute_timestamp_date(op, data, **kwargs):\n return data.dt.floor('d')\n\n\n@execute_node.register((ops.TimestampTruncate, ops.DateTruncate), pd.Series)\ndef execute_timestamp_truncate(op, data, **kwargs):\n dtype = 'datetime64[{}]'.format(op.unit)\n array = data.values.astype(dtype)\n return pd.Series(array, name=data.name)\n\n\nOFFSET_CLASS = {\n \"Y\": pd.offsets.DateOffset,\n \"Q\": pd.offsets.DateOffset,\n \"M\": pd.offsets.DateOffset,\n \"W\": pd.offsets.DateOffset,\n # all other units are timedelta64s\n}\n\n\n@execute_node.register(ops.IntervalFromInteger, pd.Series)\ndef execute_interval_from_integer_series(op, data, **kwargs):\n unit = op.unit\n resolution = \"{}s\".format(op.resolution)\n cls = OFFSET_CLASS.get(unit, None)\n\n # fast path for timedelta conversion\n if cls is None:\n return data.astype(\"timedelta64[{}]\".format(unit))\n return data.apply(\n lambda n, cls=cls, resolution=resolution: cls(**{resolution: n})\n )\n\n\n@execute_node.register(ops.IntervalFromInteger, integer_types)\ndef execute_interval_from_integer_integer_types(op, data, **kwargs):\n unit = op.unit\n resolution = \"{}s\".format(op.resolution)\n cls = OFFSET_CLASS.get(unit, None)\n\n if cls is None:\n return pd.Timedelta(data, unit=unit)\n return cls(**{resolution: data})\n\n\n@execute_node.register(ops.Cast, pd.Series, dt.Interval)\ndef execute_cast_integer_to_interval_series(op, data, type, **kwargs):\n to = op.to\n unit = to.unit\n resolution = \"{}s\".format(to.resolution)\n cls = OFFSET_CLASS.get(unit, None)\n\n if cls is None:\n return data.astype(\"timedelta64[{}]\".format(unit))\n return data.apply(\n lambda n, cls=cls, resolution=resolution: cls(**{resolution: n})\n )\n\n\n@execute_node.register(ops.Cast, integer_types, dt.Interval)\ndef execute_cast_integer_to_interval_integer_types(op, data, type, **kwargs):\n to = op.to\n unit = to.unit\n resolution = \"{}s\".format(to.resolution)\n cls = OFFSET_CLASS.get(unit, None)\n\n if cls is None:\n return pd.Timedelta(data, unit=unit)\n return cls(**{resolution: data})\n\n\n@execute_node.register(ops.TimestampAdd, timestamp_types, timedelta_types)\ndef execute_timestamp_add_datetime_timedelta(op, left, right, **kwargs):\n return pd.Timestamp(left) + pd.Timedelta(right)\n\n\n@execute_node.register(ops.TimestampAdd, timestamp_types, pd.Series)\ndef execute_timestamp_add_datetime_series(op, left, right, **kwargs):\n return pd.Timestamp(left) + right\n\n\n@execute_node.register(ops.IntervalAdd, timedelta_types, timedelta_types)\ndef execute_interval_add_delta_delta(op, left, right, **kwargs):\n return op.op(pd.Timedelta(left), pd.Timedelta(right))\n\n\n@execute_node.register(ops.IntervalAdd, timedelta_types, pd.Series)\n@execute_node.register(\n ops.IntervalMultiply, timedelta_types, numeric_types + (pd.Series,)\n)\ndef execute_interval_add_multiply_delta_series(op, left, right, **kwargs):\n return op.op(pd.Timedelta(left), right)\n\n\n@execute_node.register(\n (ops.TimestampAdd, ops.IntervalAdd), pd.Series, timedelta_types\n)\ndef execute_timestamp_interval_add_series_delta(op, left, right, **kwargs):\n return left + pd.Timedelta(right)\n\n\n@execute_node.register(\n (ops.TimestampAdd, ops.IntervalAdd), pd.Series, pd.Series\n)\ndef execute_timestamp_interval_add_series_series(op, left, right, **kwargs):\n return left + right\n\n\n@execute_node.register(ops.TimestampSub, timestamp_types, timedelta_types)\ndef execute_timestamp_sub_datetime_timedelta(op, left, right, **kwargs):\n return pd.Timestamp(left) - pd.Timedelta(right)\n\n\n@execute_node.register(\n (ops.TimestampDiff, ops.TimestampSub), timestamp_types, pd.Series\n)\ndef execute_timestamp_diff_sub_datetime_series(op, left, right, **kwargs):\n return pd.Timestamp(left) - right\n\n\n@execute_node.register(ops.TimestampSub, pd.Series, timedelta_types)\ndef execute_timestamp_sub_series_timedelta(op, left, right, **kwargs):\n return left - pd.Timedelta(right)\n\n\n@execute_node.register(\n (ops.TimestampDiff, ops.TimestampSub, ops.IntervalSubtract),\n pd.Series,\n pd.Series\n)\ndef execute_timestamp_diff_sub_series_series(op, left, right, **kwargs):\n return left - right\n\n\n@execute_node.register(ops.TimestampDiff, timestamp_types, timestamp_types)\ndef execute_timestamp_diff_datetime_datetime(op, left, right, **kwargs):\n return pd.Timestamp(left) - pd.Timestamp(right)\n\n\n@execute_node.register(ops.TimestampDiff, pd.Series, timestamp_types)\ndef execute_timestamp_diff_series_datetime(op, left, right, **kwargs):\n return left - pd.Timestamp(right)\n\n\n@execute_node.register(\n ops.IntervalMultiply, pd.Series, numeric_types + (pd.Series,)\n)\n@execute_node.register(\n ops.IntervalFloorDivide,\n (pd.Timedelta, pd.Series),\n numeric_types + (pd.Series,),\n)\ndef execute_interval_multiply_fdiv_series_numeric(op, left, right, **kwargs):\n return op.op(left, right)\n\n\n@execute_node.register(ops.TimestampFromUNIX, (pd.Series,) + integer_types)\ndef execute_timestamp_from_unix(op, data, **kwargs):\n return pd.to_datetime(data, unit=op.unit)\n\n\n@pre_execute.register(ops.TimestampNow)\n@pre_execute.register(ops.TimestampNow, ibis.client.Client)\ndef pre_execute_timestamp_now(op, *args, **kwargs):\n return {op: pd.Timestamp('now')}\n\n\n@execute_node.register(ops.DayOfWeekIndex, (str, datetime.date))\ndef execute_day_of_week_index_any(op, value, **kwargs):\n return pd.Timestamp(value).dayofweek\n\n\n@execute_node.register(ops.DayOfWeekIndex, pd.Series)\ndef execute_day_of_week_index_series(op, data, **kwargs):\n return data.dt.dayofweek.astype(np.int16)\n\n\n@execute_node.register(ops.DayOfWeekIndex, SeriesGroupBy)\ndef execute_day_of_week_index_series_group_by(op, data, **kwargs):\n groupings = data.grouper.groupings\n return data.obj.dt.dayofweek.astype(np.int16).groupby(groupings)\n\n\ndef day_name(obj):\n \"\"\"Backwards compatible name of day getting function.\n\n Parameters\n ----------\n obj : Union[Series, pd.Timestamp]\n\n Returns\n -------\n str\n The name of the day corresponding to `obj`\n \"\"\"\n try:\n return obj.day_name()\n except AttributeError:\n return obj.weekday_name\n\n\n@execute_node.register(ops.DayOfWeekName, (str, datetime.date))\ndef execute_day_of_week_name_any(op, value, **kwargs):\n return day_name(pd.Timestamp(value))\n\n\n@execute_node.register(ops.DayOfWeekName, pd.Series)\ndef execute_day_of_week_name_series(op, data, **kwargs):\n return day_name(data.dt)\n\n\n@execute_node.register(ops.DayOfWeekName, SeriesGroupBy)\ndef execute_day_of_week_name_series_group_by(op, data, **kwargs):\n return day_name(data.obj.dt).groupby(data.grouper.groupings)\n\n\n@execute_node.register(ops.DateSub, date_types, timedelta_types)\n@execute_node.register((ops.DateDiff, ops.DateSub), date_types, pd.Series)\n@execute_node.register(ops.DateSub, pd.Series, timedelta_types)\n@execute_node.register((ops.DateDiff, ops.DateSub), pd.Series, pd.Series)\n@execute_node.register(ops.DateDiff, date_types, date_types)\n@execute_node.register(ops.DateDiff, pd.Series, date_types)\ndef execute_date_sub_diff(op, left, right, **kwargs):\n return left - right\n\n\n@execute_node.register(ops.DateAdd, pd.Series, timedelta_types)\n@execute_node.register(ops.DateAdd, timedelta_types, pd.Series)\n@execute_node.register(ops.DateAdd, pd.Series, pd.Series)\n@execute_node.register(ops.DateAdd, date_types, timedelta_types)\n@execute_node.register(ops.DateAdd, timedelta_types, date_types)\n@execute_node.register(ops.DateAdd, date_types, pd.Series)\n@execute_node.register(ops.DateAdd, pd.Series, date_types)\ndef execute_date_add(op, left, right, **kwargs):\n return left + right\n","path":"ibis/pandas/execution/temporal.py"}],"string":"[\n {\n \"content\": \"import datetime\\n\\nimport numpy as np\\nimport pandas as pd\\nfrom pandas.core.groupby import SeriesGroupBy\\n\\nimport ibis\\nimport ibis.expr.datatypes as dt\\nimport ibis.expr.operations as ops\\nfrom ibis.pandas.core import (\\n date_types,\\n integer_types,\\n numeric_types,\\n timedelta_types,\\n timestamp_types,\\n)\\nfrom ibis.pandas.dispatch import execute_node, pre_execute\\n\\n\\n@execute_node.register(ops.Strftime, pd.Timestamp, str)\\ndef execute_strftime_timestamp_str(op, data, format_string, **kwargs):\\n return data.strftime(format_string)\\n\\n\\n@execute_node.register(ops.Strftime, pd.Series, str)\\ndef execute_strftime_series_str(op, data, format_string, **kwargs):\\n return data.dt.strftime(format_string)\\n\\n\\n@execute_node.register(ops.ExtractTemporalField, pd.Timestamp)\\ndef execute_extract_timestamp_field_timestamp(op, data, **kwargs):\\n field_name = type(op).__name__.lower().replace('extract', '')\\n return getattr(data, field_name)\\n\\n\\n@execute_node.register(ops.ExtractMillisecond, pd.Timestamp)\\ndef execute_extract_millisecond_timestamp(op, data, **kwargs):\\n return int(data.microsecond // 1000.0)\\n\\n\\n@execute_node.register(ops.ExtractTemporalField, pd.Series)\\ndef execute_extract_timestamp_field_series(op, data, **kwargs):\\n field_name = type(op).__name__.lower().replace('extract', '')\\n return getattr(data.dt, field_name).astype(np.int32)\\n\\n\\n@execute_node.register(\\n ops.BetweenTime,\\n pd.Series,\\n (pd.Series, str, datetime.time),\\n (pd.Series, str, datetime.time),\\n)\\ndef execute_between_time(op, data, lower, upper, **kwargs):\\n indexer = pd.DatetimeIndex(data).indexer_between_time(lower, upper)\\n result = np.zeros(len(data), dtype=np.bool_)\\n result[indexer] = True\\n return pd.Series(result)\\n\\n\\n@execute_node.register(ops.Date, pd.Series)\\ndef execute_timestamp_date(op, data, **kwargs):\\n return data.dt.floor('d')\\n\\n\\n@execute_node.register((ops.TimestampTruncate, ops.DateTruncate), pd.Series)\\ndef execute_timestamp_truncate(op, data, **kwargs):\\n dtype = 'datetime64[{}]'.format(op.unit)\\n array = data.values.astype(dtype)\\n return pd.Series(array, name=data.name)\\n\\n\\nOFFSET_CLASS = {\\n \\\"Y\\\": pd.offsets.DateOffset,\\n \\\"Q\\\": pd.offsets.DateOffset,\\n \\\"M\\\": pd.offsets.DateOffset,\\n \\\"W\\\": pd.offsets.DateOffset,\\n # all other units are timedelta64s\\n}\\n\\n\\n@execute_node.register(ops.IntervalFromInteger, pd.Series)\\ndef execute_interval_from_integer_series(op, data, **kwargs):\\n unit = op.unit\\n resolution = \\\"{}s\\\".format(op.resolution)\\n cls = OFFSET_CLASS.get(unit, None)\\n\\n # fast path for timedelta conversion\\n if cls is None:\\n return data.astype(\\\"timedelta64[{}]\\\".format(unit))\\n return data.apply(\\n lambda n, cls=cls, resolution=resolution: cls(**{resolution: n})\\n )\\n\\n\\n@execute_node.register(ops.IntervalFromInteger, integer_types)\\ndef execute_interval_from_integer_integer_types(op, data, **kwargs):\\n unit = op.unit\\n resolution = \\\"{}s\\\".format(op.resolution)\\n cls = OFFSET_CLASS.get(unit, None)\\n\\n if cls is None:\\n return pd.Timedelta(data, unit=unit)\\n return cls(**{resolution: data})\\n\\n\\n@execute_node.register(ops.Cast, pd.Series, dt.Interval)\\ndef execute_cast_integer_to_interval_series(op, data, type, **kwargs):\\n to = op.to\\n unit = to.unit\\n resolution = \\\"{}s\\\".format(to.resolution)\\n cls = OFFSET_CLASS.get(unit, None)\\n\\n if cls is None:\\n return data.astype(\\\"timedelta64[{}]\\\".format(unit))\\n return data.apply(\\n lambda n, cls=cls, resolution=resolution: cls(**{resolution: n})\\n )\\n\\n\\n@execute_node.register(ops.Cast, integer_types, dt.Interval)\\ndef execute_cast_integer_to_interval_integer_types(op, data, type, **kwargs):\\n to = op.to\\n unit = to.unit\\n resolution = \\\"{}s\\\".format(to.resolution)\\n cls = OFFSET_CLASS.get(unit, None)\\n\\n if cls is None:\\n return pd.Timedelta(data, unit=unit)\\n return cls(**{resolution: data})\\n\\n\\n@execute_node.register(ops.TimestampAdd, timestamp_types, timedelta_types)\\ndef execute_timestamp_add_datetime_timedelta(op, left, right, **kwargs):\\n return pd.Timestamp(left) + pd.Timedelta(right)\\n\\n\\n@execute_node.register(ops.TimestampAdd, timestamp_types, pd.Series)\\ndef execute_timestamp_add_datetime_series(op, left, right, **kwargs):\\n return pd.Timestamp(left) + right\\n\\n\\n@execute_node.register(ops.IntervalAdd, timedelta_types, timedelta_types)\\ndef execute_interval_add_delta_delta(op, left, right, **kwargs):\\n return op.op(pd.Timedelta(left), pd.Timedelta(right))\\n\\n\\n@execute_node.register(ops.IntervalAdd, timedelta_types, pd.Series)\\n@execute_node.register(\\n ops.IntervalMultiply, timedelta_types, numeric_types + (pd.Series,)\\n)\\ndef execute_interval_add_multiply_delta_series(op, left, right, **kwargs):\\n return op.op(pd.Timedelta(left), right)\\n\\n\\n@execute_node.register(\\n (ops.TimestampAdd, ops.IntervalAdd), pd.Series, timedelta_types\\n)\\ndef execute_timestamp_interval_add_series_delta(op, left, right, **kwargs):\\n return left + pd.Timedelta(right)\\n\\n\\n@execute_node.register(\\n (ops.TimestampAdd, ops.IntervalAdd), pd.Series, pd.Series\\n)\\ndef execute_timestamp_interval_add_series_series(op, left, right, **kwargs):\\n return left + right\\n\\n\\n@execute_node.register(ops.TimestampSub, timestamp_types, timedelta_types)\\ndef execute_timestamp_sub_datetime_timedelta(op, left, right, **kwargs):\\n return pd.Timestamp(left) - pd.Timedelta(right)\\n\\n\\n@execute_node.register(\\n (ops.TimestampDiff, ops.TimestampSub), timestamp_types, pd.Series\\n)\\ndef execute_timestamp_diff_sub_datetime_series(op, left, right, **kwargs):\\n return pd.Timestamp(left) - right\\n\\n\\n@execute_node.register(ops.TimestampSub, pd.Series, timedelta_types)\\ndef execute_timestamp_sub_series_timedelta(op, left, right, **kwargs):\\n return left - pd.Timedelta(right)\\n\\n\\n@execute_node.register(\\n (ops.TimestampDiff, ops.TimestampSub, ops.IntervalSubtract),\\n pd.Series,\\n pd.Series\\n)\\ndef execute_timestamp_diff_sub_series_series(op, left, right, **kwargs):\\n return left - right\\n\\n\\n@execute_node.register(ops.TimestampDiff, timestamp_types, timestamp_types)\\ndef execute_timestamp_diff_datetime_datetime(op, left, right, **kwargs):\\n return pd.Timestamp(left) - pd.Timestamp(right)\\n\\n\\n@execute_node.register(ops.TimestampDiff, pd.Series, timestamp_types)\\ndef execute_timestamp_diff_series_datetime(op, left, right, **kwargs):\\n return left - pd.Timestamp(right)\\n\\n\\n@execute_node.register(\\n ops.IntervalMultiply, pd.Series, numeric_types + (pd.Series,)\\n)\\n@execute_node.register(\\n ops.IntervalFloorDivide,\\n (pd.Timedelta, pd.Series),\\n numeric_types + (pd.Series,),\\n)\\ndef execute_interval_multiply_fdiv_series_numeric(op, left, right, **kwargs):\\n return op.op(left, right)\\n\\n\\n@execute_node.register(ops.TimestampFromUNIX, (pd.Series,) + integer_types)\\ndef execute_timestamp_from_unix(op, data, **kwargs):\\n return pd.to_datetime(data, unit=op.unit)\\n\\n\\n@pre_execute.register(ops.TimestampNow)\\n@pre_execute.register(ops.TimestampNow, ibis.client.Client)\\ndef pre_execute_timestamp_now(op, *args, **kwargs):\\n return {op: pd.Timestamp('now')}\\n\\n\\n@execute_node.register(ops.DayOfWeekIndex, (str, datetime.date))\\ndef execute_day_of_week_index_any(op, value, **kwargs):\\n return pd.Timestamp(value).dayofweek\\n\\n\\n@execute_node.register(ops.DayOfWeekIndex, pd.Series)\\ndef execute_day_of_week_index_series(op, data, **kwargs):\\n return data.dt.dayofweek.astype(np.int16)\\n\\n\\n@execute_node.register(ops.DayOfWeekIndex, SeriesGroupBy)\\ndef execute_day_of_week_index_series_group_by(op, data, **kwargs):\\n groupings = data.grouper.groupings\\n return data.obj.dt.dayofweek.astype(np.int16).groupby(groupings)\\n\\n\\ndef day_name(obj):\\n \\\"\\\"\\\"Backwards compatible name of day getting function.\\n\\n Parameters\\n ----------\\n obj : Union[Series, pd.Timestamp]\\n\\n Returns\\n -------\\n str\\n The name of the day corresponding to `obj`\\n \\\"\\\"\\\"\\n try:\\n return obj.day_name()\\n except AttributeError:\\n return obj.weekday_name\\n\\n\\n@execute_node.register(ops.DayOfWeekName, (str, datetime.date))\\ndef execute_day_of_week_name_any(op, value, **kwargs):\\n return day_name(pd.Timestamp(value))\\n\\n\\n@execute_node.register(ops.DayOfWeekName, pd.Series)\\ndef execute_day_of_week_name_series(op, data, **kwargs):\\n return day_name(data.dt)\\n\\n\\n@execute_node.register(ops.DayOfWeekName, SeriesGroupBy)\\ndef execute_day_of_week_name_series_group_by(op, data, **kwargs):\\n return day_name(data.obj.dt).groupby(data.grouper.groupings)\\n\\n\\n@execute_node.register(ops.DateSub, date_types, timedelta_types)\\n@execute_node.register((ops.DateDiff, ops.DateSub), date_types, pd.Series)\\n@execute_node.register(ops.DateSub, pd.Series, timedelta_types)\\n@execute_node.register((ops.DateDiff, ops.DateSub), pd.Series, pd.Series)\\n@execute_node.register(ops.DateDiff, date_types, date_types)\\n@execute_node.register(ops.DateDiff, pd.Series, date_types)\\ndef execute_date_sub_diff(op, left, right, **kwargs):\\n return left - right\\n\\n\\n@execute_node.register(ops.DateAdd, pd.Series, timedelta_types)\\n@execute_node.register(ops.DateAdd, timedelta_types, pd.Series)\\n@execute_node.register(ops.DateAdd, pd.Series, pd.Series)\\n@execute_node.register(ops.DateAdd, date_types, timedelta_types)\\n@execute_node.register(ops.DateAdd, timedelta_types, date_types)\\n@execute_node.register(ops.DateAdd, date_types, pd.Series)\\n@execute_node.register(ops.DateAdd, pd.Series, date_types)\\ndef execute_date_add(op, left, right, **kwargs):\\n return left + right\\n\",\n \"path\": \"ibis/pandas/execution/temporal.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/ibis/pandas/execution/temporal.py b/ibis/pandas/execution/temporal.py\nindex a3eecf3735cc..2d193a03e7c4 100644\n--- a/ibis/pandas/execution/temporal.py\n+++ b/ibis/pandas/execution/temporal.py\n@@ -184,7 +184,9 @@ def execute_timestamp_sub_series_timedelta(op, left, right, **kwargs):\n \n \n @execute_node.register(\n- (ops.TimestampDiff, ops.TimestampSub), pd.Series, pd.Series\n+ (ops.TimestampDiff, ops.TimestampSub, ops.IntervalSubtract),\n+ pd.Series,\n+ pd.Series\n )\n def execute_timestamp_diff_sub_series_series(op, left, right, **kwargs):\n return left - right\ndiff --git a/ibis/pandas/execution/tests/test_temporal.py b/ibis/pandas/execution/tests/test_temporal.py\nindex f0eed7552070..4f4d1c23e145 100644\n--- a/ibis/pandas/execution/tests/test_temporal.py\n+++ b/ibis/pandas/execution/tests/test_temporal.py\n@@ -147,6 +147,7 @@ def test_times_ops_with_tz(t, df, tz, rconstruct, column):\n ('op', 'expected'),\n [\n param(lambda x, y: x + y, lambda x, y: x.values * 2, id='add'),\n+ param(lambda x, y: x - y, lambda x, y: x.values - y.values, id='sub'),\n param(lambda x, y: x * 2, lambda x, y: x.values * 2, id='mul'),\n param(\n lambda x, y: x // 2,\n"}}},{"rowIdx":2698,"cells":{"in_source_id":{"kind":"string","value":"getpelican__pelican-2632"},"issue":{"kind":"string","value":"Add Markdown as an (optional) dependency\nSince its inception, this project has taken the collective position that since not everyone uses Markdown, the `markdown` package should not be a dependency of the project and should instead be manually installed by users who want to use Markdown.\r\n\r\nOn the other hand, the `docutils` package that parses reStructuredText markup has always been a dependency. Particularly given Markdown's widespread popularity, I cannot come up with a compelling argument to support the continuation of this discrepancy.\r\n\r\nThis project is littered with issues caused by environments with missing `markdown` packages. Many folks have encountered frustration when trying to build their Markdown-content sites, only to be met with an (often inscrutable) error message. And that's just the folks who have taken the time to file issues! Imagine how many threw up their hands and just moved on to another solution…\r\n\r\nAdding Markdown as a dependency would have significant benefits, including simplifying installation instructions, reducing frustration, and minimizing support request load. So to take another approach at this topic… What are the reasons for *not* adding Markdown as a dependency, and do you think they are sufficiently important to out-weigh the concerns raised above?\n"},"before_files":{"kind":"list like","value":[{"content":"#!/usr/bin/env python\nimport sys\nfrom io import open\nfrom os import walk\nfrom os.path import join, relpath\n\nfrom setuptools import setup\n\n\nversion = \"4.1.2\"\n\nrequires = ['feedgenerator >= 1.9', 'jinja2 >= 2.7', 'pygments', 'docutils',\n 'pytz >= 0a', 'blinker', 'unidecode', 'six >= 1.4',\n 'python-dateutil']\n\nentry_points = {\n 'console_scripts': [\n 'pelican = pelican.__main__:main',\n 'pelican-import = pelican.tools.pelican_import:main',\n 'pelican-quickstart = pelican.tools.pelican_quickstart:main',\n 'pelican-themes = pelican.tools.pelican_themes:main'\n ]\n}\n\nREADME = open('README.rst', encoding='utf-8').read()\nCHANGELOG = open('docs/changelog.rst', encoding='utf-8').read()\n\ndescription = u'\\n'.join([README, CHANGELOG])\nif sys.version_info.major < 3:\n description = description.encode('utf-8')\n\nsetup(\n name='pelican',\n version=version,\n url='https://getpelican.com/',\n author='Justin Mayer',\n author_email='authors@getpelican.com',\n description=\"Static site generator supporting reStructuredText and \"\n \"Markdown source content.\",\n project_urls={\n 'Documentation': 'https://docs.getpelican.com/',\n 'Funding': 'https://donate.getpelican.com/',\n 'Source': 'https://github.com/getpelican/pelican',\n 'Tracker': 'https://github.com/getpelican/pelican/issues',\n },\n keywords='static web site generator SSG reStructuredText Markdown',\n license='AGPLv3',\n long_description=description,\n packages=['pelican', 'pelican.tools'],\n package_data={\n # we manually collect the package data, as opposed to using,\n # include_package_data=True because we don't want the tests to be\n # included automatically as package data (MANIFEST.in is too greedy)\n 'pelican': [relpath(join(root, name), 'pelican')\n for root, _, names in walk(join('pelican', 'themes'))\n for name in names],\n 'pelican.tools': [relpath(join(root, name), join('pelican', 'tools'))\n for root, _, names in walk(join('pelican',\n 'tools',\n 'templates'))\n for name in names],\n },\n install_requires=requires,\n entry_points=entry_points,\n classifiers=[\n 'Development Status :: 5 - Production/Stable',\n 'Environment :: Console',\n 'Framework :: Pelican',\n 'License :: OSI Approved :: GNU Affero General Public License v3',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python :: 2',\n 'Programming Language :: Python :: 2.7',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.5',\n 'Programming Language :: Python :: 3.6',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: Implementation :: CPython',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n ],\n test_suite='pelican.tests',\n)\n","path":"setup.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/env python\\nimport sys\\nfrom io import open\\nfrom os import walk\\nfrom os.path import join, relpath\\n\\nfrom setuptools import setup\\n\\n\\nversion = \\\"4.1.2\\\"\\n\\nrequires = ['feedgenerator >= 1.9', 'jinja2 >= 2.7', 'pygments', 'docutils',\\n 'pytz >= 0a', 'blinker', 'unidecode', 'six >= 1.4',\\n 'python-dateutil']\\n\\nentry_points = {\\n 'console_scripts': [\\n 'pelican = pelican.__main__:main',\\n 'pelican-import = pelican.tools.pelican_import:main',\\n 'pelican-quickstart = pelican.tools.pelican_quickstart:main',\\n 'pelican-themes = pelican.tools.pelican_themes:main'\\n ]\\n}\\n\\nREADME = open('README.rst', encoding='utf-8').read()\\nCHANGELOG = open('docs/changelog.rst', encoding='utf-8').read()\\n\\ndescription = u'\\\\n'.join([README, CHANGELOG])\\nif sys.version_info.major < 3:\\n description = description.encode('utf-8')\\n\\nsetup(\\n name='pelican',\\n version=version,\\n url='https://getpelican.com/',\\n author='Justin Mayer',\\n author_email='authors@getpelican.com',\\n description=\\\"Static site generator supporting reStructuredText and \\\"\\n \\\"Markdown source content.\\\",\\n project_urls={\\n 'Documentation': 'https://docs.getpelican.com/',\\n 'Funding': 'https://donate.getpelican.com/',\\n 'Source': 'https://github.com/getpelican/pelican',\\n 'Tracker': 'https://github.com/getpelican/pelican/issues',\\n },\\n keywords='static web site generator SSG reStructuredText Markdown',\\n license='AGPLv3',\\n long_description=description,\\n packages=['pelican', 'pelican.tools'],\\n package_data={\\n # we manually collect the package data, as opposed to using,\\n # include_package_data=True because we don't want the tests to be\\n # included automatically as package data (MANIFEST.in is too greedy)\\n 'pelican': [relpath(join(root, name), 'pelican')\\n for root, _, names in walk(join('pelican', 'themes'))\\n for name in names],\\n 'pelican.tools': [relpath(join(root, name), join('pelican', 'tools'))\\n for root, _, names in walk(join('pelican',\\n 'tools',\\n 'templates'))\\n for name in names],\\n },\\n install_requires=requires,\\n entry_points=entry_points,\\n classifiers=[\\n 'Development Status :: 5 - Production/Stable',\\n 'Environment :: Console',\\n 'Framework :: Pelican',\\n 'License :: OSI Approved :: GNU Affero General Public License v3',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python :: 2',\\n 'Programming Language :: Python :: 2.7',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.5',\\n 'Programming Language :: Python :: 3.6',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: Implementation :: CPython',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n ],\\n test_suite='pelican.tests',\\n)\\n\",\n \"path\": \"setup.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"#!/usr/bin/env python\nimport sys\nfrom io import open\nfrom os import walk\nfrom os.path import join, relpath\n\nfrom setuptools import setup\n\n\nversion = \"4.1.2\"\n\nrequires = ['feedgenerator >= 1.9', 'jinja2 >= 2.7', 'pygments', 'docutils',\n 'pytz >= 0a', 'blinker', 'unidecode', 'six >= 1.4',\n 'python-dateutil']\n\nentry_points = {\n 'console_scripts': [\n 'pelican = pelican.__main__:main',\n 'pelican-import = pelican.tools.pelican_import:main',\n 'pelican-quickstart = pelican.tools.pelican_quickstart:main',\n 'pelican-themes = pelican.tools.pelican_themes:main'\n ]\n}\n\nREADME = open('README.rst', encoding='utf-8').read()\nCHANGELOG = open('docs/changelog.rst', encoding='utf-8').read()\n\ndescription = u'\\n'.join([README, CHANGELOG])\nif sys.version_info.major < 3:\n description = description.encode('utf-8')\n\nsetup(\n name='pelican',\n version=version,\n url='https://getpelican.com/',\n author='Justin Mayer',\n author_email='authors@getpelican.com',\n description=\"Static site generator supporting reStructuredText and \"\n \"Markdown source content.\",\n project_urls={\n 'Documentation': 'https://docs.getpelican.com/',\n 'Funding': 'https://donate.getpelican.com/',\n 'Source': 'https://github.com/getpelican/pelican',\n 'Tracker': 'https://github.com/getpelican/pelican/issues',\n },\n keywords='static web site generator SSG reStructuredText Markdown',\n license='AGPLv3',\n long_description=description,\n packages=['pelican', 'pelican.tools'],\n package_data={\n # we manually collect the package data, as opposed to using,\n # include_package_data=True because we don't want the tests to be\n # included automatically as package data (MANIFEST.in is too greedy)\n 'pelican': [relpath(join(root, name), 'pelican')\n for root, _, names in walk(join('pelican', 'themes'))\n for name in names],\n 'pelican.tools': [relpath(join(root, name), join('pelican', 'tools'))\n for root, _, names in walk(join('pelican',\n 'tools',\n 'templates'))\n for name in names],\n },\n install_requires=requires,\n extras_require={\n 'Markdown': ['markdown~=3.1.1']\n },\n entry_points=entry_points,\n classifiers=[\n 'Development Status :: 5 - Production/Stable',\n 'Environment :: Console',\n 'Framework :: Pelican',\n 'License :: OSI Approved :: GNU Affero General Public License v3',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python :: 2',\n 'Programming Language :: Python :: 2.7',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.5',\n 'Programming Language :: Python :: 3.6',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: Implementation :: CPython',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n ],\n test_suite='pelican.tests',\n)\n","path":"setup.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/env python\\nimport sys\\nfrom io import open\\nfrom os import walk\\nfrom os.path import join, relpath\\n\\nfrom setuptools import setup\\n\\n\\nversion = \\\"4.1.2\\\"\\n\\nrequires = ['feedgenerator >= 1.9', 'jinja2 >= 2.7', 'pygments', 'docutils',\\n 'pytz >= 0a', 'blinker', 'unidecode', 'six >= 1.4',\\n 'python-dateutil']\\n\\nentry_points = {\\n 'console_scripts': [\\n 'pelican = pelican.__main__:main',\\n 'pelican-import = pelican.tools.pelican_import:main',\\n 'pelican-quickstart = pelican.tools.pelican_quickstart:main',\\n 'pelican-themes = pelican.tools.pelican_themes:main'\\n ]\\n}\\n\\nREADME = open('README.rst', encoding='utf-8').read()\\nCHANGELOG = open('docs/changelog.rst', encoding='utf-8').read()\\n\\ndescription = u'\\\\n'.join([README, CHANGELOG])\\nif sys.version_info.major < 3:\\n description = description.encode('utf-8')\\n\\nsetup(\\n name='pelican',\\n version=version,\\n url='https://getpelican.com/',\\n author='Justin Mayer',\\n author_email='authors@getpelican.com',\\n description=\\\"Static site generator supporting reStructuredText and \\\"\\n \\\"Markdown source content.\\\",\\n project_urls={\\n 'Documentation': 'https://docs.getpelican.com/',\\n 'Funding': 'https://donate.getpelican.com/',\\n 'Source': 'https://github.com/getpelican/pelican',\\n 'Tracker': 'https://github.com/getpelican/pelican/issues',\\n },\\n keywords='static web site generator SSG reStructuredText Markdown',\\n license='AGPLv3',\\n long_description=description,\\n packages=['pelican', 'pelican.tools'],\\n package_data={\\n # we manually collect the package data, as opposed to using,\\n # include_package_data=True because we don't want the tests to be\\n # included automatically as package data (MANIFEST.in is too greedy)\\n 'pelican': [relpath(join(root, name), 'pelican')\\n for root, _, names in walk(join('pelican', 'themes'))\\n for name in names],\\n 'pelican.tools': [relpath(join(root, name), join('pelican', 'tools'))\\n for root, _, names in walk(join('pelican',\\n 'tools',\\n 'templates'))\\n for name in names],\\n },\\n install_requires=requires,\\n extras_require={\\n 'Markdown': ['markdown~=3.1.1']\\n },\\n entry_points=entry_points,\\n classifiers=[\\n 'Development Status :: 5 - Production/Stable',\\n 'Environment :: Console',\\n 'Framework :: Pelican',\\n 'License :: OSI Approved :: GNU Affero General Public License v3',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python :: 2',\\n 'Programming Language :: Python :: 2.7',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.5',\\n 'Programming Language :: Python :: 3.6',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: Implementation :: CPython',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n ],\\n test_suite='pelican.tests',\\n)\\n\",\n \"path\": \"setup.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/docs/install.rst b/docs/install.rst\nindex 571de95e8..2da7b9be2 100644\n--- a/docs/install.rst\n+++ b/docs/install.rst\n@@ -9,6 +9,10 @@ You can install Pelican via several different methods. The simplest is via\n \n pip install pelican\n \n+Or, if you plan on using Markdown::\n+\n+ pip install pelican[Markdown]\n+\n (Keep in mind that operating systems will often require you to prefix the above\n command with ``sudo`` in order to install Pelican system-wide.)\n \n@@ -40,7 +44,11 @@ Optional packages\n -----------------\n \n If you plan on using `Markdown <http://pypi.python.org/pypi/Markdown>`_ as a\n-markup format, you'll need to install the Markdown library::\n+markup format, you can install Pelican with Markdown support::\n+\n+ pip install pelican[Markdown]\n+\n+Or you might need to install it a posteriori::\n \n pip install Markdown\n \ndiff --git a/docs/quickstart.rst b/docs/quickstart.rst\nindex 646dd987a..484a318ff 100644\n--- a/docs/quickstart.rst\n+++ b/docs/quickstart.rst\n@@ -11,7 +11,7 @@ Install Pelican (and optionally Markdown if you intend to use it) on Python\n 2.7.x or Python 3.5+ by running the following command in your preferred\n terminal, prefixing with ``sudo`` if permissions warrant::\n \n- pip install pelican markdown\n+ pip install pelican[Markdown]\n \n Create a project\n ----------------\ndiff --git a/setup.py b/setup.py\nindex 5eea85b64..0979d1c40 100755\n--- a/setup.py\n+++ b/setup.py\n@@ -61,6 +61,9 @@\n for name in names],\n },\n install_requires=requires,\n+ extras_require={\n+ 'Markdown': ['markdown~=3.1.1']\n+ },\n entry_points=entry_points,\n classifiers=[\n 'Development Status :: 5 - Production/Stable',\n"}}},{"rowIdx":2699,"cells":{"in_source_id":{"kind":"string","value":"gratipay__gratipay.com-2948"},"issue":{"kind":"string","value":"VirtualEnv error with Windows + Vagrant\nNo idea where to even start with this one. Fresh clone with fresh vagrant box. \n\nHere's the weird part, at home my Windows 8.1 x64 computer experiences this problem but my Windows 7 x64 computer at work doesn't. This also happens to @abnor\n\n```\nvagrant@precise64:~/www.gittip.com$ make clean env\nrm -rf env *.egg *.egg-info\nfind . -name \\*.pyc -delete\n\"/usr/bin/python2.7\" \"./vendor/virtualenv-1.9.1.py\"\\\n --unzip-setuptools \\\n --prompt=\"[gittip] \" \\\n --never-download \\\n --extra-search-dir=./vendor/ \\\n --distribute \\\n ./env/\nTraceback (most recent call last):\n File \"./vendor/virtualenv-1.9.1.py\", line 2577, in <module>\n main()\n File \"./vendor/virtualenv-1.9.1.py\", line 979, in main\n no_pip=options.no_pip)\n File \"./vendor/virtualenv-1.9.1.py\", line 1081, in create_environment\n site_packages=site_packages, clear=clear))\n File \"./vendor/virtualenv-1.9.1.py\", line 1275, in install_python\n copyfile(join(stdlib_dir, fn), join(lib_dir, fn))\n File \"./vendor/virtualenv-1.9.1.py\", line 437, in copyfile\n copyfileordir(src, dest)\n File \"./vendor/virtualenv-1.9.1.py\", line 412, in copyfileordir\n shutil.copytree(src, dest, True)\n File \"/usr/lib/python2.7/shutil.py\", line 206, in copytree\n raise Error, errors\nshutil.Error: [('/usr/lib/python2.7/config/libpython2.7.so', './env/lib/python2.\n7/config/libpython2.7.so', '[Errno 71] Protocol error')]\nmake: *** [env] Error 1\n```\n\n<bountysource-plugin>\n\n---\n\nWant to back this issue? **[Place a bounty on it!](https://www.bountysource.com/issues/1846612-virtualenv-error-with-windows-vagrant?utm_campaign=plugin&utm_content=tracker%2F85909&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://www.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F85909&utm_medium=issues&utm_source=github).\n</bountysource-plugin>\n\nfake_data generates 0.00 transfers that break positive constraint\nRunning fake_data may yield:\n\n```\n==> basebox: psycopg2.IntegrityError: new row for relation \"transfers\" violates check constraint \"positive\"\n==> basebox: DETAIL: Failing row contains (578395790, 2014-08-20 12:00:37+00, Dominicbdp, Katharina92q, 0.00, tip).\n```\n\n"},"before_files":{"kind":"list like","value":[{"content":"from faker import Factory\nfrom gratipay import wireup, MAX_TIP_SINGULAR, MIN_TIP\nfrom gratipay.elsewhere import PLATFORMS\nfrom gratipay.models.participant import Participant\n\nimport datetime\nimport decimal\nimport random\nimport string\n\n\nfaker = Factory.create()\n\n\ndef _fake_thing(db, tablename, **kw):\n column_names = []\n column_value_placeholders = []\n column_values = []\n\n for k,v in kw.items():\n column_names.append(k)\n column_value_placeholders.append(\"%s\")\n column_values.append(v)\n\n column_names = \", \".join(column_names)\n column_value_placeholders = \", \".join(column_value_placeholders)\n\n db.run( \"INSERT INTO {} ({}) VALUES ({})\"\n .format(tablename, column_names, column_value_placeholders)\n , column_values\n )\n return kw\n\n\ndef fake_text_id(size=6, chars=string.ascii_lowercase + string.digits):\n \"\"\"Create a random text id.\n \"\"\"\n return ''.join(random.choice(chars) for x in range(size))\n\n\ndef fake_balance(max_amount=100):\n \"\"\"Return a random amount between 0 and max_amount.\n \"\"\"\n return random.random() * max_amount\n\n\ndef fake_int_id(nmax=2 ** 31 -1):\n \"\"\"Create a random int id.\n \"\"\"\n return random.randint(0, nmax)\n\n\ndef fake_sentence(start=1, stop=100):\n \"\"\"Create a sentence of random length.\n \"\"\"\n return faker.sentence(random.randrange(start,stop))\n\n\ndef fake_participant(db, number=\"singular\", is_admin=False):\n \"\"\"Create a fake User.\n \"\"\"\n username = faker.first_name() + fake_text_id(3)\n _fake_thing( db\n , \"participants\"\n , id=fake_int_id()\n , username=username\n , username_lower=username.lower()\n , statement=fake_sentence()\n , ctime=faker.date_time_this_year()\n , is_admin=is_admin\n , balance=fake_balance()\n , anonymous_giving=(random.randrange(5) == 0)\n , anonymous_receiving=(random.randrange(5) == 0)\n , goal=fake_balance()\n , balanced_customer_href=faker.uri()\n , last_ach_result=''\n , is_suspicious=False\n , last_bill_result='' # Needed to not be suspicious\n , claimed_time=faker.date_time_this_year()\n , number=number\n )\n #Call participant constructor to perform other DB initialization\n return Participant.from_username(username)\n\n\n\ndef fake_tip_amount():\n amount = ((decimal.Decimal(random.random()) * (MAX_TIP_SINGULAR - MIN_TIP))\n + MIN_TIP)\n\n decimal_amount = decimal.Decimal(amount).quantize(decimal.Decimal('.01'))\n\n return decimal_amount\n\n\ndef fake_tip(db, tipper, tippee):\n \"\"\"Create a fake tip.\n \"\"\"\n return _fake_thing( db\n , \"tips\"\n , id=fake_int_id()\n , ctime=faker.date_time_this_year()\n , mtime=faker.date_time_this_month()\n , tipper=tipper.username\n , tippee=tippee.username\n , amount=fake_tip_amount()\n )\n\n\ndef fake_elsewhere(db, participant, platform):\n \"\"\"Create a fake elsewhere.\n \"\"\"\n _fake_thing( db\n , \"elsewhere\"\n , id=fake_int_id()\n , platform=platform\n , user_id=fake_text_id()\n , user_name=participant.username\n , is_locked=False\n , participant=participant.username\n , extra_info=None\n )\n\n\ndef fake_transfer(db, tipper, tippee):\n return _fake_thing( db\n , \"transfers\"\n , id=fake_int_id()\n , timestamp=faker.date_time_this_year()\n , tipper=tipper.username\n , tippee=tippee.username\n , amount=fake_tip_amount()\n , context='tip'\n )\n\n\ndef populate_db(db, num_participants=100, num_tips=200, num_teams=5, num_transfers=5000):\n \"\"\"Populate DB with fake data.\n \"\"\"\n #Make the participants\n participants = []\n for i in xrange(num_participants):\n participants.append(fake_participant(db))\n\n #Make the \"Elsewhere's\"\n for p in participants:\n #All participants get between 1 and 3 elsewheres\n num_elsewheres = random.randint(1, 3)\n for platform_name in random.sample(PLATFORMS, num_elsewheres):\n fake_elsewhere(db, p, platform_name)\n\n #Make teams\n for i in xrange(num_teams):\n t = fake_participant(db, number=\"plural\")\n #Add 1 to 3 members to the team\n members = random.sample(participants, random.randint(1, 3))\n for p in members:\n t.add_member(p)\n\n #Make the tips\n tips = []\n for i in xrange(num_tips):\n tipper, tippee = random.sample(participants, 2)\n tips.append(fake_tip(db, tipper, tippee))\n\n\n #Make the transfers\n transfers = []\n for i in xrange(num_transfers):\n tipper, tippee = random.sample(participants, 2)\n transfers.append(fake_transfer(db, tipper, tippee))\n\n\n #Make some paydays\n #First determine the boundaries - min and max date\n min_date = min(min(x['ctime'] for x in tips), \\\n min(x['timestamp'] for x in transfers))\n max_date = max(max(x['ctime'] for x in tips), \\\n max(x['timestamp'] for x in transfers))\n #iterate through min_date, max_date one week at a time\n date = min_date\n while date < max_date:\n end_date = date + datetime.timedelta(days=7)\n week_tips = filter(lambda x: date <= x['ctime'] <= end_date, tips)\n week_transfers = filter(lambda x: date <= x['timestamp'] <= end_date, transfers)\n week_participants = filter(lambda x: x.ctime.replace(tzinfo=None) <= end_date, participants)\n actives=set()\n tippers=set()\n for xfers in week_tips, week_transfers:\n actives.update(x['tipper'] for x in xfers)\n actives.update(x['tippee'] for x in xfers)\n tippers.update(x['tipper'] for x in xfers)\n payday = {\n 'id': fake_int_id(),\n 'ts_start': date,\n 'ts_end': end_date,\n 'ntips': len(week_tips),\n 'ntransfers': len(week_transfers),\n 'nparticipants': len(week_participants),\n 'ntippers': len(tippers),\n 'nactive': len(actives),\n 'transfer_volume': sum(x['amount'] for x in week_transfers)\n }\n #Make ach_volume and charge_volume between 0 and 10% of transfer volume\n def rand_part():\n return decimal.Decimal(random.random()* 0.1)\n payday['ach_volume'] = -1 * payday['transfer_volume'] * rand_part()\n payday['charge_volume'] = payday['transfer_volume'] * rand_part()\n _fake_thing(db, \"paydays\", **payday)\n date = end_date\n\n\n\ndef main():\n populate_db(wireup.db(wireup.env()))\n\nif __name__ == '__main__':\n main()\n","path":"gratipay/utils/fake_data.py"}],"string":"[\n {\n \"content\": \"from faker import Factory\\nfrom gratipay import wireup, MAX_TIP_SINGULAR, MIN_TIP\\nfrom gratipay.elsewhere import PLATFORMS\\nfrom gratipay.models.participant import Participant\\n\\nimport datetime\\nimport decimal\\nimport random\\nimport string\\n\\n\\nfaker = Factory.create()\\n\\n\\ndef _fake_thing(db, tablename, **kw):\\n column_names = []\\n column_value_placeholders = []\\n column_values = []\\n\\n for k,v in kw.items():\\n column_names.append(k)\\n column_value_placeholders.append(\\\"%s\\\")\\n column_values.append(v)\\n\\n column_names = \\\", \\\".join(column_names)\\n column_value_placeholders = \\\", \\\".join(column_value_placeholders)\\n\\n db.run( \\\"INSERT INTO {} ({}) VALUES ({})\\\"\\n .format(tablename, column_names, column_value_placeholders)\\n , column_values\\n )\\n return kw\\n\\n\\ndef fake_text_id(size=6, chars=string.ascii_lowercase + string.digits):\\n \\\"\\\"\\\"Create a random text id.\\n \\\"\\\"\\\"\\n return ''.join(random.choice(chars) for x in range(size))\\n\\n\\ndef fake_balance(max_amount=100):\\n \\\"\\\"\\\"Return a random amount between 0 and max_amount.\\n \\\"\\\"\\\"\\n return random.random() * max_amount\\n\\n\\ndef fake_int_id(nmax=2 ** 31 -1):\\n \\\"\\\"\\\"Create a random int id.\\n \\\"\\\"\\\"\\n return random.randint(0, nmax)\\n\\n\\ndef fake_sentence(start=1, stop=100):\\n \\\"\\\"\\\"Create a sentence of random length.\\n \\\"\\\"\\\"\\n return faker.sentence(random.randrange(start,stop))\\n\\n\\ndef fake_participant(db, number=\\\"singular\\\", is_admin=False):\\n \\\"\\\"\\\"Create a fake User.\\n \\\"\\\"\\\"\\n username = faker.first_name() + fake_text_id(3)\\n _fake_thing( db\\n , \\\"participants\\\"\\n , id=fake_int_id()\\n , username=username\\n , username_lower=username.lower()\\n , statement=fake_sentence()\\n , ctime=faker.date_time_this_year()\\n , is_admin=is_admin\\n , balance=fake_balance()\\n , anonymous_giving=(random.randrange(5) == 0)\\n , anonymous_receiving=(random.randrange(5) == 0)\\n , goal=fake_balance()\\n , balanced_customer_href=faker.uri()\\n , last_ach_result=''\\n , is_suspicious=False\\n , last_bill_result='' # Needed to not be suspicious\\n , claimed_time=faker.date_time_this_year()\\n , number=number\\n )\\n #Call participant constructor to perform other DB initialization\\n return Participant.from_username(username)\\n\\n\\n\\ndef fake_tip_amount():\\n amount = ((decimal.Decimal(random.random()) * (MAX_TIP_SINGULAR - MIN_TIP))\\n + MIN_TIP)\\n\\n decimal_amount = decimal.Decimal(amount).quantize(decimal.Decimal('.01'))\\n\\n return decimal_amount\\n\\n\\ndef fake_tip(db, tipper, tippee):\\n \\\"\\\"\\\"Create a fake tip.\\n \\\"\\\"\\\"\\n return _fake_thing( db\\n , \\\"tips\\\"\\n , id=fake_int_id()\\n , ctime=faker.date_time_this_year()\\n , mtime=faker.date_time_this_month()\\n , tipper=tipper.username\\n , tippee=tippee.username\\n , amount=fake_tip_amount()\\n )\\n\\n\\ndef fake_elsewhere(db, participant, platform):\\n \\\"\\\"\\\"Create a fake elsewhere.\\n \\\"\\\"\\\"\\n _fake_thing( db\\n , \\\"elsewhere\\\"\\n , id=fake_int_id()\\n , platform=platform\\n , user_id=fake_text_id()\\n , user_name=participant.username\\n , is_locked=False\\n , participant=participant.username\\n , extra_info=None\\n )\\n\\n\\ndef fake_transfer(db, tipper, tippee):\\n return _fake_thing( db\\n , \\\"transfers\\\"\\n , id=fake_int_id()\\n , timestamp=faker.date_time_this_year()\\n , tipper=tipper.username\\n , tippee=tippee.username\\n , amount=fake_tip_amount()\\n , context='tip'\\n )\\n\\n\\ndef populate_db(db, num_participants=100, num_tips=200, num_teams=5, num_transfers=5000):\\n \\\"\\\"\\\"Populate DB with fake data.\\n \\\"\\\"\\\"\\n #Make the participants\\n participants = []\\n for i in xrange(num_participants):\\n participants.append(fake_participant(db))\\n\\n #Make the \\\"Elsewhere's\\\"\\n for p in participants:\\n #All participants get between 1 and 3 elsewheres\\n num_elsewheres = random.randint(1, 3)\\n for platform_name in random.sample(PLATFORMS, num_elsewheres):\\n fake_elsewhere(db, p, platform_name)\\n\\n #Make teams\\n for i in xrange(num_teams):\\n t = fake_participant(db, number=\\\"plural\\\")\\n #Add 1 to 3 members to the team\\n members = random.sample(participants, random.randint(1, 3))\\n for p in members:\\n t.add_member(p)\\n\\n #Make the tips\\n tips = []\\n for i in xrange(num_tips):\\n tipper, tippee = random.sample(participants, 2)\\n tips.append(fake_tip(db, tipper, tippee))\\n\\n\\n #Make the transfers\\n transfers = []\\n for i in xrange(num_transfers):\\n tipper, tippee = random.sample(participants, 2)\\n transfers.append(fake_transfer(db, tipper, tippee))\\n\\n\\n #Make some paydays\\n #First determine the boundaries - min and max date\\n min_date = min(min(x['ctime'] for x in tips), \\\\\\n min(x['timestamp'] for x in transfers))\\n max_date = max(max(x['ctime'] for x in tips), \\\\\\n max(x['timestamp'] for x in transfers))\\n #iterate through min_date, max_date one week at a time\\n date = min_date\\n while date < max_date:\\n end_date = date + datetime.timedelta(days=7)\\n week_tips = filter(lambda x: date <= x['ctime'] <= end_date, tips)\\n week_transfers = filter(lambda x: date <= x['timestamp'] <= end_date, transfers)\\n week_participants = filter(lambda x: x.ctime.replace(tzinfo=None) <= end_date, participants)\\n actives=set()\\n tippers=set()\\n for xfers in week_tips, week_transfers:\\n actives.update(x['tipper'] for x in xfers)\\n actives.update(x['tippee'] for x in xfers)\\n tippers.update(x['tipper'] for x in xfers)\\n payday = {\\n 'id': fake_int_id(),\\n 'ts_start': date,\\n 'ts_end': end_date,\\n 'ntips': len(week_tips),\\n 'ntransfers': len(week_transfers),\\n 'nparticipants': len(week_participants),\\n 'ntippers': len(tippers),\\n 'nactive': len(actives),\\n 'transfer_volume': sum(x['amount'] for x in week_transfers)\\n }\\n #Make ach_volume and charge_volume between 0 and 10% of transfer volume\\n def rand_part():\\n return decimal.Decimal(random.random()* 0.1)\\n payday['ach_volume'] = -1 * payday['transfer_volume'] * rand_part()\\n payday['charge_volume'] = payday['transfer_volume'] * rand_part()\\n _fake_thing(db, \\\"paydays\\\", **payday)\\n date = end_date\\n\\n\\n\\ndef main():\\n populate_db(wireup.db(wireup.env()))\\n\\nif __name__ == '__main__':\\n main()\\n\",\n \"path\": \"gratipay/utils/fake_data.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"from faker import Factory\nfrom gratipay import wireup, MAX_TIP_SINGULAR, MIN_TIP\nfrom gratipay.elsewhere import PLATFORMS\nfrom gratipay.models.participant import Participant\n\nimport datetime\nimport decimal\nimport random\nimport string\n\n\nfaker = Factory.create()\n\n\ndef _fake_thing(db, tablename, **kw):\n column_names = []\n column_value_placeholders = []\n column_values = []\n\n for k,v in kw.items():\n column_names.append(k)\n column_value_placeholders.append(\"%s\")\n column_values.append(v)\n\n column_names = \", \".join(column_names)\n column_value_placeholders = \", \".join(column_value_placeholders)\n\n db.run( \"INSERT INTO {} ({}) VALUES ({})\"\n .format(tablename, column_names, column_value_placeholders)\n , column_values\n )\n return kw\n\n\ndef fake_text_id(size=6, chars=string.ascii_lowercase + string.digits):\n \"\"\"Create a random text id.\n \"\"\"\n return ''.join(random.choice(chars) for x in range(size))\n\n\ndef fake_balance(max_amount=100):\n \"\"\"Return a random amount between 0 and max_amount.\n \"\"\"\n return random.random() * max_amount\n\n\ndef fake_int_id(nmax=2 ** 31 -1):\n \"\"\"Create a random int id.\n \"\"\"\n return random.randint(0, nmax)\n\n\ndef fake_sentence(start=1, stop=100):\n \"\"\"Create a sentence of random length.\n \"\"\"\n return faker.sentence(random.randrange(start,stop))\n\n\ndef fake_participant(db, number=\"singular\", is_admin=False):\n \"\"\"Create a fake User.\n \"\"\"\n username = faker.first_name() + fake_text_id(3)\n _fake_thing( db\n , \"participants\"\n , id=fake_int_id()\n , username=username\n , username_lower=username.lower()\n , statement=fake_sentence()\n , ctime=faker.date_time_this_year()\n , is_admin=is_admin\n , balance=fake_balance()\n , anonymous_giving=(random.randrange(5) == 0)\n , anonymous_receiving=(random.randrange(5) == 0)\n , goal=fake_balance()\n , balanced_customer_href=faker.uri()\n , last_ach_result=''\n , is_suspicious=False\n , last_bill_result='' # Needed to not be suspicious\n , claimed_time=faker.date_time_this_year()\n , number=number\n )\n #Call participant constructor to perform other DB initialization\n return Participant.from_username(username)\n\n\n\ndef fake_tip_amount():\n amount = ((decimal.Decimal(random.random()) * (MAX_TIP_SINGULAR - MIN_TIP))\n + MIN_TIP)\n\n decimal_amount = decimal.Decimal(amount).quantize(decimal.Decimal('.01'))\n while decimal_amount == decimal.Decimal('0.00'):\n # https://github.com/gratipay/gratipay.com/issues/2950\n decimal_amount = fake_tip_amount() \n return decimal_amount\n\n\ndef fake_tip(db, tipper, tippee):\n \"\"\"Create a fake tip.\n \"\"\"\n return _fake_thing( db\n , \"tips\"\n , id=fake_int_id()\n , ctime=faker.date_time_this_year()\n , mtime=faker.date_time_this_month()\n , tipper=tipper.username\n , tippee=tippee.username\n , amount=fake_tip_amount()\n )\n\n\ndef fake_elsewhere(db, participant, platform):\n \"\"\"Create a fake elsewhere.\n \"\"\"\n _fake_thing( db\n , \"elsewhere\"\n , id=fake_int_id()\n , platform=platform\n , user_id=fake_text_id()\n , user_name=participant.username\n , is_locked=False\n , participant=participant.username\n , extra_info=None\n )\n\n\ndef fake_transfer(db, tipper, tippee):\n return _fake_thing( db\n , \"transfers\"\n , id=fake_int_id()\n , timestamp=faker.date_time_this_year()\n , tipper=tipper.username\n , tippee=tippee.username\n , amount=fake_tip_amount()\n , context='tip'\n )\n\n\ndef populate_db(db, num_participants=100, num_tips=200, num_teams=5, num_transfers=5000):\n \"\"\"Populate DB with fake data.\n \"\"\"\n #Make the participants\n participants = []\n for i in xrange(num_participants):\n participants.append(fake_participant(db))\n\n #Make the \"Elsewhere's\"\n for p in participants:\n #All participants get between 1 and 3 elsewheres\n num_elsewheres = random.randint(1, 3)\n for platform_name in random.sample(PLATFORMS, num_elsewheres):\n fake_elsewhere(db, p, platform_name)\n\n #Make teams\n for i in xrange(num_teams):\n t = fake_participant(db, number=\"plural\")\n #Add 1 to 3 members to the team\n members = random.sample(participants, random.randint(1, 3))\n for p in members:\n t.add_member(p)\n\n #Make the tips\n tips = []\n for i in xrange(num_tips):\n tipper, tippee = random.sample(participants, 2)\n tips.append(fake_tip(db, tipper, tippee))\n\n\n #Make the transfers\n transfers = []\n for i in xrange(num_transfers):\n tipper, tippee = random.sample(participants, 2)\n transfers.append(fake_transfer(db, tipper, tippee))\n\n\n #Make some paydays\n #First determine the boundaries - min and max date\n min_date = min(min(x['ctime'] for x in tips), \\\n min(x['timestamp'] for x in transfers))\n max_date = max(max(x['ctime'] for x in tips), \\\n max(x['timestamp'] for x in transfers))\n #iterate through min_date, max_date one week at a time\n date = min_date\n while date < max_date:\n end_date = date + datetime.timedelta(days=7)\n week_tips = filter(lambda x: date <= x['ctime'] <= end_date, tips)\n week_transfers = filter(lambda x: date <= x['timestamp'] <= end_date, transfers)\n week_participants = filter(lambda x: x.ctime.replace(tzinfo=None) <= end_date, participants)\n actives=set()\n tippers=set()\n for xfers in week_tips, week_transfers:\n actives.update(x['tipper'] for x in xfers)\n actives.update(x['tippee'] for x in xfers)\n tippers.update(x['tipper'] for x in xfers)\n payday = {\n 'id': fake_int_id(),\n 'ts_start': date,\n 'ts_end': end_date,\n 'ntips': len(week_tips),\n 'ntransfers': len(week_transfers),\n 'nparticipants': len(week_participants),\n 'ntippers': len(tippers),\n 'nactive': len(actives),\n 'transfer_volume': sum(x['amount'] for x in week_transfers)\n }\n #Make ach_volume and charge_volume between 0 and 10% of transfer volume\n def rand_part():\n return decimal.Decimal(random.random()* 0.1)\n payday['ach_volume'] = -1 * payday['transfer_volume'] * rand_part()\n payday['charge_volume'] = payday['transfer_volume'] * rand_part()\n _fake_thing(db, \"paydays\", **payday)\n date = end_date\n\n\n\ndef main():\n populate_db(wireup.db(wireup.env()))\n\nif __name__ == '__main__':\n main()\n","path":"gratipay/utils/fake_data.py"}],"string":"[\n {\n \"content\": \"from faker import Factory\\nfrom gratipay import wireup, MAX_TIP_SINGULAR, MIN_TIP\\nfrom gratipay.elsewhere import PLATFORMS\\nfrom gratipay.models.participant import Participant\\n\\nimport datetime\\nimport decimal\\nimport random\\nimport string\\n\\n\\nfaker = Factory.create()\\n\\n\\ndef _fake_thing(db, tablename, **kw):\\n column_names = []\\n column_value_placeholders = []\\n column_values = []\\n\\n for k,v in kw.items():\\n column_names.append(k)\\n column_value_placeholders.append(\\\"%s\\\")\\n column_values.append(v)\\n\\n column_names = \\\", \\\".join(column_names)\\n column_value_placeholders = \\\", \\\".join(column_value_placeholders)\\n\\n db.run( \\\"INSERT INTO {} ({}) VALUES ({})\\\"\\n .format(tablename, column_names, column_value_placeholders)\\n , column_values\\n )\\n return kw\\n\\n\\ndef fake_text_id(size=6, chars=string.ascii_lowercase + string.digits):\\n \\\"\\\"\\\"Create a random text id.\\n \\\"\\\"\\\"\\n return ''.join(random.choice(chars) for x in range(size))\\n\\n\\ndef fake_balance(max_amount=100):\\n \\\"\\\"\\\"Return a random amount between 0 and max_amount.\\n \\\"\\\"\\\"\\n return random.random() * max_amount\\n\\n\\ndef fake_int_id(nmax=2 ** 31 -1):\\n \\\"\\\"\\\"Create a random int id.\\n \\\"\\\"\\\"\\n return random.randint(0, nmax)\\n\\n\\ndef fake_sentence(start=1, stop=100):\\n \\\"\\\"\\\"Create a sentence of random length.\\n \\\"\\\"\\\"\\n return faker.sentence(random.randrange(start,stop))\\n\\n\\ndef fake_participant(db, number=\\\"singular\\\", is_admin=False):\\n \\\"\\\"\\\"Create a fake User.\\n \\\"\\\"\\\"\\n username = faker.first_name() + fake_text_id(3)\\n _fake_thing( db\\n , \\\"participants\\\"\\n , id=fake_int_id()\\n , username=username\\n , username_lower=username.lower()\\n , statement=fake_sentence()\\n , ctime=faker.date_time_this_year()\\n , is_admin=is_admin\\n , balance=fake_balance()\\n , anonymous_giving=(random.randrange(5) == 0)\\n , anonymous_receiving=(random.randrange(5) == 0)\\n , goal=fake_balance()\\n , balanced_customer_href=faker.uri()\\n , last_ach_result=''\\n , is_suspicious=False\\n , last_bill_result='' # Needed to not be suspicious\\n , claimed_time=faker.date_time_this_year()\\n , number=number\\n )\\n #Call participant constructor to perform other DB initialization\\n return Participant.from_username(username)\\n\\n\\n\\ndef fake_tip_amount():\\n amount = ((decimal.Decimal(random.random()) * (MAX_TIP_SINGULAR - MIN_TIP))\\n + MIN_TIP)\\n\\n decimal_amount = decimal.Decimal(amount).quantize(decimal.Decimal('.01'))\\n while decimal_amount == decimal.Decimal('0.00'):\\n # https://github.com/gratipay/gratipay.com/issues/2950\\n decimal_amount = fake_tip_amount() \\n return decimal_amount\\n\\n\\ndef fake_tip(db, tipper, tippee):\\n \\\"\\\"\\\"Create a fake tip.\\n \\\"\\\"\\\"\\n return _fake_thing( db\\n , \\\"tips\\\"\\n , id=fake_int_id()\\n , ctime=faker.date_time_this_year()\\n , mtime=faker.date_time_this_month()\\n , tipper=tipper.username\\n , tippee=tippee.username\\n , amount=fake_tip_amount()\\n )\\n\\n\\ndef fake_elsewhere(db, participant, platform):\\n \\\"\\\"\\\"Create a fake elsewhere.\\n \\\"\\\"\\\"\\n _fake_thing( db\\n , \\\"elsewhere\\\"\\n , id=fake_int_id()\\n , platform=platform\\n , user_id=fake_text_id()\\n , user_name=participant.username\\n , is_locked=False\\n , participant=participant.username\\n , extra_info=None\\n )\\n\\n\\ndef fake_transfer(db, tipper, tippee):\\n return _fake_thing( db\\n , \\\"transfers\\\"\\n , id=fake_int_id()\\n , timestamp=faker.date_time_this_year()\\n , tipper=tipper.username\\n , tippee=tippee.username\\n , amount=fake_tip_amount()\\n , context='tip'\\n )\\n\\n\\ndef populate_db(db, num_participants=100, num_tips=200, num_teams=5, num_transfers=5000):\\n \\\"\\\"\\\"Populate DB with fake data.\\n \\\"\\\"\\\"\\n #Make the participants\\n participants = []\\n for i in xrange(num_participants):\\n participants.append(fake_participant(db))\\n\\n #Make the \\\"Elsewhere's\\\"\\n for p in participants:\\n #All participants get between 1 and 3 elsewheres\\n num_elsewheres = random.randint(1, 3)\\n for platform_name in random.sample(PLATFORMS, num_elsewheres):\\n fake_elsewhere(db, p, platform_name)\\n\\n #Make teams\\n for i in xrange(num_teams):\\n t = fake_participant(db, number=\\\"plural\\\")\\n #Add 1 to 3 members to the team\\n members = random.sample(participants, random.randint(1, 3))\\n for p in members:\\n t.add_member(p)\\n\\n #Make the tips\\n tips = []\\n for i in xrange(num_tips):\\n tipper, tippee = random.sample(participants, 2)\\n tips.append(fake_tip(db, tipper, tippee))\\n\\n\\n #Make the transfers\\n transfers = []\\n for i in xrange(num_transfers):\\n tipper, tippee = random.sample(participants, 2)\\n transfers.append(fake_transfer(db, tipper, tippee))\\n\\n\\n #Make some paydays\\n #First determine the boundaries - min and max date\\n min_date = min(min(x['ctime'] for x in tips), \\\\\\n min(x['timestamp'] for x in transfers))\\n max_date = max(max(x['ctime'] for x in tips), \\\\\\n max(x['timestamp'] for x in transfers))\\n #iterate through min_date, max_date one week at a time\\n date = min_date\\n while date < max_date:\\n end_date = date + datetime.timedelta(days=7)\\n week_tips = filter(lambda x: date <= x['ctime'] <= end_date, tips)\\n week_transfers = filter(lambda x: date <= x['timestamp'] <= end_date, transfers)\\n week_participants = filter(lambda x: x.ctime.replace(tzinfo=None) <= end_date, participants)\\n actives=set()\\n tippers=set()\\n for xfers in week_tips, week_transfers:\\n actives.update(x['tipper'] for x in xfers)\\n actives.update(x['tippee'] for x in xfers)\\n tippers.update(x['tipper'] for x in xfers)\\n payday = {\\n 'id': fake_int_id(),\\n 'ts_start': date,\\n 'ts_end': end_date,\\n 'ntips': len(week_tips),\\n 'ntransfers': len(week_transfers),\\n 'nparticipants': len(week_participants),\\n 'ntippers': len(tippers),\\n 'nactive': len(actives),\\n 'transfer_volume': sum(x['amount'] for x in week_transfers)\\n }\\n #Make ach_volume and charge_volume between 0 and 10% of transfer volume\\n def rand_part():\\n return decimal.Decimal(random.random()* 0.1)\\n payday['ach_volume'] = -1 * payday['transfer_volume'] * rand_part()\\n payday['charge_volume'] = payday['transfer_volume'] * rand_part()\\n _fake_thing(db, \\\"paydays\\\", **payday)\\n date = end_date\\n\\n\\n\\ndef main():\\n populate_db(wireup.db(wireup.env()))\\n\\nif __name__ == '__main__':\\n main()\\n\",\n \"path\": \"gratipay/utils/fake_data.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/Makefile b/Makefile\nindex 5360cadb7d..39fdc9707f 100644\n--- a/Makefile\n+++ b/Makefile\n@@ -16,6 +16,7 @@ env: requirements.txt requirements_tests.txt setup.py\n \t\t\t\t--unzip-setuptools \\\n \t\t\t\t--prompt=\"[gratipay] \" \\\n \t\t\t\t--extra-search-dir=./vendor/ \\\n+\t\t\t\t--always-copy \\\n \t\t\t\t./env/\n \t$(pip) install -r requirements.txt\n \t$(pip) install -r requirements_tests.txt\ndiff --git a/Vagrantfile b/Vagrantfile\nindex 94c7b3db72..6825f7948a 100644\n--- a/Vagrantfile\n+++ b/Vagrantfile\n@@ -5,35 +5,48 @@\n VAGRANTFILE_API_VERSION = \"2\"\n \n Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|\n- config.vm.provider \"virtualbox\" do |v|\n- v.customize [\"modifyvm\", :id, \"--natdnshostresolver1\", \"on\"]\n- end\n \n- # For now we have a custom built vagrant image. It was built in the following manner:\n- #\n- # - Use 'precise64' as a base.\n- # - perform a 'vagrant up' using this vagrantfile: \n- # https://github.com/gratipay/gratipay.com/blob/83312e60c6b31c298ffca61036baa9849044c75e/Vagrantfile\n- # - drop database gratipay\n- # - drop role gratipay\n+ # We use multi-machine config here. First one to rebuild the box from scratch\n+ # (it is normally commented) and second (faster) that download built version. \n+\n+ # Previous configs are:\n+ # - https://github.com/gratipay/gratipay.com/blob/83312e60c6b31c298ffca61036baa9849044c75e/Vagrantfile\n+ # - https://github.com/gratipay/gratipay.com/blob/fc0b4395e85259cdd17d9fe8560bf654abd756ce/Vagrantfile\n+\n+\n+ # --- [ common access parameters ] ---\n+\n+ # Gratipay app is accessible at http://localhost:8537/ from host\n #\n- # Here are some instructions for modifying an existing box:\n+ config.vm.network :forwarded_port, guest: 8537, host: 8537\n+\n+ # Current folder is available as /vagrant from guest.\n+ # We speed up access by installing and using NFS as described here:\n+ # https://docs.vagrantup.com/v2/synced-folders/nfs.html\n+ config.vm.synced_folder \".\", \"/vagrant\", type: \"nfs\"\n+ config.vm.network \"private_network\", ip: \"172.27.36.119\"\n+\n+\n+ # --- [ boxes ] ---\n #\n- # http://www.pvcloudsystems.com/2012/10/vagrant-modify-existing-box/\n+ # after you bootstrap this box, saving it into a gratipay.box is as easy as\n+ # $ vagrant package --output gratipay.box\n #\n- # I used that successfully on https://github.com/gratipay/gratipay.com/pull/2815.\n-\n- config.vm.box = \"gratipay\"\n- config.vm.box_url = File.exist?(\"gratipay.box\") ? \"file://gratipay.box\" : \"https://downloads.gratipay.com/gratipay.box\"\n+ config.vm.define \"basebox\" do |base|\n+ # using Ubuntu 14.04, because it is what our hosting (Heroku) uses\n+ # (search cedar-14 for details)\n+ base.vm.box = \"ubuntu/trusty64\"\n \n- # Sync the project directory and expose the app\n- config.vm.network \"private_network\", ip: \"172.27.36.119\"\n- config.vm.synced_folder \".\", \"/vagrant\", type: \"nfs\"\n- config.vm.network :forwarded_port, guest: 8537, host: 8537\n+ # --- install prerequisites ---\n+ # [ ] use the same package versions as Heroku\n+ # [ ] figure out how to fetch Heroku versions\n+ base.vm.provision :shell, :path => \"scripts/vagrant-debian.sh\" # install system prerequisites\n+ base.vm.provision :shell, :path => \"scripts/vagrant-setup.sh\" # apply user specific settings \n+ end\n \n- # TODO: Pin apt-get packages to the same versions Heroku uses\n+ #config.vm.define \"gratipay\" do |box|\n+ # box.vm.box = \"gratipay\"\n+ # box.vm.box_url = File.exist?(\"gratipay.box\") ? \"file://gratipay.box\" : \"https://downloads.gratipay.com/gratipay.box\"\n+ #end\n \n- # Installed dependencies are already part of the base image now\n- config.vm.provision :shell,\n- :path => \"scripts/vagrant-setup.sh\"\n end\ndiff --git a/gratipay/utils/fake_data.py b/gratipay/utils/fake_data.py\nindex eb45484a6f..eb5325073d 100644\n--- a/gratipay/utils/fake_data.py\n+++ b/gratipay/utils/fake_data.py\n@@ -89,7 +89,9 @@ def fake_tip_amount():\n + MIN_TIP)\n \n decimal_amount = decimal.Decimal(amount).quantize(decimal.Decimal('.01'))\n-\n+ while decimal_amount == decimal.Decimal('0.00'):\n+ # https://github.com/gratipay/gratipay.com/issues/2950\n+ decimal_amount = fake_tip_amount() \n return decimal_amount\n \n \ndiff --git a/scripts/create_db.sql b/scripts/create_db.sql\ndeleted file mode 100644\nindex a5dd2229f9..0000000000\n--- a/scripts/create_db.sql\n+++ /dev/null\n@@ -1,2 +0,0 @@\n-CREATE ROLE gratipay LOGIN PASSWORD 'gratipay' SUPERUSER;\n-CREATE DATABASE gratipay WITH OWNER = gratipay;\ndiff --git a/scripts/create_test_db.sql b/scripts/create_test_db.sql\ndeleted file mode 100644\nindex 76ae728d63..0000000000\n--- a/scripts/create_test_db.sql\n+++ /dev/null\n@@ -1 +0,0 @@\n-CREATE DATABASE \"gratipay-test\" WITH OWNER = gratipay;\ndiff --git a/scripts/crlf-warning.txt b/scripts/crlf-warning.txt\ndeleted file mode 100644\nindex 939465bc0a..0000000000\n--- a/scripts/crlf-warning.txt\n+++ /dev/null\n@@ -1,14 +0,0 @@\n-*** WARNING ***\n-CRLF detected. You must fix the line endings manually before continuing.\n-\n-PROBLEM\n-Vagrant syncs your working directory with Ubuntu. Scripts and the Makefile\n-expect Unix line endings, but git converts them to Windows CRLF with autocrlf.\n-\n-SOLUTION\n-1. git stash # Stash your work\n-2. git rm --cached -r . # Remove everything from the index\n-3. git reset --hard # Remove the index and working directory from git\n-\n-Run \"vagrant provision\" again afterward to continue.\n-***************\ndiff --git a/scripts/reset-db.sql b/scripts/reset-db.sql\nnew file mode 100644\nindex 0000000000..15f70d6b09\n--- /dev/null\n+++ b/scripts/reset-db.sql\n@@ -0,0 +1,7 @@\n+DROP DATABASE IF EXISTS \"gratipay-test\";\n+DROP DATABASE IF EXISTS gratipay;\n+DROP ROLE IF EXISTS gratipay;\n+\n+CREATE ROLE gratipay LOGIN PASSWORD 'gratipay' SUPERUSER;\n+CREATE DATABASE gratipay WITH OWNER = gratipay;\n+CREATE DATABASE \"gratipay-test\" WITH OWNER = gratipay;\ndiff --git a/scripts/vagrant-debian.sh b/scripts/vagrant-debian.sh\nnew file mode 100644\nindex 0000000000..1613da33cd\n--- /dev/null\n+++ b/scripts/vagrant-debian.sh\n@@ -0,0 +1,9 @@\n+#!/usr/bin/env bash\n+\n+# installs Python-independent project dependencies\n+\n+apt-get -y install postgresql\n+apt-get -y install libpq-dev\n+apt-get -y install python-dev # for building psycopg2\n+apt-get -y install g++ # for libsass\n+apt-get -y install git # for gratipay.version\ndiff --git a/scripts/vagrant-postgre.sql b/scripts/vagrant-postgre.sql\nnew file mode 100644\nindex 0000000000..d94e0ae50c\n--- /dev/null\n+++ b/scripts/vagrant-postgre.sql\n@@ -0,0 +1,3 @@\n+DROP ROLE IF EXISTS vagrant;\n+\n+CREATE ROLE vagrant LOGIN SUPERUSER;\ndiff --git a/scripts/vagrant-setup.sh b/scripts/vagrant-setup.sh\nindex 1850206bcb..c83cafffb6 100644\n--- a/scripts/vagrant-setup.sh\n+++ b/scripts/vagrant-setup.sh\n@@ -3,28 +3,16 @@\n set -e\n \n # Set login directory to root vagrant share\n-echo \"cd /vagrant\" > /etc/profile.d/login-directory.sh\n+sudo sh -c \"echo 'cd /vagrant' > /etc/profile.d/login-directory.sh\"\n \n-# Configure Postgres\n-sudo -u postgres psql -U postgres -qf /vagrant/scripts/create_db.sql\n-sudo -u postgres psql -U postgres -qf /vagrant/scripts/create_test_db.sql\n-\n-cd /vagrant\n-\n-# Warn if Windows newlines are detected and try to fix the problem\n-if grep --quiet --binary --binary-files=without-match $(printf '\\r') README.md; then\n- echo\n- cat scripts/crlf-warning.txt\n- echo\n-\n- echo 'Running \"git config core.autocrlf false\"'\n- git config core.autocrlf false\n-\n- exit 1\n-fi\n+# Configure Postgres (using system user 'postgres' run command\n+# 'psql' with PostreSQL user 'postgres` to quietly execute scripts)\n+sudo -u postgres psql -U postgres -qf /vagrant/scripts/reset-db.sql\n+sudo -u postgres psql -U postgres -qf /vagrant/scripts/vagrant-postgre.sql\n \n # Set up the environment, the database, and run Gratipay\n-cd /vagrant && make clean env schema data\n+cd /vagrant\n+sudo -u vagrant make clean env schema data\n \n # Output helper text\n cat <<EOF\n"}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":26,"numItemsPerPage":100,"numTotalItems":69711,"offset":2600,"length":100}},"jwt":"eyJhbGciOiJFZERTQSJ9.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sImlhdCI6MTc3OTE1MTA1OCwic3ViIjoiL2RhdGFzZXRzL3Jhc2RhbmkvZ2l0aHViLXBhdGNoZXMiLCJleHAiOjE3NzkxNTQ2NTgsImlzcyI6Imh0dHBzOi8vaHVnZ2luZ2ZhY2UuY28ifQ.xPi2WKurEFALw-bA2ZkdnjgFWdPsUEDgxyrqcHiEcDd7RRX_79Gjb65-furNuFfPii3s_OY6ahuwsu_E5QJnAw","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":69711,"numBytesParquet":2677201019}]},"discussionsStats":{"closed":0,"open":1,"total":1},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
in_source_id stringlengths 13 58 | issue stringlengths 3 241k | before_files listlengths 0 3 | after_files listlengths 0 3 | pr_diff stringlengths 109 107M ⌀ |
|---|---|---|---|---|
genialis__resolwe-167 | Ordering of processes does not work
Tested on the QA server:
https://qa.genialis.com/api/process?slug=alignment-bwa-mem&ordering=-version
For the above query, the `alignment-bwa-mem` processes should be sorted by version, descending. The version 16777232 should be at the top, but comes second.
| [
{
"content": "\"\"\".. Ignore pydocstyle D400.\n\n==========\nFlow Views\n==========\n\n\"\"\"\nfrom __future__ import absolute_import, division, print_function, unicode_literals\n\nimport os\nimport pkgutil\nfrom importlib import import_module\n\nfrom django.db import IntegrityError, transaction\nfrom django.d... | [
{
"content": "\"\"\".. Ignore pydocstyle D400.\n\n==========\nFlow Views\n==========\n\n\"\"\"\nfrom __future__ import absolute_import, division, print_function, unicode_literals\n\nimport os\nimport pkgutil\nfrom importlib import import_module\n\nfrom django.db import IntegrityError, transaction\nfrom django.d... | diff --git a/resolwe/flow/tests/test_ordering.py b/resolwe/flow/tests/test_ordering.py
new file mode 100644
index 000000000..58ab4126d
--- /dev/null
+++ b/resolwe/flow/tests/test_ordering.py
@@ -0,0 +1,35 @@
+# pylint: disable=missing-docstring
+from __future__ import absolute_import, division, print_function, unicode_... |
ietf-tools__datatracker-4294 | cvs export of group documents is dumping b'' strings
From Tim Wicinski:
>FYI
>
>So I went and dumped the WG documents via the CSV link:
>
>https://datatracker.ietf.org/group/dnsop/documents/csv/
>
>Then I imported them into the googles sheets.
>The CSV file has all strings as "b'<string>'" which
>makes the imp... | [
{
"content": "# Copyright The IETF Trust 2012-2020, All Rights Reserved\n# -*- coding: utf-8 -*-\n\n\nimport csv\nimport datetime\nimport json\nimport uuid\n\nfrom django.http import HttpResponse, HttpResponseRedirect, Http404\nfrom django.shortcuts import get_object_or_404, render\nfrom django.contrib.auth.dec... | [
{
"content": "# Copyright The IETF Trust 2012-2020, All Rights Reserved\n# -*- coding: utf-8 -*-\n\n\nimport csv\nimport datetime\nimport json\nimport uuid\n\nfrom django.http import HttpResponse, HttpResponseRedirect, Http404\nfrom django.shortcuts import get_object_or_404, render\nfrom django.contrib.auth.dec... | diff --git a/ietf/community/views.py b/ietf/community/views.py
index 7717c6ee1f..c67f992d6f 100644
--- a/ietf/community/views.py
+++ b/ietf/community/views.py
@@ -208,7 +208,7 @@ def export_to_csv(request, username=None, acronym=None, group_type=None):
row.append(str(doc.ad) if doc.ad else "")
e = doc... |
deis__deis-3308 | Controller: Domain remove, removes always the latest domain
(deis):~/mozilla/deis-apps/masterfirefoxos-dev$ deis domains:list
=== masterfirefoxos-dev Domains
dev.masterfirefoxos.com
(deis):~/mozilla/deis-apps/masterfirefoxos-dev$ deis domains:add foo.example.com
Adding foo.example.com to masterfirefoxos-dev... done
(d... | [
{
"content": "\"\"\"\nRESTful view classes for presenting Deis API objects.\n\"\"\"\n\nfrom django.conf import settings\nfrom django.core.exceptions import ValidationError\nfrom django.contrib.auth.models import User\nfrom django.shortcuts import get_object_or_404\nfrom guardian.shortcuts import assign_perm, ge... | [
{
"content": "\"\"\"\nRESTful view classes for presenting Deis API objects.\n\"\"\"\n\nfrom django.conf import settings\nfrom django.core.exceptions import ValidationError\nfrom django.contrib.auth.models import User\nfrom django.shortcuts import get_object_or_404\nfrom guardian.shortcuts import assign_perm, ge... | diff --git a/controller/api/tests/test_domain.py b/controller/api/tests/test_domain.py
index 7b8d98f927..b3bbe5675a 100644
--- a/controller/api/tests/test_domain.py
+++ b/controller/api/tests/test_domain.py
@@ -12,6 +12,8 @@
from django.test import TestCase
from rest_framework.authtoken.models import Token
+from ap... |
mlflow__mlflow-6881 | [FR] Add the ability to search runs based on 'user_id'
### Willingness to contribute
No. I cannot contribute this feature at this time.
### Proposal Summary
Enable run search to perform searches based on the `user_id` that submitted the run.
### Motivation
> #### What is the use case for this feature?
To return ... | [
{
"content": "from mlflow.entities.run_status import RunStatus\nfrom mlflow.entities._mlflow_object import _MLflowObject\nfrom mlflow.entities.lifecycle_stage import LifecycleStage\nfrom mlflow.exceptions import MlflowException\n\nfrom mlflow.protos.service_pb2 import RunInfo as ProtoRunInfo\nfrom mlflow.protos... | [
{
"content": "from mlflow.entities.run_status import RunStatus\nfrom mlflow.entities._mlflow_object import _MLflowObject\nfrom mlflow.entities.lifecycle_stage import LifecycleStage\nfrom mlflow.exceptions import MlflowException\n\nfrom mlflow.protos.service_pb2 import RunInfo as ProtoRunInfo\nfrom mlflow.protos... | diff --git a/docs/source/search-runs.rst b/docs/source/search-runs.rst
index feb99aa7e4c92..ff5e57f7e306e 100644
--- a/docs/source/search-runs.rst
+++ b/docs/source/search-runs.rst
@@ -86,7 +86,7 @@ that have a leading number. If an entity name contains a leading number, enclose
Run Attributes
~~~~~~~~~~~~~~
-You c... |
Gallopsled__pwntools-597 | A little bug in Buffer class
There is a litttle bug in pwnlib.tubes.Buffer class.The class method unget has a type error in line 117.add a buffer and a list
```
Traceback (most recent call last):
File "<input>", line 1, in <module>
a.unget(b)
File "buffer.py", line 117, in unget
self.data = data + self.da... | [
{
"content": "#!/usr/bin/env python2\n\nclass Buffer(Exception):\n \"\"\"\n List of strings with some helper routines.\n\n Example:\n\n >>> b = Buffer()\n >>> b.add(\"A\" * 10)\n >>> b.add(\"B\" * 10)\n >>> len(b)\n 20\n >>> b.get(1)\n 'A'\n >>> l... | [
{
"content": "#!/usr/bin/env python2\n\nclass Buffer(Exception):\n \"\"\"\n List of strings with some helper routines.\n\n Example:\n\n >>> b = Buffer()\n >>> b.add(\"A\" * 10)\n >>> b.add(\"B\" * 10)\n >>> len(b)\n 20\n >>> b.get(1)\n 'A'\n >>> l... | diff --git a/pwnlib/tubes/buffer.py b/pwnlib/tubes/buffer.py
index 199dcebfd..305d7e1b4 100644
--- a/pwnlib/tubes/buffer.py
+++ b/pwnlib/tubes/buffer.py
@@ -114,7 +114,7 @@ def unget(self, data):
'goodbyeworld'
"""
if isinstance(data, Buffer):
- self.data = data + self.data
+ ... |
pyinstaller__pyinstaller-5778 | Problem with scikitimage and _rolling_ball_cy
Hello Everyone,
When I run exe file on my computer everything works ok but when I try to run on virtual machine I get the error File "skimage\restoration\rolling_ball.py", line 3, in <module>
ImportError: DLL load failed while importing _rolling_ball_cy: The specified ... | [
{
"content": "#-----------------------------------------------------------------------------\n# Copyright (c) 2013-2021, PyInstaller Development Team.\n#\n# Distributed under the terms of the GNU General Public License (version 2\n# or later) with exception for distributing the bootloader.\n#\n# The full licens... | [
{
"content": "#-----------------------------------------------------------------------------\n# Copyright (c) 2013-2021, PyInstaller Development Team.\n#\n# Distributed under the terms of the GNU General Public License (version 2\n# or later) with exception for distributing the bootloader.\n#\n# The full licens... | diff --git a/PyInstaller/depend/dylib.py b/PyInstaller/depend/dylib.py
index cf4ebe05d7..47eb327bf1 100644
--- a/PyInstaller/depend/dylib.py
+++ b/PyInstaller/depend/dylib.py
@@ -104,6 +104,7 @@
r'msvcp140_1\.dll',
r'msvcp140_2\.dll',
r'vcruntime140_1\.dll',
+ r'vcomp140\.dll',
# Allow pythonNN... |
zostera__django-bootstrap4-219 | Use Markdown
The README, HISTORY, CONTRIBUTING and AUTHORS file are written in RST. Markdown is easier to read and easier to write, and usually the standard for files like these. Let's use Markdown for these files.
Also, rename HISTORY to CHANGELOG, this is a more recognizable name.
| [
{
"content": "import os\n\ntry:\n from importlib.metadata import metadata\nexcept ImportError:\n from importlib_metadata import metadata\n\nPROJECT_NAME = \"django-bootstrap4\"\n\non_rtd = os.environ.get(\"READTHEDOCS\", None) == \"True\"\nproject_metadata = metadata(PROJECT_NAME)\n\nproject = project_met... | [
{
"content": "import os\n\ntry:\n from importlib.metadata import metadata\nexcept ImportError:\n from importlib_metadata import metadata\n\nPROJECT_NAME = \"django-bootstrap4\"\n\non_rtd = os.environ.get(\"READTHEDOCS\", None) == \"True\"\nproject_metadata = metadata(PROJECT_NAME)\n\nproject = project_met... | diff --git a/AUTHORS.md b/AUTHORS.md
new file mode 100644
index 00000000..4128757e
--- /dev/null
+++ b/AUTHORS.md
@@ -0,0 +1,25 @@
+# Authors
+
+This application is developed and maintained by [Zostera](https://zostera.nl).
+
+## Development Lead
+
+- Dylan Verheul <dylan@dyve.net>
+
+## Contributors
+
+- Allard Stijnm... |
evennia__evennia-2708 | [BUG - Develop] Global scripts are not being started, only restarted.
#### Describe the bug
When creating a new game, global scripts are not automatically started.
#### To Reproduce
Steps to reproduce the behavior:
1. Create a new game dir.
2. Create a script with `at_repeat` and add it to your server conf.
3. ... | [
{
"content": "\"\"\"\nContainers\n\nContainers are storage classes usually initialized from a setting. They\nrepresent Singletons and acts as a convenient place to find resources (\navailable as properties on the singleton)\n\nevennia.GLOBAL_SCRIPTS\nevennia.OPTION_CLASSES\n\n\"\"\"\n\n\nfrom pickle import dump... | [
{
"content": "\"\"\"\nContainers\n\nContainers are storage classes usually initialized from a setting. They\nrepresent Singletons and acts as a convenient place to find resources (\navailable as properties on the singleton)\n\nevennia.GLOBAL_SCRIPTS\nevennia.OPTION_CLASSES\n\n\"\"\"\n\n\nfrom pickle import dump... | diff --git a/evennia/utils/containers.py b/evennia/utils/containers.py
index 6b709fbf75d..85678ee03ee 100644
--- a/evennia/utils/containers.py
+++ b/evennia/utils/containers.py
@@ -167,7 +167,7 @@ def _load_script(self, key):
# store a hash representation of the setup
script.attributes.add("... |
svthalia__concrexit-1767 | Delete tpay payment if order is modified
### Summary
Right now it is possible to order a pizza, pay it with tpay, change the order to a pizza with a different price, and the payment will not match the order anymore.
### How to test
1. Order a pizza
2. Pay with tpay
3. Change the order
4. The payment should be d... | [
{
"content": "\"\"\"Views provided by the pizzas package.\"\"\"\nfrom django.contrib import messages\nfrom django.contrib.auth.decorators import login_required\nfrom django.http import Http404\nfrom django.shortcuts import get_object_or_404, render, redirect\nfrom django.utils.translation import gettext_lazy as... | [
{
"content": "\"\"\"Views provided by the pizzas package.\"\"\"\nfrom django.contrib import messages\nfrom django.contrib.auth.decorators import login_required\nfrom django.http import Http404\nfrom django.shortcuts import get_object_or_404, render, redirect\nfrom django.utils.translation import gettext_lazy as... | diff --git a/website/pizzas/views.py b/website/pizzas/views.py
index ffcf4c60c..f23167551 100644
--- a/website/pizzas/views.py
+++ b/website/pizzas/views.py
@@ -67,6 +67,6 @@ def place_order(request):
obj = FoodOrder(food_event=event, member=request.member)
obj.product = product
if obj.pa... |
boto__boto-2475 | VPC Peering Connection "delete()" calls wrong method
The "delete()" method of VpcPeeringConnection calls "self.connection.delete_vpc(self.id)" instead of "self.connection.delete_vpc_peering_connection(self.id)"
**File:** boto/vpc/vpc_peering_connection.py
| [
{
"content": "# Copyright (c) 2014 Skytap http://skytap.com/\n#\n# Permission is hereby granted, free of charge, to any person obtaining a\n# copy of this software and associated documentation files (the\n# \"Software\"), to deal in the Software without restriction, including\n# without limitation the rights to... | [
{
"content": "# Copyright (c) 2014 Skytap http://skytap.com/\n#\n# Permission is hereby granted, free of charge, to any person obtaining a\n# copy of this software and associated documentation files (the\n# \"Software\"), to deal in the Software without restriction, including\n# without limitation the rights to... | diff --git a/boto/vpc/vpc_peering_connection.py b/boto/vpc/vpc_peering_connection.py
index d7c11e8e59..cdb9af8dae 100644
--- a/boto/vpc/vpc_peering_connection.py
+++ b/boto/vpc/vpc_peering_connection.py
@@ -145,7 +145,7 @@ def endElement(self, name, value, connection):
setattr(self, name, value)
def... |
ManimCommunity__manim-2328 | Fade animation blends with background color, even if background is transparent
## Description of bug / unexpected behavior
When playing a FadeOut animation on an MObject, the color of the object interpolates to the background color even when the background is transparent. I encountered this bug when compositing a PNG ... | [
{
"content": "\"\"\"Colors and utility functions for conversion between different color models.\"\"\"\n\n__all__ = [\n \"color_to_rgb\",\n \"color_to_rgba\",\n \"rgb_to_color\",\n \"rgba_to_color\",\n \"rgb_to_hex\",\n \"hex_to_rgb\",\n \"invert_color\",\n \"color_to_int_rgb\",\n \"co... | [
{
"content": "\"\"\"Colors and utility functions for conversion between different color models.\"\"\"\n\n__all__ = [\n \"color_to_rgb\",\n \"color_to_rgba\",\n \"rgb_to_color\",\n \"rgba_to_color\",\n \"rgb_to_hex\",\n \"hex_to_rgb\",\n \"invert_color\",\n \"color_to_int_rgb\",\n \"co... | diff --git a/manim/utils/color.py b/manim/utils/color.py
index 30669fda59..fa48ac693f 100644
--- a/manim/utils/color.py
+++ b/manim/utils/color.py
@@ -491,8 +491,9 @@ def color_to_int_rgb(color: Color) -> np.ndarray:
def color_to_int_rgba(color: Color, opacity: float = 1.0) -> np.ndarray:
- alpha = int(255 * op... |
pallets__click-1695 | Automatic short help should also take linebreak into account
PEP257 defines a summary line for [multi-line docstrings](https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings) just like a [one-line docstring](https://www.python.org/dev/peps/pep-0257/#one-line-docstrings) to be a phrase ending in a period.
Cl... | [
{
"content": "import os\nimport sys\n\nfrom ._compat import _default_text_stderr\nfrom ._compat import _default_text_stdout\nfrom ._compat import _find_binary_writer\nfrom ._compat import auto_wrap_for_ansi\nfrom ._compat import binary_streams\nfrom ._compat import filename_to_ui\nfrom ._compat import get_files... | [
{
"content": "import os\nimport sys\n\nfrom ._compat import _default_text_stderr\nfrom ._compat import _default_text_stdout\nfrom ._compat import _find_binary_writer\nfrom ._compat import auto_wrap_for_ansi\nfrom ._compat import binary_streams\nfrom ._compat import filename_to_ui\nfrom ._compat import get_files... | diff --git a/CHANGES.rst b/CHANGES.rst
index c11d9108d..d86e7cede 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -147,6 +147,8 @@ Unreleased
- Fix formatting when ``Command.options_metavar`` is empty. :pr:`1551`
- The default value passed to ``prompt`` will be cast to the correct
type like an input value woul... |
netbox-community__netbox-12228 | L2VPN Bulk import not setting Tenant field
### NetBox version
v3.4.7
### Python version
3.8
### Steps to Reproduce
1. Go to Overlay -> L2VPNs
2. Click the 'Import' button
3. Fill the Data Import text field with data that has `tenant` column populated
4. Submit the form
### Expected Behavior
Imported L2VPNs sh... | [
{
"content": "from django import forms\nfrom django.contrib.contenttypes.models import ContentType\nfrom django.core.exceptions import ValidationError\nfrom django.utils.translation import gettext as _\n\nfrom dcim.models import Device, Interface, Site\nfrom ipam.choices import *\nfrom ipam.constants import *\n... | [
{
"content": "from django import forms\nfrom django.contrib.contenttypes.models import ContentType\nfrom django.core.exceptions import ValidationError\nfrom django.utils.translation import gettext as _\n\nfrom dcim.models import Device, Interface, Site\nfrom ipam.choices import *\nfrom ipam.constants import *\n... | diff --git a/netbox/ipam/forms/bulk_import.py b/netbox/ipam/forms/bulk_import.py
index 972b98db233..6546722ca36 100644
--- a/netbox/ipam/forms/bulk_import.py
+++ b/netbox/ipam/forms/bulk_import.py
@@ -443,7 +443,8 @@ class L2VPNImportForm(NetBoxModelImportForm):
class Meta:
model = L2VPN
- fields... |
mosaicml__composer-2108 | Less strict numpy version pinning
## 🚀 Feature Request
Allow for newer numpy versions than `<1.23.0`.
## Motivation
Currently, composer fixes numpy to be `'numpy>=1.21.5,<1.23.0'`. This is unfortunate, because other requirements that we use need numpy > 1.23.0, creating an incompatibility.
This was set in #1... | [
{
"content": "# Copyright 2022 MosaicML Composer authors\n# SPDX-License-Identifier: Apache-2.0\n\n\"\"\"Composer package setup.\"\"\"\n\nimport os\nimport site\nimport sys\nimport textwrap\n\nimport setuptools\nfrom setuptools import setup\nfrom setuptools.command.develop import develop as develop_orig\n\n# Re... | [
{
"content": "# Copyright 2022 MosaicML Composer authors\n# SPDX-License-Identifier: Apache-2.0\n\n\"\"\"Composer package setup.\"\"\"\n\nimport os\nimport site\nimport sys\nimport textwrap\n\nimport setuptools\nfrom setuptools import setup\nfrom setuptools.command.develop import develop as develop_orig\n\n# Re... | diff --git a/setup.py b/setup.py
index 40bf7709cb..89e03ce7e6 100644
--- a/setup.py
+++ b/setup.py
@@ -80,7 +80,7 @@ def package_files(prefix: str, directory: str, extension: str):
'torchvision>=0.11.0,<0.15',
'torch>=1.10.0,<1.14',
'requests>=2.26.0,<3',
- 'numpy>=1.21.5,<1.23.0',
+ 'numpy>=1.21.5... |
obspy__obspy-2344 | fdsn EIDA routed client: problem with spammed subprocesses (memory leak)
Issue reported on the users mailing list:
```
I am facing a potential issue with the ObsPy FDSN client. I am using the EIDA
routing client to download waveform data and metadata for many stations. The
way I do it is a simple loop over all s... | [
{
"content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n\"\"\"\nBase class for all FDSN routers.\n\n:copyright:\n The ObsPy Development Team (devs@obspy.org)\n Celso G Reyes, 2017\n IRIS-DMC\n:license:\n GNU Lesser General Public License, Version 3\n (https://www.gnu.org/copyleft/lesser.htm... | [
{
"content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n\"\"\"\nBase class for all FDSN routers.\n\n:copyright:\n The ObsPy Development Team (devs@obspy.org)\n Celso G Reyes, 2017\n IRIS-DMC\n:license:\n GNU Lesser General Public License, Version 3\n (https://www.gnu.org/copyleft/lesser.htm... | diff --git a/CHANGELOG.txt b/CHANGELOG.txt
index b1b49484664..5abcccdd144 100644
--- a/CHANGELOG.txt
+++ b/CHANGELOG.txt
@@ -37,6 +37,8 @@ master:
* make sure that streams fetched via FDSN are properly trimmed to user
requested times if data center serves additional data around the start/end
(see #1887,... |
ckan__ckan-6057 | Activity queries getting slow (~15 seconds) when following entities.
## CKAN version
Tested in 2.9.2 but probably also happening in master
## Describe the bug
`<lib/helpers.py:2567(new_activities)>` spikes to ~15 seconds if the user is following 2 or 3 organizations (with around 200 datasets each) in a ~1000+ data... | [
{
"content": "# encoding: utf-8\n\nimport datetime\n\nfrom sqlalchemy import (\n orm,\n types,\n Column,\n Table,\n ForeignKey,\n desc,\n or_,\n and_,\n union_all,\n text,\n)\n\nfrom ckan.common import config\nimport ckan.model\nfrom ckan.model import meta\nfrom ckan.model import d... | [
{
"content": "# encoding: utf-8\n\nimport datetime\n\nfrom sqlalchemy import (\n orm,\n types,\n Column,\n Table,\n ForeignKey,\n desc,\n or_,\n and_,\n union_all,\n text,\n)\n\nfrom ckan.common import config\nimport ckan.model\nfrom ckan.model import meta\nfrom ckan.model import d... | diff --git a/changes/6028.bugfix b/changes/6028.bugfix
new file mode 100644
index 00000000000..2bbd9faf175
--- /dev/null
+++ b/changes/6028.bugfix
@@ -0,0 +1 @@
+Fix performance bottleneck in activity queries
diff --git a/ckan/model/activity.py b/ckan/model/activity.py
index a1cada55c90..12ac4b9c631 100644
--- a/ckan/m... |
obspy__obspy-2204 | Cartopy local projection for south hemisphere.
Hi,
There is a misbehavior on the local projection option on the South hemisphere using cartopy:
Test code as follow:
```
import matplotlib.pyplot as plt
import obspy
from obspy.clients.fdsn import Client
auspass = Client("http://auspass.edu.au:8080")
station... | [
{
"content": "# -*- coding: utf-8 -*-\n\"\"\"\nModule for basemap related plotting in ObsPy.\n\n:copyright:\n The ObsPy Development Team (devs@obspy.org)\n:license:\n GNU Lesser General Public License, Version 3\n (https://www.gnu.org/copyleft/lesser.html)\n\"\"\"\nfrom __future__ import (absolute_impo... | [
{
"content": "# -*- coding: utf-8 -*-\n\"\"\"\nModule for basemap related plotting in ObsPy.\n\n:copyright:\n The ObsPy Development Team (devs@obspy.org)\n:license:\n GNU Lesser General Public License, Version 3\n (https://www.gnu.org/copyleft/lesser.html)\n\"\"\"\nfrom __future__ import (absolute_impo... | diff --git a/CHANGELOG.txt b/CHANGELOG.txt
index de4973fde94..5850c9afe37 100644
--- a/CHANGELOG.txt
+++ b/CHANGELOG.txt
@@ -26,6 +26,8 @@
- obspy.imaging:
* Normalize moment tensors prior to plotting in the mopad wrapper to
stabilize the algorithm (see #2114, #2125).
+ * fix some map plotting issues with... |
bokeh__bokeh-10308 | bokehjs' version has duplicated dev suffix
```sh
$ jq '.version' bokehjs/package.json
"2.2.0dev4-dev.4"
```
Should be `2.2.0-dev.4` instead.
| [
{
"content": "# -----------------------------------------------------------------------------\n# Copyright (c) 2012 - 2020, Anaconda, Inc., and Bokeh Contributors.\n# All rights reserved.\n#\n# The full license is in the file LICENSE.txt, distributed with this software.\n# --------------------------------------... | [
{
"content": "# -----------------------------------------------------------------------------\n# Copyright (c) 2012 - 2020, Anaconda, Inc., and Bokeh Contributors.\n# All rights reserved.\n#\n# The full license is in the file LICENSE.txt, distributed with this software.\n# --------------------------------------... | diff --git a/ci/environment-test-3.6.yml b/ci/environment-test-3.6.yml
index feb684fac01..b9556657501 100644
--- a/ci/environment-test-3.6.yml
+++ b/ci/environment-test-3.6.yml
@@ -28,7 +28,7 @@ dependencies:
- flaky
- geckodriver
- ipython
- - isort >=4.3.21
+ - isort <5.0
- mock
- mypy
- nbconvert... |
akvo__akvo-rsr-2604 | urgent: projects missing iggwater.akvoapp.org
Created via Reamaze:
Link: https://rsrsupport.reamaze.com/admin/conversations/urgent-projects-missing-iggwater-dot-akvoapp-dot-org
Assignee: Anthony Gonzalez
Message:
Hi RSR-team,
Just wanted to visit iggwater.akvoapp.org, but somehow all projects that were previ... | [
{
"content": "# -*- coding: utf-8 -*-\n\"\"\"\nAkvo RSR is covered by the GNU Affero General Public License.\n\nSee more details in the license.txt file located at the root folder of the\nAkvo RSR module. For additional details on the GNU license please see\n< http://www.gnu.org/licenses/agpl.html >.\n\"\"\"\n\... | [
{
"content": "# -*- coding: utf-8 -*-\n\"\"\"\nAkvo RSR is covered by the GNU Affero General Public License.\n\nSee more details in the license.txt file located at the root folder of the\nAkvo RSR module. For additional details on the GNU license please see\n< http://www.gnu.org/licenses/agpl.html >.\n\"\"\"\n\... | diff --git a/akvo/rsr/tests/views/test_project.py b/akvo/rsr/tests/views/test_project.py
index 9581530c89..7aeb31a7fd 100644
--- a/akvo/rsr/tests/views/test_project.py
+++ b/akvo/rsr/tests/views/test_project.py
@@ -15,7 +15,7 @@
from django.conf import settings
from django.test import Client, TestCase
-from akvo.rs... |
rucio__rucio-2776 | Account and Scope new types
Motivation
----------
For multi-vo the internal representation of scope and account will need to be different from the external representation. The translations for these should be done in a consistent way and this can be prepared beforehand.
Modification
------------
Create a new t... | [
{
"content": "\n'''\nThis file is automatically generated; Do not edit it. :)\n'''\nVERSION_INFO = {\n 'final': True,\n 'version': '1.20.3',\n 'branch_nick': 'patch-0-Release__Rucio_1_20_3_preparation',\n 'revision_id': 'f05e019f7178590718bf3f1eee415cc46cb59159',\n 'revno': 8410\n}\n",
"path"... | [
{
"content": "\n'''\nThis file is automatically generated; Do not edit it. :)\n'''\nVERSION_INFO = {\n 'final': True,\n 'version': '1.20.4rc1',\n 'branch_nick': 'patch-0-Release__1_20_4rc1_preparation',\n 'revision_id': '525812b8f83f1069d38ab78aebedb732f21e77ec',\n 'revno': 8418\n}\n",
"path"... | diff --git a/doc/source/releasenotes/1.20.4rc1.rst b/doc/source/releasenotes/1.20.4rc1.rst
new file mode 100644
index 0000000000..4be3659cb5
--- /dev/null
+++ b/doc/source/releasenotes/1.20.4rc1.rst
@@ -0,0 +1,20 @@
+=========
+1.20.4rc1
+=========
+
+-------
+General
+-------
+
+************
+Enhancements
+***********... |
dotkom__onlineweb4-165 | Adding 'Offline Informasjonstekster' causes error
Not really sure what this does but it casts an error saying:
Exception Type: IntegrityError
Exception Value: column key is not unique
| [
{
"content": "from apps.offline.models import ProxyChunk, Issue\nfrom chunks.models import Chunk\nfrom django.contrib import admin\nfrom django.db.models import Q\n\n\nclass ProxyChunkAdmin(admin.ModelAdmin):\n\n readonly_fields = ['key']\n\n def queryset(self, request):\n offline = Chunk.objects.f... | [
{
"content": "from apps.offline.models import ProxyChunk, Issue\nfrom chunks.models import Chunk\nfrom django.contrib import admin\nfrom django.db.models import Q\n\n\nclass ProxyChunkAdmin(admin.ModelAdmin):\n\n readonly_fields = ['key']\n\n def has_add_permission(self, request):\n return False\n\... | diff --git a/apps/offline/admin.py b/apps/offline/admin.py
index c4fc6e020..8ec805833 100644
--- a/apps/offline/admin.py
+++ b/apps/offline/admin.py
@@ -8,6 +8,9 @@ class ProxyChunkAdmin(admin.ModelAdmin):
readonly_fields = ['key']
+ def has_add_permission(self, request):
+ return False
+
def qu... |
PyGithub__PyGithub-2460 | 401 unauthorized after upgrading to 1.58.0
We use `GithubIntegration.get_access_token` to authenticate and after upgrading we now get this response:
```
github.GithubException.GithubException: 401 {"message": "'Expiration time' claim ('exp') must be a numeric value representing the future time at which the assertio... | [
{
"content": "import time\n\nimport deprecated\nimport jwt\n\nfrom github import Consts\nfrom github.GithubException import GithubException\nfrom github.Installation import Installation\nfrom github.InstallationAuthorization import InstallationAuthorization\nfrom github.PaginatedList import PaginatedList\nfrom ... | [
{
"content": "import time\n\nimport deprecated\nimport jwt\n\nfrom github import Consts\nfrom github.GithubException import GithubException\nfrom github.Installation import Installation\nfrom github.InstallationAuthorization import InstallationAuthorization\nfrom github.PaginatedList import PaginatedList\nfrom ... | diff --git a/github/GithubIntegration.py b/github/GithubIntegration.py
index 82c85bc9c2..475a6c0f7a 100644
--- a/github/GithubIntegration.py
+++ b/github/GithubIntegration.py
@@ -135,6 +135,7 @@ def get_access_token(self, installation_id, permissions=None):
headers, response = self.__requester.requestJsonAndCh... |
cobbler__cobbler-3292 | Cobbler modules don't load properly
### Describe the bug
Introduced in https://github.com/cobbler/cobbler/commit/2477c78094af7ba44ecbe350294c775296d96560
### Steps to reproduce
1. Import any Cobbler Module
2. See import error
### Expected behavior
Bug not present
### Cobbler version
````paste belo... | [
{
"content": "\"\"\"\nModule loader, adapted for Cobbler usage\n\"\"\"\n\n# SPDX-License-Identifier: GPL-2.0-or-later\n# SPDX-FileCopyrightText: Copyright 2006-2009, Red Hat, Inc and Others\n# SPDX-FileCopyrightText: Adrian Likins <alikins@redhat.com>\n# SPDX-FileCopyrightText: Michael DeHaan <michael.dehaan AT... | [
{
"content": "\"\"\"\nModule loader, adapted for Cobbler usage\n\"\"\"\n\n# SPDX-License-Identifier: GPL-2.0-or-later\n# SPDX-FileCopyrightText: Copyright 2006-2009, Red Hat, Inc and Others\n# SPDX-FileCopyrightText: Adrian Likins <alikins@redhat.com>\n# SPDX-FileCopyrightText: Michael DeHaan <michael.dehaan AT... | diff --git a/cobbler/module_loader.py b/cobbler/module_loader.py
index 88765c3094..801223cf41 100644
--- a/cobbler/module_loader.py
+++ b/cobbler/module_loader.py
@@ -63,7 +63,7 @@ def load_modules(self):
basename = filename.replace(self.mod_path, "")
modname = ""
- if basename in... |
django-oscar__django-oscar-2130 | Broken sandbox gateway page
The README states that dashboard users for the sandbox site could be created using [this gateway page](http://latest.oscarcommerce.com/gateway/) - however this link returns a django error page:
```
TemplateDoesNotExist at /de/gateway/
gateway/form.html
```
| [
{
"content": "import os\n\nimport oscar\n\n# Path helper\nlocation = lambda x: os.path.join(\n os.path.dirname(os.path.realpath(__file__)), x)\n\nDEBUG = os.environ.get('DEBUG', 'true') != 'false'\nSQL_DEBUG = DEBUG\n\nALLOWED_HOSTS = [\n 'latest.oscarcommerce.com',\n 'master.oscarcommerce.com'\n]\n\n#... | [
{
"content": "import os\n\nimport oscar\n\n# Path helper\nlocation = lambda x: os.path.join(\n os.path.dirname(os.path.realpath(__file__)), x)\n\nDEBUG = os.environ.get('DEBUG', 'true') != 'false'\nSQL_DEBUG = DEBUG\n\nALLOWED_HOSTS = [\n 'latest.oscarcommerce.com',\n 'master.oscarcommerce.com'\n]\n\n#... | diff --git a/sites/sandbox/settings.py b/sites/sandbox/settings.py
index 0f395d12a56..fa2fcf1e11b 100644
--- a/sites/sandbox/settings.py
+++ b/sites/sandbox/settings.py
@@ -123,7 +123,7 @@
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [
- location('_site/templ... |
freedomofpress__securedrop-359 | securedrop_init script in Tails doesn't work right if you run it twice
It appends torrc-additions to torrc multiple times, and it should just append it once.
securedrop_init script in Tails doesn't work right if you run it twice
It appends torrc-additions to torrc multiple times, and it should just append it once.
| [
{
"content": "#!/usr/bin/env python\n\nimport os, sys, subprocess\n\nif __name__ == '__main__':\n # check for root\n if not os.geteuid()==0:\n sys.exit('You need to run this as root')\n\n # paths\n path_torrc_additions = '/home/amnesia/Persistent/.securedrop/torrc_additions'\n path_torrc_b... | [
{
"content": "#!/usr/bin/env python\n\nimport os, sys, subprocess\n\nif __name__ == '__main__':\n # check for root\n if not os.geteuid()==0:\n sys.exit('You need to run this as root')\n\n # paths\n path_torrc_additions = '/home/amnesia/Persistent/.securedrop/torrc_additions'\n path_torrc_b... | diff --git a/tails_files/securedrop_init.py b/tails_files/securedrop_init.py
index 1c43513917..c9b9e2d7bd 100644
--- a/tails_files/securedrop_init.py
+++ b/tails_files/securedrop_init.py
@@ -31,7 +31,7 @@
open(path_torrc_backup, 'w').write(torrc)
# append the additions
- open(path_torrc, 'a').write(t... |
liqd__a4-meinberlin-951 | Projectcontainer active projects count broken
https://mein.berlin.de/projects/stadtforum-berlin-wohnen/
shows `7 of 4` active projects.
| [
{
"content": "from django.db import models\nfrom django.utils import timezone\nfrom django.utils.translation import ugettext_lazy as _\n\nfrom adhocracy4.projects import models as project_models\n\n\nclass ProjectContainer(project_models.Project):\n projects = models.ManyToManyField(\n project_models.... | [
{
"content": "from django.db import models\nfrom django.utils import timezone\nfrom django.utils.translation import ugettext_lazy as _\n\nfrom adhocracy4.projects import models as project_models\n\n\nclass ProjectContainer(project_models.Project):\n projects = models.ManyToManyField(\n project_models.... | diff --git a/meinberlin/apps/projectcontainers/models.py b/meinberlin/apps/projectcontainers/models.py
index dc3a40aac3..4919b720f0 100644
--- a/meinberlin/apps/projectcontainers/models.py
+++ b/meinberlin/apps/projectcontainers/models.py
@@ -21,7 +21,7 @@ def active_projects(self):
now = timezone.now()
... |
svthalia__concrexit-3136 | Liked photos API returns duplicate photos on different api requests
### Describe the bug
Different pages of the liked photos API return the same photo
### How to reproduce
Difficult, this is using @JeeVee11's account as I could not reproduce it.
https://staging.thalia.nu/api/v2/photos/photos/liked/?limit=10&of... | [
{
"content": "from django.db.models import Count, Prefetch, Q\n\nfrom oauth2_provider.contrib.rest_framework import IsAuthenticatedOrTokenHasScope\nfrom rest_framework import filters, status\nfrom rest_framework.exceptions import PermissionDenied\nfrom rest_framework.generics import ListAPIView, RetrieveAPIView... | [
{
"content": "from django.db.models import Count, Prefetch, Q\n\nfrom oauth2_provider.contrib.rest_framework import IsAuthenticatedOrTokenHasScope\nfrom rest_framework import filters, status\nfrom rest_framework.exceptions import PermissionDenied\nfrom rest_framework.generics import ListAPIView, RetrieveAPIView... | diff --git a/website/photos/api/v2/views.py b/website/photos/api/v2/views.py
index ae3589829..10272b20d 100644
--- a/website/photos/api/v2/views.py
+++ b/website/photos/api/v2/views.py
@@ -105,6 +105,8 @@ def get_queryset(self):
member_likes=Count("likes", filter=Q(likes__member=self.request.member))
... |
bentoml__BentoML-1233 | Respect Docker env variables when creating docker API client in bentoml containerize
**Is your feature request related to a problem? Please describe.**
When building Docker images for a private Docker registry, Docker authentication is required. However, since BentoML uses `docker.APIClient()` instead of `docker.from... | [
{
"content": "import click\nimport sys\nimport os\nimport json\nimport re\nimport psutil\n\nfrom bentoml import __version__\nfrom bentoml.utils.lazy_loader import LazyLoader\nfrom bentoml.utils.s3 import is_s3_url\nfrom bentoml.utils.gcs import is_gcs_url\nfrom bentoml.server.api_server import BentoAPIServer\nf... | [
{
"content": "import click\nimport sys\nimport os\nimport json\nimport re\nimport psutil\n\nfrom bentoml import __version__\nfrom bentoml.utils.lazy_loader import LazyLoader\nfrom bentoml.utils.s3 import is_s3_url\nfrom bentoml.utils.gcs import is_gcs_url\nfrom bentoml.server.api_server import BentoAPIServer\nf... | diff --git a/bentoml/cli/bento_service.py b/bentoml/cli/bento_service.py
index 184280a86ea..4cfd078debe 100644
--- a/bentoml/cli/bento_service.py
+++ b/bentoml/cli/bento_service.py
@@ -406,7 +406,7 @@ def containerize(bento, push, tag, build_arg, username, password):
import docker
- docker_api = doc... |
DataDog__dd-agent-1047 | Windows agent connection error
agent version: 4.4
OS: Windows 2008 Standard, SP2.
case: https://datadog.desk.com/agent/case/11902
- log snippet:
> 2014-06-24 13:45:04 Eastern Daylight Time | ERROR | forwarder(ddagent.pyc:240) | Response: HTTPResponse(_body=None,buffer=None,code=599,effective_url='https://app.datadoghq... | [
{
"content": "import platform\nimport sys\nfrom config import get_version\nfrom jmxfetch import JMX_FETCH_JAR_NAME\n\ntry:\n from setuptools import setup, find_packages\n\n # required to build the cython extensions\n from distutils.extension import Extension #pylint: disable=no-name-in-module\n\nexcept... | [
{
"content": "import platform\nimport sys\nfrom config import *\nfrom jmxfetch import JMX_FETCH_JAR_NAME\n\ntry:\n from setuptools import setup, find_packages\n\n # required to build the cython extensions\n from distutils.extension import Extension #pylint: disable=no-name-in-module\n\nexcept ImportErr... | diff --git a/packaging/datadog-agent/win32/build.ps1 b/packaging/datadog-agent/win32/build.ps1
index 3c96964d17..b42d44d3a1 100644
--- a/packaging/datadog-agent/win32/build.ps1
+++ b/packaging/datadog-agent/win32/build.ps1
@@ -3,6 +3,7 @@ $version = "$(python -c "from config import get_version; print get_version()").$
... |
DDMAL__CantusDB-1116 | Admin Area, Change Source page: we should hide "Source Status" field
Debra got tripped up trying to publish a source - instead of checking the "Published" checkbox, she selected something in the "Source Status" dropdown.
~~Everything regarding source visibility is handled by our `published` field, so I think "Source... | [
{
"content": "from django.contrib import admin\nfrom main_app.models import *\nfrom main_app.forms import (\n AdminCenturyForm,\n AdminChantForm,\n AdminFeastForm,\n AdminGenreForm,\n AdminNotationForm,\n AdminOfficeForm,\n AdminProvenanceForm,\n AdminRismSiglumForm,\n AdminSegmentFor... | [
{
"content": "from django.contrib import admin\nfrom main_app.models import *\nfrom main_app.forms import (\n AdminCenturyForm,\n AdminChantForm,\n AdminFeastForm,\n AdminGenreForm,\n AdminNotationForm,\n AdminOfficeForm,\n AdminProvenanceForm,\n AdminRismSiglumForm,\n AdminSegmentFor... | diff --git a/django/cantusdb_project/main_app/admin.py b/django/cantusdb_project/main_app/admin.py
index 1049cd088..10a74b371 100644
--- a/django/cantusdb_project/main_app/admin.py
+++ b/django/cantusdb_project/main_app/admin.py
@@ -172,6 +172,8 @@ def get_source_siglum(self, obj):
class SourceAdmin(BaseModelAdmin... |
learningequality__kolibri-6490 | Importing more content (or deleting resources) to a channel undoes its original position in channel list
<!--
Instructions:
* Fill out the sections below, replace …'s with information about your issue
* Use the 'preview' function above this text box to verify formatting before submitting
-->
### Observed behav... | [
{
"content": "import datetime\nimport logging\nimport os\n\nfrom django.db.models import Sum\nfrom le_utils.constants import content_kinds\nfrom sqlalchemy import and_\nfrom sqlalchemy import cast\nfrom sqlalchemy import exists\nfrom sqlalchemy import func\nfrom sqlalchemy import Integer\nfrom sqlalchemy import... | [
{
"content": "import datetime\nimport logging\nimport os\n\nfrom django.db.models import Sum\nfrom le_utils.constants import content_kinds\nfrom sqlalchemy import and_\nfrom sqlalchemy import cast\nfrom sqlalchemy import exists\nfrom sqlalchemy import func\nfrom sqlalchemy import Integer\nfrom sqlalchemy import... | diff --git a/kolibri/core/content/utils/annotation.py b/kolibri/core/content/utils/annotation.py
index f06a9c1e09c..c2c6f3d0924 100644
--- a/kolibri/core/content/utils/annotation.py
+++ b/kolibri/core/content/utils/annotation.py
@@ -478,6 +478,8 @@ def calculate_next_order(channel, model=ChannelMetadata):
latest_o... |
rlworkgroup__garage-692 | Add Intel-optimized version of the package
| [
{
"content": "from setuptools import find_packages\nfrom setuptools import setup\n\n# Required dependencies\nrequired = [\n # Please keep alphabetized\n 'akro',\n 'boto3',\n 'cached_property',\n 'click',\n 'cloudpickle',\n 'cma==1.1.06',\n # dm_control throws an error during install abou... | [
{
"content": "from setuptools import find_packages\nfrom setuptools import setup\n\n# Required dependencies\nrequired = [\n # Please keep alphabetized\n 'akro',\n 'boto3',\n 'cached_property',\n 'click',\n 'cloudpickle',\n 'cma==1.1.06',\n # dm_control throws an error during install abou... | diff --git a/Makefile b/Makefile
index 66b971f473..1b95fa4c68 100644
--- a/Makefile
+++ b/Makefile
@@ -67,6 +67,14 @@ build-nvidia: docker/docker-compose-nvidia.yml
build \
${ADD_ARGS}
+build-intel: TAG ?= rlworkgroup/garage-intel:latest
+build-intel: docker/docker-compose-intel.yml
+ TAG=${TAG} \
+ docker-comp... |
ansible__ansible-modules-extras-3479 | Remove ESXi hostname requirement from vmware_guest module
##### ISSUE TYPE
- Feature Idea
##### COMPONENT NAME
vmware_guest
##### ANSIBLE VERSION
```
ansible 2.3.0.0
config file = /etc/ansible/ansible.cfg
configured module search path = Default w/o overrides
```
##### CONFIGURATION
<!---
Vanill... | [
{
"content": "#!/usr/bin/python\n# -*- coding: utf-8 -*-\n# This file is part of Ansible\n#\n# Ansible is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your ... | [
{
"content": "#!/usr/bin/python\n# -*- coding: utf-8 -*-\n# This file is part of Ansible\n#\n# Ansible is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your ... | diff --git a/cloud/vmware/vmware_guest.py b/cloud/vmware/vmware_guest.py
index cc520432de4..2a749bda674 100644
--- a/cloud/vmware/vmware_guest.py
+++ b/cloud/vmware/vmware_guest.py
@@ -88,7 +88,7 @@
esxi_hostname:
description:
- The esxi hostname where the VM will run.
- required: True
... |
pyro-ppl__numpyro-1589 | mnist loader should not scale the label
Scaling the label as in [this line](https://github.com/pyro-ppl/numpyro/blob/db2913b61b1d82fcad6662eb4d25ce5808f46d00/numpyro/examples/datasets.py#L167) seems wrong to me.
| [
{
"content": "# Copyright Contributors to the Pyro project.\n# SPDX-License-Identifier: Apache-2.0\n\nfrom collections import namedtuple\nimport csv\nimport gzip\nimport io\nimport os\nimport pickle\nimport struct\nfrom urllib.parse import urlparse\nfrom urllib.request import urlretrieve\nimport warnings\nimpor... | [
{
"content": "# Copyright Contributors to the Pyro project.\n# SPDX-License-Identifier: Apache-2.0\n\nfrom collections import namedtuple\nimport csv\nimport gzip\nimport io\nimport os\nimport pickle\nimport struct\nfrom urllib.parse import urlparse\nfrom urllib.request import urlretrieve\nimport warnings\nimpor... | diff --git a/numpyro/examples/datasets.py b/numpyro/examples/datasets.py
index 927e60b3a..f04a56b3c 100644
--- a/numpyro/examples/datasets.py
+++ b/numpyro/examples/datasets.py
@@ -164,7 +164,7 @@ def _load_mnist():
def read_label(file):
with gzip.open(file, "rb") as f:
f.read(8)
- ... |
pulp__pulpcore-4293 | Querying content in repository versions with lots of content is slow
**Version**
All
**Describe the bug**
When a repository version has upwards of 50k content in it, querying the content in the repository using `repo_version.get_content()` becomes extremely slow. In my testing the results haven't been consistent, ... | [
{
"content": "\"\"\"\nRepository related Django models.\n\"\"\"\nfrom contextlib import suppress\nfrom gettext import gettext as _\nfrom os import path\nfrom collections import defaultdict\nimport logging\n\nimport django\nfrom asyncio_throttle import Throttler\nfrom django.conf import settings\nfrom django.con... | [
{
"content": "\"\"\"\nRepository related Django models.\n\"\"\"\nfrom contextlib import suppress\nfrom gettext import gettext as _\nfrom os import path\nfrom collections import defaultdict\nimport logging\n\nimport django\nfrom asyncio_throttle import Throttler\nfrom django.conf import settings\nfrom django.con... | diff --git a/CHANGES/3969.bugfix b/CHANGES/3969.bugfix
new file mode 100644
index 0000000000..c283c14070
--- /dev/null
+++ b/CHANGES/3969.bugfix
@@ -0,0 +1 @@
+Improved the performance when looking up content for repository versions.
diff --git a/pulpcore/app/models/repository.py b/pulpcore/app/models/repository.py
ind... |
pulp__pulpcore-4275 | Querying content in repository versions with lots of content is slow
**Version**
All
**Describe the bug**
When a repository version has upwards of 50k content in it, querying the content in the repository using `repo_version.get_content()` becomes extremely slow. In my testing the results haven't been consistent, ... | [
{
"content": "\"\"\"\nRepository related Django models.\n\"\"\"\nfrom contextlib import suppress\nfrom gettext import gettext as _\nfrom os import path\nfrom collections import defaultdict\nimport logging\n\nimport django\nfrom asyncio_throttle import Throttler\nfrom django.conf import settings\nfrom django.con... | [
{
"content": "\"\"\"\nRepository related Django models.\n\"\"\"\nfrom contextlib import suppress\nfrom gettext import gettext as _\nfrom os import path\nfrom collections import defaultdict\nimport logging\n\nimport django\nfrom asyncio_throttle import Throttler\nfrom django.conf import settings\nfrom django.con... | diff --git a/CHANGES/3969.bugfix b/CHANGES/3969.bugfix
new file mode 100644
index 0000000000..c283c14070
--- /dev/null
+++ b/CHANGES/3969.bugfix
@@ -0,0 +1 @@
+Improved the performance when looking up content for repository versions.
diff --git a/pulpcore/app/models/repository.py b/pulpcore/app/models/repository.py
ind... |
rucio__rucio-6440 | gfal RSE protocol ignores the verify_checksum attribute
The protocol raises an exception even if the attribute is set to false:
https://github.com/rucio/rucio/blob/436ecc9005934e1e4332cd2718d160bdbf5105d2/lib/rucio/rse/protocols/gfal.py#L413
| [
{
"content": "# -*- coding: utf-8 -*-\n# Copyright European Organization for Nuclear Research (CERN) since 2012\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://w... | [
{
"content": "# -*- coding: utf-8 -*-\n# Copyright European Organization for Nuclear Research (CERN) since 2012\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://w... | diff --git a/lib/rucio/rse/protocols/gfal.py b/lib/rucio/rse/protocols/gfal.py
index 580cddaf60..127f11864d 100644
--- a/lib/rucio/rse/protocols/gfal.py
+++ b/lib/rucio/rse/protocols/gfal.py
@@ -394,6 +394,9 @@ def stat(self, path):
ret['filesize'] = stats[7]
+ if not self.rse.get('verify_checksum',... |
pulp__pulpcore-4405 | Querying content in repository versions with lots of content is slow
**Version**
All
**Describe the bug**
When a repository version has upwards of 50k content in it, querying the content in the repository using `repo_version.get_content()` becomes extremely slow. In my testing the results haven't been consistent, ... | [
{
"content": "\"\"\"\nRepository related Django models.\n\"\"\"\nfrom contextlib import suppress\nfrom gettext import gettext as _\nfrom os import path\nfrom collections import defaultdict\nimport logging\n\nimport django\nfrom asyncio_throttle import Throttler\nfrom dynaconf import settings\nfrom django.core.v... | [
{
"content": "\"\"\"\nRepository related Django models.\n\"\"\"\nfrom contextlib import suppress\nfrom gettext import gettext as _\nfrom os import path\nfrom collections import defaultdict\nimport logging\n\nimport django\nfrom asyncio_throttle import Throttler\nfrom dynaconf import settings\nfrom django.core.v... | diff --git a/CHANGES/3969.bugfix b/CHANGES/3969.bugfix
new file mode 100644
index 0000000000..c283c14070
--- /dev/null
+++ b/CHANGES/3969.bugfix
@@ -0,0 +1 @@
+Improved the performance when looking up content for repository versions.
diff --git a/pulpcore/app/models/repository.py b/pulpcore/app/models/repository.py
ind... |
spotify__luigi-1494 | Python 3.5 support
Luigi may already work with Python 3.5, but since the README doesn't mention it I thought I'd ask.
Does Luigi support Python 3.5?
| [
{
"content": "# Copyright (c) 2012 Spotify AB\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\"); you may not\n# use this file except in compliance with the License. You may obtain a copy of\n# the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicabl... | [
{
"content": "# Copyright (c) 2012 Spotify AB\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\"); you may not\n# use this file except in compliance with the License. You may obtain a copy of\n# the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicabl... | diff --git a/.travis.yml b/.travis.yml
index 1cf88120f2..f7e3c9a0ac 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -30,6 +30,17 @@ env:
- TOXENV=py27-postgres
- TOXENV=visualiser
+# Python 3.5 has to go here until Travis adds it to the default build images.
+# https://github.com/travis-ci/travis-ci/issues/47... |
coala__coala-6088 | Small typo in coalib/output/printers/LogPrinter.py
Should read responsibility instead of reponsibility.
| [
{
"content": "import traceback\nimport logging\n\nfrom coalib.output.printers.LOG_LEVEL import LOG_LEVEL\nfrom coalib.processes.communication.LogMessage import LogMessage\n\n\nclass LogPrinterMixin:\n \"\"\"\n Provides access to the logging interfaces (e.g. err, warn, info) by routing\n them to the log... | [
{
"content": "import traceback\nimport logging\n\nfrom coalib.output.printers.LOG_LEVEL import LOG_LEVEL\nfrom coalib.processes.communication.LogMessage import LogMessage\n\n\nclass LogPrinterMixin:\n \"\"\"\n Provides access to the logging interfaces (e.g. err, warn, info) by routing\n them to the log... | diff --git a/coalib/output/printers/LogPrinter.py b/coalib/output/printers/LogPrinter.py
index 21f3e62495..1e389cbb0d 100644
--- a/coalib/output/printers/LogPrinter.py
+++ b/coalib/output/printers/LogPrinter.py
@@ -85,7 +85,7 @@ def log_exception(self,
def log_message(self, log_message, **kwargs):
"""
-... |
fossasia__open-event-server-3901 | Handle invalid data while change data types during migrations
**Related error:**
```
sqlalchemy.exc.IntegrityError: (psycopg2.IntegrityError) column "pdf_url" contains null values
[SQL: 'ALTER TABLE ticket_holders ADD COLUMN pdf_url VARCHAR NOT NULL']
```
Due to this, migration are not running on `api.eventyay... | [
{
"content": "\"\"\"empty message\n\nRevision ID: c6b183975be9\nRevises: ccd80550c01f\nCreate Date: 2017-06-12 00:42:29.329727\n\n\"\"\"\n\n# revision identifiers, used by Alembic.\nrevision = 'c6b183975be9'\ndown_revision = 'ccd80550c01f'\n\nfrom alembic import op\nimport sqlalchemy as sa\nimport sqlalchemy_ut... | [
{
"content": "\"\"\"empty message\n\nRevision ID: c6b183975be9\nRevises: ccd80550c01f\nCreate Date: 2017-06-12 00:42:29.329727\n\n\"\"\"\n\n# revision identifiers, used by Alembic.\nrevision = 'c6b183975be9'\ndown_revision = 'ccd80550c01f'\n\nfrom alembic import op\nimport sqlalchemy as sa\nimport sqlalchemy_ut... | diff --git a/migrations/versions/c6b183975be9_.py b/migrations/versions/c6b183975be9_.py
index 3c37eb1b2f..ec4e835fe9 100644
--- a/migrations/versions/c6b183975be9_.py
+++ b/migrations/versions/c6b183975be9_.py
@@ -17,7 +17,7 @@
def upgrade():
# ### commands auto generated by Alembic - please adjust! ###
- o... |
xonsh__xonsh-3136 | xonsh sudoedit (nano as root) queues up lines of keystrokes
## xonfig
<details>
```
jimbo1qaz@manjaro ~ $ xonfig
+------------------+-----------------+
| xonsh | 0.9.0 |
| Python | 3.7.3 |
| PLY | 3.11 |
| have readline | True |
|... | [
{
"content": "# -*- coding: utf-8 -*-\n\"\"\"Module for caching command & alias names as well as for predicting whether\na command will be able to be run in the background.\n\nA background predictor is a function that accepts a single argument list\nand returns whether or not the process can be run in the backg... | [
{
"content": "# -*- coding: utf-8 -*-\n\"\"\"Module for caching command & alias names as well as for predicting whether\na command will be able to be run in the background.\n\nA background predictor is a function that accepts a single argument list\nand returns whether or not the process can be run in the backg... | diff --git a/news/unthread-sudoedit.rst b/news/unthread-sudoedit.rst
new file mode 100644
index 0000000000..3a924b44b9
--- /dev/null
+++ b/news/unthread-sudoedit.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+* <news item>
+
+**Changed:**
+
+* sudoedit now runs unthreaded
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <... |
nautobot__nautobot-5656 | serve-docs Doesn't Stop on Invoke stop
<!--
NOTE: IF YOUR ISSUE DOES NOT FOLLOW THIS TEMPLATE, IT WILL BE CLOSED.
This form is only for reporting reproducible bugs. If you need assistance
with Nautobot installation, or if you have a general question, please start a
discussion instead: https://gith... | [
{
"content": "\"\"\"Tasks for use with Invoke.\n\n(c) 2020-2021 Network To Code\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n http://www.apache.org/licenses/LICENSE-2.0\nUnless requ... | [
{
"content": "\"\"\"Tasks for use with Invoke.\n\n(c) 2020-2021 Network To Code\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n http://www.apache.org/licenses/LICENSE-2.0\nUnless requ... | diff --git a/changes/5637.housekeeping b/changes/5637.housekeeping
new file mode 100644
index 00000000000..6e6c2fb8fd5
--- /dev/null
+++ b/changes/5637.housekeeping
@@ -0,0 +1,2 @@
+Removed "version" from development `docker-compose.yml` files as newer versions of Docker complain about it being obsolete.
+Fixed behavio... |
pypa__pipenv-1086 | pipenv broken
Occurred in 44053b52bbbda1884edd12baecbe7f3c4d251c98
could be because im on python 2 and FileNotFoundError doesnt exist? or maybe it just needs `from os import FileNotFoundError`
| [
{
"content": "# -*- coding: utf-8 -*-\nfrom collections import namedtuple\nimport os\nimport hashlib\nimport tempfile\nimport sys\nimport shutil\nimport logging\n\nimport click\nimport crayons\nimport delegator\nimport pip\nimport parse\nimport requirements\nimport fuzzywuzzy.process\nimport requests\nimport si... | [
{
"content": "# -*- coding: utf-8 -*-\nfrom collections import namedtuple\nimport os\nimport hashlib\nimport tempfile\nimport sys\nimport shutil\nimport logging\n\nimport click\nimport crayons\nimport delegator\nimport pip\nimport parse\nimport requirements\nimport fuzzywuzzy.process\nimport requests\nimport si... | diff --git a/pipenv/utils.py b/pipenv/utils.py
index ca2e03e1d2..e1f8de2ed8 100644
--- a/pipenv/utils.py
+++ b/pipenv/utils.py
@@ -1060,7 +1060,7 @@ def touch_update_stamp():
mkdir_p(PIPENV_CACHE_DIR)
p = os.sep.join((PIPENV_CACHE_DIR, '.pipenv_update_check'))
try:
- os.utime(p)
- except FileNo... |
pulp__pulpcore-4290 | Querying content in repository versions with lots of content is slow
**Version**
All
**Describe the bug**
When a repository version has upwards of 50k content in it, querying the content in the repository using `repo_version.get_content()` becomes extremely slow. In my testing the results haven't been consistent, ... | [
{
"content": "\"\"\"\nRepository related Django models.\n\"\"\"\nfrom contextlib import suppress\nfrom gettext import gettext as _\nfrom os import path, environ\nfrom collections import defaultdict\nimport logging\n\nimport django\nfrom asyncio_throttle import Throttler\nfrom dynaconf import settings\nfrom djan... | [
{
"content": "\"\"\"\nRepository related Django models.\n\"\"\"\nfrom contextlib import suppress\nfrom gettext import gettext as _\nfrom os import path, environ\nfrom collections import defaultdict\nimport logging\n\nimport django\nfrom asyncio_throttle import Throttler\nfrom dynaconf import settings\nfrom djan... | diff --git a/CHANGES/3969.bugfix b/CHANGES/3969.bugfix
new file mode 100644
index 0000000000..c283c14070
--- /dev/null
+++ b/CHANGES/3969.bugfix
@@ -0,0 +1 @@
+Improved the performance when looking up content for repository versions.
diff --git a/pulpcore/app/models/repository.py b/pulpcore/app/models/repository.py
ind... |
liberapay__liberapay.com-173 | Changing organization type doesn't work
In identity tab, when I change the organization type to set Organization instead of Business, my changes are not saved.
| [
{
"content": "\"\"\"Defines website authentication helpers.\n\"\"\"\nimport binascii\n\nfrom six.moves.urllib.parse import urlencode\n\nfrom aspen import Response\n\nfrom liberapay.constants import SESSION, SESSION_TIMEOUT\nfrom liberapay.exceptions import AuthRequired\nfrom liberapay.models.participant import ... | [
{
"content": "\"\"\"Defines website authentication helpers.\n\"\"\"\nimport binascii\n\nfrom six.moves.urllib.parse import urlencode\n\nfrom aspen import Response\n\nfrom liberapay.constants import SESSION, SESSION_TIMEOUT\nfrom liberapay.exceptions import AuthRequired\nfrom liberapay.models.participant import ... | diff --git a/liberapay/security/authentication.py b/liberapay/security/authentication.py
index a26bc0c9e7..6e7388426b 100644
--- a/liberapay/security/authentication.py
+++ b/liberapay/security/authentication.py
@@ -44,6 +44,8 @@ def sign_in_with_form_data(body, state):
k, 'password',
id, body.... |
liqd__a4-meinberlin-2974 | test 2959: redesign mail of new Stellungnahme in b-plan module
**URL:** mail
**user:** sachbearbeiter
**expected behaviour:** logo is no longer in the email
**behaviour:** logo is on the bottom left corner of the mail, outside the mail layout box
**important screensize:**
**device & browser:** mail on mac
**Comm... | [
{
"content": "from django.conf import settings\n\nfrom meinberlin.apps.contrib.emails import Email\n\n\nclass OfficeWorkerNotification(Email):\n template_name = 'meinberlin_bplan/emails/office_worker_notification'\n\n @property\n def office_worker_email(self):\n project = self.object.module.proj... | [
{
"content": "from django.conf import settings\n\nfrom meinberlin.apps.contrib.emails import Email\n\n\nclass OfficeWorkerNotification(Email):\n template_name = 'meinberlin_bplan/emails/office_worker_notification'\n\n @property\n def office_worker_email(self):\n project = self.object.module.proj... | diff --git a/meinberlin/apps/bplan/emails.py b/meinberlin/apps/bplan/emails.py
index 752569f9c3..b3d1d158c2 100644
--- a/meinberlin/apps/bplan/emails.py
+++ b/meinberlin/apps/bplan/emails.py
@@ -27,6 +27,9 @@ def get_context(self):
context['identifier'] = self.bplan_identifier
return context
+ de... |
python-pillow__Pillow-6559 | Alpha channel ignored in tkinter using PIL.Image.open and PIL.ImageTk.PhotoImage for PNGs in palette mode
### What did you do?
I opened a PNG image (palette mode with alpha channel) using pillow and passed it to tkinter.
### What did you expect to happen?
It should work just like using tkinter.PhotoImage.
#... | [
{
"content": "#\n# The Python Imaging Library.\n# $Id$\n#\n# a Tk display interface\n#\n# History:\n# 96-04-08 fl Created\n# 96-09-06 fl Added getimage method\n# 96-11-01 fl Rewritten, removed image attribute and crop method\n# 97-05-09 fl Use PyImagingPaste method instead of image type\n# 97-05-12 fl ... | [
{
"content": "#\n# The Python Imaging Library.\n# $Id$\n#\n# a Tk display interface\n#\n# History:\n# 96-04-08 fl Created\n# 96-09-06 fl Added getimage method\n# 96-11-01 fl Rewritten, removed image attribute and crop method\n# 97-05-09 fl Use PyImagingPaste method instead of image type\n# 97-05-12 fl ... | diff --git a/Tests/test_imagetk.py b/Tests/test_imagetk.py
index a929910b3cc..a848c786f04 100644
--- a/Tests/test_imagetk.py
+++ b/Tests/test_imagetk.py
@@ -69,6 +69,13 @@ def test_photoimage():
assert_image_equal(reloaded, im.convert("RGBA"))
+def test_photoimage_apply_transparency():
+ with Image.open... |
encode__uvicorn-436 | --limit-max-requests not working
Hi! I'm trying to figure out why my workers are not restarting as expected when using the `--limit-max-requests` flag. I ran `uvicorn` in debug mode and noticed that the `self.server_state.total_requests` count is not increasing (stays at 0 after each request) so `self.server_state.tota... | [
{
"content": "import asyncio\n\nfrom gunicorn.workers.base import Worker\n\nfrom uvicorn.config import Config\nfrom uvicorn.main import Server\n\n\nclass UvicornWorker(Worker):\n \"\"\"\n A worker class for Gunicorn that interfaces with an ASGI consumer callable,\n rather than a WSGI callable.\n \"\... | [
{
"content": "import asyncio\n\nfrom gunicorn.workers.base import Worker\n\nfrom uvicorn.config import Config\nfrom uvicorn.main import Server\n\n\nclass UvicornWorker(Worker):\n \"\"\"\n A worker class for Gunicorn that interfaces with an ASGI consumer callable,\n rather than a WSGI callable.\n \"\... | diff --git a/uvicorn/workers.py b/uvicorn/workers.py
index 0f6de7a2f..8c823d8f6 100644
--- a/uvicorn/workers.py
+++ b/uvicorn/workers.py
@@ -25,6 +25,7 @@ def __init__(self, *args, **kwargs):
"timeout_keep_alive": self.cfg.keepalive,
"timeout_notify": self.timeout,
"callback_notif... |
python-discord__bot-910 | Handle out of range year in Duration converter
Sentry Issue: [BOT-39](https://sentry.io/organizations/python-discord/issues/1611103057/?referrer=github_integration)
As documented [here](https://docs.python.org/3/library/datetime.html#datetime.date), it has to be `MINYEAR <= year <= MAXYEAR` which is effectively `1 <= ... | [
{
"content": "import logging\nimport re\nimport typing as t\nfrom datetime import datetime\nfrom ssl import CertificateError\n\nimport dateutil.parser\nimport dateutil.tz\nimport discord\nfrom aiohttp import ClientConnectorError\nfrom dateutil.relativedelta import relativedelta\nfrom discord.ext.commands import... | [
{
"content": "import logging\nimport re\nimport typing as t\nfrom datetime import datetime\nfrom ssl import CertificateError\n\nimport dateutil.parser\nimport dateutil.tz\nimport discord\nfrom aiohttp import ClientConnectorError\nfrom dateutil.relativedelta import relativedelta\nfrom discord.ext.commands import... | diff --git a/bot/converters.py b/bot/converters.py
index 72c46fdf0a..4deb59f877 100644
--- a/bot/converters.py
+++ b/bot/converters.py
@@ -217,7 +217,10 @@ async def convert(self, ctx: Context, duration: str) -> datetime:
delta = relativedelta(**duration_dict)
now = datetime.utcnow()
- return... |
Cog-Creators__Red-DiscordBot-1632 | [V3 Streams] issue with `[p]streamset`
# Command bugs
<!--
Did you find a bug with a command? Fill out the following:
-->
#### Command name
`streamset`
#### What cog is this command from?
`Streams`
#### What were you expecting to happen?
Should output help
#### What actually happened?
```p... | [
{
"content": "import re\nfrom pathlib import Path\n\nfrom . import commands\n\n__all__ = ['get_locale', 'set_locale', 'reload_locales', 'cog_i18n',\n 'Translator']\n\n_current_locale = 'en_us'\n\nWAITING_FOR_MSGID = 1\nIN_MSGID = 2\nWAITING_FOR_MSGSTR = 3\nIN_MSGSTR = 4\n\nMSGID = 'msgid \"'\nMSGSTR =... | [
{
"content": "import re\nfrom pathlib import Path\n\nfrom . import commands\n\n__all__ = ['get_locale', 'set_locale', 'reload_locales', 'cog_i18n',\n 'Translator']\n\n_current_locale = 'en_us'\n\nWAITING_FOR_MSGID = 1\nIN_MSGID = 2\nWAITING_FOR_MSGSTR = 3\nIN_MSGSTR = 4\n\nMSGID = 'msgid \"'\nMSGSTR =... | diff --git a/redbot/core/i18n.py b/redbot/core/i18n.py
index c4e700e8eec..844869973b8 100644
--- a/redbot/core/i18n.py
+++ b/redbot/core/i18n.py
@@ -124,6 +124,9 @@ def normalize_whitespace(s):
s += ' '
return s
+ if string is None:
+ return ""
+
string = string.replace('\\n\\... |
cal-itp__benefits-1215 | Refactor Agency dynamic headline into model prop
Right now we are hardcoding the [Agency index headline PO key](https://github.com/cal-itp/benefits/blob/dev/benefits/core/views.py#L62):
```python
page = viewmodels.Page(
title=_("core.pages.agency_index.title"),
headline=_("core.pages.agency_index.mst_... | [
{
"content": "\"\"\"\nThe core application: view definition for the root of the webapp.\n\"\"\"\nfrom django.http import HttpResponse, HttpResponseBadRequest, HttpResponseNotFound, HttpResponseServerError\nfrom django.template import loader\nfrom django.template.response import TemplateResponse\nfrom django.url... | [
{
"content": "\"\"\"\nThe core application: view definition for the root of the webapp.\n\"\"\"\nfrom django.http import HttpResponse, HttpResponseBadRequest, HttpResponseNotFound, HttpResponseServerError\nfrom django.template import loader\nfrom django.template.response import TemplateResponse\nfrom django.url... | diff --git a/benefits/core/views.py b/benefits/core/views.py
index 954fa63bb2..913ca5f1f8 100644
--- a/benefits/core/views.py
+++ b/benefits/core/views.py
@@ -49,7 +49,8 @@ def agency_index(request, agency):
page = viewmodels.Page(
title=_("core.pages.agency_index.title"),
- headline=_("core.page... |
pytorch__rl-578 | [BUG] Argument for `PPOLoss.get_entropy_bonus()` should probably not be optional
## Describe the bug
https://github.com/pytorch/rl/blob/86a1a139682edc8bc747f088423937db1773aa24/torchrl/objectives/costs/ppo.py#L88-L94
The code doesn't seem to be compatible with `None` argument, will throw `AttributeError`.
- [x... | [
{
"content": "# Copyright (c) Meta Platforms, Inc. and affiliates.\n#\n# This source code is licensed under the MIT license found in the\n# LICENSE file in the root directory of this source tree.\n\nimport math\nfrom typing import Callable, Optional, Tuple\n\nimport torch\nfrom torch import distributions as d\n... | [
{
"content": "# Copyright (c) Meta Platforms, Inc. and affiliates.\n#\n# This source code is licensed under the MIT license found in the\n# LICENSE file in the root directory of this source tree.\n\nimport math\nfrom typing import Callable, Optional, Tuple\n\nimport torch\nfrom torch import distributions as d\n... | diff --git a/torchrl/objectives/costs/ppo.py b/torchrl/objectives/costs/ppo.py
index fde02234bea..6c18e6b57bd 100644
--- a/torchrl/objectives/costs/ppo.py
+++ b/torchrl/objectives/costs/ppo.py
@@ -85,7 +85,7 @@ def __init__(
def reset(self) -> None:
pass
- def get_entropy_bonus(self, dist: Optional[d... |
googleapis__python-bigquery-189 | Packaging: prep for 1.0.0 release of `google-resumable-media-python`.
See: https://github.com/googleapis/google-resumable-media-python/issues/138
| [
{
"content": "# Copyright 2018 Google LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicabl... | [
{
"content": "# Copyright 2018 Google LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicabl... | diff --git a/setup.py b/setup.py
index 497853be0..0ac3a8598 100644
--- a/setup.py
+++ b/setup.py
@@ -32,7 +32,7 @@
'enum34; python_version < "3.4"',
"google-api-core >= 1.21.0, < 2.0dev",
"google-cloud-core >= 1.1.0, < 2.0dev",
- "google-resumable-media >= 0.5.0, < 0.6dev",
+ "google-resumable-medi... |
microsoft__knossos-ksc-872 | infer_fn_type_from_derived_fn_args should return Type?
Should the return type here be `Type`? I don't understand how the return type could be `StructuredName`.
https://github.com/microsoft/knossos-ksc/blob/fe0771d7451685c47aa519dfec80bd6ccd256b4f/src/python/ksc/type_propagate.py#L86-L88
| [
{
"content": "\"\"\"\ntype_propagate: Type propagation for Knossos IR\n\"\"\"\n\nfrom typing import List\nfrom ksc.type import (\n Type,\n shape_type,\n tangent_type,\n make_tuple_if_many,\n KSTypeError,\n)\n\nfrom ksc.expr import (\n ASTNode,\n Expr,\n Def,\n EDef,\n GDef,\n Ru... | [
{
"content": "\"\"\"\ntype_propagate: Type propagation for Knossos IR\n\"\"\"\n\nfrom typing import List\nfrom ksc.type import (\n Type,\n shape_type,\n tangent_type,\n make_tuple_if_many,\n KSTypeError,\n)\n\nfrom ksc.expr import (\n ASTNode,\n Expr,\n Def,\n EDef,\n GDef,\n Ru... | diff --git a/src/python/ksc/type_propagate.py b/src/python/ksc/type_propagate.py
index dc775e004..c850feb4f 100644
--- a/src/python/ksc/type_propagate.py
+++ b/src/python/ksc/type_propagate.py
@@ -83,9 +83,7 @@ def _type_propagate_helper(ex: ASTNode, symtab, respect_existing: bool):
# [rev [fwd f]] : ((S, dS), dT) -> ... |
kivy__kivy-6362 | Error in Kivy Carousel 1.11.0rc2
### Versions
* Python: Python 3.7.3
* OS: Windows 10
* Kivy: Kivy 1.11.0rc2
* Kivy installation method: Installed via pip --pre
### Description
Carousel will not function and throws an error in the logs.
Error is here
def _curr_slide(self):
ret... | [
{
"content": "'''\nCarousel\n========\n\n.. image:: images/carousel.gif\n :align: right\n\n.. versionadded:: 1.4.0\n\nThe :class:`Carousel` widget provides the classic mobile-friendly carousel view\nwhere you can swipe between slides.\nYou can add any content to the carousel and have it move horizontally or\... | [
{
"content": "'''\nCarousel\n========\n\n.. image:: images/carousel.gif\n :align: right\n\n.. versionadded:: 1.4.0\n\nThe :class:`Carousel` widget provides the classic mobile-friendly carousel view\nwhere you can swipe between slides.\nYou can add any content to the carousel and have it move horizontally or\... | diff --git a/kivy/uix/carousel.py b/kivy/uix/carousel.py
index bc1ccece13..c722df863f 100644
--- a/kivy/uix/carousel.py
+++ b/kivy/uix/carousel.py
@@ -191,7 +191,7 @@ def _prev_slide(self):
def _curr_slide(self):
if len(self.slides):
- return self.slides[self.index]
+ return self.s... |
kornia__kornia-679 | Enable typing support
## 🚀 Feature
Enable typing support for `kornia` so other packages can benefit from the type hints.
## Motivation
Currently `kornia` only uses the type hints to check for internal consistency. For other packages you get the following error message when running `mypy`:
```python
import... | [
{
"content": "# Welcome to the Kornia setup.py.\n#\n\nimport os\nfrom setuptools import setup, find_packages\nimport subprocess\nimport distutils.command.clean\n\n\n################\n# The variables below define the current version under\n# development and the current pytorch supported verions.\n# WARNING: Beca... | [
{
"content": "# Welcome to the Kornia setup.py.\n#\n\nimport os\nfrom setuptools import setup, find_packages\nimport subprocess\nimport distutils.command.clean\n\n\n################\n# The variables below define the current version under\n# development and the current pytorch supported verions.\n# WARNING: Beca... | diff --git a/kornia/py.typed b/kornia/py.typed
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/setup.py b/setup.py
index d0ad2dc5c9..f234e52376 100644
--- a/setup.py
+++ b/setup.py
@@ -122,6 +122,10 @@ def run(self):
# Package info
packages=find_packages(exclude=('docs', 'test', 'exampl... |
scikit-hep__pyhf-1049 | Fix Fixture use in pytest
# Description
In pytest `v4.0.0` the [direct call of a fixture results in an error](https://travis-ci.org/diana-hep/pyhf/jobs/455364238#L661-L669).
```
==================================== ERRORS ====================================
__________________ ERROR collecting tests/test_valid... | [
{
"content": "from setuptools import setup\n\nextras_require = {\n 'shellcomplete': ['click_completion'],\n 'tensorflow': [\n 'tensorflow~=2.2.0', # TensorFlow minor releases are as volatile as major\n 'tensorflow-probability~=0.10.0',\n ],\n 'torch': ['torch~=1.2'],\n 'jax': ['jax... | [
{
"content": "from setuptools import setup\n\nextras_require = {\n 'shellcomplete': ['click_completion'],\n 'tensorflow': [\n 'tensorflow~=2.2.0', # TensorFlow minor releases are as volatile as major\n 'tensorflow-probability~=0.10.0',\n ],\n 'torch': ['torch~=1.2'],\n 'jax': ['jax... | diff --git a/docs/governance/ROADMAP.rst b/docs/governance/ROADMAP.rst
index d78cdc4497..89520c1116 100644
--- a/docs/governance/ROADMAP.rst
+++ b/docs/governance/ROADMAP.rst
@@ -84,7 +84,7 @@ Roadmap
#518) [2019-Q3]
- |check| Add CI with GitHub Actions and Azure Pipelines (PR #527, Issue
#517) [2019... |
rasterio__rasterio-1628 | support pickle for multiprocessing with rasterio.profiles.Profile data
Trying to do a bit of multiprocessing parallel, async IO to write out GeoTIFF data. If there's a better way to do this, would like to hear about it.
Related to #909 - another concern with serializing the profile data.
## OS and versions
```
... | [
{
"content": "\"\"\"Coordinate Reference Systems\n\nNotes\n-----\n\nIn Rasterio versions <= 1.0.13, coordinate reference system support was limited\nto the CRS that can be described by PROJ parameters. This limitation is gone in\nversions >= 1.0.14. Any CRS that can be defined using WKT (version 1) may be\nused... | [
{
"content": "\"\"\"Coordinate Reference Systems\n\nNotes\n-----\n\nIn Rasterio versions <= 1.0.13, coordinate reference system support was limited\nto the CRS that can be described by PROJ parameters. This limitation is gone in\nversions >= 1.0.14. Any CRS that can be defined using WKT (version 1) may be\nused... | diff --git a/CHANGES.txt b/CHANGES.txt
index 24ccf6aad..049f1352a 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -1,6 +1,13 @@
Changes
=======
+1.0.19 (?)
+----------
+
+- Restore pickle protocol for CRS, using WKT as state (#1625).
+- Support for signed 8-bit integer datasets ("int8" dtype) has been added
+ (#1595... |
lutris__lutris-1004 | Menu bar visible during install
While installing a game, the menu bar at the dialog window shouldn't be visible.
| [
{
"content": "# -*- coding: utf-8 -*-\nimport os\nimport time\nimport re\nimport webbrowser\n\nfrom gi.repository import Gtk, Pango\n\nfrom lutris import api, pga, settings\nfrom lutris.services import xdg\nfrom lutris.installer import interpreter\nfrom lutris.installer.errors import ScriptingError\nfrom lutris... | [
{
"content": "# -*- coding: utf-8 -*-\nimport os\nimport time\nimport re\nimport webbrowser\n\nfrom gi.repository import Gtk, Pango\n\nfrom lutris import api, pga, settings\nfrom lutris.services import xdg\nfrom lutris.installer import interpreter\nfrom lutris.installer.errors import ScriptingError\nfrom lutris... | diff --git a/lutris/gui/installerwindow.py b/lutris/gui/installerwindow.py
index 8f581f9bb0..4507e712e7 100644
--- a/lutris/gui/installerwindow.py
+++ b/lutris/gui/installerwindow.py
@@ -44,6 +44,7 @@ def __init__(self, game_slug=None, installer_file=None, revision=None, parent=No
self.set_size_request(420, 42... |
systemd__mkosi-1847 | tput smam breaks build
Using latest on Debian Sid.
```
‣ Running finalize script…
‣ Creating tar archive /home/ander/Desktop/mkosi/tools/mkosi.workspace/.mkosi-tmp9zitpbja/staging/image.tar…
‣ /home/ander/Desktop/mkosi/tools/mkosi.output/image size is 1016.1M, consumes 1016.1M.
‣ "tput smam" returned non-zero... | [
{
"content": "# SPDX-License-Identifier: LGPL-2.1+\n# PYTHON_ARGCOMPLETE_OK\n\nimport contextlib\nimport logging\nimport shutil\nimport subprocess\nimport sys\nfrom collections.abc import Iterator\n\nfrom mkosi import run_verb\nfrom mkosi.config import MkosiConfigParser\nfrom mkosi.log import ARG_DEBUG, log_set... | [
{
"content": "# SPDX-License-Identifier: LGPL-2.1+\n# PYTHON_ARGCOMPLETE_OK\n\nimport contextlib\nimport logging\nimport shutil\nimport subprocess\nimport sys\nfrom collections.abc import Iterator\n\nfrom mkosi import run_verb\nfrom mkosi.config import MkosiConfigParser\nfrom mkosi.log import ARG_DEBUG, log_set... | diff --git a/mkosi/__main__.py b/mkosi/__main__.py
index bf8aab7b1..1ca236af4 100644
--- a/mkosi/__main__.py
+++ b/mkosi/__main__.py
@@ -51,8 +51,8 @@ def main() -> None:
run_verb(args, presets)
finally:
if sys.stderr.isatty() and shutil.which("tput"):
- run(["tput", "cnorm"])
- ... |
django-cms__django-cms-3011 | New redirect widget is not nullable
There is no way to empty the new redirect field.
Plus a min-width should be used to have a proper size.
| [
{
"content": "# -*- coding: utf-8 -*-\n\nfrom itertools import chain\n\nfrom django.contrib.sites.models import Site\nfrom django.core.urlresolvers import reverse\nfrom django.forms.widgets import Select, MultiWidget, TextInput\nfrom django.utils.encoding import force_text\nfrom django.utils.safestring import m... | [
{
"content": "# -*- coding: utf-8 -*-\n\nfrom itertools import chain\n\nfrom django.contrib.sites.models import Site\nfrom django.core.urlresolvers import reverse\nfrom django.forms.widgets import Select, MultiWidget, TextInput\nfrom django.utils.encoding import force_text\nfrom django.utils.safestring import m... | diff --git a/cms/forms/widgets.py b/cms/forms/widgets.py
index b31a9570404..6ed02a500e3 100644
--- a/cms/forms/widgets.py
+++ b/cms/forms/widgets.py
@@ -138,6 +138,7 @@ def render(self, name=None, value=None, attrs=None):
$(function(){
$("#%(element_id)s").select2({
placeholder: "%(placeholde... |
cloudtools__troposphere-1683 | ApiGatewayV2 is missing VpcLink
We appear to be unable to create an HTTP Vpc Link, as the ApiGatewayV2 Vpc Link is not yet implemented.
From the AWS documentation:
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html
From the Troposphere codebase, VpcLink is mis... | [
{
"content": "# Copyright (c) 2012-2019, Mark Peek <mark@peek.org>\n# All rights reserved.\n#\n# See LICENSE file for full license.\n#\n# *** Do not modify - this file is autogenerated ***\n# Resource specification version: 10.0.0\n\n\nfrom . import AWSObject\nfrom . import AWSProperty\nfrom .validators import ... | [
{
"content": "# Copyright (c) 2012-2019, Mark Peek <mark@peek.org>\n# All rights reserved.\n#\n# See LICENSE file for full license.\n#\n# *** Do not modify - this file is autogenerated ***\n# Resource specification version: 10.0.0\n\n\nfrom . import AWSObject\nfrom . import AWSProperty\nfrom .validators import ... | diff --git a/troposphere/apigatewayv2.py b/troposphere/apigatewayv2.py
index 38e2ab15a..2fca0b5a8 100644
--- a/troposphere/apigatewayv2.py
+++ b/troposphere/apigatewayv2.py
@@ -333,3 +333,14 @@ class Stage(AWSObject):
'StageVariables': (dict, False),
'Tags': (dict, False),
}
+
+
+class VpcLink(AW... |
Lightning-AI__torchmetrics-1892 | Result of IoU is Nan when there is empty item in preds.
## 🐛 Bug
<!-- A clear and concise description of what the bug is. -->
### To Reproduce
The `target` is:
```
[
{'boxes': tensor([[ 86.0000, 15.0000, 214.0000, 224.0000],
[201.0000, 109.0000, 294.0000, 141.0000]], device='... | [
{
"content": "# Copyright The PyTorch Lightning team.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required ... | [
{
"content": "# Copyright The PyTorch Lightning team.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required ... | diff --git a/CHANGELOG.md b/CHANGELOG.md
index eedd710f6de..8ba3977f207 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -26,7 +26,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed
--
+- Fixed bug related to empty predictions for `IntersectionOverUnion` metric ([#1892](... |
nvaccess__nvda-9864 | Braille: The fall-back input table does not match the default input table.
<!--
Please thoroughly read NVDA's wiki article on how to fill in this template, including how to provide the required files.
Issues may be closed if the required information is not present.
https://github.com/nvaccess/nvda/wiki/Github-issue-... | [
{
"content": "# -*- coding: UTF-8 -*-\n#brailleInput.py\n#A part of NonVisual Desktop Access (NVDA)\n#This file is covered by the GNU General Public License.\n#See the file COPYING for more details.\n#Copyright (C) 2012-2017 NV Access Limited, Rui Batista, Babbage B.V.\n\nimport os.path\nimport time\nfrom typin... | [
{
"content": "# -*- coding: UTF-8 -*-\n#brailleInput.py\n#A part of NonVisual Desktop Access (NVDA)\n#This file is covered by the GNU General Public License.\n#See the file COPYING for more details.\n#Copyright (C) 2012-2017 NV Access Limited, Rui Batista, Babbage B.V.\n\nimport os.path\nimport time\nfrom typin... | diff --git a/source/brailleInput.py b/source/brailleInput.py
index a2b7d6dcbc0..22ed84be20f 100644
--- a/source/brailleInput.py
+++ b/source/brailleInput.py
@@ -29,7 +29,7 @@
"""
#: Table to use if the input table configuration is invalid.
-FALLBACK_TABLE = "en-us-comp8.ctb"
+FALLBACK_TABLE = "en-ueb-g1.ctb"
DOT7 ... |
pulp__pulpcore-3646 | The validation of input parameters for the repair endpoint is omitted
```
curl -X POST -H 'Content-Type: application/json' -H 'Authorization: Basic YWRtaW46cGFzc3dvcmQ=' -d '[]' http://localhost:5001/pulp/api/v3/repair/
```
```
pulp [804a07335b9f4417ad0c71dde478634e]: django.request:ERROR: Internal Server Error: ... | [
{
"content": "from drf_spectacular.utils import extend_schema\nfrom rest_framework.views import APIView\n\nfrom pulpcore.app.response import OperationPostponedResponse\nfrom pulpcore.app.serializers import AsyncOperationResponseSerializer, RepairSerializer\nfrom pulpcore.app.tasks import repair_all_artifacts\nf... | [
{
"content": "from drf_spectacular.utils import extend_schema\nfrom rest_framework.views import APIView\n\nfrom pulpcore.app.response import OperationPostponedResponse\nfrom pulpcore.app.serializers import AsyncOperationResponseSerializer, RepairSerializer\nfrom pulpcore.app.tasks import repair_all_artifacts\nf... | diff --git a/CHANGES/3645.bugfix b/CHANGES/3645.bugfix
new file mode 100644
index 0000000000..c93ade4f18
--- /dev/null
+++ b/CHANGES/3645.bugfix
@@ -0,0 +1 @@
+Added missing validation to the ``repair`` endpoint.
diff --git a/pulpcore/app/views/repair.py b/pulpcore/app/views/repair.py
index 49a1ac7281..7d22861b44 10064... |
DDMAL__CantusDB-1001 | in content overview, have sources by last-updated
Currently the sources are sorted by creation, but some active projects are working on fairly old source objects. I think it would be more useful to have them sorted by last update.
| [
{
"content": "import csv\nfrom typing import Optional, Union\nfrom django.http.response import JsonResponse\nfrom django.http import HttpResponse, HttpResponseNotFound\nfrom django.shortcuts import render, redirect\nfrom django.urls.base import reverse\nfrom articles.models import Article\nfrom main_app.models ... | [
{
"content": "import csv\nfrom typing import Optional, Union\nfrom django.http.response import JsonResponse\nfrom django.http import HttpResponse, HttpResponseNotFound\nfrom django.shortcuts import render, redirect\nfrom django.urls.base import reverse\nfrom articles.models import Article\nfrom main_app.models ... | diff --git a/django/cantusdb_project/main_app/views/views.py b/django/cantusdb_project/main_app/views/views.py
index 29284ffcc..95aff6ffe 100644
--- a/django/cantusdb_project/main_app/views/views.py
+++ b/django/cantusdb_project/main_app/views/views.py
@@ -853,7 +853,7 @@ def content_overview(request):
objects =... |
python__peps-2229 | Don't auto-add inline links to ref section & rm if empty, per #2130
First step to implementing #2130 , as agreed with @gvanrossum and the PEP editor team.
When building, don't add redundant footnotes and references entries for URLs that are already directly linked inline. This avoids an unnecessary, potentially conf... | [
{
"content": "import datetime\nfrom pathlib import Path\nimport subprocess\n\nfrom docutils import nodes\nfrom docutils import transforms\n\n\nclass PEPFooter(transforms.Transform):\n \"\"\"Footer transforms for PEPs.\n\n - Removes the References section if it is empty when rendered.\n - Creates a li... | [
{
"content": "import datetime\nfrom pathlib import Path\nimport subprocess\n\nfrom docutils import nodes\nfrom docutils import transforms\n\n\nclass PEPFooter(transforms.Transform):\n \"\"\"Footer transforms for PEPs.\n\n - Removes the References section if it is empty when rendered.\n - Creates a li... | diff --git a/pep_sphinx_extensions/pep_processor/transforms/pep_footer.py b/pep_sphinx_extensions/pep_processor/transforms/pep_footer.py
index 497811dc495..1f907dfb701 100644
--- a/pep_sphinx_extensions/pep_processor/transforms/pep_footer.py
+++ b/pep_sphinx_extensions/pep_processor/transforms/pep_footer.py
@@ -18,8 +1... |
optuna__optuna-122 | `TPESampler._sample_categorical` fails with PostgreSQL backend
`TPESampler._sample_categorical` fails with PostgreSQL backend. This happens because:
- `TPESampler._sample_categorical` returns an integer as `numpy.int32`.
- The integer value is input to storage class without any cast.
- SQLAlchemy with psycopg2 backe... | [
{
"content": "import math\nimport numpy\nfrom typing import List # NOQA\nfrom typing import Optional # NOQA\n\nfrom pfnopt import distributions # NOQA\nfrom pfnopt.samplers import _hyperopt\nfrom pfnopt.samplers import base\nfrom pfnopt.samplers import random\nfrom pfnopt.storages.base import BaseStorage # ... | [
{
"content": "import math\nimport numpy\nfrom typing import List # NOQA\nfrom typing import Optional # NOQA\n\nfrom pfnopt import distributions # NOQA\nfrom pfnopt.samplers import _hyperopt\nfrom pfnopt.samplers import base\nfrom pfnopt.samplers import random\nfrom pfnopt.storages.base import BaseStorage # ... | diff --git a/pfnopt/samplers/tpe.py b/pfnopt/samplers/tpe.py
index 57844f2c87..a8d0916f1a 100644
--- a/pfnopt/samplers/tpe.py
+++ b/pfnopt/samplers/tpe.py
@@ -80,4 +80,4 @@ def _sample_categorical(self, distribution, below, above):
idx = _hyperopt.sample_categorical(
obs_below=below, obs_above=abo... |
frappe__frappe-15250 | AttributeError: 'bool' object has no attribute 'fields_'
Getting this migrate error on the newest release; works fine with the previous release.
```
> bench --site my_site migrate
Migrating my_site
Executing execute:frappe.reload_doc('core', 'doctype', 'doctype') in my_site (_c0bc0e8af8edb577)
Success: Done in 0... | [
{
"content": "# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors\n# License: MIT. See LICENSE\nimport hashlib\nimport json\nimport os\n\nimport frappe\nfrom frappe.model.base_document import get_controller\nfrom frappe.modules import get_module_path, scrub_dt_dn\nfrom frappe.query_builder impo... | [
{
"content": "# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors\n# License: MIT. See LICENSE\nimport hashlib\nimport json\nimport os\n\nimport frappe\nfrom frappe.model.base_document import get_controller\nfrom frappe.modules import get_module_path, scrub_dt_dn\nfrom frappe.query_builder impo... | diff --git a/frappe/modules/import_file.py b/frappe/modules/import_file.py
index cf8ec46d7613..50a56d9dbb10 100644
--- a/frappe/modules/import_file.py
+++ b/frappe/modules/import_file.py
@@ -189,7 +189,7 @@ def update_modified(original_modified, doc):
).set(
singles_table.value,original_modified
).where(
- ... |
Parsl__parsl-328 | fatal: Not a git repository: '/homes/vvikraman/anaconda3/lib/python3.6/site-packages/.git
Hi
When I try to run parsl I am getting the following issue:
fatal: Not a git repository: '/homes/vvikraman/anaconda3/lib/python3.6/site-packages/.git
Is it a real issue?
I am using python3 and jupyter but run parsl in ... | [
{
"content": "import logging\nimport os\nimport shlex\nimport subprocess\nimport threading\nimport time\nfrom contextlib import contextmanager\nfrom functools import wraps\n\nimport parsl\nfrom parsl.version import VERSION\n\nlogger = logging.getLogger(__name__)\n\n\ndef get_version():\n version = parsl.__ve... | [
{
"content": "import logging\nimport os\nimport shlex\nimport subprocess\nimport threading\nimport time\nfrom contextlib import contextmanager\nfrom functools import wraps\n\nimport parsl\nfrom parsl.version import VERSION\n\nlogger = logging.getLogger(__name__)\n\n\ndef get_version():\n version = parsl.__ve... | diff --git a/parsl/utils.py b/parsl/utils.py
index 8a2e7ca8bd..7f6c2d685b 100644
--- a/parsl/utils.py
+++ b/parsl/utils.py
@@ -25,7 +25,7 @@ def get_version():
status = 'dirty' if diff else 'clean'
version = '{v}-{head}-{status}'.format(v=VERSION, head=head, status=status)
except Exception as e:
... |
pydantic__pydantic-4920 | `__fields_set__` includes excluded extras on copy
### Initial Checks
- [X] I have searched GitHub for a duplicate issue and I'm sure this is something new
- [X] I have searched Google & StackOverflow for a solution and couldn't find anything
- [X] I have read and followed [the docs](https://pydantic-docs.helpmanual.io... | [
{
"content": "\"\"\"\nLogic for creating models, could perhaps be renamed to `models.py`.\n\"\"\"\nfrom __future__ import annotations as _annotations\n\nimport typing\nimport warnings\nfrom abc import ABCMeta\nfrom copy import deepcopy\nfrom enum import Enum\nfrom functools import partial\nfrom types import pre... | [
{
"content": "\"\"\"\nLogic for creating models, could perhaps be renamed to `models.py`.\n\"\"\"\nfrom __future__ import annotations as _annotations\n\nimport typing\nimport warnings\nfrom abc import ABCMeta\nfrom copy import deepcopy\nfrom enum import Enum\nfrom functools import partial\nfrom types import pre... | diff --git a/pydantic/main.py b/pydantic/main.py
index a9da3d10172..e032cf511f6 100644
--- a/pydantic/main.py
+++ b/pydantic/main.py
@@ -359,6 +359,10 @@ def copy(
else:
fields_set = set(self.__fields_set__)
+ # removing excluded fields from `__fields_set__`
+ if exclude:
+ ... |
ivy-llc__ivy-23070 | exponential_
| [
{
"content": "# global\nimport ivy\nfrom ivy.func_wrapper import with_supported_dtypes\nfrom ivy.func_wrapper import with_supported_device_and_dtypes, with_unsupported_dtypes\nfrom ivy.functional.frontends.paddle.func_wrapper import (\n to_ivy_arrays_and_back,\n)\n\n\n@with_supported_dtypes(\n {\"2.5.1 an... | [
{
"content": "# global\nimport ivy\nfrom ivy.func_wrapper import with_supported_dtypes\nfrom ivy.func_wrapper import with_supported_device_and_dtypes, with_unsupported_dtypes\nfrom ivy.functional.frontends.paddle.func_wrapper import (\n to_ivy_arrays_and_back,\n)\n\n\n@with_supported_dtypes(\n {\"2.5.1 an... | diff --git a/ivy/functional/frontends/paddle/tensor/random.py b/ivy/functional/frontends/paddle/tensor/random.py
index b69d73d8a5e25..570983d131d34 100644
--- a/ivy/functional/frontends/paddle/tensor/random.py
+++ b/ivy/functional/frontends/paddle/tensor/random.py
@@ -7,6 +7,15 @@
)
+@with_supported_dtypes(
+ {... |
wemake-services__wemake-python-styleguide-2452 | Site unavailable
### What's wrong
Not sure where exactly to put this, but https://wemake-python-stylegui.de/ is unavailable
| [
{
"content": "\"\"\"\nOur very own ``flake8`` formatter for better error messages.\n\nThat's how all ``flake8`` formatters work:\n\n.. mermaid::\n :caption: ``flake8`` formatting API calls order.\n\n graph LR\n F2[start] --> F3[after_init]\n F3 --> F4[start]\n F4 --> F... | [
{
"content": "\"\"\"\nOur very own ``flake8`` formatter for better error messages.\n\nThat's how all ``flake8`` formatters work:\n\n.. mermaid::\n :caption: ``flake8`` formatting API calls order.\n\n graph LR\n F2[start] --> F3[after_init]\n F3 --> F4[start]\n F4 --> F... | diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9230e3e03..926b70e71 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -24,7 +24,7 @@ Semantic versioning in our case means:
## 0.16.2
### Misc
-- Adds full violation codes to docs and `BaseViolation.full_code` #2409
+- Adds full violation codes to docs and `BaseViolati... |
CTFd__CTFd-1508 | Access media library from Challenge UI
Accessing the media library from the challenge UI is a useful idea if you're using images in the challenge interface. Saves some clicks.
| [
{
"content": "from flask import render_template, request\n\nfrom CTFd.admin import admin\nfrom CTFd.models import Pages\nfrom CTFd.schemas.pages import PageSchema\nfrom CTFd.utils import markdown\nfrom CTFd.utils.config.pages import build_html\nfrom CTFd.utils.decorators import admins_only\n\n\n@admin.route(\"/... | [
{
"content": "from flask import render_template, request\n\nfrom CTFd.admin import admin\nfrom CTFd.models import Pages\nfrom CTFd.schemas.pages import PageSchema\nfrom CTFd.utils import markdown\nfrom CTFd.utils.config.pages import build_html\nfrom CTFd.utils.decorators import admins_only\n\n\n@admin.route(\"/... | diff --git a/CTFd/admin/pages.py b/CTFd/admin/pages.py
index a228002dd..8fbe2a7da 100644
--- a/CTFd/admin/pages.py
+++ b/CTFd/admin/pages.py
@@ -27,7 +27,7 @@ def pages_preview():
data = request.form.to_dict()
schema = PageSchema()
page = schema.load(data)
- return render_template("page.html", content... |
mlflow__mlflow-7504 | Convert `. code-block:: python` to `.. test-code-block:: python` in `mlflow/tracking/_model_registry/fluent.py`
See #7457 for more information.
| [
{
"content": "from mlflow.tracking.client import MlflowClient\nfrom mlflow.exceptions import MlflowException\nfrom mlflow.entities.model_registry import ModelVersion\nfrom mlflow.entities.model_registry import RegisteredModel\nfrom mlflow.protos.databricks_pb2 import RESOURCE_ALREADY_EXISTS, ErrorCode\nfrom mlf... | [
{
"content": "from mlflow.tracking.client import MlflowClient\nfrom mlflow.exceptions import MlflowException\nfrom mlflow.entities.model_registry import ModelVersion\nfrom mlflow.entities.model_registry import RegisteredModel\nfrom mlflow.protos.databricks_pb2 import RESOURCE_ALREADY_EXISTS, ErrorCode\nfrom mlf... | diff --git a/mlflow/tracking/_model_registry/fluent.py b/mlflow/tracking/_model_registry/fluent.py
index 215ef984d0ed9..0b11ec0563ddd 100644
--- a/mlflow/tracking/_model_registry/fluent.py
+++ b/mlflow/tracking/_model_registry/fluent.py
@@ -37,7 +37,7 @@ def register_model(
:return: Single :py:class:`mlflow.entiti... |
biolab__orange3-text-82 | Preprocessor: Toggling ON/OFF Runs Preprocessing Twice
When enabling/disabling preprocessor modules whole preprocessing is run twice whereas it should be run only once.
Preprocessor: Toggling ON/OFF Runs Preprocessing Twice
When enabling/disabling preprocessor modules whole preprocessing is run twice whereas it should... | [
{
"content": "import os\n\nfrom PyQt4 import QtGui, QtCore\n\nfrom PyQt4.QtCore import (pyqtSignal as Signal, pyqtSlot as Slot)\nfrom PyQt4.QtGui import (QWidget, QLabel, QHBoxLayout, QVBoxLayout,\n QButtonGroup, QRadioButton, QSizePolicy, QFrame,\n QApplication, ... | [
{
"content": "import os\n\nfrom PyQt4 import QtGui, QtCore\n\nfrom PyQt4.QtCore import (pyqtSignal as Signal, pyqtSlot as Slot)\nfrom PyQt4.QtGui import (QWidget, QLabel, QHBoxLayout, QVBoxLayout,\n QButtonGroup, QRadioButton, QSizePolicy, QFrame,\n QApplication, ... | diff --git a/orangecontrib/text/widgets/owpreprocess.py b/orangecontrib/text/widgets/owpreprocess.py
index d64f5229f..3d458d1ea 100644
--- a/orangecontrib/text/widgets/owpreprocess.py
+++ b/orangecontrib/text/widgets/owpreprocess.py
@@ -147,7 +147,6 @@ def on_toggle(self):
# Activated when the widget is enable... |
liqd__a4-meinberlin-5153 | Wording: no formal adress regarding notice when comment is too long (missing String on Weblate)
**URL:** https://meinberlin-demo.liqd.net/budgeting/2023-00049/
**user:** any
**expected behaviour:** as a user on mein Berlin I want to be adressed in a formal way (Sie)
**behaviour:** When I write a comment which is to... | [
{
"content": "def _(s):\n return s\n\n\ndjango_standard_messages_to_override = [\n _(\"You have signed out.\"),\n _(\"Verify Your E-mail Address\"),\n _(\"You must type the same password each time.\"),\n _(\"You have confirmed %(email)s.\"),\n _(\"You cannot remove your primary e-mail address ... | [
{
"content": "def _(s):\n return s\n\n\ndjango_standard_messages_to_override = [\n _(\"You have signed out.\"),\n _(\"Verify Your E-mail Address\"),\n _(\"You must type the same password each time.\"),\n _(\"You have confirmed %(email)s.\"),\n _(\"You cannot remove your primary e-mail address ... | diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6408f95eb4..845993b202 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,8 @@ Since version <unreleased> the format is based on [Keep a Changelog](https://kee
This project (not yet) adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## Unrelea... |
docker__docker-py-1272 | exec_create not work with detach=True
Ubuntu 14.04, Python 2.7.12
docker-py 1.5.0 - Ok
```
In [28]: import docker
In [29]: docker.version
Out[29]: '1.5.0'
In [30]: cli = docker.Client()
In [31]: container = cli.create_container('python:2.7.11', command='sleep 1h')
In [32]: cli.start(container['Id'])
In [33]: e =... | [
{
"content": "import six\n\nfrom .. import errors\nfrom .. import utils\n\n\nclass ExecApiMixin(object):\n @utils.minimum_version('1.15')\n @utils.check_resource\n def exec_create(self, container, cmd, stdout=True, stderr=True,\n stdin=False, tty=False, privileged=False, user=''):\n ... | [
{
"content": "import six\n\nfrom .. import errors\nfrom .. import utils\n\n\nclass ExecApiMixin(object):\n @utils.minimum_version('1.15')\n @utils.check_resource\n def exec_create(self, container, cmd, stdout=True, stderr=True,\n stdin=False, tty=False, privileged=False, user=''):\n ... | diff --git a/docker/api/exec_api.py b/docker/api/exec_api.py
index 694b30a67..6c3e63833 100644
--- a/docker/api/exec_api.py
+++ b/docker/api/exec_api.py
@@ -137,7 +137,8 @@ def exec_start(self, exec_id, detach=False, tty=False, stream=False,
data=data,
stream=True
)
-
+ if deta... |
ibis-project__ibis-6433 | bug: cannot read from cloud storage
### What happened?
for the `ibis.read_*` functions, cloud storage should be supported via fsspec in the underlying libraries. the main issue seems to be the "normalize_filename()" calls, incorrectly editing the URI
a simple example:
```python
import ibis
import polars as pl
... | [
{
"content": "\"\"\"Ibis utility functions.\"\"\"\nfrom __future__ import annotations\n\nimport base64\nimport collections\nimport functools\nimport importlib.metadata\nimport itertools\nimport logging\nimport operator\nimport os\nimport sys\nimport textwrap\nimport types\nimport uuid\nimport warnings\nfrom typ... | [
{
"content": "\"\"\"Ibis utility functions.\"\"\"\nfrom __future__ import annotations\n\nimport base64\nimport collections\nimport functools\nimport importlib.metadata\nimport itertools\nimport logging\nimport operator\nimport os\nimport sys\nimport textwrap\nimport types\nimport uuid\nimport warnings\nfrom typ... | diff --git a/ibis/util.py b/ibis/util.py
index 1c2c50fecd43..2506ab006731 100644
--- a/ibis/util.py
+++ b/ibis/util.py
@@ -530,7 +530,7 @@ def _removeprefix(text, prefix):
source = _removeprefix(source, f"{prefix}://")
def _absolufy_paths(name):
- if not name.startswith(("http", "s3")):
+ ... |
biopython__biopython-4545 | ScanProsite no longer working
### Setup
I am reporting a problem with Biopython version, Python version, and operating
system as follows:
```python
import sys; print(sys.version)
import platform; print(platform.python_implementation()); print(platform.platform())
import Bio; print(Bio.__version__)
```
(*P... | [
{
"content": "# Copyright 2009 by Michiel de Hoon. All rights reserved.\n# This code is part of the Biopython distribution and governed by its\n# license. Please see the LICENSE file that should have been included\n# as part of this package.\n\n\"\"\"Code for calling and parsing ScanProsite from ExPASy.\"\"\"\n... | [
{
"content": "# Copyright 2009 by Michiel de Hoon. All rights reserved.\n# This code is part of the Biopython distribution and governed by its\n# license. Please see the LICENSE file that should have been included\n# as part of this package.\n\n\"\"\"Code for calling and parsing ScanProsite from ExPASy.\"\"\"\n... | diff --git a/Bio/ExPASy/ScanProsite.py b/Bio/ExPASy/ScanProsite.py
index 629ec15f159..e05570b5421 100644
--- a/Bio/ExPASy/ScanProsite.py
+++ b/Bio/ExPASy/ScanProsite.py
@@ -59,7 +59,7 @@ def scan(seq="", mirror="https://prosite.expasy.org", output="xml", **keywords):
if value is not None:
paramete... |
streamlit__streamlit-724 | Fix Danny's S3 sharing issue
It looks like `[s3] keyPrefix=...` isn't making it into the URLs being fetched from S3.
This is the address of a manifest protobuf we want to fetch:
`https://yelp-people-dev.s3-us-west-2.amazonaws.com/~dqn/st/0.49.0-A8NT/reports/NJphBiGR4twz88mU9wTegn/manifest.pb`
And this is the add... | [
{
"content": "# -*- coding: utf-8 -*-\n# Copyright 2018-2019 Streamlit Inc.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n... | [
{
"content": "# -*- coding: utf-8 -*-\n# Copyright 2018-2019 Streamlit Inc.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n... | diff --git a/examples/bart_vs_bikes.py b/examples/bart_vs_bikes.py
index 13284d5c8180..e79247600639 100644
--- a/examples/bart_vs_bikes.py
+++ b/examples/bart_vs_bikes.py
@@ -33,7 +33,9 @@
@st.cache
def from_data_file(filename):
- dirname = "https://raw.githubusercontent.com/streamlit/streamlit/develop/examples/... |
semgrep__semgrep-rules-1051 | python tempfile-without-flush: Don't require .write() for exception?
**Describe the bug**
The `python.lang.correctness.tempfile.flush.tempfile-without-flush` rule has [exceptions](https://github.com/returntocorp/semgrep-rules/blob/35e9f350a5d0190c936502fff179ba2c465c4438/python/lang/correctness/tempfile/flush.yaml#L5-... | [
{
"content": "import tempfile\n\nimport at\nimport tf\n\n\ndef main():\n with tempfile.NamedTemporaryFile(\"w\") as fout:\n debug_print(astr)\n fout.write(astr)\n # ok:tempfile-without-flush\n fout.flush()\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\n... | [
{
"content": "import tempfile\n\nimport at\nimport tf\n\n\ndef main():\n with tempfile.NamedTemporaryFile(\"w\") as fout:\n debug_print(astr)\n fout.write(astr)\n # ok:tempfile-without-flush\n fout.flush()\n cmd = [binary_name, fout.name, *[str(path) for path in targets]]\n... | diff --git a/python/lang/correctness/tempfile/flush.py b/python/lang/correctness/tempfile/flush.py
index 020f6f7050..07b5183327 100644
--- a/python/lang/correctness/tempfile/flush.py
+++ b/python/lang/correctness/tempfile/flush.py
@@ -61,3 +61,12 @@ def main_e():
print(fout.name)
# ruleid:tempfile-without-flu... |
encode__httpx-2523 | Support passing bytes keys/values in `params=...`
``` python
>>> httpx.get('https://example.org', params={b'testparam': b'testvalue'}).url
URL('https://example.org?b%27testparam%27=b%27testvalue%27')
```
I don't think this is intentional, as there is an isinstance check for bytes in the ``flatten_queryparams`` fu... | [
{
"content": "import codecs\nimport email.message\nimport logging\nimport mimetypes\nimport netrc\nimport os\nimport re\nimport sys\nimport time\nimport typing\nfrom pathlib import Path\nfrom urllib.request import getproxies\n\nimport sniffio\n\nfrom ._types import PrimitiveData\n\nif typing.TYPE_CHECKING: # p... | [
{
"content": "import codecs\nimport email.message\nimport logging\nimport mimetypes\nimport netrc\nimport os\nimport re\nimport sys\nimport time\nimport typing\nfrom pathlib import Path\nfrom urllib.request import getproxies\n\nimport sniffio\n\nfrom ._types import PrimitiveData\n\nif typing.TYPE_CHECKING: # p... | diff --git a/httpx/_utils.py b/httpx/_utils.py
index 1f64deedcd..1e1570ee7f 100644
--- a/httpx/_utils.py
+++ b/httpx/_utils.py
@@ -67,7 +67,11 @@ def primitive_value_to_str(value: "PrimitiveData") -> str:
return "false"
elif value is None:
return ""
- return str(value)
+ elif isinstance(val... |
scikit-image__scikit-image-6839 | `segmentation.watershed` returns wrong data type
### Description:
The documentation of `segmentation.watershed` says that:
> ### Returns
> **out**: ndarray
> A labeled matrix of the same type and shape as markers
[[0.18.x]](https://scikit-image.org/docs/0.18.x/api/skimage.segmentation.html#skimage.segmenta... | [
{
"content": "\"\"\"watershed.py - watershed algorithm\n\nThis module implements a watershed algorithm that apportions pixels into\nmarked basins. The algorithm uses a priority queue to hold the pixels\nwith the metric for the priority queue being pixel value, then the time\nof entry into the queue - this settl... | [
{
"content": "\"\"\"watershed.py - watershed algorithm\n\nThis module implements a watershed algorithm that apportions pixels into\nmarked basins. The algorithm uses a priority queue to hold the pixels\nwith the metric for the priority queue being pixel value, then the time\nof entry into the queue - this settl... | diff --git a/skimage/segmentation/_watershed.py b/skimage/segmentation/_watershed.py
index 244f7a3462d..9b47b8f1688 100644
--- a/skimage/segmentation/_watershed.py
+++ b/skimage/segmentation/_watershed.py
@@ -79,7 +79,7 @@ def _validate_inputs(image, markers, mask, connectivity):
f'shape as `ima... |
hylang__hy-2454 | `(hy.models.Symbol "#foo")` should be an error
for the same reason as `(hy.models.Symbol "5")`: `#foo` doesn't parse as a symbol. It parses as a reader-macro call.
| [
{
"content": "\"Character reader for parsing Hy source.\"\n\nfrom itertools import islice\n\nimport hy\nfrom hy.models import (\n Bytes,\n Complex,\n Dict,\n Expression,\n FComponent,\n Float,\n FString,\n Integer,\n Keyword,\n List,\n Set,\n String,\n Symbol,\n Tuple,\... | [
{
"content": "\"Character reader for parsing Hy source.\"\n\nfrom itertools import islice\n\nimport hy\nfrom hy.models import (\n Bytes,\n Complex,\n Dict,\n Expression,\n FComponent,\n Float,\n FString,\n Integer,\n Keyword,\n List,\n Set,\n String,\n Symbol,\n Tuple,\... | diff --git a/NEWS.rst b/NEWS.rst
index cbd903774..d4765e986 100644
--- a/NEWS.rst
+++ b/NEWS.rst
@@ -29,6 +29,8 @@ Bug Fixes
* The parser no longer looks for shebangs in the REPL or `hy -c`.
* `require` with relative module names should now work correctly with
`hy -m`, as well as `hy2py`'s recursive mode.
+* `hy.m... |
tobymao__sqlglot-1279 | type `TIMESTAMPTZ` doesn't exist in sparksql
sqlglot transpiles a trino type like `timestamp(6) with time zone` as the hive type `TIMESTAMPTZ` for spark, which isn't a spark type. I'd be happy to submit a PR if there's advice about how to address this.
```
>>> sqlglot.transpile('select cast(created as timestamp(6)... | [
{
"content": "from __future__ import annotations\n\nfrom sqlglot import exp, generator, parser, tokens, transforms\nfrom sqlglot.dialects.dialect import (\n Dialect,\n approx_count_distinct_sql,\n create_with_partitions_sql,\n format_time_lambda,\n if_sql,\n locate_to_strposition,\n min_or_... | [
{
"content": "from __future__ import annotations\n\nfrom sqlglot import exp, generator, parser, tokens, transforms\nfrom sqlglot.dialects.dialect import (\n Dialect,\n approx_count_distinct_sql,\n create_with_partitions_sql,\n format_time_lambda,\n if_sql,\n locate_to_strposition,\n min_or_... | diff --git a/sqlglot/dialects/hive.py b/sqlglot/dialects/hive.py
index c4b8fa9ce5..9f72347bcc 100644
--- a/sqlglot/dialects/hive.py
+++ b/sqlglot/dialects/hive.py
@@ -263,6 +263,7 @@ class Generator(generator.Generator):
exp.DataType.Type.TEXT: "STRING",
exp.DataType.Type.DATETIME: "TIMESTAMP"... |
interlegis__sapl-2981 | Retirar a OBRIGATORIEDADE na pesquisar para adicionar várias matérias na ordem do dia
<!--- Forneça um resumo geral da _issue_ no título acima -->
## Comportamento Esperado
<!--- Se você está descrevendo um _bug_, conte-nos o que deveria acontecer. -->
<!--- Se você está sugerindo uma mudança/melhoria, conte-nos c... | [
{
"content": "from datetime import datetime\n\nfrom crispy_forms.layout import HTML, Button, Fieldset, Layout\nfrom django import forms\nfrom django.contrib.contenttypes.models import ContentType\nfrom django.core.exceptions import ObjectDoesNotExist, ValidationError\nfrom django.db import transaction\nfrom dja... | [
{
"content": "from datetime import datetime\n\nfrom crispy_forms.layout import HTML, Button, Fieldset, Layout\nfrom django import forms\nfrom django.contrib.contenttypes.models import ContentType\nfrom django.core.exceptions import ObjectDoesNotExist, ValidationError\nfrom django.db import transaction\nfrom dja... | diff --git a/sapl/sessao/forms.py b/sapl/sessao/forms.py
index 01f0c3636..4e2a0498f 100644
--- a/sapl/sessao/forms.py
+++ b/sapl/sessao/forms.py
@@ -577,7 +577,7 @@ class AdicionarVariasMateriasFilterSet(MateriaLegislativaFilterSet):
o = MateriaPesquisaOrderingFilter()
tramitacao__status = django_filters.Mo... |
projectmesa__mesa-1256 | CI: test flake: batch runner sometimes takes 6 hours then gets killed by GitHub Actions
See e.g. https://github.com/projectmesa/mesa/runs/5259005495?check_suite_focus=true.
We might want to add timeout to batch runner tests, with https://pypi.org/project/pytest-timeout/.
| [
{
"content": "\"\"\"\nBatchrunner\n===========\n\nA single class to manage a batch run or parameter sweep of a given model.\n\n\"\"\"\nimport copy\nimport itertools\nimport random\nfrom collections import OrderedDict\nfrom functools import partial\nfrom itertools import count, product\nfrom multiprocessing impo... | [
{
"content": "\"\"\"\nBatchrunner\n===========\n\nA single class to manage a batch run or parameter sweep of a given model.\n\n\"\"\"\nimport copy\nimport itertools\nimport random\nfrom collections import OrderedDict\nfrom functools import partial\nfrom itertools import count, product\nfrom multiprocessing impo... | diff --git a/mesa/batchrunner.py b/mesa/batchrunner.py
index 4b19c47ee9c..0556a38f461 100644
--- a/mesa/batchrunner.py
+++ b/mesa/batchrunner.py
@@ -610,7 +610,7 @@ def __init__(
)
-class BatchRunnerMP(BatchRunner):
+class BatchRunnerMP(BatchRunner): # pragma: no cover
"""DEPRECATION WARNING: Bat... |
ManimCommunity__manim-235 | -f broken on windows
Basically the title.
When passing -f on windows in show the video file with the default video browser (like -p does) and not in the file explorer.
| [
{
"content": "import inspect\nimport os\nimport platform\nimport subprocess as sp\nimport sys\nimport re\nimport traceback\nimport importlib.util\nimport types\n\nfrom .config import file_writer_config\nfrom .scene.scene import Scene\nfrom .utils.sounds import play_error_sound\nfrom .utils.sounds import play_fi... | [
{
"content": "import inspect\nimport os\nimport platform\nimport subprocess as sp\nimport sys\nimport re\nimport traceback\nimport importlib.util\nimport types\n\nfrom .config import file_writer_config\nfrom .scene.scene import Scene\nfrom .utils.sounds import play_error_sound\nfrom .utils.sounds import play_fi... | diff --git a/manim/__main__.py b/manim/__main__.py
index fed9b7827a..1cee5c05a5 100644
--- a/manim/__main__.py
+++ b/manim/__main__.py
@@ -36,7 +36,7 @@ def open_file_if_needed(file_writer):
for file_path in file_paths:
if current_os == "Windows":
- os.startfile(file_path)
+ ... |
plotly__plotly.py-3763 | graphs from plotly >= 5.8 don't render in databricks
displaying a python figure in an iframe within databricks works with plotly==5.7 but when I attempt to do it using 5.8 it fails with `Uncaught SyntaxError: Unexpected token '&&'`:
![Screenshot from 2022-06-02 10-56-02](https://user-images.githubusercontent.com/410... | [
{
"content": "import uuid\nimport os\nfrom pathlib import Path\nimport webbrowser\n\nfrom _plotly_utils.optional_imports import get_module\nfrom plotly.io._utils import validate_coerce_fig_to_dict, plotly_cdn_url\nfrom plotly.offline.offline import _get_jconfig, get_plotlyjs\nfrom plotly import utils\n\n_json =... | [
{
"content": "import uuid\nimport os\nfrom pathlib import Path\nimport webbrowser\n\nfrom _plotly_utils.optional_imports import get_module\nfrom plotly.io._utils import validate_coerce_fig_to_dict, plotly_cdn_url\nfrom plotly.offline.offline import _get_jconfig, get_plotlyjs\nfrom plotly import utils\n\n_json =... | diff --git a/packages/python/plotly/plotly/io/_html.py b/packages/python/plotly/plotly/io/_html.py
index b6f61facc5a..606df721f33 100644
--- a/packages/python/plotly/plotly/io/_html.py
+++ b/packages/python/plotly/plotly/io/_html.py
@@ -20,7 +20,7 @@
_mathjax_config = """\
<script type="text/javascript">\
-if (wind... |
AUTOMATIC1111__stable-diffusion-webui-12327 | [Bug]: incorrect file path when prompt contains new line
### Is there an existing issue for this?
- [X] I have searched the existing issues and checked the recent builds/commits
### What happened?
prompt:
```
portrait of a woman, art by
Henry Asencio
Anton Fadeev
Artgerm
Bastien Lecouffe-Deharme
Carne Grif... | [
{
"content": "from __future__ import annotations\r\n\r\nimport datetime\r\n\r\nimport pytz\r\nimport io\r\nimport math\r\nimport os\r\nfrom collections import namedtuple\r\nimport re\r\n\r\nimport numpy as np\r\nimport piexif\r\nimport piexif.helper\r\nfrom PIL import Image, ImageFont, ImageDraw, ImageColor, Pn... | [
{
"content": "from __future__ import annotations\r\n\r\nimport datetime\r\n\r\nimport pytz\r\nimport io\r\nimport math\r\nimport os\r\nfrom collections import namedtuple\r\nimport re\r\n\r\nimport numpy as np\r\nimport piexif\r\nimport piexif.helper\r\nfrom PIL import Image, ImageFont, ImageDraw, ImageColor, Pn... | diff --git a/modules/images.py b/modules/images.py
index 38aa933d6e5..ba3c43a4509 100644
--- a/modules/images.py
+++ b/modules/images.py
@@ -318,7 +318,7 @@ def resize(im, w, h):
return res
-invalid_filename_chars = '<>:"/\\|?*\n'
+invalid_filename_chars = '<>:"/\\|?*\n\r\t'
invalid_filename_prefix = ' '... |
python-poetry__poetry-1673 | `poetry shell` with fish does not echo in python REPL
- [x] I am on the [latest](https://github.com/sdispater/poetry/releases/latest) Poetry version.
- [x] I have searched the [issues](https://github.com/sdispater/poetry/issues) of this repo and believe that this is not a duplicate.
- [x] If an exception occurs when ... | [
{
"content": "import os\nimport signal\nimport sys\n\nimport pexpect\n\nfrom clikit.utils.terminal import Terminal\nfrom shellingham import ShellDetectionFailure\nfrom shellingham import detect_shell\n\nfrom ._compat import WINDOWS\nfrom .env import VirtualEnv\n\n\nclass Shell:\n \"\"\"\n Represents the c... | [
{
"content": "import os\nimport signal\nimport sys\n\nimport pexpect\n\nfrom clikit.utils.terminal import Terminal\nfrom shellingham import ShellDetectionFailure\nfrom shellingham import detect_shell\n\nfrom ._compat import WINDOWS\nfrom .env import VirtualEnv\n\n\nclass Shell:\n \"\"\"\n Represents the c... | diff --git a/poetry/utils/shell.py b/poetry/utils/shell.py
index 5a6afb650e1..e883c80fc6e 100644
--- a/poetry/utils/shell.py
+++ b/poetry/utils/shell.py
@@ -58,7 +58,7 @@ def activate(self, env): # type: (VirtualEnv) -> None
self._path, ["-i"], dimensions=(terminal.height, terminal.width)
... |
ManageIQ__integration_tests-7470 | [BUG] get_mgmt blowing error if provider_key is a dict
This piece of code
https://github.com/ManageIQ/integration_tests/blob/3ccb7ac459f98df2da3c6b522ee257c80ae29aba/cfme/utils/providers.py#L389-L393
is causing `TypeError: unhashable type: 'AttrDict'` if `provider_key` is a unhashable type (dict).
using the first a... | [
{
"content": "\"\"\" Helper functions related to the creation, listing, filtering and destruction of providers\n\nThe list_providers function in this module depend on a (by default global) dict of filters.\nIf you are writing tests or fixtures, you want to depend on this function as a de facto gateway.\n\nThe r... | [
{
"content": "\"\"\" Helper functions related to the creation, listing, filtering and destruction of providers\n\nThe list_providers function in this module depend on a (by default global) dict of filters.\nIf you are writing tests or fixtures, you want to depend on this function as a de facto gateway.\n\nThe r... | diff --git a/cfme/utils/providers.py b/cfme/utils/providers.py
index 5c5844b579..7231eb7847 100644
--- a/cfme/utils/providers.py
+++ b/cfme/utils/providers.py
@@ -358,6 +358,7 @@ def get_mgmt(provider_key, providers=None, credentials=None):
# TODO rename the parameter; might break things
if isinstance(provide... |
saulpw__visidata-1887 | resize-cols-input missing from Column -> Resize menu
**Small description**
resize-cols-input is missing from the Column -> Resize menu
**Expected result**
when I go to the menu under Column -> Resize, I expect resize-cols-input (gz_) to be given as an option
**Additional context**
checked against v2.11
(Sub... | [
{
"content": "from visidata import VisiData, vd, Column, Sheet, Fanout\n\n@Column.api\ndef setWidth(self, w):\n if self.width != w:\n if self.width == 0 or w == 0: # hide/unhide\n vd.addUndo(setattr, self, '_width', self.width)\n self._width = w\n\n\n@Column.api\ndef toggleWidth(self, w... | [
{
"content": "from visidata import VisiData, vd, Column, Sheet, Fanout\n\n@Column.api\ndef setWidth(self, w):\n if self.width != w:\n if self.width == 0 or w == 0: # hide/unhide\n vd.addUndo(setattr, self, '_width', self.width)\n self._width = w\n\n\n@Column.api\ndef toggleWidth(self, w... | diff --git a/visidata/features/layout.py b/visidata/features/layout.py
index 32b29e5d5..eed59737f 100644
--- a/visidata/features/layout.py
+++ b/visidata/features/layout.py
@@ -50,4 +50,5 @@ def unhide_cols(vd, cols, rows):
Column > Resize > current column to max > resize-col-max
Column > Resize > current col... |
microsoft__ptvsd-297 | Unable to launch the debugger
Getting the following error in master when debugging in VSC:
```
Could not connect to None: 60857
Traceback (most recent call last):
File "/Users/donjayamanne/Desktop/Development/vscode/ptvsd/ptvsd/pydevd/pydevd.py", line 1620, in main
debugger.connect(host, port)
File "/User... | [
{
"content": "# Copyright (c) Microsoft Corporation. All rights reserved.\n# Licensed under the MIT License. See LICENSE in the project root\n# for license information.\n\nfrom ptvsd.__main__ import run_module, run_file\n\n\n__author__ = \"Microsoft Corporation <ptvshelp@microsoft.com>\"\n__version__ = \"4.0.0a... | [
{
"content": "# Copyright (c) Microsoft Corporation. All rights reserved.\n# Licensed under the MIT License. See LICENSE in the project root\n# for license information.\n\nfrom ptvsd.__main__ import run_module, run_file\n\n\n__author__ = \"Microsoft Corporation <ptvshelp@microsoft.com>\"\n__version__ = \"4.0.0a... | diff --git a/ptvsd/debugger.py b/ptvsd/debugger.py
index 00175be89..ec6717868 100644
--- a/ptvsd/debugger.py
+++ b/ptvsd/debugger.py
@@ -14,7 +14,7 @@
def debug(filename, port_num, debug_id, debug_options, run_as, **kwargs):
# TODO: docstring
- address = (None, port_num)
+ address = ('localhost', port_num... |
pypa__pipenv-3338 | package in a namespace from pip fails to lock
I checked the diagnose.
### Issue description
installing a package from pip with a namespace, i.e. fsc.export results in locking-failure, since (I assume) pipenv looks for `fsc-export` on https://pypi.org/simple and not for `fsc.export` (which is available). This pa... | [
{
"content": "# -*- coding: utf-8 -*-\nimport base64\nimport fnmatch\nimport glob\nimport hashlib\nimport io\nimport json\nimport operator\nimport os\nimport re\nimport sys\n\nimport six\nimport toml\nimport tomlkit\nimport vistir\n\nfrom first import first\n\nimport pipfile\nimport pipfile.api\n\nfrom cached_p... | [
{
"content": "# -*- coding: utf-8 -*-\nimport base64\nimport fnmatch\nimport glob\nimport hashlib\nimport io\nimport json\nimport operator\nimport os\nimport re\nimport sys\n\nimport six\nimport toml\nimport tomlkit\nimport vistir\n\nfrom first import first\n\nimport pipfile\nimport pipfile.api\n\nfrom cached_p... | diff --git a/news/3324.bugfix.rst b/news/3324.bugfix.rst
new file mode 100644
index 0000000000..d13a8d468f
--- /dev/null
+++ b/news/3324.bugfix.rst
@@ -0,0 +1 @@
+Don't normalize the package name user passes in.
diff --git a/pipenv/project.py b/pipenv/project.py
index 46f82cf34c..e8550a041a 100644
--- a/pipenv/project.... |
ibis-project__ibis-1951 | Implement Interval arithmetic on one or more backends
After subtraction is in from #1489, we'll want to implement this on at least one backend.
| [
{
"content": "import datetime\n\nimport numpy as np\nimport pandas as pd\nfrom pandas.core.groupby import SeriesGroupBy\n\nimport ibis\nimport ibis.expr.datatypes as dt\nimport ibis.expr.operations as ops\nfrom ibis.pandas.core import (\n date_types,\n integer_types,\n numeric_types,\n timedelta_typ... | [
{
"content": "import datetime\n\nimport numpy as np\nimport pandas as pd\nfrom pandas.core.groupby import SeriesGroupBy\n\nimport ibis\nimport ibis.expr.datatypes as dt\nimport ibis.expr.operations as ops\nfrom ibis.pandas.core import (\n date_types,\n integer_types,\n numeric_types,\n timedelta_typ... | diff --git a/ibis/pandas/execution/temporal.py b/ibis/pandas/execution/temporal.py
index a3eecf3735cc..2d193a03e7c4 100644
--- a/ibis/pandas/execution/temporal.py
+++ b/ibis/pandas/execution/temporal.py
@@ -184,7 +184,9 @@ def execute_timestamp_sub_series_timedelta(op, left, right, **kwargs):
@execute_node.registe... |
getpelican__pelican-2632 | Add Markdown as an (optional) dependency
Since its inception, this project has taken the collective position that since not everyone uses Markdown, the `markdown` package should not be a dependency of the project and should instead be manually installed by users who want to use Markdown.
On the other hand, the `docu... | [
{
"content": "#!/usr/bin/env python\nimport sys\nfrom io import open\nfrom os import walk\nfrom os.path import join, relpath\n\nfrom setuptools import setup\n\n\nversion = \"4.1.2\"\n\nrequires = ['feedgenerator >= 1.9', 'jinja2 >= 2.7', 'pygments', 'docutils',\n 'pytz >= 0a', 'blinker', 'unidecode',... | [
{
"content": "#!/usr/bin/env python\nimport sys\nfrom io import open\nfrom os import walk\nfrom os.path import join, relpath\n\nfrom setuptools import setup\n\n\nversion = \"4.1.2\"\n\nrequires = ['feedgenerator >= 1.9', 'jinja2 >= 2.7', 'pygments', 'docutils',\n 'pytz >= 0a', 'blinker', 'unidecode',... | diff --git a/docs/install.rst b/docs/install.rst
index 571de95e8..2da7b9be2 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -9,6 +9,10 @@ You can install Pelican via several different methods. The simplest is via
pip install pelican
+Or, if you plan on using Markdown::
+
+ pip install pelican[Markdo... |
gratipay__gratipay.com-2948 | VirtualEnv error with Windows + Vagrant
No idea where to even start with this one. Fresh clone with fresh vagrant box.
Here's the weird part, at home my Windows 8.1 x64 computer experiences this problem but my Windows 7 x64 computer at work doesn't. This also happens to @abnor
```
vagrant@precise64:~/www.gittip.com$... | [
{
"content": "from faker import Factory\nfrom gratipay import wireup, MAX_TIP_SINGULAR, MIN_TIP\nfrom gratipay.elsewhere import PLATFORMS\nfrom gratipay.models.participant import Participant\n\nimport datetime\nimport decimal\nimport random\nimport string\n\n\nfaker = Factory.create()\n\n\ndef _fake_thing(db, t... | [
{
"content": "from faker import Factory\nfrom gratipay import wireup, MAX_TIP_SINGULAR, MIN_TIP\nfrom gratipay.elsewhere import PLATFORMS\nfrom gratipay.models.participant import Participant\n\nimport datetime\nimport decimal\nimport random\nimport string\n\n\nfaker = Factory.create()\n\n\ndef _fake_thing(db, t... | diff --git a/Makefile b/Makefile
index 5360cadb7d..39fdc9707f 100644
--- a/Makefile
+++ b/Makefile
@@ -16,6 +16,7 @@ env: requirements.txt requirements_tests.txt setup.py
--unzip-setuptools \
--prompt="[gratipay] " \
--extra-search-dir=./vendor/ \
+ --always-copy \
./env/
$(pip) install -r requ... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.