\n+ <ResponseMetadata>\n+ <RequestId>9fb7e2db-6998-11e2-a985-57c82EXAMPLE</RequestId>\n+ </ResponseMetadata>\n+ </SetDesiredCapacityResponse>\n+ \"\"\"\n+\n+ def test_honor_cooldown(self):\n+ self.set_http_response(status_code=200)\n+ self.service_connection.set_desired_capacity('foo', 10, True)\n+ self.assert_request_parameters({\n+ 'Action': 'SetDesiredCapacity',\n+ 'AutoScalingGroupName': 'foo',\n+ 'DesiredCapacity': 10,\n+ 'HonorCooldown': 'true',\n+ }, ignore_params_values=['Version'])\n+\n class TestScheduledGroup(AWSMockServiceTestCase):\n connection_class = AutoScaleConnection\n \n"}}},{"rowIdx":4658,"cells":{"in_source_id":{"kind":"string","value":"open-telemetry__opentelemetry-python-contrib-1313"},"issue":{"kind":"string","value":"is_instrumented_by_opentelemetry is not set in _InstrumentedFastAPI class\n**Steps to reproduce**\r\nIf `instrument_app` function is called for already instrumented object of `_InstrumentedFastAPI` then it will add Opentelemtery middleware again in the `user_middleware` list as `is_instrumented_by_opentelemetry` is not set in the `__init__` function of `_InstrumentedFastAPI`.\r\n\r\n**What is the expected behavior?**\r\nIf a fastapi app is already instrumented, i.e., it already has otel middleware in it then it shouldn't add another one.\r\n\r\n**What is the actual behavior?**\r\nMultiple otel middlewares are added.\n"},"before_files":{"kind":"list like","value":[{"content":"# Copyright The OpenTelemetry Authors\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\"\"\"\nUsage\n-----\n\n.. code-block:: python\n\n import fastapi\n from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor\n\n app = fastapi.FastAPI()\n\n @app.get(\"/foobar\")\n async def foobar():\n return {\"message\": \"hello world\"}\n\n FastAPIInstrumentor.instrument_app(app)\n\nConfiguration\n-------------\n\nExclude lists\n*************\nTo exclude certain URLs from being tracked, set the environment variable ``OTEL_PYTHON_FASTAPI_EXCLUDED_URLS``\n(or ``OTEL_PYTHON_EXCLUDED_URLS`` as fallback) with comma delimited regexes representing which URLs to exclude.\n\nFor example,\n\n::\n\n export OTEL_PYTHON_FASTAPI_EXCLUDED_URLS=\"client/.*/info,healthcheck\"\n\nwill exclude requests such as ``https://site/client/123/info`` and ``https://site/xyz/healthcheck``.\n\nYou can also pass the comma delimited regexes to the ``instrument_app`` method directly:\n\n.. code-block:: python\n\n FastAPIInstrumentor.instrument_app(app, excluded_urls=\"client/.*/info,healthcheck\")\n\nRequest/Response hooks\n**********************\n\nUtilize request/response hooks to execute custom logic to be performed before/after performing a request. The server request hook takes in a server span and ASGI\nscope object for every incoming request. The client request hook is called with the internal span and an ASGI scope which is sent as a dictionary for when the method receive is called.\nThe client response hook is called with the internal span and an ASGI event which is sent as a dictionary for when the method send is called.\n\n.. code-block:: python\n\n def server_request_hook(span: Span, scope: dict):\n if span and span.is_recording():\n span.set_attribute(\"custom_user_attribute_from_request_hook\", \"some-value\")\n\n def client_request_hook(span: Span, scope: dict):\n if span and span.is_recording():\n span.set_attribute(\"custom_user_attribute_from_client_request_hook\", \"some-value\")\n\n def client_response_hook(span: Span, message: dict):\n if span and span.is_recording():\n span.set_attribute(\"custom_user_attribute_from_response_hook\", \"some-value\")\n\n FastAPIInstrumentor().instrument(server_request_hook=server_request_hook, client_request_hook=client_request_hook, client_response_hook=client_response_hook)\n\nCapture HTTP request and response headers\n*****************************************\nYou can configure the agent to capture predefined HTTP headers as span attributes, according to the `semantic convention <https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-request-and-response-headers>`_.\n\nRequest headers\n***************\nTo capture predefined HTTP request headers as span attributes, set the environment variable ``OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST``\nto a comma-separated list of HTTP header names.\n\nFor example,\n\n::\n\n export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST=\"content-type,custom_request_header\"\n\nwill extract ``content-type`` and ``custom_request_header`` from request headers and add them as span attributes.\n\nIt is recommended that you should give the correct names of the headers to be captured in the environment variable.\nRequest header names in fastapi are case insensitive. So, giving header name as ``CUStom-Header`` in environment variable will be able capture header with name ``custom-header``.\n\nThe name of the added span attribute will follow the format ``http.request.header.<header_name>`` where ``<header_name>`` being the normalized HTTP header name (lowercase, with - characters replaced by _ ).\nThe value of the attribute will be single item list containing all the header values.\n\nExample of the added span attribute,\n``http.request.header.custom_request_header = [\"<value1>,<value2>\"]``\n\nResponse headers\n****************\nTo capture predefined HTTP response headers as span attributes, set the environment variable ``OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE``\nto a comma-separated list of HTTP header names.\n\nFor example,\n\n::\n\n export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE=\"content-type,custom_response_header\"\n\nwill extract ``content-type`` and ``custom_response_header`` from response headers and add them as span attributes.\n\nIt is recommended that you should give the correct names of the headers to be captured in the environment variable.\nResponse header names captured in fastapi are case insensitive. So, giving header name as ``CUStomHeader`` in environment variable will be able capture header with name ``customheader``.\n\nThe name of the added span attribute will follow the format ``http.response.header.<header_name>`` where ``<header_name>`` being the normalized HTTP header name (lowercase, with - characters replaced by _ ).\nThe value of the attribute will be single item list containing all the header values.\n\nExample of the added span attribute,\n``http.response.header.custom_response_header = [\"<value1>,<value2>\"]``\n\nNote:\n Environment variable names to capture http headers are still experimental, and thus are subject to change.\n\nAPI\n---\n\"\"\"\nimport logging\nimport typing\nfrom typing import Collection\n\nimport fastapi\nfrom starlette.routing import Match\n\nfrom opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware\nfrom opentelemetry.instrumentation.asgi.package import _instruments\nfrom opentelemetry.instrumentation.instrumentor import BaseInstrumentor\nfrom opentelemetry.semconv.trace import SpanAttributes\nfrom opentelemetry.trace import Span\nfrom opentelemetry.util.http import get_excluded_urls, parse_excluded_urls\n\n_excluded_urls_from_env = get_excluded_urls(\"FASTAPI\")\n_logger = logging.getLogger(__name__)\n\n_ServerRequestHookT = typing.Optional[typing.Callable[[Span, dict], None]]\n_ClientRequestHookT = typing.Optional[typing.Callable[[Span, dict], None]]\n_ClientResponseHookT = typing.Optional[typing.Callable[[Span, dict], None]]\n\n\nclass FastAPIInstrumentor(BaseInstrumentor):\n \"\"\"An instrumentor for FastAPI\n\n See `BaseInstrumentor`\n \"\"\"\n\n _original_fastapi = None\n\n @staticmethod\n def instrument_app(\n app: fastapi.FastAPI,\n server_request_hook: _ServerRequestHookT = None,\n client_request_hook: _ClientRequestHookT = None,\n client_response_hook: _ClientResponseHookT = None,\n tracer_provider=None,\n excluded_urls=None,\n ):\n \"\"\"Instrument an uninstrumented FastAPI application.\"\"\"\n if not hasattr(app, \"_is_instrumented_by_opentelemetry\"):\n app._is_instrumented_by_opentelemetry = False\n\n if not getattr(app, \"_is_instrumented_by_opentelemetry\", False):\n if excluded_urls is None:\n excluded_urls = _excluded_urls_from_env\n else:\n excluded_urls = parse_excluded_urls(excluded_urls)\n\n app.add_middleware(\n OpenTelemetryMiddleware,\n excluded_urls=excluded_urls,\n default_span_details=_get_route_details,\n server_request_hook=server_request_hook,\n client_request_hook=client_request_hook,\n client_response_hook=client_response_hook,\n tracer_provider=tracer_provider,\n )\n app._is_instrumented_by_opentelemetry = True\n else:\n _logger.warning(\n \"Attempting to instrument FastAPI app while already instrumented\"\n )\n\n @staticmethod\n def uninstrument_app(app: fastapi.FastAPI):\n app.user_middleware = [\n x\n for x in app.user_middleware\n if x.cls is not OpenTelemetryMiddleware\n ]\n app.middleware_stack = app.build_middleware_stack()\n app._is_instrumented_by_opentelemetry = False\n\n def instrumentation_dependencies(self) -> Collection[str]:\n return _instruments\n\n def _instrument(self, **kwargs):\n self._original_fastapi = fastapi.FastAPI\n _InstrumentedFastAPI._tracer_provider = kwargs.get(\"tracer_provider\")\n _InstrumentedFastAPI._server_request_hook = kwargs.get(\n \"server_request_hook\"\n )\n _InstrumentedFastAPI._client_request_hook = kwargs.get(\n \"client_request_hook\"\n )\n _InstrumentedFastAPI._client_response_hook = kwargs.get(\n \"client_response_hook\"\n )\n _excluded_urls = kwargs.get(\"excluded_urls\")\n _InstrumentedFastAPI._excluded_urls = (\n _excluded_urls_from_env\n if _excluded_urls is None\n else parse_excluded_urls(_excluded_urls)\n )\n fastapi.FastAPI = _InstrumentedFastAPI\n\n def _uninstrument(self, **kwargs):\n fastapi.FastAPI = self._original_fastapi\n\n\nclass _InstrumentedFastAPI(fastapi.FastAPI):\n _tracer_provider = None\n _excluded_urls = None\n _server_request_hook: _ServerRequestHookT = None\n _client_request_hook: _ClientRequestHookT = None\n _client_response_hook: _ClientResponseHookT = None\n\n def __init__(self, *args, **kwargs):\n super().__init__(*args, **kwargs)\n self.add_middleware(\n OpenTelemetryMiddleware,\n excluded_urls=_InstrumentedFastAPI._excluded_urls,\n default_span_details=_get_route_details,\n server_request_hook=_InstrumentedFastAPI._server_request_hook,\n client_request_hook=_InstrumentedFastAPI._client_request_hook,\n client_response_hook=_InstrumentedFastAPI._client_response_hook,\n tracer_provider=_InstrumentedFastAPI._tracer_provider,\n )\n\n\ndef _get_route_details(scope):\n \"\"\"Callback to retrieve the fastapi route being served.\n\n TODO: there is currently no way to retrieve http.route from\n a starlette application from scope.\n\n See: https://github.com/encode/starlette/pull/804\n \"\"\"\n app = scope[\"app\"]\n route = None\n for starlette_route in app.routes:\n match, _ = starlette_route.matches(scope)\n if match == Match.FULL:\n route = starlette_route.path\n break\n if match == Match.PARTIAL:\n route = starlette_route.path\n # method only exists for http, if websocket\n # leave it blank.\n span_name = route or scope.get(\"method\", \"\")\n attributes = {}\n if route:\n attributes[SpanAttributes.HTTP_ROUTE] = route\n return span_name, attributes\n","path":"instrumentation/opentelemetry-instrumentation-fastapi/src/opentelemetry/instrumentation/fastapi/__init__.py"}],"string":"[\n {\n \"content\": \"# Copyright The OpenTelemetry Authors\\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\\\"\\\"\\\"\\nUsage\\n-----\\n\\n.. code-block:: python\\n\\n import fastapi\\n from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor\\n\\n app = fastapi.FastAPI()\\n\\n @app.get(\\\"/foobar\\\")\\n async def foobar():\\n return {\\\"message\\\": \\\"hello world\\\"}\\n\\n FastAPIInstrumentor.instrument_app(app)\\n\\nConfiguration\\n-------------\\n\\nExclude lists\\n*************\\nTo exclude certain URLs from being tracked, set the environment variable ``OTEL_PYTHON_FASTAPI_EXCLUDED_URLS``\\n(or ``OTEL_PYTHON_EXCLUDED_URLS`` as fallback) with comma delimited regexes representing which URLs to exclude.\\n\\nFor example,\\n\\n::\\n\\n export OTEL_PYTHON_FASTAPI_EXCLUDED_URLS=\\\"client/.*/info,healthcheck\\\"\\n\\nwill exclude requests such as ``https://site/client/123/info`` and ``https://site/xyz/healthcheck``.\\n\\nYou can also pass the comma delimited regexes to the ``instrument_app`` method directly:\\n\\n.. code-block:: python\\n\\n FastAPIInstrumentor.instrument_app(app, excluded_urls=\\\"client/.*/info,healthcheck\\\")\\n\\nRequest/Response hooks\\n**********************\\n\\nUtilize request/response hooks to execute custom logic to be performed before/after performing a request. The server request hook takes in a server span and ASGI\\nscope object for every incoming request. The client request hook is called with the internal span and an ASGI scope which is sent as a dictionary for when the method receive is called.\\nThe client response hook is called with the internal span and an ASGI event which is sent as a dictionary for when the method send is called.\\n\\n.. code-block:: python\\n\\n def server_request_hook(span: Span, scope: dict):\\n if span and span.is_recording():\\n span.set_attribute(\\\"custom_user_attribute_from_request_hook\\\", \\\"some-value\\\")\\n\\n def client_request_hook(span: Span, scope: dict):\\n if span and span.is_recording():\\n span.set_attribute(\\\"custom_user_attribute_from_client_request_hook\\\", \\\"some-value\\\")\\n\\n def client_response_hook(span: Span, message: dict):\\n if span and span.is_recording():\\n span.set_attribute(\\\"custom_user_attribute_from_response_hook\\\", \\\"some-value\\\")\\n\\n FastAPIInstrumentor().instrument(server_request_hook=server_request_hook, client_request_hook=client_request_hook, client_response_hook=client_response_hook)\\n\\nCapture HTTP request and response headers\\n*****************************************\\nYou can configure the agent to capture predefined HTTP headers as span attributes, according to the `semantic convention <https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-request-and-response-headers>`_.\\n\\nRequest headers\\n***************\\nTo capture predefined HTTP request headers as span attributes, set the environment variable ``OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST``\\nto a comma-separated list of HTTP header names.\\n\\nFor example,\\n\\n::\\n\\n export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST=\\\"content-type,custom_request_header\\\"\\n\\nwill extract ``content-type`` and ``custom_request_header`` from request headers and add them as span attributes.\\n\\nIt is recommended that you should give the correct names of the headers to be captured in the environment variable.\\nRequest header names in fastapi are case insensitive. So, giving header name as ``CUStom-Header`` in environment variable will be able capture header with name ``custom-header``.\\n\\nThe name of the added span attribute will follow the format ``http.request.header.<header_name>`` where ``<header_name>`` being the normalized HTTP header name (lowercase, with - characters replaced by _ ).\\nThe value of the attribute will be single item list containing all the header values.\\n\\nExample of the added span attribute,\\n``http.request.header.custom_request_header = [\\\"<value1>,<value2>\\\"]``\\n\\nResponse headers\\n****************\\nTo capture predefined HTTP response headers as span attributes, set the environment variable ``OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE``\\nto a comma-separated list of HTTP header names.\\n\\nFor example,\\n\\n::\\n\\n export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE=\\\"content-type,custom_response_header\\\"\\n\\nwill extract ``content-type`` and ``custom_response_header`` from response headers and add them as span attributes.\\n\\nIt is recommended that you should give the correct names of the headers to be captured in the environment variable.\\nResponse header names captured in fastapi are case insensitive. So, giving header name as ``CUStomHeader`` in environment variable will be able capture header with name ``customheader``.\\n\\nThe name of the added span attribute will follow the format ``http.response.header.<header_name>`` where ``<header_name>`` being the normalized HTTP header name (lowercase, with - characters replaced by _ ).\\nThe value of the attribute will be single item list containing all the header values.\\n\\nExample of the added span attribute,\\n``http.response.header.custom_response_header = [\\\"<value1>,<value2>\\\"]``\\n\\nNote:\\n Environment variable names to capture http headers are still experimental, and thus are subject to change.\\n\\nAPI\\n---\\n\\\"\\\"\\\"\\nimport logging\\nimport typing\\nfrom typing import Collection\\n\\nimport fastapi\\nfrom starlette.routing import Match\\n\\nfrom opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware\\nfrom opentelemetry.instrumentation.asgi.package import _instruments\\nfrom opentelemetry.instrumentation.instrumentor import BaseInstrumentor\\nfrom opentelemetry.semconv.trace import SpanAttributes\\nfrom opentelemetry.trace import Span\\nfrom opentelemetry.util.http import get_excluded_urls, parse_excluded_urls\\n\\n_excluded_urls_from_env = get_excluded_urls(\\\"FASTAPI\\\")\\n_logger = logging.getLogger(__name__)\\n\\n_ServerRequestHookT = typing.Optional[typing.Callable[[Span, dict], None]]\\n_ClientRequestHookT = typing.Optional[typing.Callable[[Span, dict], None]]\\n_ClientResponseHookT = typing.Optional[typing.Callable[[Span, dict], None]]\\n\\n\\nclass FastAPIInstrumentor(BaseInstrumentor):\\n \\\"\\\"\\\"An instrumentor for FastAPI\\n\\n See `BaseInstrumentor`\\n \\\"\\\"\\\"\\n\\n _original_fastapi = None\\n\\n @staticmethod\\n def instrument_app(\\n app: fastapi.FastAPI,\\n server_request_hook: _ServerRequestHookT = None,\\n client_request_hook: _ClientRequestHookT = None,\\n client_response_hook: _ClientResponseHookT = None,\\n tracer_provider=None,\\n excluded_urls=None,\\n ):\\n \\\"\\\"\\\"Instrument an uninstrumented FastAPI application.\\\"\\\"\\\"\\n if not hasattr(app, \\\"_is_instrumented_by_opentelemetry\\\"):\\n app._is_instrumented_by_opentelemetry = False\\n\\n if not getattr(app, \\\"_is_instrumented_by_opentelemetry\\\", False):\\n if excluded_urls is None:\\n excluded_urls = _excluded_urls_from_env\\n else:\\n excluded_urls = parse_excluded_urls(excluded_urls)\\n\\n app.add_middleware(\\n OpenTelemetryMiddleware,\\n excluded_urls=excluded_urls,\\n default_span_details=_get_route_details,\\n server_request_hook=server_request_hook,\\n client_request_hook=client_request_hook,\\n client_response_hook=client_response_hook,\\n tracer_provider=tracer_provider,\\n )\\n app._is_instrumented_by_opentelemetry = True\\n else:\\n _logger.warning(\\n \\\"Attempting to instrument FastAPI app while already instrumented\\\"\\n )\\n\\n @staticmethod\\n def uninstrument_app(app: fastapi.FastAPI):\\n app.user_middleware = [\\n x\\n for x in app.user_middleware\\n if x.cls is not OpenTelemetryMiddleware\\n ]\\n app.middleware_stack = app.build_middleware_stack()\\n app._is_instrumented_by_opentelemetry = False\\n\\n def instrumentation_dependencies(self) -> Collection[str]:\\n return _instruments\\n\\n def _instrument(self, **kwargs):\\n self._original_fastapi = fastapi.FastAPI\\n _InstrumentedFastAPI._tracer_provider = kwargs.get(\\\"tracer_provider\\\")\\n _InstrumentedFastAPI._server_request_hook = kwargs.get(\\n \\\"server_request_hook\\\"\\n )\\n _InstrumentedFastAPI._client_request_hook = kwargs.get(\\n \\\"client_request_hook\\\"\\n )\\n _InstrumentedFastAPI._client_response_hook = kwargs.get(\\n \\\"client_response_hook\\\"\\n )\\n _excluded_urls = kwargs.get(\\\"excluded_urls\\\")\\n _InstrumentedFastAPI._excluded_urls = (\\n _excluded_urls_from_env\\n if _excluded_urls is None\\n else parse_excluded_urls(_excluded_urls)\\n )\\n fastapi.FastAPI = _InstrumentedFastAPI\\n\\n def _uninstrument(self, **kwargs):\\n fastapi.FastAPI = self._original_fastapi\\n\\n\\nclass _InstrumentedFastAPI(fastapi.FastAPI):\\n _tracer_provider = None\\n _excluded_urls = None\\n _server_request_hook: _ServerRequestHookT = None\\n _client_request_hook: _ClientRequestHookT = None\\n _client_response_hook: _ClientResponseHookT = None\\n\\n def __init__(self, *args, **kwargs):\\n super().__init__(*args, **kwargs)\\n self.add_middleware(\\n OpenTelemetryMiddleware,\\n excluded_urls=_InstrumentedFastAPI._excluded_urls,\\n default_span_details=_get_route_details,\\n server_request_hook=_InstrumentedFastAPI._server_request_hook,\\n client_request_hook=_InstrumentedFastAPI._client_request_hook,\\n client_response_hook=_InstrumentedFastAPI._client_response_hook,\\n tracer_provider=_InstrumentedFastAPI._tracer_provider,\\n )\\n\\n\\ndef _get_route_details(scope):\\n \\\"\\\"\\\"Callback to retrieve the fastapi route being served.\\n\\n TODO: there is currently no way to retrieve http.route from\\n a starlette application from scope.\\n\\n See: https://github.com/encode/starlette/pull/804\\n \\\"\\\"\\\"\\n app = scope[\\\"app\\\"]\\n route = None\\n for starlette_route in app.routes:\\n match, _ = starlette_route.matches(scope)\\n if match == Match.FULL:\\n route = starlette_route.path\\n break\\n if match == Match.PARTIAL:\\n route = starlette_route.path\\n # method only exists for http, if websocket\\n # leave it blank.\\n span_name = route or scope.get(\\\"method\\\", \\\"\\\")\\n attributes = {}\\n if route:\\n attributes[SpanAttributes.HTTP_ROUTE] = route\\n return span_name, attributes\\n\",\n \"path\": \"instrumentation/opentelemetry-instrumentation-fastapi/src/opentelemetry/instrumentation/fastapi/__init__.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# Copyright The OpenTelemetry Authors\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\"\"\"\nUsage\n-----\n\n.. code-block:: python\n\n import fastapi\n from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor\n\n app = fastapi.FastAPI()\n\n @app.get(\"/foobar\")\n async def foobar():\n return {\"message\": \"hello world\"}\n\n FastAPIInstrumentor.instrument_app(app)\n\nConfiguration\n-------------\n\nExclude lists\n*************\nTo exclude certain URLs from being tracked, set the environment variable ``OTEL_PYTHON_FASTAPI_EXCLUDED_URLS``\n(or ``OTEL_PYTHON_EXCLUDED_URLS`` as fallback) with comma delimited regexes representing which URLs to exclude.\n\nFor example,\n\n::\n\n export OTEL_PYTHON_FASTAPI_EXCLUDED_URLS=\"client/.*/info,healthcheck\"\n\nwill exclude requests such as ``https://site/client/123/info`` and ``https://site/xyz/healthcheck``.\n\nYou can also pass the comma delimited regexes to the ``instrument_app`` method directly:\n\n.. code-block:: python\n\n FastAPIInstrumentor.instrument_app(app, excluded_urls=\"client/.*/info,healthcheck\")\n\nRequest/Response hooks\n**********************\n\nUtilize request/response hooks to execute custom logic to be performed before/after performing a request. The server request hook takes in a server span and ASGI\nscope object for every incoming request. The client request hook is called with the internal span and an ASGI scope which is sent as a dictionary for when the method receive is called.\nThe client response hook is called with the internal span and an ASGI event which is sent as a dictionary for when the method send is called.\n\n.. code-block:: python\n\n def server_request_hook(span: Span, scope: dict):\n if span and span.is_recording():\n span.set_attribute(\"custom_user_attribute_from_request_hook\", \"some-value\")\n\n def client_request_hook(span: Span, scope: dict):\n if span and span.is_recording():\n span.set_attribute(\"custom_user_attribute_from_client_request_hook\", \"some-value\")\n\n def client_response_hook(span: Span, message: dict):\n if span and span.is_recording():\n span.set_attribute(\"custom_user_attribute_from_response_hook\", \"some-value\")\n\n FastAPIInstrumentor().instrument(server_request_hook=server_request_hook, client_request_hook=client_request_hook, client_response_hook=client_response_hook)\n\nCapture HTTP request and response headers\n*****************************************\nYou can configure the agent to capture predefined HTTP headers as span attributes, according to the `semantic convention <https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-request-and-response-headers>`_.\n\nRequest headers\n***************\nTo capture predefined HTTP request headers as span attributes, set the environment variable ``OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST``\nto a comma-separated list of HTTP header names.\n\nFor example,\n\n::\n\n export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST=\"content-type,custom_request_header\"\n\nwill extract ``content-type`` and ``custom_request_header`` from request headers and add them as span attributes.\n\nIt is recommended that you should give the correct names of the headers to be captured in the environment variable.\nRequest header names in fastapi are case insensitive. So, giving header name as ``CUStom-Header`` in environment variable will be able capture header with name ``custom-header``.\n\nThe name of the added span attribute will follow the format ``http.request.header.<header_name>`` where ``<header_name>`` being the normalized HTTP header name (lowercase, with - characters replaced by _ ).\nThe value of the attribute will be single item list containing all the header values.\n\nExample of the added span attribute,\n``http.request.header.custom_request_header = [\"<value1>,<value2>\"]``\n\nResponse headers\n****************\nTo capture predefined HTTP response headers as span attributes, set the environment variable ``OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE``\nto a comma-separated list of HTTP header names.\n\nFor example,\n\n::\n\n export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE=\"content-type,custom_response_header\"\n\nwill extract ``content-type`` and ``custom_response_header`` from response headers and add them as span attributes.\n\nIt is recommended that you should give the correct names of the headers to be captured in the environment variable.\nResponse header names captured in fastapi are case insensitive. So, giving header name as ``CUStomHeader`` in environment variable will be able capture header with name ``customheader``.\n\nThe name of the added span attribute will follow the format ``http.response.header.<header_name>`` where ``<header_name>`` being the normalized HTTP header name (lowercase, with - characters replaced by _ ).\nThe value of the attribute will be single item list containing all the header values.\n\nExample of the added span attribute,\n``http.response.header.custom_response_header = [\"<value1>,<value2>\"]``\n\nNote:\n Environment variable names to capture http headers are still experimental, and thus are subject to change.\n\nAPI\n---\n\"\"\"\nimport logging\nimport typing\nfrom typing import Collection\n\nimport fastapi\nfrom starlette.routing import Match\n\nfrom opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware\nfrom opentelemetry.instrumentation.asgi.package import _instruments\nfrom opentelemetry.instrumentation.instrumentor import BaseInstrumentor\nfrom opentelemetry.semconv.trace import SpanAttributes\nfrom opentelemetry.trace import Span\nfrom opentelemetry.util.http import get_excluded_urls, parse_excluded_urls\n\n_excluded_urls_from_env = get_excluded_urls(\"FASTAPI\")\n_logger = logging.getLogger(__name__)\n\n_ServerRequestHookT = typing.Optional[typing.Callable[[Span, dict], None]]\n_ClientRequestHookT = typing.Optional[typing.Callable[[Span, dict], None]]\n_ClientResponseHookT = typing.Optional[typing.Callable[[Span, dict], None]]\n\n\nclass FastAPIInstrumentor(BaseInstrumentor):\n \"\"\"An instrumentor for FastAPI\n\n See `BaseInstrumentor`\n \"\"\"\n\n _original_fastapi = None\n\n @staticmethod\n def instrument_app(\n app: fastapi.FastAPI,\n server_request_hook: _ServerRequestHookT = None,\n client_request_hook: _ClientRequestHookT = None,\n client_response_hook: _ClientResponseHookT = None,\n tracer_provider=None,\n excluded_urls=None,\n ):\n \"\"\"Instrument an uninstrumented FastAPI application.\"\"\"\n if not hasattr(app, \"_is_instrumented_by_opentelemetry\"):\n app._is_instrumented_by_opentelemetry = False\n\n if not getattr(app, \"_is_instrumented_by_opentelemetry\", False):\n if excluded_urls is None:\n excluded_urls = _excluded_urls_from_env\n else:\n excluded_urls = parse_excluded_urls(excluded_urls)\n\n app.add_middleware(\n OpenTelemetryMiddleware,\n excluded_urls=excluded_urls,\n default_span_details=_get_route_details,\n server_request_hook=server_request_hook,\n client_request_hook=client_request_hook,\n client_response_hook=client_response_hook,\n tracer_provider=tracer_provider,\n )\n app._is_instrumented_by_opentelemetry = True\n else:\n _logger.warning(\n \"Attempting to instrument FastAPI app while already instrumented\"\n )\n\n @staticmethod\n def uninstrument_app(app: fastapi.FastAPI):\n app.user_middleware = [\n x\n for x in app.user_middleware\n if x.cls is not OpenTelemetryMiddleware\n ]\n app.middleware_stack = app.build_middleware_stack()\n app._is_instrumented_by_opentelemetry = False\n\n def instrumentation_dependencies(self) -> Collection[str]:\n return _instruments\n\n def _instrument(self, **kwargs):\n self._original_fastapi = fastapi.FastAPI\n _InstrumentedFastAPI._tracer_provider = kwargs.get(\"tracer_provider\")\n _InstrumentedFastAPI._server_request_hook = kwargs.get(\n \"server_request_hook\"\n )\n _InstrumentedFastAPI._client_request_hook = kwargs.get(\n \"client_request_hook\"\n )\n _InstrumentedFastAPI._client_response_hook = kwargs.get(\n \"client_response_hook\"\n )\n _excluded_urls = kwargs.get(\"excluded_urls\")\n _InstrumentedFastAPI._excluded_urls = (\n _excluded_urls_from_env\n if _excluded_urls is None\n else parse_excluded_urls(_excluded_urls)\n )\n fastapi.FastAPI = _InstrumentedFastAPI\n\n def _uninstrument(self, **kwargs):\n fastapi.FastAPI = self._original_fastapi\n\n\nclass _InstrumentedFastAPI(fastapi.FastAPI):\n _tracer_provider = None\n _excluded_urls = None\n _server_request_hook: _ServerRequestHookT = None\n _client_request_hook: _ClientRequestHookT = None\n _client_response_hook: _ClientResponseHookT = None\n\n def __init__(self, *args, **kwargs):\n super().__init__(*args, **kwargs)\n self.add_middleware(\n OpenTelemetryMiddleware,\n excluded_urls=_InstrumentedFastAPI._excluded_urls,\n default_span_details=_get_route_details,\n server_request_hook=_InstrumentedFastAPI._server_request_hook,\n client_request_hook=_InstrumentedFastAPI._client_request_hook,\n client_response_hook=_InstrumentedFastAPI._client_response_hook,\n tracer_provider=_InstrumentedFastAPI._tracer_provider,\n )\n self._is_instrumented_by_opentelemetry = True\n\n\ndef _get_route_details(scope):\n \"\"\"Callback to retrieve the fastapi route being served.\n\n TODO: there is currently no way to retrieve http.route from\n a starlette application from scope.\n\n See: https://github.com/encode/starlette/pull/804\n \"\"\"\n app = scope[\"app\"]\n route = None\n for starlette_route in app.routes:\n match, _ = starlette_route.matches(scope)\n if match == Match.FULL:\n route = starlette_route.path\n break\n if match == Match.PARTIAL:\n route = starlette_route.path\n # method only exists for http, if websocket\n # leave it blank.\n span_name = route or scope.get(\"method\", \"\")\n attributes = {}\n if route:\n attributes[SpanAttributes.HTTP_ROUTE] = route\n return span_name, attributes\n","path":"instrumentation/opentelemetry-instrumentation-fastapi/src/opentelemetry/instrumentation/fastapi/__init__.py"}],"string":"[\n {\n \"content\": \"# Copyright The OpenTelemetry Authors\\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\\\"\\\"\\\"\\nUsage\\n-----\\n\\n.. code-block:: python\\n\\n import fastapi\\n from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor\\n\\n app = fastapi.FastAPI()\\n\\n @app.get(\\\"/foobar\\\")\\n async def foobar():\\n return {\\\"message\\\": \\\"hello world\\\"}\\n\\n FastAPIInstrumentor.instrument_app(app)\\n\\nConfiguration\\n-------------\\n\\nExclude lists\\n*************\\nTo exclude certain URLs from being tracked, set the environment variable ``OTEL_PYTHON_FASTAPI_EXCLUDED_URLS``\\n(or ``OTEL_PYTHON_EXCLUDED_URLS`` as fallback) with comma delimited regexes representing which URLs to exclude.\\n\\nFor example,\\n\\n::\\n\\n export OTEL_PYTHON_FASTAPI_EXCLUDED_URLS=\\\"client/.*/info,healthcheck\\\"\\n\\nwill exclude requests such as ``https://site/client/123/info`` and ``https://site/xyz/healthcheck``.\\n\\nYou can also pass the comma delimited regexes to the ``instrument_app`` method directly:\\n\\n.. code-block:: python\\n\\n FastAPIInstrumentor.instrument_app(app, excluded_urls=\\\"client/.*/info,healthcheck\\\")\\n\\nRequest/Response hooks\\n**********************\\n\\nUtilize request/response hooks to execute custom logic to be performed before/after performing a request. The server request hook takes in a server span and ASGI\\nscope object for every incoming request. The client request hook is called with the internal span and an ASGI scope which is sent as a dictionary for when the method receive is called.\\nThe client response hook is called with the internal span and an ASGI event which is sent as a dictionary for when the method send is called.\\n\\n.. code-block:: python\\n\\n def server_request_hook(span: Span, scope: dict):\\n if span and span.is_recording():\\n span.set_attribute(\\\"custom_user_attribute_from_request_hook\\\", \\\"some-value\\\")\\n\\n def client_request_hook(span: Span, scope: dict):\\n if span and span.is_recording():\\n span.set_attribute(\\\"custom_user_attribute_from_client_request_hook\\\", \\\"some-value\\\")\\n\\n def client_response_hook(span: Span, message: dict):\\n if span and span.is_recording():\\n span.set_attribute(\\\"custom_user_attribute_from_response_hook\\\", \\\"some-value\\\")\\n\\n FastAPIInstrumentor().instrument(server_request_hook=server_request_hook, client_request_hook=client_request_hook, client_response_hook=client_response_hook)\\n\\nCapture HTTP request and response headers\\n*****************************************\\nYou can configure the agent to capture predefined HTTP headers as span attributes, according to the `semantic convention <https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-request-and-response-headers>`_.\\n\\nRequest headers\\n***************\\nTo capture predefined HTTP request headers as span attributes, set the environment variable ``OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST``\\nto a comma-separated list of HTTP header names.\\n\\nFor example,\\n\\n::\\n\\n export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST=\\\"content-type,custom_request_header\\\"\\n\\nwill extract ``content-type`` and ``custom_request_header`` from request headers and add them as span attributes.\\n\\nIt is recommended that you should give the correct names of the headers to be captured in the environment variable.\\nRequest header names in fastapi are case insensitive. So, giving header name as ``CUStom-Header`` in environment variable will be able capture header with name ``custom-header``.\\n\\nThe name of the added span attribute will follow the format ``http.request.header.<header_name>`` where ``<header_name>`` being the normalized HTTP header name (lowercase, with - characters replaced by _ ).\\nThe value of the attribute will be single item list containing all the header values.\\n\\nExample of the added span attribute,\\n``http.request.header.custom_request_header = [\\\"<value1>,<value2>\\\"]``\\n\\nResponse headers\\n****************\\nTo capture predefined HTTP response headers as span attributes, set the environment variable ``OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE``\\nto a comma-separated list of HTTP header names.\\n\\nFor example,\\n\\n::\\n\\n export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE=\\\"content-type,custom_response_header\\\"\\n\\nwill extract ``content-type`` and ``custom_response_header`` from response headers and add them as span attributes.\\n\\nIt is recommended that you should give the correct names of the headers to be captured in the environment variable.\\nResponse header names captured in fastapi are case insensitive. So, giving header name as ``CUStomHeader`` in environment variable will be able capture header with name ``customheader``.\\n\\nThe name of the added span attribute will follow the format ``http.response.header.<header_name>`` where ``<header_name>`` being the normalized HTTP header name (lowercase, with - characters replaced by _ ).\\nThe value of the attribute will be single item list containing all the header values.\\n\\nExample of the added span attribute,\\n``http.response.header.custom_response_header = [\\\"<value1>,<value2>\\\"]``\\n\\nNote:\\n Environment variable names to capture http headers are still experimental, and thus are subject to change.\\n\\nAPI\\n---\\n\\\"\\\"\\\"\\nimport logging\\nimport typing\\nfrom typing import Collection\\n\\nimport fastapi\\nfrom starlette.routing import Match\\n\\nfrom opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware\\nfrom opentelemetry.instrumentation.asgi.package import _instruments\\nfrom opentelemetry.instrumentation.instrumentor import BaseInstrumentor\\nfrom opentelemetry.semconv.trace import SpanAttributes\\nfrom opentelemetry.trace import Span\\nfrom opentelemetry.util.http import get_excluded_urls, parse_excluded_urls\\n\\n_excluded_urls_from_env = get_excluded_urls(\\\"FASTAPI\\\")\\n_logger = logging.getLogger(__name__)\\n\\n_ServerRequestHookT = typing.Optional[typing.Callable[[Span, dict], None]]\\n_ClientRequestHookT = typing.Optional[typing.Callable[[Span, dict], None]]\\n_ClientResponseHookT = typing.Optional[typing.Callable[[Span, dict], None]]\\n\\n\\nclass FastAPIInstrumentor(BaseInstrumentor):\\n \\\"\\\"\\\"An instrumentor for FastAPI\\n\\n See `BaseInstrumentor`\\n \\\"\\\"\\\"\\n\\n _original_fastapi = None\\n\\n @staticmethod\\n def instrument_app(\\n app: fastapi.FastAPI,\\n server_request_hook: _ServerRequestHookT = None,\\n client_request_hook: _ClientRequestHookT = None,\\n client_response_hook: _ClientResponseHookT = None,\\n tracer_provider=None,\\n excluded_urls=None,\\n ):\\n \\\"\\\"\\\"Instrument an uninstrumented FastAPI application.\\\"\\\"\\\"\\n if not hasattr(app, \\\"_is_instrumented_by_opentelemetry\\\"):\\n app._is_instrumented_by_opentelemetry = False\\n\\n if not getattr(app, \\\"_is_instrumented_by_opentelemetry\\\", False):\\n if excluded_urls is None:\\n excluded_urls = _excluded_urls_from_env\\n else:\\n excluded_urls = parse_excluded_urls(excluded_urls)\\n\\n app.add_middleware(\\n OpenTelemetryMiddleware,\\n excluded_urls=excluded_urls,\\n default_span_details=_get_route_details,\\n server_request_hook=server_request_hook,\\n client_request_hook=client_request_hook,\\n client_response_hook=client_response_hook,\\n tracer_provider=tracer_provider,\\n )\\n app._is_instrumented_by_opentelemetry = True\\n else:\\n _logger.warning(\\n \\\"Attempting to instrument FastAPI app while already instrumented\\\"\\n )\\n\\n @staticmethod\\n def uninstrument_app(app: fastapi.FastAPI):\\n app.user_middleware = [\\n x\\n for x in app.user_middleware\\n if x.cls is not OpenTelemetryMiddleware\\n ]\\n app.middleware_stack = app.build_middleware_stack()\\n app._is_instrumented_by_opentelemetry = False\\n\\n def instrumentation_dependencies(self) -> Collection[str]:\\n return _instruments\\n\\n def _instrument(self, **kwargs):\\n self._original_fastapi = fastapi.FastAPI\\n _InstrumentedFastAPI._tracer_provider = kwargs.get(\\\"tracer_provider\\\")\\n _InstrumentedFastAPI._server_request_hook = kwargs.get(\\n \\\"server_request_hook\\\"\\n )\\n _InstrumentedFastAPI._client_request_hook = kwargs.get(\\n \\\"client_request_hook\\\"\\n )\\n _InstrumentedFastAPI._client_response_hook = kwargs.get(\\n \\\"client_response_hook\\\"\\n )\\n _excluded_urls = kwargs.get(\\\"excluded_urls\\\")\\n _InstrumentedFastAPI._excluded_urls = (\\n _excluded_urls_from_env\\n if _excluded_urls is None\\n else parse_excluded_urls(_excluded_urls)\\n )\\n fastapi.FastAPI = _InstrumentedFastAPI\\n\\n def _uninstrument(self, **kwargs):\\n fastapi.FastAPI = self._original_fastapi\\n\\n\\nclass _InstrumentedFastAPI(fastapi.FastAPI):\\n _tracer_provider = None\\n _excluded_urls = None\\n _server_request_hook: _ServerRequestHookT = None\\n _client_request_hook: _ClientRequestHookT = None\\n _client_response_hook: _ClientResponseHookT = None\\n\\n def __init__(self, *args, **kwargs):\\n super().__init__(*args, **kwargs)\\n self.add_middleware(\\n OpenTelemetryMiddleware,\\n excluded_urls=_InstrumentedFastAPI._excluded_urls,\\n default_span_details=_get_route_details,\\n server_request_hook=_InstrumentedFastAPI._server_request_hook,\\n client_request_hook=_InstrumentedFastAPI._client_request_hook,\\n client_response_hook=_InstrumentedFastAPI._client_response_hook,\\n tracer_provider=_InstrumentedFastAPI._tracer_provider,\\n )\\n self._is_instrumented_by_opentelemetry = True\\n\\n\\ndef _get_route_details(scope):\\n \\\"\\\"\\\"Callback to retrieve the fastapi route being served.\\n\\n TODO: there is currently no way to retrieve http.route from\\n a starlette application from scope.\\n\\n See: https://github.com/encode/starlette/pull/804\\n \\\"\\\"\\\"\\n app = scope[\\\"app\\\"]\\n route = None\\n for starlette_route in app.routes:\\n match, _ = starlette_route.matches(scope)\\n if match == Match.FULL:\\n route = starlette_route.path\\n break\\n if match == Match.PARTIAL:\\n route = starlette_route.path\\n # method only exists for http, if websocket\\n # leave it blank.\\n span_name = route or scope.get(\\\"method\\\", \\\"\\\")\\n attributes = {}\\n if route:\\n attributes[SpanAttributes.HTTP_ROUTE] = route\\n return span_name, attributes\\n\",\n \"path\": \"instrumentation/opentelemetry-instrumentation-fastapi/src/opentelemetry/instrumentation/fastapi/__init__.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/CHANGELOG.md b/CHANGELOG.md\nindex 595da827bd..10d6d27c21 100644\n--- a/CHANGELOG.md\n+++ b/CHANGELOG.md\n@@ -21,6 +21,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0\n ([#1208](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1208))\n - `opentelemetry-instrumentation-aiohttp-client` Fix producing additional spans with each newly created ClientSession\n - ([#1246](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1246))\n+- Add _is_openetlemetry_instrumented check in _InstrumentedFastAPI class\n+ ([#1313](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1313))\n \n ## [1.12.0-0.33b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.12.0-0.33b0) - 2022-08-08\n \ndiff --git a/instrumentation/opentelemetry-instrumentation-fastapi/src/opentelemetry/instrumentation/fastapi/__init__.py b/instrumentation/opentelemetry-instrumentation-fastapi/src/opentelemetry/instrumentation/fastapi/__init__.py\nindex 1c76c8bb50..4fd4947418 100644\n--- a/instrumentation/opentelemetry-instrumentation-fastapi/src/opentelemetry/instrumentation/fastapi/__init__.py\n+++ b/instrumentation/opentelemetry-instrumentation-fastapi/src/opentelemetry/instrumentation/fastapi/__init__.py\n@@ -247,6 +247,7 @@ def __init__(self, *args, **kwargs):\n client_response_hook=_InstrumentedFastAPI._client_response_hook,\n tracer_provider=_InstrumentedFastAPI._tracer_provider,\n )\n+ self._is_instrumented_by_opentelemetry = True\n \n \n def _get_route_details(scope):\ndiff --git a/instrumentation/opentelemetry-instrumentation-fastapi/tests/test_fastapi_instrumentation.py b/instrumentation/opentelemetry-instrumentation-fastapi/tests/test_fastapi_instrumentation.py\nindex 0d42e7533c..4cd3cbee29 100644\n--- a/instrumentation/opentelemetry-instrumentation-fastapi/tests/test_fastapi_instrumentation.py\n+++ b/instrumentation/opentelemetry-instrumentation-fastapi/tests/test_fastapi_instrumentation.py\n@@ -274,6 +274,14 @@ def test_request(self):\n self.assertEqual(span.resource.attributes[\"key1\"], \"value1\")\n self.assertEqual(span.resource.attributes[\"key2\"], \"value2\")\n \n+ def test_mulitple_way_instrumentation(self):\n+ self._instrumentor.instrument_app(self._app)\n+ count = 0\n+ for middleware in self._app.user_middleware:\n+ if middleware.cls is OpenTelemetryMiddleware:\n+ count += 1\n+ self.assertEqual(count, 1)\n+\n def tearDown(self):\n self._instrumentor.uninstrument()\n super().tearDown()\n"}}},{"rowIdx":4659,"cells":{"in_source_id":{"kind":"string","value":"zulip__zulip-12231"},"issue":{"kind":"string","value":"Open Graph og:url tags over-canonicalize all URLs back to the home page\nSplit from #12187:\r\n\r\n> By the way, it turns out all our OpenGraph tags are [busted anyway](https://developers.facebook.com/tools/debug/sharing/?q=https%3A%2F%2Fchat.zulip.org%2Fapi%2Fincoming-webhooks-walkthrough) because we always set `og:url` to point to the home page (which redirects to /login, whose `og:url` points back to the home page).\n"},"before_files":{"kind":"list like","value":[{"content":"\nfrom typing import Any, Dict\nfrom django.http import HttpRequest\nfrom django.conf import settings\nfrom django.urls import reverse\n\nfrom zerver.models import UserProfile, get_realm, Realm\nfrom zproject.backends import (\n any_oauth_backend_enabled,\n password_auth_enabled,\n require_email_format_usernames,\n auth_enabled_helper,\n AUTH_BACKEND_NAME_MAP,\n SOCIAL_AUTH_BACKENDS,\n)\nfrom zerver.decorator import get_client_name\nfrom zerver.lib.send_email import FromAddress\nfrom zerver.lib.subdomains import get_subdomain\nfrom zerver.lib.realm_icon import get_realm_icon_url\nfrom zerver.lib.realm_description import get_realm_rendered_description, get_realm_text_description\n\nfrom version import ZULIP_VERSION, LATEST_RELEASE_VERSION, LATEST_MAJOR_VERSION, \\\n LATEST_RELEASE_ANNOUNCEMENT\n\ndef common_context(user: UserProfile) -> Dict[str, Any]:\n \"\"\"Common context used for things like outgoing emails that don't\n have a request.\n \"\"\"\n return {\n 'realm_uri': user.realm.uri,\n 'realm_name': user.realm.name,\n 'root_domain_uri': settings.ROOT_DOMAIN_URI,\n 'external_uri_scheme': settings.EXTERNAL_URI_SCHEME,\n 'external_host': settings.EXTERNAL_HOST,\n 'user_name': user.full_name,\n }\n\ndef get_realm_from_request(request: HttpRequest) -> Realm:\n if hasattr(request, \"user\") and hasattr(request.user, \"realm\"):\n return request.user.realm\n if not hasattr(request, \"realm\"):\n # We cache the realm object from this function on the request,\n # so that functions that call get_realm_from_request don't\n # need to do duplicate queries on the same realm while\n # processing a single request.\n subdomain = get_subdomain(request)\n request.realm = get_realm(subdomain)\n return request.realm\n\ndef zulip_default_context(request: HttpRequest) -> Dict[str, Any]:\n \"\"\"Context available to all Zulip Jinja2 templates that have a request\n passed in. Designed to provide the long list of variables at the\n bottom of this function in a wide range of situations: logged-in\n or logged-out, subdomains or not, etc.\n\n The main variable in the below is whether we know what realm the\n user is trying to interact with.\n \"\"\"\n realm = get_realm_from_request(request)\n\n if realm is None:\n realm_uri = settings.ROOT_DOMAIN_URI\n realm_name = None\n realm_icon = None\n else:\n realm_uri = realm.uri\n realm_name = realm.name\n realm_icon = get_realm_icon_url(realm)\n\n register_link_disabled = settings.REGISTER_LINK_DISABLED\n login_link_disabled = settings.LOGIN_LINK_DISABLED\n find_team_link_disabled = settings.FIND_TEAM_LINK_DISABLED\n allow_search_engine_indexing = False\n\n if (settings.ROOT_DOMAIN_LANDING_PAGE\n and get_subdomain(request) == Realm.SUBDOMAIN_FOR_ROOT_DOMAIN):\n register_link_disabled = True\n login_link_disabled = True\n find_team_link_disabled = False\n allow_search_engine_indexing = True\n\n apps_page_url = 'https://zulipchat.com/apps/'\n if settings.ZILENCER_ENABLED:\n apps_page_url = '/apps/'\n\n user_is_authenticated = False\n if hasattr(request, 'user') and hasattr(request.user, 'is_authenticated'):\n user_is_authenticated = request.user.is_authenticated.value\n\n if settings.DEVELOPMENT:\n secrets_path = \"zproject/dev-secrets.conf\"\n settings_path = \"zproject/dev_settings.py\"\n settings_comments_path = \"zproject/prod_settings_template.py\"\n else:\n secrets_path = \"/etc/zulip/zulip-secrets.conf\"\n settings_path = \"/etc/zulip/settings.py\"\n settings_comments_path = \"/etc/zulip/settings.py\"\n\n # We can't use request.client here because we might not be using\n # an auth decorator that sets it, but we can call its helper to\n # get the same result.\n platform = get_client_name(request, True)\n\n context = {\n 'root_domain_landing_page': settings.ROOT_DOMAIN_LANDING_PAGE,\n 'custom_logo_url': settings.CUSTOM_LOGO_URL,\n 'register_link_disabled': register_link_disabled,\n 'login_link_disabled': login_link_disabled,\n 'terms_of_service': settings.TERMS_OF_SERVICE,\n 'privacy_policy': settings.PRIVACY_POLICY,\n 'login_url': settings.HOME_NOT_LOGGED_IN,\n 'only_sso': settings.ONLY_SSO,\n 'external_host': settings.EXTERNAL_HOST,\n 'external_uri_scheme': settings.EXTERNAL_URI_SCHEME,\n 'realm_uri': realm_uri,\n 'realm_name': realm_name,\n 'realm_icon': realm_icon,\n 'root_domain_uri': settings.ROOT_DOMAIN_URI,\n 'apps_page_url': apps_page_url,\n 'open_realm_creation': settings.OPEN_REALM_CREATION,\n 'development_environment': settings.DEVELOPMENT,\n 'support_email': FromAddress.SUPPORT,\n 'find_team_link_disabled': find_team_link_disabled,\n 'password_min_length': settings.PASSWORD_MIN_LENGTH,\n 'password_min_guesses': settings.PASSWORD_MIN_GUESSES,\n 'jitsi_server_url': settings.JITSI_SERVER_URL,\n 'zulip_version': ZULIP_VERSION,\n 'user_is_authenticated': user_is_authenticated,\n 'settings_path': settings_path,\n 'secrets_path': secrets_path,\n 'settings_comments_path': settings_comments_path,\n 'platform': platform,\n 'allow_search_engine_indexing': allow_search_engine_indexing,\n }\n\n if realm is not None and realm.icon_source == realm.ICON_UPLOADED:\n context['OPEN_GRAPH_IMAGE'] = '%s%s' % (realm_uri, realm_icon)\n\n return context\n\ndef login_context(request: HttpRequest) -> Dict[str, Any]:\n realm = get_realm_from_request(request)\n\n if realm is None:\n realm_description = None\n realm_invite_required = False\n else:\n realm_description = get_realm_rendered_description(realm)\n realm_invite_required = realm.invite_required\n\n context = {\n 'realm_invite_required': realm_invite_required,\n 'realm_description': realm_description,\n 'require_email_format_usernames': require_email_format_usernames(realm),\n 'password_auth_enabled': password_auth_enabled(realm),\n 'any_oauth_backend_enabled': any_oauth_backend_enabled(realm),\n 'two_factor_authentication_enabled': settings.TWO_FACTOR_AUTHENTICATION_ENABLED,\n } # type: Dict[str, Any]\n\n if realm is not None and realm.description:\n context['OPEN_GRAPH_TITLE'] = realm.name\n context['OPEN_GRAPH_DESCRIPTION'] = get_realm_text_description(realm)\n\n # Add the keys for our standard authentication backends.\n no_auth_enabled = True\n social_backends = []\n for auth_backend_name in AUTH_BACKEND_NAME_MAP:\n name_lower = auth_backend_name.lower()\n key = \"%s_auth_enabled\" % (name_lower,)\n is_enabled = auth_enabled_helper([auth_backend_name], realm)\n context[key] = is_enabled\n if is_enabled:\n no_auth_enabled = False\n\n # Now add the enabled social backends to the social_backends\n # list used to generate buttons for login/register pages.\n backend = AUTH_BACKEND_NAME_MAP[auth_backend_name]\n if not is_enabled or backend not in SOCIAL_AUTH_BACKENDS:\n continue\n social_backends.append({\n 'name': backend.name,\n 'display_name': backend.auth_backend_name,\n 'login_url': reverse('login-social', args=(backend.name,)),\n 'signup_url': reverse('signup-social', args=(backend.name,)),\n 'sort_order': backend.sort_order,\n })\n context['social_backends'] = sorted(social_backends, key=lambda x: x['sort_order'], reverse=True)\n context['no_auth_enabled'] = no_auth_enabled\n\n return context\n\ndef latest_info_context() -> Dict[str, str]:\n context = {\n 'latest_release_version': LATEST_RELEASE_VERSION,\n 'latest_major_version': LATEST_MAJOR_VERSION,\n 'latest_release_announcement': LATEST_RELEASE_ANNOUNCEMENT,\n }\n return context\n","path":"zerver/context_processors.py"}],"string":"[\n {\n \"content\": \"\\nfrom typing import Any, Dict\\nfrom django.http import HttpRequest\\nfrom django.conf import settings\\nfrom django.urls import reverse\\n\\nfrom zerver.models import UserProfile, get_realm, Realm\\nfrom zproject.backends import (\\n any_oauth_backend_enabled,\\n password_auth_enabled,\\n require_email_format_usernames,\\n auth_enabled_helper,\\n AUTH_BACKEND_NAME_MAP,\\n SOCIAL_AUTH_BACKENDS,\\n)\\nfrom zerver.decorator import get_client_name\\nfrom zerver.lib.send_email import FromAddress\\nfrom zerver.lib.subdomains import get_subdomain\\nfrom zerver.lib.realm_icon import get_realm_icon_url\\nfrom zerver.lib.realm_description import get_realm_rendered_description, get_realm_text_description\\n\\nfrom version import ZULIP_VERSION, LATEST_RELEASE_VERSION, LATEST_MAJOR_VERSION, \\\\\\n LATEST_RELEASE_ANNOUNCEMENT\\n\\ndef common_context(user: UserProfile) -> Dict[str, Any]:\\n \\\"\\\"\\\"Common context used for things like outgoing emails that don't\\n have a request.\\n \\\"\\\"\\\"\\n return {\\n 'realm_uri': user.realm.uri,\\n 'realm_name': user.realm.name,\\n 'root_domain_uri': settings.ROOT_DOMAIN_URI,\\n 'external_uri_scheme': settings.EXTERNAL_URI_SCHEME,\\n 'external_host': settings.EXTERNAL_HOST,\\n 'user_name': user.full_name,\\n }\\n\\ndef get_realm_from_request(request: HttpRequest) -> Realm:\\n if hasattr(request, \\\"user\\\") and hasattr(request.user, \\\"realm\\\"):\\n return request.user.realm\\n if not hasattr(request, \\\"realm\\\"):\\n # We cache the realm object from this function on the request,\\n # so that functions that call get_realm_from_request don't\\n # need to do duplicate queries on the same realm while\\n # processing a single request.\\n subdomain = get_subdomain(request)\\n request.realm = get_realm(subdomain)\\n return request.realm\\n\\ndef zulip_default_context(request: HttpRequest) -> Dict[str, Any]:\\n \\\"\\\"\\\"Context available to all Zulip Jinja2 templates that have a request\\n passed in. Designed to provide the long list of variables at the\\n bottom of this function in a wide range of situations: logged-in\\n or logged-out, subdomains or not, etc.\\n\\n The main variable in the below is whether we know what realm the\\n user is trying to interact with.\\n \\\"\\\"\\\"\\n realm = get_realm_from_request(request)\\n\\n if realm is None:\\n realm_uri = settings.ROOT_DOMAIN_URI\\n realm_name = None\\n realm_icon = None\\n else:\\n realm_uri = realm.uri\\n realm_name = realm.name\\n realm_icon = get_realm_icon_url(realm)\\n\\n register_link_disabled = settings.REGISTER_LINK_DISABLED\\n login_link_disabled = settings.LOGIN_LINK_DISABLED\\n find_team_link_disabled = settings.FIND_TEAM_LINK_DISABLED\\n allow_search_engine_indexing = False\\n\\n if (settings.ROOT_DOMAIN_LANDING_PAGE\\n and get_subdomain(request) == Realm.SUBDOMAIN_FOR_ROOT_DOMAIN):\\n register_link_disabled = True\\n login_link_disabled = True\\n find_team_link_disabled = False\\n allow_search_engine_indexing = True\\n\\n apps_page_url = 'https://zulipchat.com/apps/'\\n if settings.ZILENCER_ENABLED:\\n apps_page_url = '/apps/'\\n\\n user_is_authenticated = False\\n if hasattr(request, 'user') and hasattr(request.user, 'is_authenticated'):\\n user_is_authenticated = request.user.is_authenticated.value\\n\\n if settings.DEVELOPMENT:\\n secrets_path = \\\"zproject/dev-secrets.conf\\\"\\n settings_path = \\\"zproject/dev_settings.py\\\"\\n settings_comments_path = \\\"zproject/prod_settings_template.py\\\"\\n else:\\n secrets_path = \\\"/etc/zulip/zulip-secrets.conf\\\"\\n settings_path = \\\"/etc/zulip/settings.py\\\"\\n settings_comments_path = \\\"/etc/zulip/settings.py\\\"\\n\\n # We can't use request.client here because we might not be using\\n # an auth decorator that sets it, but we can call its helper to\\n # get the same result.\\n platform = get_client_name(request, True)\\n\\n context = {\\n 'root_domain_landing_page': settings.ROOT_DOMAIN_LANDING_PAGE,\\n 'custom_logo_url': settings.CUSTOM_LOGO_URL,\\n 'register_link_disabled': register_link_disabled,\\n 'login_link_disabled': login_link_disabled,\\n 'terms_of_service': settings.TERMS_OF_SERVICE,\\n 'privacy_policy': settings.PRIVACY_POLICY,\\n 'login_url': settings.HOME_NOT_LOGGED_IN,\\n 'only_sso': settings.ONLY_SSO,\\n 'external_host': settings.EXTERNAL_HOST,\\n 'external_uri_scheme': settings.EXTERNAL_URI_SCHEME,\\n 'realm_uri': realm_uri,\\n 'realm_name': realm_name,\\n 'realm_icon': realm_icon,\\n 'root_domain_uri': settings.ROOT_DOMAIN_URI,\\n 'apps_page_url': apps_page_url,\\n 'open_realm_creation': settings.OPEN_REALM_CREATION,\\n 'development_environment': settings.DEVELOPMENT,\\n 'support_email': FromAddress.SUPPORT,\\n 'find_team_link_disabled': find_team_link_disabled,\\n 'password_min_length': settings.PASSWORD_MIN_LENGTH,\\n 'password_min_guesses': settings.PASSWORD_MIN_GUESSES,\\n 'jitsi_server_url': settings.JITSI_SERVER_URL,\\n 'zulip_version': ZULIP_VERSION,\\n 'user_is_authenticated': user_is_authenticated,\\n 'settings_path': settings_path,\\n 'secrets_path': secrets_path,\\n 'settings_comments_path': settings_comments_path,\\n 'platform': platform,\\n 'allow_search_engine_indexing': allow_search_engine_indexing,\\n }\\n\\n if realm is not None and realm.icon_source == realm.ICON_UPLOADED:\\n context['OPEN_GRAPH_IMAGE'] = '%s%s' % (realm_uri, realm_icon)\\n\\n return context\\n\\ndef login_context(request: HttpRequest) -> Dict[str, Any]:\\n realm = get_realm_from_request(request)\\n\\n if realm is None:\\n realm_description = None\\n realm_invite_required = False\\n else:\\n realm_description = get_realm_rendered_description(realm)\\n realm_invite_required = realm.invite_required\\n\\n context = {\\n 'realm_invite_required': realm_invite_required,\\n 'realm_description': realm_description,\\n 'require_email_format_usernames': require_email_format_usernames(realm),\\n 'password_auth_enabled': password_auth_enabled(realm),\\n 'any_oauth_backend_enabled': any_oauth_backend_enabled(realm),\\n 'two_factor_authentication_enabled': settings.TWO_FACTOR_AUTHENTICATION_ENABLED,\\n } # type: Dict[str, Any]\\n\\n if realm is not None and realm.description:\\n context['OPEN_GRAPH_TITLE'] = realm.name\\n context['OPEN_GRAPH_DESCRIPTION'] = get_realm_text_description(realm)\\n\\n # Add the keys for our standard authentication backends.\\n no_auth_enabled = True\\n social_backends = []\\n for auth_backend_name in AUTH_BACKEND_NAME_MAP:\\n name_lower = auth_backend_name.lower()\\n key = \\\"%s_auth_enabled\\\" % (name_lower,)\\n is_enabled = auth_enabled_helper([auth_backend_name], realm)\\n context[key] = is_enabled\\n if is_enabled:\\n no_auth_enabled = False\\n\\n # Now add the enabled social backends to the social_backends\\n # list used to generate buttons for login/register pages.\\n backend = AUTH_BACKEND_NAME_MAP[auth_backend_name]\\n if not is_enabled or backend not in SOCIAL_AUTH_BACKENDS:\\n continue\\n social_backends.append({\\n 'name': backend.name,\\n 'display_name': backend.auth_backend_name,\\n 'login_url': reverse('login-social', args=(backend.name,)),\\n 'signup_url': reverse('signup-social', args=(backend.name,)),\\n 'sort_order': backend.sort_order,\\n })\\n context['social_backends'] = sorted(social_backends, key=lambda x: x['sort_order'], reverse=True)\\n context['no_auth_enabled'] = no_auth_enabled\\n\\n return context\\n\\ndef latest_info_context() -> Dict[str, str]:\\n context = {\\n 'latest_release_version': LATEST_RELEASE_VERSION,\\n 'latest_major_version': LATEST_MAJOR_VERSION,\\n 'latest_release_announcement': LATEST_RELEASE_ANNOUNCEMENT,\\n }\\n return context\\n\",\n \"path\": \"zerver/context_processors.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"\nfrom typing import Any, Dict\nfrom django.http import HttpRequest\nfrom django.conf import settings\nfrom django.urls import reverse\n\nfrom zerver.models import UserProfile, get_realm, Realm\nfrom zproject.backends import (\n any_oauth_backend_enabled,\n password_auth_enabled,\n require_email_format_usernames,\n auth_enabled_helper,\n AUTH_BACKEND_NAME_MAP,\n SOCIAL_AUTH_BACKENDS,\n)\nfrom zerver.decorator import get_client_name\nfrom zerver.lib.send_email import FromAddress\nfrom zerver.lib.subdomains import get_subdomain\nfrom zerver.lib.realm_icon import get_realm_icon_url\nfrom zerver.lib.realm_description import get_realm_rendered_description, get_realm_text_description\n\nfrom version import ZULIP_VERSION, LATEST_RELEASE_VERSION, LATEST_MAJOR_VERSION, \\\n LATEST_RELEASE_ANNOUNCEMENT\n\ndef common_context(user: UserProfile) -> Dict[str, Any]:\n \"\"\"Common context used for things like outgoing emails that don't\n have a request.\n \"\"\"\n return {\n 'realm_uri': user.realm.uri,\n 'realm_name': user.realm.name,\n 'root_domain_uri': settings.ROOT_DOMAIN_URI,\n 'external_uri_scheme': settings.EXTERNAL_URI_SCHEME,\n 'external_host': settings.EXTERNAL_HOST,\n 'user_name': user.full_name,\n }\n\ndef get_realm_from_request(request: HttpRequest) -> Realm:\n if hasattr(request, \"user\") and hasattr(request.user, \"realm\"):\n return request.user.realm\n if not hasattr(request, \"realm\"):\n # We cache the realm object from this function on the request,\n # so that functions that call get_realm_from_request don't\n # need to do duplicate queries on the same realm while\n # processing a single request.\n subdomain = get_subdomain(request)\n request.realm = get_realm(subdomain)\n return request.realm\n\ndef zulip_default_context(request: HttpRequest) -> Dict[str, Any]:\n \"\"\"Context available to all Zulip Jinja2 templates that have a request\n passed in. Designed to provide the long list of variables at the\n bottom of this function in a wide range of situations: logged-in\n or logged-out, subdomains or not, etc.\n\n The main variable in the below is whether we know what realm the\n user is trying to interact with.\n \"\"\"\n realm = get_realm_from_request(request)\n\n if realm is None:\n realm_uri = settings.ROOT_DOMAIN_URI\n realm_name = None\n realm_icon = None\n else:\n realm_uri = realm.uri\n realm_name = realm.name\n realm_icon = get_realm_icon_url(realm)\n\n register_link_disabled = settings.REGISTER_LINK_DISABLED\n login_link_disabled = settings.LOGIN_LINK_DISABLED\n find_team_link_disabled = settings.FIND_TEAM_LINK_DISABLED\n allow_search_engine_indexing = False\n\n if (settings.ROOT_DOMAIN_LANDING_PAGE\n and get_subdomain(request) == Realm.SUBDOMAIN_FOR_ROOT_DOMAIN):\n register_link_disabled = True\n login_link_disabled = True\n find_team_link_disabled = False\n allow_search_engine_indexing = True\n\n apps_page_url = 'https://zulipchat.com/apps/'\n if settings.ZILENCER_ENABLED:\n apps_page_url = '/apps/'\n\n user_is_authenticated = False\n if hasattr(request, 'user') and hasattr(request.user, 'is_authenticated'):\n user_is_authenticated = request.user.is_authenticated.value\n\n if settings.DEVELOPMENT:\n secrets_path = \"zproject/dev-secrets.conf\"\n settings_path = \"zproject/dev_settings.py\"\n settings_comments_path = \"zproject/prod_settings_template.py\"\n else:\n secrets_path = \"/etc/zulip/zulip-secrets.conf\"\n settings_path = \"/etc/zulip/settings.py\"\n settings_comments_path = \"/etc/zulip/settings.py\"\n\n # We can't use request.client here because we might not be using\n # an auth decorator that sets it, but we can call its helper to\n # get the same result.\n platform = get_client_name(request, True)\n\n context = {\n 'root_domain_landing_page': settings.ROOT_DOMAIN_LANDING_PAGE,\n 'custom_logo_url': settings.CUSTOM_LOGO_URL,\n 'register_link_disabled': register_link_disabled,\n 'login_link_disabled': login_link_disabled,\n 'terms_of_service': settings.TERMS_OF_SERVICE,\n 'privacy_policy': settings.PRIVACY_POLICY,\n 'login_url': settings.HOME_NOT_LOGGED_IN,\n 'only_sso': settings.ONLY_SSO,\n 'external_host': settings.EXTERNAL_HOST,\n 'external_uri_scheme': settings.EXTERNAL_URI_SCHEME,\n 'realm_uri': realm_uri,\n 'realm_name': realm_name,\n 'realm_icon': realm_icon,\n 'root_domain_uri': settings.ROOT_DOMAIN_URI,\n 'apps_page_url': apps_page_url,\n 'open_realm_creation': settings.OPEN_REALM_CREATION,\n 'development_environment': settings.DEVELOPMENT,\n 'support_email': FromAddress.SUPPORT,\n 'find_team_link_disabled': find_team_link_disabled,\n 'password_min_length': settings.PASSWORD_MIN_LENGTH,\n 'password_min_guesses': settings.PASSWORD_MIN_GUESSES,\n 'jitsi_server_url': settings.JITSI_SERVER_URL,\n 'zulip_version': ZULIP_VERSION,\n 'user_is_authenticated': user_is_authenticated,\n 'settings_path': settings_path,\n 'secrets_path': secrets_path,\n 'settings_comments_path': settings_comments_path,\n 'platform': platform,\n 'allow_search_engine_indexing': allow_search_engine_indexing,\n }\n\n context['OPEN_GRAPH_URL'] = '%s%s' % (realm_uri, request.path)\n if realm is not None and realm.icon_source == realm.ICON_UPLOADED:\n context['OPEN_GRAPH_IMAGE'] = '%s%s' % (realm_uri, realm_icon)\n\n return context\n\ndef login_context(request: HttpRequest) -> Dict[str, Any]:\n realm = get_realm_from_request(request)\n\n if realm is None:\n realm_description = None\n realm_invite_required = False\n else:\n realm_description = get_realm_rendered_description(realm)\n realm_invite_required = realm.invite_required\n\n context = {\n 'realm_invite_required': realm_invite_required,\n 'realm_description': realm_description,\n 'require_email_format_usernames': require_email_format_usernames(realm),\n 'password_auth_enabled': password_auth_enabled(realm),\n 'any_oauth_backend_enabled': any_oauth_backend_enabled(realm),\n 'two_factor_authentication_enabled': settings.TWO_FACTOR_AUTHENTICATION_ENABLED,\n } # type: Dict[str, Any]\n\n if realm is not None and realm.description:\n context['OPEN_GRAPH_TITLE'] = realm.name\n context['OPEN_GRAPH_DESCRIPTION'] = get_realm_text_description(realm)\n\n # Add the keys for our standard authentication backends.\n no_auth_enabled = True\n social_backends = []\n for auth_backend_name in AUTH_BACKEND_NAME_MAP:\n name_lower = auth_backend_name.lower()\n key = \"%s_auth_enabled\" % (name_lower,)\n is_enabled = auth_enabled_helper([auth_backend_name], realm)\n context[key] = is_enabled\n if is_enabled:\n no_auth_enabled = False\n\n # Now add the enabled social backends to the social_backends\n # list used to generate buttons for login/register pages.\n backend = AUTH_BACKEND_NAME_MAP[auth_backend_name]\n if not is_enabled or backend not in SOCIAL_AUTH_BACKENDS:\n continue\n social_backends.append({\n 'name': backend.name,\n 'display_name': backend.auth_backend_name,\n 'login_url': reverse('login-social', args=(backend.name,)),\n 'signup_url': reverse('signup-social', args=(backend.name,)),\n 'sort_order': backend.sort_order,\n })\n context['social_backends'] = sorted(social_backends, key=lambda x: x['sort_order'], reverse=True)\n context['no_auth_enabled'] = no_auth_enabled\n\n return context\n\ndef latest_info_context() -> Dict[str, str]:\n context = {\n 'latest_release_version': LATEST_RELEASE_VERSION,\n 'latest_major_version': LATEST_MAJOR_VERSION,\n 'latest_release_announcement': LATEST_RELEASE_ANNOUNCEMENT,\n }\n return context\n","path":"zerver/context_processors.py"}],"string":"[\n {\n \"content\": \"\\nfrom typing import Any, Dict\\nfrom django.http import HttpRequest\\nfrom django.conf import settings\\nfrom django.urls import reverse\\n\\nfrom zerver.models import UserProfile, get_realm, Realm\\nfrom zproject.backends import (\\n any_oauth_backend_enabled,\\n password_auth_enabled,\\n require_email_format_usernames,\\n auth_enabled_helper,\\n AUTH_BACKEND_NAME_MAP,\\n SOCIAL_AUTH_BACKENDS,\\n)\\nfrom zerver.decorator import get_client_name\\nfrom zerver.lib.send_email import FromAddress\\nfrom zerver.lib.subdomains import get_subdomain\\nfrom zerver.lib.realm_icon import get_realm_icon_url\\nfrom zerver.lib.realm_description import get_realm_rendered_description, get_realm_text_description\\n\\nfrom version import ZULIP_VERSION, LATEST_RELEASE_VERSION, LATEST_MAJOR_VERSION, \\\\\\n LATEST_RELEASE_ANNOUNCEMENT\\n\\ndef common_context(user: UserProfile) -> Dict[str, Any]:\\n \\\"\\\"\\\"Common context used for things like outgoing emails that don't\\n have a request.\\n \\\"\\\"\\\"\\n return {\\n 'realm_uri': user.realm.uri,\\n 'realm_name': user.realm.name,\\n 'root_domain_uri': settings.ROOT_DOMAIN_URI,\\n 'external_uri_scheme': settings.EXTERNAL_URI_SCHEME,\\n 'external_host': settings.EXTERNAL_HOST,\\n 'user_name': user.full_name,\\n }\\n\\ndef get_realm_from_request(request: HttpRequest) -> Realm:\\n if hasattr(request, \\\"user\\\") and hasattr(request.user, \\\"realm\\\"):\\n return request.user.realm\\n if not hasattr(request, \\\"realm\\\"):\\n # We cache the realm object from this function on the request,\\n # so that functions that call get_realm_from_request don't\\n # need to do duplicate queries on the same realm while\\n # processing a single request.\\n subdomain = get_subdomain(request)\\n request.realm = get_realm(subdomain)\\n return request.realm\\n\\ndef zulip_default_context(request: HttpRequest) -> Dict[str, Any]:\\n \\\"\\\"\\\"Context available to all Zulip Jinja2 templates that have a request\\n passed in. Designed to provide the long list of variables at the\\n bottom of this function in a wide range of situations: logged-in\\n or logged-out, subdomains or not, etc.\\n\\n The main variable in the below is whether we know what realm the\\n user is trying to interact with.\\n \\\"\\\"\\\"\\n realm = get_realm_from_request(request)\\n\\n if realm is None:\\n realm_uri = settings.ROOT_DOMAIN_URI\\n realm_name = None\\n realm_icon = None\\n else:\\n realm_uri = realm.uri\\n realm_name = realm.name\\n realm_icon = get_realm_icon_url(realm)\\n\\n register_link_disabled = settings.REGISTER_LINK_DISABLED\\n login_link_disabled = settings.LOGIN_LINK_DISABLED\\n find_team_link_disabled = settings.FIND_TEAM_LINK_DISABLED\\n allow_search_engine_indexing = False\\n\\n if (settings.ROOT_DOMAIN_LANDING_PAGE\\n and get_subdomain(request) == Realm.SUBDOMAIN_FOR_ROOT_DOMAIN):\\n register_link_disabled = True\\n login_link_disabled = True\\n find_team_link_disabled = False\\n allow_search_engine_indexing = True\\n\\n apps_page_url = 'https://zulipchat.com/apps/'\\n if settings.ZILENCER_ENABLED:\\n apps_page_url = '/apps/'\\n\\n user_is_authenticated = False\\n if hasattr(request, 'user') and hasattr(request.user, 'is_authenticated'):\\n user_is_authenticated = request.user.is_authenticated.value\\n\\n if settings.DEVELOPMENT:\\n secrets_path = \\\"zproject/dev-secrets.conf\\\"\\n settings_path = \\\"zproject/dev_settings.py\\\"\\n settings_comments_path = \\\"zproject/prod_settings_template.py\\\"\\n else:\\n secrets_path = \\\"/etc/zulip/zulip-secrets.conf\\\"\\n settings_path = \\\"/etc/zulip/settings.py\\\"\\n settings_comments_path = \\\"/etc/zulip/settings.py\\\"\\n\\n # We can't use request.client here because we might not be using\\n # an auth decorator that sets it, but we can call its helper to\\n # get the same result.\\n platform = get_client_name(request, True)\\n\\n context = {\\n 'root_domain_landing_page': settings.ROOT_DOMAIN_LANDING_PAGE,\\n 'custom_logo_url': settings.CUSTOM_LOGO_URL,\\n 'register_link_disabled': register_link_disabled,\\n 'login_link_disabled': login_link_disabled,\\n 'terms_of_service': settings.TERMS_OF_SERVICE,\\n 'privacy_policy': settings.PRIVACY_POLICY,\\n 'login_url': settings.HOME_NOT_LOGGED_IN,\\n 'only_sso': settings.ONLY_SSO,\\n 'external_host': settings.EXTERNAL_HOST,\\n 'external_uri_scheme': settings.EXTERNAL_URI_SCHEME,\\n 'realm_uri': realm_uri,\\n 'realm_name': realm_name,\\n 'realm_icon': realm_icon,\\n 'root_domain_uri': settings.ROOT_DOMAIN_URI,\\n 'apps_page_url': apps_page_url,\\n 'open_realm_creation': settings.OPEN_REALM_CREATION,\\n 'development_environment': settings.DEVELOPMENT,\\n 'support_email': FromAddress.SUPPORT,\\n 'find_team_link_disabled': find_team_link_disabled,\\n 'password_min_length': settings.PASSWORD_MIN_LENGTH,\\n 'password_min_guesses': settings.PASSWORD_MIN_GUESSES,\\n 'jitsi_server_url': settings.JITSI_SERVER_URL,\\n 'zulip_version': ZULIP_VERSION,\\n 'user_is_authenticated': user_is_authenticated,\\n 'settings_path': settings_path,\\n 'secrets_path': secrets_path,\\n 'settings_comments_path': settings_comments_path,\\n 'platform': platform,\\n 'allow_search_engine_indexing': allow_search_engine_indexing,\\n }\\n\\n context['OPEN_GRAPH_URL'] = '%s%s' % (realm_uri, request.path)\\n if realm is not None and realm.icon_source == realm.ICON_UPLOADED:\\n context['OPEN_GRAPH_IMAGE'] = '%s%s' % (realm_uri, realm_icon)\\n\\n return context\\n\\ndef login_context(request: HttpRequest) -> Dict[str, Any]:\\n realm = get_realm_from_request(request)\\n\\n if realm is None:\\n realm_description = None\\n realm_invite_required = False\\n else:\\n realm_description = get_realm_rendered_description(realm)\\n realm_invite_required = realm.invite_required\\n\\n context = {\\n 'realm_invite_required': realm_invite_required,\\n 'realm_description': realm_description,\\n 'require_email_format_usernames': require_email_format_usernames(realm),\\n 'password_auth_enabled': password_auth_enabled(realm),\\n 'any_oauth_backend_enabled': any_oauth_backend_enabled(realm),\\n 'two_factor_authentication_enabled': settings.TWO_FACTOR_AUTHENTICATION_ENABLED,\\n } # type: Dict[str, Any]\\n\\n if realm is not None and realm.description:\\n context['OPEN_GRAPH_TITLE'] = realm.name\\n context['OPEN_GRAPH_DESCRIPTION'] = get_realm_text_description(realm)\\n\\n # Add the keys for our standard authentication backends.\\n no_auth_enabled = True\\n social_backends = []\\n for auth_backend_name in AUTH_BACKEND_NAME_MAP:\\n name_lower = auth_backend_name.lower()\\n key = \\\"%s_auth_enabled\\\" % (name_lower,)\\n is_enabled = auth_enabled_helper([auth_backend_name], realm)\\n context[key] = is_enabled\\n if is_enabled:\\n no_auth_enabled = False\\n\\n # Now add the enabled social backends to the social_backends\\n # list used to generate buttons for login/register pages.\\n backend = AUTH_BACKEND_NAME_MAP[auth_backend_name]\\n if not is_enabled or backend not in SOCIAL_AUTH_BACKENDS:\\n continue\\n social_backends.append({\\n 'name': backend.name,\\n 'display_name': backend.auth_backend_name,\\n 'login_url': reverse('login-social', args=(backend.name,)),\\n 'signup_url': reverse('signup-social', args=(backend.name,)),\\n 'sort_order': backend.sort_order,\\n })\\n context['social_backends'] = sorted(social_backends, key=lambda x: x['sort_order'], reverse=True)\\n context['no_auth_enabled'] = no_auth_enabled\\n\\n return context\\n\\ndef latest_info_context() -> Dict[str, str]:\\n context = {\\n 'latest_release_version': LATEST_RELEASE_VERSION,\\n 'latest_major_version': LATEST_MAJOR_VERSION,\\n 'latest_release_announcement': LATEST_RELEASE_ANNOUNCEMENT,\\n }\\n return context\\n\",\n \"path\": \"zerver/context_processors.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/templates/zerver/meta_tags.html b/templates/zerver/meta_tags.html\nindex 5432e7e3fd639..0ccb1f8276d8f 100644\n--- a/templates/zerver/meta_tags.html\n+++ b/templates/zerver/meta_tags.html\n@@ -6,7 +6,7 @@\n {% endif %}\n \n <!-- Open Graph / Facebook Meta Tags -->\n-<meta property=\"og:url\" content=\"{{ realm_uri }}\">\n+<meta property=\"og:url\" content=\"{{ OPEN_GRAPH_URL }}\">\n <meta property=\"og:type\" content=\"website\">\n <meta property=\"og:site_name\" content=\"Zulip\">\n {% if OPEN_GRAPH_TITLE %}\ndiff --git a/zerver/context_processors.py b/zerver/context_processors.py\nindex 9ca095b57be98..b57ab8ef93bae 100644\n--- a/zerver/context_processors.py\n+++ b/zerver/context_processors.py\n@@ -133,6 +133,7 @@ def zulip_default_context(request: HttpRequest) -> Dict[str, Any]:\n 'allow_search_engine_indexing': allow_search_engine_indexing,\n }\n \n+ context['OPEN_GRAPH_URL'] = '%s%s' % (realm_uri, request.path)\n if realm is not None and realm.icon_source == realm.ICON_UPLOADED:\n context['OPEN_GRAPH_IMAGE'] = '%s%s' % (realm_uri, realm_icon)\n \ndiff --git a/zerver/tests/test_middleware.py b/zerver/tests/test_middleware.py\nindex 0c0dbf4835528..1b2af1e86f0dd 100644\n--- a/zerver/tests/test_middleware.py\n+++ b/zerver/tests/test_middleware.py\n@@ -184,3 +184,13 @@ def test_login_page_realm_icon(self) -> None:\n twitter_image = bs.select_one('meta[name=\"twitter:image\"]').get('content')\n self.assertTrue(open_graph_image.endswith(realm_icon))\n self.assertTrue(twitter_image.endswith(realm_icon))\n+\n+ def test_no_realm_api_page_og_url(self) -> None:\n+ response = self.client_get('/api/', subdomain='')\n+ self.assertEqual(response.status_code, 200)\n+\n+ decoded = response.content.decode('utf-8')\n+ bs = BeautifulSoup(decoded, features='lxml')\n+ open_graph_url = bs.select_one('meta[property=\"og:url\"]').get('content')\n+\n+ self.assertTrue(open_graph_url.endswith('/api/'))\n"}}},{"rowIdx":4660,"cells":{"in_source_id":{"kind":"string","value":"ytdl-org__youtube-dl-18281"},"issue":{"kind":"string","value":"Problem with joj.sk\n## Please follow the guide below\r\n\r\n- You will be asked some questions and requested to provide some information, please read them **carefully** and answer honestly\r\n- Put an `x` into all the boxes [ ] relevant to your *issue* (like this: `[x]`)\r\n- Use the *Preview* tab to see what your issue will actually look like\r\n\r\n---\r\n\r\n### Make sure you are using the *latest* version: run `youtube-dl --version` and ensure your version is *2018.11.23*. If it's not, read [this FAQ entry](https://github.com/rg3/youtube-dl/blob/master/README.md#how-do-i-update-youtube-dl) and update. Issues with outdated version will be rejected.\r\n- [x] I've **verified** and **I assure** that I'm running youtube-dl **2018.11.23**\r\n\r\n### Before submitting an *issue* make sure you have:\r\n- [x] At least skimmed through the [README](https://github.com/rg3/youtube-dl/blob/master/README.md), **most notably** the [FAQ](https://github.com/rg3/youtube-dl#faq) and [BUGS](https://github.com/rg3/youtube-dl#bugs) sections\r\n- [x] [Searched](https://github.com/rg3/youtube-dl/search?type=Issues) the bugtracker for similar issues including closed ones\r\n- [x] Checked that provided video/audio/playlist URLs (if any) are alive and playable in a browser\r\n\r\n### What is the purpose of your *issue*?\r\n- [x] Bug report (encountered problems with youtube-dl)\r\n- [ ] Site support request (request for adding support for a new site)\r\n- [ ] Feature request (request for a new functionality)\r\n- [ ] Question\r\n- [ ] Other\r\n\r\n---\r\n\r\n### The following sections concretize particular purposed issues, you can erase any section (the contents between triple ---) not applicable to your *issue*\r\n\r\n---\r\n\r\n```\r\n[debug] System config: []\r\n[debug] User config: []\r\n[debug] Custom config: []\r\n[debug] Command-line args: ['https://videoportal.joj.sk/som-mama/epizoda/59636-som-mama', '-v']\r\n[debug] Encodings: locale cp1250, fs mbcs, out cp852, pref cp1250\r\n[debug] youtube-dl version 2018.11.23\r\n[debug] Python version 3.4.4 (CPython) - Windows-10-10.0.17134\r\n[debug] exe versions: ffmpeg N-69406-ga73c411, ffprobe 3.3.2\r\n[debug] Proxy map: {}\r\n[generic] 59636-som-mama: Requesting header\r\nWARNING: Falling back on generic information extractor.\r\n[generic] 59636-som-mama: Downloading webpage\r\n[generic] 59636-som-mama: Extracting information\r\n[download] Downloading playlist: SOM MAMA | Som mama | Relácie A-Z | Videoportál - najlepšie seriály a relácie TV JOJ\r\n[generic] playlist SOM MAMA | Som mama | Relácie A-Z | Videoportál - najlepšie seriály a relácie TV JOJ: Collected 1 video ids (downloading 1 of them)\r\n[download] Downloading video 1 of 1\r\n[Joj] 1a2dokc: Downloading webpage\r\n[Joj] 1a2dokc: Downloading XML\r\nERROR: No video formats found; please report this issue on https://yt-dl.org/bug . Make sure you are using the latest version; type youtube-dl -U to update. Be sure to call youtube-dl with the --verbose flag and include its complete output.\r\nTraceback (most recent call last):\r\n File \"C:\\Users\\dst\\AppData\\Roaming\\Build archive\\youtube-dl\\rg3\\tmp6bh3thhm\\build\\youtube_dl\\YoutubeDL.py\", line 792, in extract_info\r\n File \"C:\\Users\\dst\\AppData\\Roaming\\Build archive\\youtube-dl\\rg3\\tmp6bh3thhm\\build\\youtube_dl\\extractor\\common.py\", line 508, in extract\r\n File \"C:\\Users\\dst\\AppData\\Roaming\\Build archive\\youtube-dl\\rg3\\tmp6bh3thhm\\build\\youtube_dl\\extractor\\joj.py\", line 95, in _real_extract\r\n File \"C:\\Users\\dst\\AppData\\Roaming\\Build archive\\youtube-dl\\rg3\\tmp6bh3thhm\\build\\youtube_dl\\extractor\\common.py\", line 1292, in _sort_formats\r\nyoutube_dl.utils.ExtractorError: No video formats found; please report this issue on https://yt-dl.org/bug . Make sure you are using the latest version; type youtube-dl -U to update. Be sure to call youtube-dl with the --verbose flag and include its complete output.\r\n\r\n```\r\n---\r\n\r\n### If the purpose of this *issue* is a *site support request* please provide all kinds of example URLs support for which should be included (replace following example URLs by **yours**):\r\n- Single video: https://videoportal.joj.sk/som-mama/epizoda/59636-som-mama\r\n\r\n---\r\n\r\n### Description of your *issue*, suggested solution and other information\r\nDownloading is not working.\n"},"before_files":{"kind":"list like","value":[{"content":"# coding: utf-8\r\nfrom __future__ import unicode_literals\r\n\r\nimport re\r\n\r\nfrom .common import InfoExtractor\r\nfrom ..compat import compat_str\r\nfrom ..utils import (\r\n int_or_none,\r\n js_to_json,\r\n try_get,\r\n)\r\n\r\n\r\nclass JojIE(InfoExtractor):\r\n _VALID_URL = r'''(?x)\r\n (?:\r\n joj:|\r\n https?://media\\.joj\\.sk/embed/\r\n )\r\n (?P<id>[^/?#^]+)\r\n '''\r\n _TESTS = [{\r\n 'url': 'https://media.joj.sk/embed/a388ec4c-6019-4a4a-9312-b1bee194e932',\r\n 'info_dict': {\r\n 'id': 'a388ec4c-6019-4a4a-9312-b1bee194e932',\r\n 'ext': 'mp4',\r\n 'title': 'NOVÉ BÝVANIE',\r\n 'thumbnail': r're:^https?://.*\\.jpg$',\r\n 'duration': 3118,\r\n }\r\n }, {\r\n 'url': 'https://media.joj.sk/embed/9i1cxv',\r\n 'only_matching': True,\r\n }, {\r\n 'url': 'joj:a388ec4c-6019-4a4a-9312-b1bee194e932',\r\n 'only_matching': True,\r\n }, {\r\n 'url': 'joj:9i1cxv',\r\n 'only_matching': True,\r\n }]\r\n\r\n @staticmethod\r\n def _extract_urls(webpage):\r\n return [\r\n mobj.group('url')\r\n for mobj in re.finditer(\r\n r'<iframe\\b[^>]+\\bsrc=([\"\\'])(?P<url>(?:https?:)?//media\\.joj\\.sk/embed/(?:(?!\\1).)+)\\1',\r\n webpage)]\r\n\r\n def _real_extract(self, url):\r\n video_id = self._match_id(url)\r\n\r\n webpage = self._download_webpage(\r\n 'https://media.joj.sk/embed/%s' % video_id, video_id)\r\n\r\n title = self._search_regex(\r\n (r'videoTitle\\s*:\\s*([\"\\'])(?P<title>(?:(?!\\1).)+)\\1',\r\n r'<title>(?P<title>[^<]+)'), webpage, 'title',\r\n default=None, group='title') or self._og_search_title(webpage)\r\n\r\n bitrates = self._parse_json(\r\n self._search_regex(\r\n r'(?s)bitrates\\s*=\\s*({.+?});', webpage, 'bitrates',\r\n default='{}'),\r\n video_id, transform_source=js_to_json, fatal=False)\r\n\r\n formats = []\r\n for format_url in try_get(bitrates, lambda x: x['mp4'], list) or []:\r\n if isinstance(format_url, compat_str):\r\n height = self._search_regex(\r\n r'(\\d+)[pP]\\.', format_url, 'height', default=None)\r\n formats.append({\r\n 'url': format_url,\r\n 'format_id': '%sp' % height if height else None,\r\n 'height': int(height),\r\n })\r\n if not formats:\r\n playlist = self._download_xml(\r\n 'https://media.joj.sk/services/Video.php?clip=%s' % video_id,\r\n video_id)\r\n for file_el in playlist.findall('./files/file'):\r\n path = file_el.get('path')\r\n if not path:\r\n continue\r\n format_id = file_el.get('id') or file_el.get('label')\r\n formats.append({\r\n 'url': 'http://n16.joj.sk/storage/%s' % path.replace(\r\n 'dat/', '', 1),\r\n 'format_id': format_id,\r\n 'height': int_or_none(self._search_regex(\r\n r'(\\d+)[pP]', format_id or path, 'height',\r\n default=None)),\r\n })\r\n self._sort_formats(formats)\r\n\r\n thumbnail = self._og_search_thumbnail(webpage)\r\n\r\n duration = int_or_none(self._search_regex(\r\n r'videoDuration\\s*:\\s*(\\d+)', webpage, 'duration', fatal=False))\r\n\r\n return {\r\n 'id': video_id,\r\n 'title': title,\r\n 'thumbnail': thumbnail,\r\n 'duration': duration,\r\n 'formats': formats,\r\n }\r\n","path":"youtube_dl/extractor/joj.py"}],"string":"[\n {\n \"content\": \"# coding: utf-8\\r\\nfrom __future__ import unicode_literals\\r\\n\\r\\nimport re\\r\\n\\r\\nfrom .common import InfoExtractor\\r\\nfrom ..compat import compat_str\\r\\nfrom ..utils import (\\r\\n int_or_none,\\r\\n js_to_json,\\r\\n try_get,\\r\\n)\\r\\n\\r\\n\\r\\nclass JojIE(InfoExtractor):\\r\\n _VALID_URL = r'''(?x)\\r\\n (?:\\r\\n joj:|\\r\\n https?://media\\\\.joj\\\\.sk/embed/\\r\\n )\\r\\n (?P<id>[^/?#^]+)\\r\\n '''\\r\\n _TESTS = [{\\r\\n 'url': 'https://media.joj.sk/embed/a388ec4c-6019-4a4a-9312-b1bee194e932',\\r\\n 'info_dict': {\\r\\n 'id': 'a388ec4c-6019-4a4a-9312-b1bee194e932',\\r\\n 'ext': 'mp4',\\r\\n 'title': 'NOVÉ BÝVANIE',\\r\\n 'thumbnail': r're:^https?://.*\\\\.jpg$',\\r\\n 'duration': 3118,\\r\\n }\\r\\n }, {\\r\\n 'url': 'https://media.joj.sk/embed/9i1cxv',\\r\\n 'only_matching': True,\\r\\n }, {\\r\\n 'url': 'joj:a388ec4c-6019-4a4a-9312-b1bee194e932',\\r\\n 'only_matching': True,\\r\\n }, {\\r\\n 'url': 'joj:9i1cxv',\\r\\n 'only_matching': True,\\r\\n }]\\r\\n\\r\\n @staticmethod\\r\\n def _extract_urls(webpage):\\r\\n return [\\r\\n mobj.group('url')\\r\\n for mobj in re.finditer(\\r\\n r'<iframe\\\\b[^>]+\\\\bsrc=([\\\"\\\\'])(?P<url>(?:https?:)?//media\\\\.joj\\\\.sk/embed/(?:(?!\\\\1).)+)\\\\1',\\r\\n webpage)]\\r\\n\\r\\n def _real_extract(self, url):\\r\\n video_id = self._match_id(url)\\r\\n\\r\\n webpage = self._download_webpage(\\r\\n 'https://media.joj.sk/embed/%s' % video_id, video_id)\\r\\n\\r\\n title = self._search_regex(\\r\\n (r'videoTitle\\\\s*:\\\\s*([\\\"\\\\'])(?P<title>(?:(?!\\\\1).)+)\\\\1',\\r\\n r'<title>(?P<title>[^<]+)'), webpage, 'title',\\r\\n default=None, group='title') or self._og_search_title(webpage)\\r\\n\\r\\n bitrates = self._parse_json(\\r\\n self._search_regex(\\r\\n r'(?s)bitrates\\\\s*=\\\\s*({.+?});', webpage, 'bitrates',\\r\\n default='{}'),\\r\\n video_id, transform_source=js_to_json, fatal=False)\\r\\n\\r\\n formats = []\\r\\n for format_url in try_get(bitrates, lambda x: x['mp4'], list) or []:\\r\\n if isinstance(format_url, compat_str):\\r\\n height = self._search_regex(\\r\\n r'(\\\\d+)[pP]\\\\.', format_url, 'height', default=None)\\r\\n formats.append({\\r\\n 'url': format_url,\\r\\n 'format_id': '%sp' % height if height else None,\\r\\n 'height': int(height),\\r\\n })\\r\\n if not formats:\\r\\n playlist = self._download_xml(\\r\\n 'https://media.joj.sk/services/Video.php?clip=%s' % video_id,\\r\\n video_id)\\r\\n for file_el in playlist.findall('./files/file'):\\r\\n path = file_el.get('path')\\r\\n if not path:\\r\\n continue\\r\\n format_id = file_el.get('id') or file_el.get('label')\\r\\n formats.append({\\r\\n 'url': 'http://n16.joj.sk/storage/%s' % path.replace(\\r\\n 'dat/', '', 1),\\r\\n 'format_id': format_id,\\r\\n 'height': int_or_none(self._search_regex(\\r\\n r'(\\\\d+)[pP]', format_id or path, 'height',\\r\\n default=None)),\\r\\n })\\r\\n self._sort_formats(formats)\\r\\n\\r\\n thumbnail = self._og_search_thumbnail(webpage)\\r\\n\\r\\n duration = int_or_none(self._search_regex(\\r\\n r'videoDuration\\\\s*:\\\\s*(\\\\d+)', webpage, 'duration', fatal=False))\\r\\n\\r\\n return {\\r\\n 'id': video_id,\\r\\n 'title': title,\\r\\n 'thumbnail': thumbnail,\\r\\n 'duration': duration,\\r\\n 'formats': formats,\\r\\n }\\r\\n\",\n \"path\": \"youtube_dl/extractor/joj.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# coding: utf-8\r\nfrom __future__ import unicode_literals\r\n\r\nimport re\r\n\r\nfrom .common import InfoExtractor\r\nfrom ..compat import compat_str\r\nfrom ..utils import (\r\n int_or_none,\r\n js_to_json,\r\n try_get,\r\n)\r\n\r\n\r\nclass JojIE(InfoExtractor):\r\n _VALID_URL = r'''(?x)\r\n (?:\r\n joj:|\r\n https?://media\\.joj\\.sk/embed/\r\n )\r\n (?P<id>[^/?#^]+)\r\n '''\r\n _TESTS = [{\r\n 'url': 'https://media.joj.sk/embed/a388ec4c-6019-4a4a-9312-b1bee194e932',\r\n 'info_dict': {\r\n 'id': 'a388ec4c-6019-4a4a-9312-b1bee194e932',\r\n 'ext': 'mp4',\r\n 'title': 'NOVÉ BÝVANIE',\r\n 'thumbnail': r're:^https?://.*\\.jpg$',\r\n 'duration': 3118,\r\n }\r\n }, {\r\n 'url': 'https://media.joj.sk/embed/9i1cxv',\r\n 'only_matching': True,\r\n }, {\r\n 'url': 'joj:a388ec4c-6019-4a4a-9312-b1bee194e932',\r\n 'only_matching': True,\r\n }, {\r\n 'url': 'joj:9i1cxv',\r\n 'only_matching': True,\r\n }]\r\n\r\n @staticmethod\r\n def _extract_urls(webpage):\r\n return [\r\n mobj.group('url')\r\n for mobj in re.finditer(\r\n r'<iframe\\b[^>]+\\bsrc=([\"\\'])(?P<url>(?:https?:)?//media\\.joj\\.sk/embed/(?:(?!\\1).)+)\\1',\r\n webpage)]\r\n\r\n def _real_extract(self, url):\r\n video_id = self._match_id(url)\r\n\r\n webpage = self._download_webpage(\r\n 'https://media.joj.sk/embed/%s' % video_id, video_id)\r\n\r\n title = self._search_regex(\r\n (r'videoTitle\\s*:\\s*([\"\\'])(?P<title>(?:(?!\\1).)+)\\1',\r\n r'<title>(?P<title>[^<]+)'), webpage, 'title',\r\n default=None, group='title') or self._og_search_title(webpage)\r\n\r\n bitrates = self._parse_json(\r\n self._search_regex(\r\n r'(?s)(?:src|bitrates)\\s*=\\s*({.+?});', webpage, 'bitrates',\r\n default='{}'),\r\n video_id, transform_source=js_to_json, fatal=False)\r\n\r\n formats = []\r\n for format_url in try_get(bitrates, lambda x: x['mp4'], list) or []:\r\n if isinstance(format_url, compat_str):\r\n height = self._search_regex(\r\n r'(\\d+)[pP]\\.', format_url, 'height', default=None)\r\n formats.append({\r\n 'url': format_url,\r\n 'format_id': '%sp' % height if height else None,\r\n 'height': int(height),\r\n })\r\n if not formats:\r\n playlist = self._download_xml(\r\n 'https://media.joj.sk/services/Video.php?clip=%s' % video_id,\r\n video_id)\r\n for file_el in playlist.findall('./files/file'):\r\n path = file_el.get('path')\r\n if not path:\r\n continue\r\n format_id = file_el.get('id') or file_el.get('label')\r\n formats.append({\r\n 'url': 'http://n16.joj.sk/storage/%s' % path.replace(\r\n 'dat/', '', 1),\r\n 'format_id': format_id,\r\n 'height': int_or_none(self._search_regex(\r\n r'(\\d+)[pP]', format_id or path, 'height',\r\n default=None)),\r\n })\r\n self._sort_formats(formats)\r\n\r\n thumbnail = self._og_search_thumbnail(webpage)\r\n\r\n duration = int_or_none(self._search_regex(\r\n r'videoDuration\\s*:\\s*(\\d+)', webpage, 'duration', fatal=False))\r\n\r\n return {\r\n 'id': video_id,\r\n 'title': title,\r\n 'thumbnail': thumbnail,\r\n 'duration': duration,\r\n 'formats': formats,\r\n }\r\n","path":"youtube_dl/extractor/joj.py"}],"string":"[\n {\n \"content\": \"# coding: utf-8\\r\\nfrom __future__ import unicode_literals\\r\\n\\r\\nimport re\\r\\n\\r\\nfrom .common import InfoExtractor\\r\\nfrom ..compat import compat_str\\r\\nfrom ..utils import (\\r\\n int_or_none,\\r\\n js_to_json,\\r\\n try_get,\\r\\n)\\r\\n\\r\\n\\r\\nclass JojIE(InfoExtractor):\\r\\n _VALID_URL = r'''(?x)\\r\\n (?:\\r\\n joj:|\\r\\n https?://media\\\\.joj\\\\.sk/embed/\\r\\n )\\r\\n (?P<id>[^/?#^]+)\\r\\n '''\\r\\n _TESTS = [{\\r\\n 'url': 'https://media.joj.sk/embed/a388ec4c-6019-4a4a-9312-b1bee194e932',\\r\\n 'info_dict': {\\r\\n 'id': 'a388ec4c-6019-4a4a-9312-b1bee194e932',\\r\\n 'ext': 'mp4',\\r\\n 'title': 'NOVÉ BÝVANIE',\\r\\n 'thumbnail': r're:^https?://.*\\\\.jpg$',\\r\\n 'duration': 3118,\\r\\n }\\r\\n }, {\\r\\n 'url': 'https://media.joj.sk/embed/9i1cxv',\\r\\n 'only_matching': True,\\r\\n }, {\\r\\n 'url': 'joj:a388ec4c-6019-4a4a-9312-b1bee194e932',\\r\\n 'only_matching': True,\\r\\n }, {\\r\\n 'url': 'joj:9i1cxv',\\r\\n 'only_matching': True,\\r\\n }]\\r\\n\\r\\n @staticmethod\\r\\n def _extract_urls(webpage):\\r\\n return [\\r\\n mobj.group('url')\\r\\n for mobj in re.finditer(\\r\\n r'<iframe\\\\b[^>]+\\\\bsrc=([\\\"\\\\'])(?P<url>(?:https?:)?//media\\\\.joj\\\\.sk/embed/(?:(?!\\\\1).)+)\\\\1',\\r\\n webpage)]\\r\\n\\r\\n def _real_extract(self, url):\\r\\n video_id = self._match_id(url)\\r\\n\\r\\n webpage = self._download_webpage(\\r\\n 'https://media.joj.sk/embed/%s' % video_id, video_id)\\r\\n\\r\\n title = self._search_regex(\\r\\n (r'videoTitle\\\\s*:\\\\s*([\\\"\\\\'])(?P<title>(?:(?!\\\\1).)+)\\\\1',\\r\\n r'<title>(?P<title>[^<]+)'), webpage, 'title',\\r\\n default=None, group='title') or self._og_search_title(webpage)\\r\\n\\r\\n bitrates = self._parse_json(\\r\\n self._search_regex(\\r\\n r'(?s)(?:src|bitrates)\\\\s*=\\\\s*({.+?});', webpage, 'bitrates',\\r\\n default='{}'),\\r\\n video_id, transform_source=js_to_json, fatal=False)\\r\\n\\r\\n formats = []\\r\\n for format_url in try_get(bitrates, lambda x: x['mp4'], list) or []:\\r\\n if isinstance(format_url, compat_str):\\r\\n height = self._search_regex(\\r\\n r'(\\\\d+)[pP]\\\\.', format_url, 'height', default=None)\\r\\n formats.append({\\r\\n 'url': format_url,\\r\\n 'format_id': '%sp' % height if height else None,\\r\\n 'height': int(height),\\r\\n })\\r\\n if not formats:\\r\\n playlist = self._download_xml(\\r\\n 'https://media.joj.sk/services/Video.php?clip=%s' % video_id,\\r\\n video_id)\\r\\n for file_el in playlist.findall('./files/file'):\\r\\n path = file_el.get('path')\\r\\n if not path:\\r\\n continue\\r\\n format_id = file_el.get('id') or file_el.get('label')\\r\\n formats.append({\\r\\n 'url': 'http://n16.joj.sk/storage/%s' % path.replace(\\r\\n 'dat/', '', 1),\\r\\n 'format_id': format_id,\\r\\n 'height': int_or_none(self._search_regex(\\r\\n r'(\\\\d+)[pP]', format_id or path, 'height',\\r\\n default=None)),\\r\\n })\\r\\n self._sort_formats(formats)\\r\\n\\r\\n thumbnail = self._og_search_thumbnail(webpage)\\r\\n\\r\\n duration = int_or_none(self._search_regex(\\r\\n r'videoDuration\\\\s*:\\\\s*(\\\\d+)', webpage, 'duration', fatal=False))\\r\\n\\r\\n return {\\r\\n 'id': video_id,\\r\\n 'title': title,\\r\\n 'thumbnail': thumbnail,\\r\\n 'duration': duration,\\r\\n 'formats': formats,\\r\\n }\\r\\n\",\n \"path\": \"youtube_dl/extractor/joj.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/youtube_dl/extractor/joj.py b/youtube_dl/extractor/joj.py\nindex d9f8dbfd240..62b28e98098 100644\n--- a/youtube_dl/extractor/joj.py\n+++ b/youtube_dl/extractor/joj.py\n@@ -61,7 +61,7 @@ def _real_extract(self, url):\n \r\n bitrates = self._parse_json(\r\n self._search_regex(\r\n- r'(?s)bitrates\\s*=\\s*({.+?});', webpage, 'bitrates',\r\n+ r'(?s)(?:src|bitrates)\\s*=\\s*({.+?});', webpage, 'bitrates',\r\n default='{}'),\r\n video_id, transform_source=js_to_json, fatal=False)\r\n \r\n"}}},{"rowIdx":4661,"cells":{"in_source_id":{"kind":"string","value":"conan-io__conan-3402"},"issue":{"kind":"string","value":"[SCM] Inability to export (and create) when using the `scm` feature while the conanfile is in a subfolder\n(Working with conan 1.61 on both OS X and Windows)\r\n\r\nThis issue is following the second part of the problem described in #3069.\r\nOur workflow relies on the *conanfile.py* `scm` feature for revision auto-deduction. We don't place said *conanfile.py* at the root of the repository, but at *conan/conanfile.py* instead.\r\n\r\nWith this configuration, any attempt to run \r\n\r\n cd $gitrepo\r\n conan export conan/ com/develop\r\n\r\nWill fail with\r\n\r\n> ERROR: Not a git repository\r\n\r\nThis seems to be because the folder containing the recipe is **not** the root of the repository (it does not contain the .git/ repository), yet its parent does.\r\n\r\nIs hosting the recipe in subfolders supported by conan? It seemed to work well for our use case, until this issue.\n"},"before_files":{"kind":"list like","value":[{"content":"import os\n\nimport re\nimport subprocess\nfrom six.moves.urllib.parse import urlparse, quote_plus\nfrom subprocess import CalledProcessError, PIPE, STDOUT\n\nfrom conans.client.tools.env import no_op, environment_append\nfrom conans.client.tools.files import chdir\nfrom conans.errors import ConanException\nfrom conans.util.files import decode_text, to_file_bytes\n\n\nclass Git(object):\n\n def __init__(self, folder=None, verify_ssl=True, username=None, password=None, force_english=True,\n runner=None):\n self.folder = folder or os.getcwd()\n if not os.path.exists(self.folder):\n os.mkdir(self.folder)\n self._verify_ssl = verify_ssl\n self._force_eng = force_english\n self._username = username\n self._password = password\n self._runner = runner\n\n def run(self, command):\n command = \"git %s\" % command\n with chdir(self.folder) if self.folder else no_op():\n with environment_append({\"LC_ALL\": \"en_US.UTF-8\"}) if self._force_eng else no_op():\n if not self._runner:\n return subprocess.check_output(command, shell=True).decode().strip()\n else:\n return self._runner(command)\n\n def get_url_with_credentials(self, url):\n if not self._username or not self._password:\n return url\n if urlparse(url).password:\n return url\n\n user_enc = quote_plus(self._username)\n pwd_enc = quote_plus(self._password)\n url = url.replace(\"://\", \"://\" + user_enc + \":\" + pwd_enc + \"@\", 1)\n return url\n\n def _configure_ssl_verify(self):\n return self.run(\"config http.sslVerify %s\" % (\"true\" if self._verify_ssl else \"false\"))\n\n def clone(self, url, branch=None):\n url = self.get_url_with_credentials(url)\n if os.path.exists(url):\n url = url.replace(\"\\\\\", \"/\") # Windows local directory\n if os.path.exists(self.folder) and os.listdir(self.folder):\n if not branch:\n raise ConanException(\"The destination folder '%s' is not empty, \"\n \"specify a branch to checkout (not a tag or commit) \"\n \"or specify a 'subfolder' \"\n \"attribute in the 'scm'\" % self.folder)\n output = self.run(\"init\")\n output += self._configure_ssl_verify()\n output += self.run('remote add origin \"%s\"' % url)\n output += self.run(\"fetch \")\n output += self.run(\"checkout -t origin/%s\" % branch)\n else:\n branch_cmd = \"--branch %s\" % branch if branch else \"\"\n output = self.run('clone \"%s\" . %s' % (url, branch_cmd))\n output += self._configure_ssl_verify()\n\n return output\n\n def checkout(self, element, submodule=None):\n self._check_git_repo()\n output = self.run('checkout \"%s\"' % element)\n\n if submodule:\n if submodule == \"shallow\":\n output += self.run(\"submodule sync\")\n output += self.run(\"submodule update --init\")\n elif submodule == \"recursive\":\n output += self.run(\"submodule sync --recursive\")\n output += self.run(\"submodule update --init --recursive\")\n else:\n raise ConanException(\"Invalid 'submodule' attribute value in the 'scm'. \"\n \"Unknown value '%s'. Allowed values: ['shallow', 'recursive']\" % submodule)\n # Element can be a tag, branch or commit\n return output\n\n def excluded_files(self):\n try:\n\n file_paths = [os.path.normpath(os.path.join(os.path.relpath(folder, self.folder), el)).replace(\"\\\\\", \"/\")\n for folder, dirpaths, fs in os.walk(self.folder)\n for el in fs + dirpaths]\n p = subprocess.Popen(['git', 'check-ignore', '--stdin'],\n stdout=PIPE, stdin=PIPE, stderr=STDOUT, cwd=self.folder)\n paths = to_file_bytes(\"\\n\".join(file_paths))\n grep_stdout = decode_text(p.communicate(input=paths)[0])\n tmp = grep_stdout.splitlines()\n except CalledProcessError:\n tmp = []\n return tmp\n\n def get_remote_url(self, remote_name=None):\n self._check_git_repo()\n remote_name = remote_name or \"origin\"\n try:\n remotes = self.run(\"remote -v\")\n for remote in remotes.splitlines():\n try:\n name, url = remote.split(None, 1)\n url, _ = url.rsplit(None, 1)\n if name == remote_name:\n return url\n except Exception:\n pass\n except subprocess.CalledProcessError:\n pass\n return None\n\n def get_commit(self):\n self._check_git_repo()\n try:\n commit = self.run(\"rev-parse HEAD\")\n commit = commit.strip()\n return commit\n except Exception as e:\n raise ConanException(\"Unable to get git commit from %s\\n%s\" % (self.folder, str(e)))\n\n get_revision = get_commit\n\n def _check_git_repo(self):\n if not os.path.exists(os.path.join(self.folder, \".git\")):\n raise ConanException(\"Not a git repository\")\n\n def get_branch(self):\n self._check_git_repo()\n try:\n status = self.run(\"status -bs --porcelain\")\n # ## feature/scm_branch...myorigin/feature/scm_branch\n branch = status.splitlines()[0].split(\"...\")[0].strip(\"#\").strip()\n # Replace non alphanumeric\n branch = re.sub('[^0-9a-zA-Z]+', '_', branch)\n return branch\n except Exception as e:\n raise ConanException(\"Unable to get git branch from %s\\n%s\" % (self.folder, str(e)))\n","path":"conans/client/tools/scm.py"}],"string":"[\n {\n \"content\": \"import os\\n\\nimport re\\nimport subprocess\\nfrom six.moves.urllib.parse import urlparse, quote_plus\\nfrom subprocess import CalledProcessError, PIPE, STDOUT\\n\\nfrom conans.client.tools.env import no_op, environment_append\\nfrom conans.client.tools.files import chdir\\nfrom conans.errors import ConanException\\nfrom conans.util.files import decode_text, to_file_bytes\\n\\n\\nclass Git(object):\\n\\n def __init__(self, folder=None, verify_ssl=True, username=None, password=None, force_english=True,\\n runner=None):\\n self.folder = folder or os.getcwd()\\n if not os.path.exists(self.folder):\\n os.mkdir(self.folder)\\n self._verify_ssl = verify_ssl\\n self._force_eng = force_english\\n self._username = username\\n self._password = password\\n self._runner = runner\\n\\n def run(self, command):\\n command = \\\"git %s\\\" % command\\n with chdir(self.folder) if self.folder else no_op():\\n with environment_append({\\\"LC_ALL\\\": \\\"en_US.UTF-8\\\"}) if self._force_eng else no_op():\\n if not self._runner:\\n return subprocess.check_output(command, shell=True).decode().strip()\\n else:\\n return self._runner(command)\\n\\n def get_url_with_credentials(self, url):\\n if not self._username or not self._password:\\n return url\\n if urlparse(url).password:\\n return url\\n\\n user_enc = quote_plus(self._username)\\n pwd_enc = quote_plus(self._password)\\n url = url.replace(\\\"://\\\", \\\"://\\\" + user_enc + \\\":\\\" + pwd_enc + \\\"@\\\", 1)\\n return url\\n\\n def _configure_ssl_verify(self):\\n return self.run(\\\"config http.sslVerify %s\\\" % (\\\"true\\\" if self._verify_ssl else \\\"false\\\"))\\n\\n def clone(self, url, branch=None):\\n url = self.get_url_with_credentials(url)\\n if os.path.exists(url):\\n url = url.replace(\\\"\\\\\\\\\\\", \\\"/\\\") # Windows local directory\\n if os.path.exists(self.folder) and os.listdir(self.folder):\\n if not branch:\\n raise ConanException(\\\"The destination folder '%s' is not empty, \\\"\\n \\\"specify a branch to checkout (not a tag or commit) \\\"\\n \\\"or specify a 'subfolder' \\\"\\n \\\"attribute in the 'scm'\\\" % self.folder)\\n output = self.run(\\\"init\\\")\\n output += self._configure_ssl_verify()\\n output += self.run('remote add origin \\\"%s\\\"' % url)\\n output += self.run(\\\"fetch \\\")\\n output += self.run(\\\"checkout -t origin/%s\\\" % branch)\\n else:\\n branch_cmd = \\\"--branch %s\\\" % branch if branch else \\\"\\\"\\n output = self.run('clone \\\"%s\\\" . %s' % (url, branch_cmd))\\n output += self._configure_ssl_verify()\\n\\n return output\\n\\n def checkout(self, element, submodule=None):\\n self._check_git_repo()\\n output = self.run('checkout \\\"%s\\\"' % element)\\n\\n if submodule:\\n if submodule == \\\"shallow\\\":\\n output += self.run(\\\"submodule sync\\\")\\n output += self.run(\\\"submodule update --init\\\")\\n elif submodule == \\\"recursive\\\":\\n output += self.run(\\\"submodule sync --recursive\\\")\\n output += self.run(\\\"submodule update --init --recursive\\\")\\n else:\\n raise ConanException(\\\"Invalid 'submodule' attribute value in the 'scm'. \\\"\\n \\\"Unknown value '%s'. Allowed values: ['shallow', 'recursive']\\\" % submodule)\\n # Element can be a tag, branch or commit\\n return output\\n\\n def excluded_files(self):\\n try:\\n\\n file_paths = [os.path.normpath(os.path.join(os.path.relpath(folder, self.folder), el)).replace(\\\"\\\\\\\\\\\", \\\"/\\\")\\n for folder, dirpaths, fs in os.walk(self.folder)\\n for el in fs + dirpaths]\\n p = subprocess.Popen(['git', 'check-ignore', '--stdin'],\\n stdout=PIPE, stdin=PIPE, stderr=STDOUT, cwd=self.folder)\\n paths = to_file_bytes(\\\"\\\\n\\\".join(file_paths))\\n grep_stdout = decode_text(p.communicate(input=paths)[0])\\n tmp = grep_stdout.splitlines()\\n except CalledProcessError:\\n tmp = []\\n return tmp\\n\\n def get_remote_url(self, remote_name=None):\\n self._check_git_repo()\\n remote_name = remote_name or \\\"origin\\\"\\n try:\\n remotes = self.run(\\\"remote -v\\\")\\n for remote in remotes.splitlines():\\n try:\\n name, url = remote.split(None, 1)\\n url, _ = url.rsplit(None, 1)\\n if name == remote_name:\\n return url\\n except Exception:\\n pass\\n except subprocess.CalledProcessError:\\n pass\\n return None\\n\\n def get_commit(self):\\n self._check_git_repo()\\n try:\\n commit = self.run(\\\"rev-parse HEAD\\\")\\n commit = commit.strip()\\n return commit\\n except Exception as e:\\n raise ConanException(\\\"Unable to get git commit from %s\\\\n%s\\\" % (self.folder, str(e)))\\n\\n get_revision = get_commit\\n\\n def _check_git_repo(self):\\n if not os.path.exists(os.path.join(self.folder, \\\".git\\\")):\\n raise ConanException(\\\"Not a git repository\\\")\\n\\n def get_branch(self):\\n self._check_git_repo()\\n try:\\n status = self.run(\\\"status -bs --porcelain\\\")\\n # ## feature/scm_branch...myorigin/feature/scm_branch\\n branch = status.splitlines()[0].split(\\\"...\\\")[0].strip(\\\"#\\\").strip()\\n # Replace non alphanumeric\\n branch = re.sub('[^0-9a-zA-Z]+', '_', branch)\\n return branch\\n except Exception as e:\\n raise ConanException(\\\"Unable to get git branch from %s\\\\n%s\\\" % (self.folder, str(e)))\\n\",\n \"path\": \"conans/client/tools/scm.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import os\n\nimport re\nimport subprocess\nfrom six.moves.urllib.parse import urlparse, quote_plus\nfrom subprocess import CalledProcessError, PIPE, STDOUT\n\nfrom conans.client.tools.env import no_op, environment_append\nfrom conans.client.tools.files import chdir\nfrom conans.errors import ConanException\nfrom conans.util.files import decode_text, to_file_bytes\n\n\nclass Git(object):\n\n def __init__(self, folder=None, verify_ssl=True, username=None, password=None, force_english=True,\n runner=None):\n self.folder = folder or os.getcwd()\n if not os.path.exists(self.folder):\n os.mkdir(self.folder)\n self._verify_ssl = verify_ssl\n self._force_eng = force_english\n self._username = username\n self._password = password\n self._runner = runner\n\n def run(self, command):\n command = \"git %s\" % command\n with chdir(self.folder) if self.folder else no_op():\n with environment_append({\"LC_ALL\": \"en_US.UTF-8\"}) if self._force_eng else no_op():\n if not self._runner:\n return subprocess.check_output(command, shell=True).decode().strip()\n else:\n return self._runner(command)\n\n def get_url_with_credentials(self, url):\n if not self._username or not self._password:\n return url\n if urlparse(url).password:\n return url\n\n user_enc = quote_plus(self._username)\n pwd_enc = quote_plus(self._password)\n url = url.replace(\"://\", \"://\" + user_enc + \":\" + pwd_enc + \"@\", 1)\n return url\n\n def _configure_ssl_verify(self):\n return self.run(\"config http.sslVerify %s\" % (\"true\" if self._verify_ssl else \"false\"))\n\n def clone(self, url, branch=None):\n url = self.get_url_with_credentials(url)\n if os.path.exists(url):\n url = url.replace(\"\\\\\", \"/\") # Windows local directory\n if os.path.exists(self.folder) and os.listdir(self.folder):\n if not branch:\n raise ConanException(\"The destination folder '%s' is not empty, \"\n \"specify a branch to checkout (not a tag or commit) \"\n \"or specify a 'subfolder' \"\n \"attribute in the 'scm'\" % self.folder)\n output = self.run(\"init\")\n output += self._configure_ssl_verify()\n output += self.run('remote add origin \"%s\"' % url)\n output += self.run(\"fetch \")\n output += self.run(\"checkout -t origin/%s\" % branch)\n else:\n branch_cmd = \"--branch %s\" % branch if branch else \"\"\n output = self.run('clone \"%s\" . %s' % (url, branch_cmd))\n output += self._configure_ssl_verify()\n\n return output\n\n def checkout(self, element, submodule=None):\n self._check_git_repo()\n output = self.run('checkout \"%s\"' % element)\n\n if submodule:\n if submodule == \"shallow\":\n output += self.run(\"submodule sync\")\n output += self.run(\"submodule update --init\")\n elif submodule == \"recursive\":\n output += self.run(\"submodule sync --recursive\")\n output += self.run(\"submodule update --init --recursive\")\n else:\n raise ConanException(\"Invalid 'submodule' attribute value in the 'scm'. \"\n \"Unknown value '%s'. Allowed values: ['shallow', 'recursive']\" % submodule)\n # Element can be a tag, branch or commit\n return output\n\n def excluded_files(self):\n try:\n\n file_paths = [os.path.normpath(os.path.join(os.path.relpath(folder, self.folder), el)).replace(\"\\\\\", \"/\")\n for folder, dirpaths, fs in os.walk(self.folder)\n for el in fs + dirpaths]\n p = subprocess.Popen(['git', 'check-ignore', '--stdin'],\n stdout=PIPE, stdin=PIPE, stderr=STDOUT, cwd=self.folder)\n paths = to_file_bytes(\"\\n\".join(file_paths))\n grep_stdout = decode_text(p.communicate(input=paths)[0])\n tmp = grep_stdout.splitlines()\n except CalledProcessError:\n tmp = []\n return tmp\n\n def get_remote_url(self, remote_name=None):\n self._check_git_repo()\n remote_name = remote_name or \"origin\"\n try:\n remotes = self.run(\"remote -v\")\n for remote in remotes.splitlines():\n try:\n name, url = remote.split(None, 1)\n url, _ = url.rsplit(None, 1)\n if name == remote_name:\n return url\n except Exception:\n pass\n except subprocess.CalledProcessError:\n pass\n return None\n\n def get_commit(self):\n self._check_git_repo()\n try:\n commit = self.run(\"rev-parse HEAD\")\n commit = commit.strip()\n return commit\n except Exception as e:\n raise ConanException(\"Unable to get git commit from %s\\n%s\" % (self.folder, str(e)))\n\n get_revision = get_commit\n\n def _check_git_repo(self):\n try:\n self.run(\"status\")\n except Exception:\n raise ConanException(\"Not a valid git repository\")\n\n def get_branch(self):\n self._check_git_repo()\n try:\n status = self.run(\"status -bs --porcelain\")\n # ## feature/scm_branch...myorigin/feature/scm_branch\n branch = status.splitlines()[0].split(\"...\")[0].strip(\"#\").strip()\n # Replace non alphanumeric\n branch = re.sub('[^0-9a-zA-Z]+', '_', branch)\n return branch\n except Exception as e:\n raise ConanException(\"Unable to get git branch from %s\\n%s\" % (self.folder, str(e)))\n","path":"conans/client/tools/scm.py"}],"string":"[\n {\n \"content\": \"import os\\n\\nimport re\\nimport subprocess\\nfrom six.moves.urllib.parse import urlparse, quote_plus\\nfrom subprocess import CalledProcessError, PIPE, STDOUT\\n\\nfrom conans.client.tools.env import no_op, environment_append\\nfrom conans.client.tools.files import chdir\\nfrom conans.errors import ConanException\\nfrom conans.util.files import decode_text, to_file_bytes\\n\\n\\nclass Git(object):\\n\\n def __init__(self, folder=None, verify_ssl=True, username=None, password=None, force_english=True,\\n runner=None):\\n self.folder = folder or os.getcwd()\\n if not os.path.exists(self.folder):\\n os.mkdir(self.folder)\\n self._verify_ssl = verify_ssl\\n self._force_eng = force_english\\n self._username = username\\n self._password = password\\n self._runner = runner\\n\\n def run(self, command):\\n command = \\\"git %s\\\" % command\\n with chdir(self.folder) if self.folder else no_op():\\n with environment_append({\\\"LC_ALL\\\": \\\"en_US.UTF-8\\\"}) if self._force_eng else no_op():\\n if not self._runner:\\n return subprocess.check_output(command, shell=True).decode().strip()\\n else:\\n return self._runner(command)\\n\\n def get_url_with_credentials(self, url):\\n if not self._username or not self._password:\\n return url\\n if urlparse(url).password:\\n return url\\n\\n user_enc = quote_plus(self._username)\\n pwd_enc = quote_plus(self._password)\\n url = url.replace(\\\"://\\\", \\\"://\\\" + user_enc + \\\":\\\" + pwd_enc + \\\"@\\\", 1)\\n return url\\n\\n def _configure_ssl_verify(self):\\n return self.run(\\\"config http.sslVerify %s\\\" % (\\\"true\\\" if self._verify_ssl else \\\"false\\\"))\\n\\n def clone(self, url, branch=None):\\n url = self.get_url_with_credentials(url)\\n if os.path.exists(url):\\n url = url.replace(\\\"\\\\\\\\\\\", \\\"/\\\") # Windows local directory\\n if os.path.exists(self.folder) and os.listdir(self.folder):\\n if not branch:\\n raise ConanException(\\\"The destination folder '%s' is not empty, \\\"\\n \\\"specify a branch to checkout (not a tag or commit) \\\"\\n \\\"or specify a 'subfolder' \\\"\\n \\\"attribute in the 'scm'\\\" % self.folder)\\n output = self.run(\\\"init\\\")\\n output += self._configure_ssl_verify()\\n output += self.run('remote add origin \\\"%s\\\"' % url)\\n output += self.run(\\\"fetch \\\")\\n output += self.run(\\\"checkout -t origin/%s\\\" % branch)\\n else:\\n branch_cmd = \\\"--branch %s\\\" % branch if branch else \\\"\\\"\\n output = self.run('clone \\\"%s\\\" . %s' % (url, branch_cmd))\\n output += self._configure_ssl_verify()\\n\\n return output\\n\\n def checkout(self, element, submodule=None):\\n self._check_git_repo()\\n output = self.run('checkout \\\"%s\\\"' % element)\\n\\n if submodule:\\n if submodule == \\\"shallow\\\":\\n output += self.run(\\\"submodule sync\\\")\\n output += self.run(\\\"submodule update --init\\\")\\n elif submodule == \\\"recursive\\\":\\n output += self.run(\\\"submodule sync --recursive\\\")\\n output += self.run(\\\"submodule update --init --recursive\\\")\\n else:\\n raise ConanException(\\\"Invalid 'submodule' attribute value in the 'scm'. \\\"\\n \\\"Unknown value '%s'. Allowed values: ['shallow', 'recursive']\\\" % submodule)\\n # Element can be a tag, branch or commit\\n return output\\n\\n def excluded_files(self):\\n try:\\n\\n file_paths = [os.path.normpath(os.path.join(os.path.relpath(folder, self.folder), el)).replace(\\\"\\\\\\\\\\\", \\\"/\\\")\\n for folder, dirpaths, fs in os.walk(self.folder)\\n for el in fs + dirpaths]\\n p = subprocess.Popen(['git', 'check-ignore', '--stdin'],\\n stdout=PIPE, stdin=PIPE, stderr=STDOUT, cwd=self.folder)\\n paths = to_file_bytes(\\\"\\\\n\\\".join(file_paths))\\n grep_stdout = decode_text(p.communicate(input=paths)[0])\\n tmp = grep_stdout.splitlines()\\n except CalledProcessError:\\n tmp = []\\n return tmp\\n\\n def get_remote_url(self, remote_name=None):\\n self._check_git_repo()\\n remote_name = remote_name or \\\"origin\\\"\\n try:\\n remotes = self.run(\\\"remote -v\\\")\\n for remote in remotes.splitlines():\\n try:\\n name, url = remote.split(None, 1)\\n url, _ = url.rsplit(None, 1)\\n if name == remote_name:\\n return url\\n except Exception:\\n pass\\n except subprocess.CalledProcessError:\\n pass\\n return None\\n\\n def get_commit(self):\\n self._check_git_repo()\\n try:\\n commit = self.run(\\\"rev-parse HEAD\\\")\\n commit = commit.strip()\\n return commit\\n except Exception as e:\\n raise ConanException(\\\"Unable to get git commit from %s\\\\n%s\\\" % (self.folder, str(e)))\\n\\n get_revision = get_commit\\n\\n def _check_git_repo(self):\\n try:\\n self.run(\\\"status\\\")\\n except Exception:\\n raise ConanException(\\\"Not a valid git repository\\\")\\n\\n def get_branch(self):\\n self._check_git_repo()\\n try:\\n status = self.run(\\\"status -bs --porcelain\\\")\\n # ## feature/scm_branch...myorigin/feature/scm_branch\\n branch = status.splitlines()[0].split(\\\"...\\\")[0].strip(\\\"#\\\").strip()\\n # Replace non alphanumeric\\n branch = re.sub('[^0-9a-zA-Z]+', '_', branch)\\n return branch\\n except Exception as e:\\n raise ConanException(\\\"Unable to get git branch from %s\\\\n%s\\\" % (self.folder, str(e)))\\n\",\n \"path\": \"conans/client/tools/scm.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/conans/client/tools/scm.py b/conans/client/tools/scm.py\nindex 1b8a6b87782..9ed03409110 100644\n--- a/conans/client/tools/scm.py\n+++ b/conans/client/tools/scm.py\n@@ -130,8 +130,10 @@ def get_commit(self):\n get_revision = get_commit\n \n def _check_git_repo(self):\n- if not os.path.exists(os.path.join(self.folder, \".git\")):\n- raise ConanException(\"Not a git repository\")\n+ try:\n+ self.run(\"status\")\n+ except Exception:\n+ raise ConanException(\"Not a valid git repository\")\n \n def get_branch(self):\n self._check_git_repo()\n"}}},{"rowIdx":4662,"cells":{"in_source_id":{"kind":"string","value":"pytorch__text-145"},"issue":{"kind":"string","value":"AttributeError: 'list' object has no attribute 'rstrip'\nHi all, previously torchtext works for me when I'm running anaconda python. However, now, when i uninstalled my anaconda python. It stops working.\r\n\r\nIt gives me the following error: \r\n\r\n```\r\nFile \"/Library/Python/2.7/site-packages/torchtext/data/example.py\", line 59, in fromlist\r\n setattr(ex, name, field.preprocess(val.rstrip('\\n')))\r\nAttributeError: 'list' object has no attribute 'rstrip'\r\n\r\n```\r\n\r\nThanks!\n"},"before_files":{"kind":"list like","value":[{"content":"import csv\nimport json\n\nimport six\n\n\nclass Example(object):\n \"\"\"Defines a single training or test example.\n\n Stores each column of the example as an attribute.\n \"\"\"\n\n @classmethod\n def fromJSON(cls, data, fields):\n return cls.fromdict(json.loads(data), fields)\n\n @classmethod\n def fromdict(cls, data, fields):\n ex = cls()\n for key, vals in fields.items():\n if key not in data:\n raise ValueError(\"Specified key {} was not found in \"\n \"the input data\".format(key))\n if vals is not None:\n if not isinstance(vals, list):\n vals = [vals]\n for val in vals:\n name, field = val\n setattr(ex, name, field.preprocess(data[key]))\n return ex\n\n @classmethod\n def fromTSV(cls, data, fields):\n return cls.fromlist(data.split('\\t'), fields)\n\n @classmethod\n def fromCSV(cls, data, fields):\n data = data.rstrip(\"\\n\")\n # If Python 2, encode to utf-8 since CSV doesn't take unicode input\n if six.PY2:\n data = data.encode('utf-8')\n # Use Python CSV module to parse the CSV line\n parsed_csv_lines = csv.reader([data])\n\n # If Python 2, decode back to unicode (the original input format).\n if six.PY2:\n for line in parsed_csv_lines:\n parsed_csv_line = [six.text_type(col, 'utf-8') for col in line]\n break\n else:\n parsed_csv_line = list(parsed_csv_lines)[0]\n return cls.fromlist(parsed_csv_line, fields)\n\n @classmethod\n def fromlist(cls, data, fields):\n ex = cls()\n for (name, field), val in zip(fields, data):\n if field is not None:\n setattr(ex, name, field.preprocess(val.rstrip('\\n')))\n return ex\n\n @classmethod\n def fromtree(cls, data, fields, subtrees=False):\n try:\n from nltk.tree import Tree\n except ImportError:\n print(\"Please install NLTK. \"\n \"See the docs at http://nltk.org for more information.\")\n raise\n tree = Tree.fromstring(data)\n if subtrees:\n return [cls.fromlist(\n [' '.join(t.leaves()), t.label()], fields) for t in tree.subtrees()]\n return cls.fromlist([' '.join(tree.leaves()), tree.label()], fields)\n","path":"torchtext/data/example.py"}],"string":"[\n {\n \"content\": \"import csv\\nimport json\\n\\nimport six\\n\\n\\nclass Example(object):\\n \\\"\\\"\\\"Defines a single training or test example.\\n\\n Stores each column of the example as an attribute.\\n \\\"\\\"\\\"\\n\\n @classmethod\\n def fromJSON(cls, data, fields):\\n return cls.fromdict(json.loads(data), fields)\\n\\n @classmethod\\n def fromdict(cls, data, fields):\\n ex = cls()\\n for key, vals in fields.items():\\n if key not in data:\\n raise ValueError(\\\"Specified key {} was not found in \\\"\\n \\\"the input data\\\".format(key))\\n if vals is not None:\\n if not isinstance(vals, list):\\n vals = [vals]\\n for val in vals:\\n name, field = val\\n setattr(ex, name, field.preprocess(data[key]))\\n return ex\\n\\n @classmethod\\n def fromTSV(cls, data, fields):\\n return cls.fromlist(data.split('\\\\t'), fields)\\n\\n @classmethod\\n def fromCSV(cls, data, fields):\\n data = data.rstrip(\\\"\\\\n\\\")\\n # If Python 2, encode to utf-8 since CSV doesn't take unicode input\\n if six.PY2:\\n data = data.encode('utf-8')\\n # Use Python CSV module to parse the CSV line\\n parsed_csv_lines = csv.reader([data])\\n\\n # If Python 2, decode back to unicode (the original input format).\\n if six.PY2:\\n for line in parsed_csv_lines:\\n parsed_csv_line = [six.text_type(col, 'utf-8') for col in line]\\n break\\n else:\\n parsed_csv_line = list(parsed_csv_lines)[0]\\n return cls.fromlist(parsed_csv_line, fields)\\n\\n @classmethod\\n def fromlist(cls, data, fields):\\n ex = cls()\\n for (name, field), val in zip(fields, data):\\n if field is not None:\\n setattr(ex, name, field.preprocess(val.rstrip('\\\\n')))\\n return ex\\n\\n @classmethod\\n def fromtree(cls, data, fields, subtrees=False):\\n try:\\n from nltk.tree import Tree\\n except ImportError:\\n print(\\\"Please install NLTK. \\\"\\n \\\"See the docs at http://nltk.org for more information.\\\")\\n raise\\n tree = Tree.fromstring(data)\\n if subtrees:\\n return [cls.fromlist(\\n [' '.join(t.leaves()), t.label()], fields) for t in tree.subtrees()]\\n return cls.fromlist([' '.join(tree.leaves()), tree.label()], fields)\\n\",\n \"path\": \"torchtext/data/example.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import csv\nimport json\n\nimport six\n\n\nclass Example(object):\n \"\"\"Defines a single training or test example.\n\n Stores each column of the example as an attribute.\n \"\"\"\n\n @classmethod\n def fromJSON(cls, data, fields):\n return cls.fromdict(json.loads(data), fields)\n\n @classmethod\n def fromdict(cls, data, fields):\n ex = cls()\n for key, vals in fields.items():\n if key not in data:\n raise ValueError(\"Specified key {} was not found in \"\n \"the input data\".format(key))\n if vals is not None:\n if not isinstance(vals, list):\n vals = [vals]\n for val in vals:\n name, field = val\n setattr(ex, name, field.preprocess(data[key]))\n return ex\n\n @classmethod\n def fromTSV(cls, data, fields):\n return cls.fromlist(data.split('\\t'), fields)\n\n @classmethod\n def fromCSV(cls, data, fields):\n data = data.rstrip(\"\\n\")\n # If Python 2, encode to utf-8 since CSV doesn't take unicode input\n if six.PY2:\n data = data.encode('utf-8')\n # Use Python CSV module to parse the CSV line\n parsed_csv_lines = csv.reader([data])\n\n # If Python 2, decode back to unicode (the original input format).\n if six.PY2:\n for line in parsed_csv_lines:\n parsed_csv_line = [six.text_type(col, 'utf-8') for col in line]\n break\n else:\n parsed_csv_line = list(parsed_csv_lines)[0]\n return cls.fromlist(parsed_csv_line, fields)\n\n @classmethod\n def fromlist(cls, data, fields):\n ex = cls()\n for (name, field), val in zip(fields, data):\n if field is not None:\n if isinstance(val, six.string_types):\n val = val.rstrip('\\n')\n setattr(ex, name, field.preprocess(val))\n return ex\n\n @classmethod\n def fromtree(cls, data, fields, subtrees=False):\n try:\n from nltk.tree import Tree\n except ImportError:\n print(\"Please install NLTK. \"\n \"See the docs at http://nltk.org for more information.\")\n raise\n tree = Tree.fromstring(data)\n if subtrees:\n return [cls.fromlist(\n [' '.join(t.leaves()), t.label()], fields) for t in tree.subtrees()]\n return cls.fromlist([' '.join(tree.leaves()), tree.label()], fields)\n","path":"torchtext/data/example.py"}],"string":"[\n {\n \"content\": \"import csv\\nimport json\\n\\nimport six\\n\\n\\nclass Example(object):\\n \\\"\\\"\\\"Defines a single training or test example.\\n\\n Stores each column of the example as an attribute.\\n \\\"\\\"\\\"\\n\\n @classmethod\\n def fromJSON(cls, data, fields):\\n return cls.fromdict(json.loads(data), fields)\\n\\n @classmethod\\n def fromdict(cls, data, fields):\\n ex = cls()\\n for key, vals in fields.items():\\n if key not in data:\\n raise ValueError(\\\"Specified key {} was not found in \\\"\\n \\\"the input data\\\".format(key))\\n if vals is not None:\\n if not isinstance(vals, list):\\n vals = [vals]\\n for val in vals:\\n name, field = val\\n setattr(ex, name, field.preprocess(data[key]))\\n return ex\\n\\n @classmethod\\n def fromTSV(cls, data, fields):\\n return cls.fromlist(data.split('\\\\t'), fields)\\n\\n @classmethod\\n def fromCSV(cls, data, fields):\\n data = data.rstrip(\\\"\\\\n\\\")\\n # If Python 2, encode to utf-8 since CSV doesn't take unicode input\\n if six.PY2:\\n data = data.encode('utf-8')\\n # Use Python CSV module to parse the CSV line\\n parsed_csv_lines = csv.reader([data])\\n\\n # If Python 2, decode back to unicode (the original input format).\\n if six.PY2:\\n for line in parsed_csv_lines:\\n parsed_csv_line = [six.text_type(col, 'utf-8') for col in line]\\n break\\n else:\\n parsed_csv_line = list(parsed_csv_lines)[0]\\n return cls.fromlist(parsed_csv_line, fields)\\n\\n @classmethod\\n def fromlist(cls, data, fields):\\n ex = cls()\\n for (name, field), val in zip(fields, data):\\n if field is not None:\\n if isinstance(val, six.string_types):\\n val = val.rstrip('\\\\n')\\n setattr(ex, name, field.preprocess(val))\\n return ex\\n\\n @classmethod\\n def fromtree(cls, data, fields, subtrees=False):\\n try:\\n from nltk.tree import Tree\\n except ImportError:\\n print(\\\"Please install NLTK. \\\"\\n \\\"See the docs at http://nltk.org for more information.\\\")\\n raise\\n tree = Tree.fromstring(data)\\n if subtrees:\\n return [cls.fromlist(\\n [' '.join(t.leaves()), t.label()], fields) for t in tree.subtrees()]\\n return cls.fromlist([' '.join(tree.leaves()), tree.label()], fields)\\n\",\n \"path\": \"torchtext/data/example.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/torchtext/data/example.py b/torchtext/data/example.py\nindex 57e4521672..576b46f66d 100644\n--- a/torchtext/data/example.py\n+++ b/torchtext/data/example.py\n@@ -56,7 +56,9 @@ def fromlist(cls, data, fields):\n ex = cls()\n for (name, field), val in zip(fields, data):\n if field is not None:\n- setattr(ex, name, field.preprocess(val.rstrip('\\n')))\n+ if isinstance(val, six.string_types):\n+ val = val.rstrip('\\n')\n+ setattr(ex, name, field.preprocess(val))\n return ex\n \n @classmethod\n"}}},{"rowIdx":4663,"cells":{"in_source_id":{"kind":"string","value":"SciTools__cartopy-169"},"issue":{"kind":"string","value":"Remove ```GenericProjectionAxes``` ```from cartopy.mpl.geoaxes```\n\n"},"before_files":{"kind":"list like","value":[{"content":"# (C) British Crown Copyright 2011 - 2012, Met Office\n#\n# This file is part of cartopy.\n#\n# cartopy is free software: you can redistribute it and/or modify it under\n# the terms of the GNU Lesser General Public License as published by the\n# Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# cartopy is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Lesser General Public License for more details.\n#\n# You should have received a copy of the GNU Lesser General Public License\n# along with cartopy. If not, see <http://www.gnu.org/licenses/>.\n\"\"\"\nThis module defines the :class:`GeoAxes` class, for use with matplotlib.\n\nWhen a matplotlib figure contains a GeoAxes the plotting commands can transform\nplot results from source coordinates to the GeoAxes' target projection.\n\n\"\"\"\nimport warnings\nimport weakref\n\nimport matplotlib.axes\nfrom matplotlib.image import imread\nimport matplotlib.transforms as mtransforms\nimport matplotlib.patches as mpatches\nimport matplotlib.path as mpath\nimport matplotlib.collections as mcollections\nimport numpy\nimport shapely.geometry\n\nimport cartopy.crs as ccrs\nimport cartopy.feature\nimport cartopy.img_transform\nimport cartopy.mpl.feature_artist as feature_artist\nimport cartopy.mpl.patch as patch\n\n\nimport matplotlib\nassert matplotlib.__version__ >= '1.2', ('Cartopy can only work with '\n 'matplotlib 1.2 or greater.')\n\n\n_PATH_TRANSFORM_CACHE = weakref.WeakKeyDictionary()\n\"\"\"\nA nested mapping from path, source CRS, and target projection to the\nresulting transformed paths::\n\n {path: {(source_crs, target_projection): list_of_paths}}\n\nProvides a significant performance boost for contours which, at\nmatplotlib 1.2.0 called transform_path_non_affine twice unnecessarily.\n\n\"\"\"\n\n\n# XXX call this InterCRSTransform\nclass InterProjectionTransform(mtransforms.Transform):\n \"\"\"\n Transforms coordinates from the source_projection to\n the ``target_projection``.\n\n \"\"\"\n input_dims = 2\n output_dims = 2\n is_separable = False\n has_inverse = True\n\n def __init__(self, source_projection, target_projection):\n \"\"\"\n Create the transform object from the given projections.\n\n Args:\n\n * source_projection - A :class:`~cartopy.crs.CRS`.\n * target_projection - A :class:`~cartopy.crs.CRS`.\n\n \"\"\"\n # assert target_projection is cartopy.crs.Projection\n # assert source_projection is cartopy.crs.CRS\n self.source_projection = source_projection\n self.target_projection = target_projection\n mtransforms.Transform.__init__(self)\n\n def __repr__(self):\n return ('< {!s} {!s} -> {!s} >'.format(self.__class__.__name__,\n self.source_projection,\n self.target_projection))\n\n def transform_non_affine(self, xy):\n \"\"\"\n Transforms from source to target coordinates.\n\n Args:\n\n * xy - An (n,2) array of points in source coordinates.\n\n Returns:\n\n * An (n,2) array of transformed points in target coordinates.\n\n \"\"\"\n prj = self.target_projection\n if isinstance(xy, numpy.ndarray):\n return prj.transform_points(self.source_projection,\n xy[:, 0], xy[:, 1])[:, 0:2]\n else:\n x, y = xy\n x, y = prj.transform_point(x, y, self.source_projection)\n return x, y\n\n def transform_path_non_affine(self, src_path):\n \"\"\"\n Transforms from source to target coordinates.\n\n Caches results, so subsequent calls with the same *src_path* argument\n (and the same source and target projections) are faster.\n\n Args:\n\n * src_path - A matplotlib :class:`~matplotlib.path.Path` object\n with vertices in source coordinates.\n\n Returns\n\n * A matplotlib :class:`~matplotlib.path.Path` with vertices\n in target coordinates.\n\n \"\"\"\n mapping = _PATH_TRANSFORM_CACHE.get(src_path)\n if mapping is not None:\n key = (self.source_projection, self.target_projection)\n result = mapping.get(key)\n if result is not None:\n return result\n\n bypass = self.source_projection == self.target_projection\n if bypass:\n projection = self.source_projection\n if isinstance(projection, ccrs._CylindricalProjection):\n x = src_path.vertices[:, 0]\n x_limits = projection.x_limits\n bypass = x.min() >= x_limits[0] and x.max() <= x_limits[1]\n if bypass:\n return src_path\n\n if src_path.vertices.shape == (1, 2):\n return mpath.Path(self.transform(src_path.vertices))\n\n transformed_geoms = []\n for geom in patch.path_to_geos(src_path):\n transformed_geoms.append(\n self.target_projection.project_geometry(geom,\n self.source_projection)\n )\n\n if not transformed_geoms:\n result = mpath.Path(numpy.empty([0, 2]))\n else:\n paths = patch.geos_to_path(transformed_geoms)\n if not paths:\n return mpath.Path(numpy.empty([0, 2]))\n points, codes = zip(*[patch.path_segments(path, curves=False,\n simplify=False)\n for path in paths])\n result = mpath.Path(numpy.concatenate(points, 0),\n numpy.concatenate(codes))\n\n # store the result in the cache for future performance boosts\n key = (self.source_projection, self.target_projection)\n if mapping is None:\n _PATH_TRANSFORM_CACHE[src_path] = {key: result}\n else:\n mapping[key] = result\n\n return result\n\n def inverted(self):\n \"\"\"\n Return a matplotlib :class:`~matplotlib.transforms.Transform`\n from target to source coordinates.\n\n \"\"\"\n return InterProjectionTransform(self.target_projection,\n self.source_projection)\n\n\nclass GeoAxes(matplotlib.axes.Axes):\n \"\"\"\n A subclass of :class:`matplotlib.axes.Axes` which represents a\n map :class:`~cartopy.crs.Projection`.\n\n This class replaces the matplotlib :class:`~matplotlib.axes.Axes` class\n when created with the *projection* keyword. For example:\n\n # Set up a standard map for latlon data.\n geo_axes = pyplot.axes(projection=cartopy.crs.PlateCarree())\n\n # Set up an OSGB map.\n geo_axes = pyplot.subplot(2, 2, 1, projection=cartopy.crs.OSGB())\n\n When a source projection is provided to one of it's plotting methods,\n using the *transform* keyword, the standard matplotlib plot result is\n transformed from source coordinates to the target projection. For example:\n\n # Plot latlon data on an OSGB map.\n pyplot.axes(projection=cartopy.crs.OSGB())\n pyplot.contourf(x, y, data, transform=cartopy.crs.PlateCarree())\n\n \"\"\"\n def __init__(self, *args, **kwargs):\n \"\"\"\n Create a GeoAxes object using standard matplotlib\n :class:`~matplotlib.axes.Axes` args and keywords.\n\n Kwargs:\n\n * map_projection - The target :class:`~cartopy.crs.Projection` of\n this Axes object.\n\n All other args and keywords are passed straight through to\n :class:`matplotlib.axes.Axes`.\n\n \"\"\"\n self.projection = kwargs.pop('map_projection')\n super(GeoAxes, self).__init__(*args, **kwargs)\n self._gridliners = []\n self.img_factories = []\n self._done_img_factory = False\n\n def add_image(self, factory, *args, **kwargs):\n \"\"\"\n Adds an image \"factory\" to the Axes.\n\n Any image \"factory\" added, will be asked to retrieve an image\n with associated metadata for a given bounding box at draw time.\n The advantage of this approach is that the limits of the map\n do not need to be known when adding the image factory, but can\n be deferred until everything which can effect the limits has been\n added.\n\n Currently an image \"factory\" is just an object with\n a ``image_for_domain`` method. Examples of image factories\n are :class:`cartopy.io.img_nest.NestedImageCollection` and\n :class:`cartopy.io.image_tiles.GoogleTiles`.\n\n \"\"\"\n # XXX TODO: Needs working on\n self.img_factories.append([factory, args, kwargs])\n\n @matplotlib.axes.allow_rasterization\n def draw(self, renderer=None, inframe=False):\n \"\"\"\n Extends the standard behaviour of :func:`matplotlib.axes.Axes.draw`.\n\n Draws grid lines and image factory results before invoking standard\n matplotlib drawing. A global range is used if no limits have yet\n been set.\n\n \"\"\"\n # if no data has been added, and no extents set, then make the\n # map global\n if self.ignore_existing_data_limits and \\\n self._autoscaleXon and self._autoscaleYon:\n self.set_global()\n self.ignore_existing_data_limits = True\n\n for gl in self._gridliners:\n gl.do_gridlines(background_patch=self.background_patch)\n self._gridliners = []\n\n # XXX This interface needs a tidy up:\n # image drawing on pan/zoom;\n # caching the resulting image;\n # buffering the result by 10%...;\n if not self._done_img_factory:\n for factory, args, kwargs in self.img_factories:\n img, extent, origin = factory.image_for_domain(\n self._get_extent_geom(factory.crs), args[0])\n self.imshow(img, extent=extent, origin=origin,\n transform=factory.crs, *args[1:], **kwargs)\n self._done_img_factory = True\n\n return matplotlib.axes.Axes.draw(self, renderer=renderer,\n inframe=inframe)\n\n def __str__(self):\n return '< GeoAxes: %s >' % self.projection\n\n def cla(self):\n \"\"\"Clears the current axes and adds boundary lines.\"\"\"\n result = matplotlib.axes.Axes.cla(self)\n self.xaxis.set_visible(False)\n self.yaxis.set_visible(False)\n self.autoscale_view(tight=True)\n self.set_aspect('equal')\n\n pre_bounary = self.ignore_existing_data_limits\n self._boundary()\n self.ignore_existing_data_limits = pre_bounary\n\n # XXX consider a margin - but only when the map is not global...\n # self._xmargin = 0.15\n # self._ymargin = 0.15\n\n return result\n\n def format_coord(self, x, y):\n \"\"\"Return a string formatted for the matplotlib GUI status bar.\"\"\"\n lon, lat = ccrs.Geodetic().transform_point(x, y, self.projection)\n\n ns = 'N' if lat >= 0.0 else 'S'\n ew = 'E' if lon >= 0.0 else 'W'\n\n return u'%.4g, %.4g (%f\\u00b0%s, %f\\u00b0%s)' % (x, y, abs(lat),\n ns, abs(lon), ew)\n\n def coastlines(self, resolution='110m', color='black', **kwargs):\n \"\"\"\n Adds coastal **outlines** to the current axes from the Natural Earth\n \"coastline\" shapefile collection.\n\n Kwargs:\n\n * resolution - a named resolution to use from the Natural Earth\n dataset. Currently can be one of \"110m\", \"50m\", and\n \"10m\".\n\n .. note::\n\n Currently no clipping is done on the coastlines before adding\n them to the axes. This means, if very high resolution coastlines\n are being used, performance is likely to be severely effected.\n This should be resolved transparently by v0.5.\n\n \"\"\"\n kwargs['edgecolor'] = color\n kwargs['facecolor'] = 'none'\n feature = cartopy.feature.NaturalEarthFeature('physical', 'coastline',\n resolution, **kwargs)\n return self.add_feature(feature)\n\n def natural_earth_shp(self, name='land', resolution='110m',\n category='physical', **kwargs):\n \"\"\"\n Adds the geometries from the specified Natural Earth shapefile to the\n Axes as a :class:`~matplotlib.collections.PathCollection`.\n\n ``**kwargs`` are passed through to the\n :class:`~matplotlib.collections.PathCollection` constructor.\n\n Returns the created :class:`~matplotlib.collections.PathCollection`.\n\n .. note::\n\n Currently no clipping is done on the geometries before adding them\n to the axes. This means, if very high resolution geometries are\n being used, performance is likely to be severely effected. This\n should be resolved transparently by v0.5.\n\n \"\"\"\n warnings.warn('This method has been deprecated.'\n ' Please use `add_feature` instead.')\n kwargs.setdefault('edgecolor', 'face')\n kwargs.setdefault('facecolor', cartopy.feature._COLOURS['land'])\n feature = cartopy.feature.NaturalEarthFeature(category, name,\n resolution, **kwargs)\n return self.add_feature(feature)\n\n def add_feature(self, feature, **kwargs):\n \"\"\"\n Adds the given :class:`~cartopy.feature.Feature` instance to the axes.\n\n Args:\n\n * feature:\n An instance of :class:`~cartopy.feature.Feature`.\n\n Kwargs:\n Keyword arguments to be used when drawing the feature. This allows\n standard matplotlib control over aspects such as 'facecolor',\n 'alpha', etc.\n\n Returns:\n * A :class:`cartopy.mpl_integration.feature_artist.FeatureArtist`\n instance responsible for drawing the feature.\n\n \"\"\"\n # Instantiate an artist to draw the feature and add it to the axes.\n artist = feature_artist.FeatureArtist(feature, **kwargs)\n return self.add_artist(artist)\n\n def add_geometries(self, geoms, crs, **kwargs):\n \"\"\"\n Add the given shapely geometries (in the given crs) to the axes.\n\n Args:\n\n * geoms:\n A collection of shapely geometries.\n * crs:\n The cartopy CRS in which the provided geometries are defined.\n\n Kwargs:\n Keyword arguments to be used when drawing this feature.\n\n Returns:\n * A :class:`cartopy.mpl_integration.feature_artist.FeatureArtist`\n instance responsible for drawing the geometries.\n\n \"\"\"\n feature = cartopy.feature.ShapelyFeature(geoms, crs, **kwargs)\n return self.add_feature(feature)\n\n def get_extent(self, crs=None):\n \"\"\"\n Get the extent (x0, x1, y0, y1) of the map in the given coordinate\n system.\n\n If no crs is given, the returned extents' coordinate system will be\n assumed to be the Geodetic version of this axes' projection.\n\n \"\"\"\n p = self._get_extent_geom(crs)\n r = p.bounds\n x1, y1, x2, y2 = r\n return x1, x2, y1, y2\n\n def _get_extent_geom(self, crs=None):\n # Perform the calculations for get_extent(), which just repackages it.\n x1, x2 = self.get_xlim()\n y1, y2 = self.get_ylim()\n\n if x1 == 0 and y1 == 0 and x2 == 1 and y2 == 1:\n x1, x2 = self.projection.x_limits\n y1, y2 = self.projection.y_limits\n\n domain_in_src_proj = shapely.geometry.Polygon([[x1, y1], [x2, y1],\n [x2, y2], [x1, y2],\n [x1, y1]])\n\n # Determine target projection based on requested CRS.\n if crs is None:\n proj = self.projection\n elif isinstance(crs, ccrs.Projection):\n proj = crs\n else:\n # Attempt to select suitable projection for\n # non-projection CRS.\n if isinstance(crs, ccrs.RotatedGeodetic):\n proj = ccrs.RotatedPole(crs.proj4_params['lon_0'] - 180,\n crs.proj4_params['o_lat_p'])\n warnings.warn('Approximating coordinate system {!r} with a '\n 'RotatedPole projection.'.format(crs))\n elif hasattr(crs, 'is_geodetic') and crs.is_geodetic():\n proj = ccrs.PlateCarree()\n warnings.warn('Approximating coordinate system {!r} with the '\n 'PlateCarree projection.'.format(crs))\n else:\n raise ValueError('Cannot determine extent in'\n ' coordinate system {!r}'.format(crs))\n\n # Calculate intersection with boundary and project if necesary.\n boundary_poly = shapely.geometry.Polygon(self.projection.boundary)\n if proj != self.projection:\n # Erode boundary by threshold to avoid transform issues.\n # This is a workaround for numerical issues at the boundary.\n eroded_boundary = boundary_poly.buffer(-self.projection.threshold)\n geom_in_src_proj = eroded_boundary.intersection(\n domain_in_src_proj)\n geom_in_crs = proj.project_geometry(geom_in_src_proj,\n self.projection)\n else:\n geom_in_crs = boundary_poly.intersection(domain_in_src_proj)\n\n return geom_in_crs\n\n def set_extent(self, extents, crs=None):\n \"\"\"\n Set the extent (x0, x1, y0, y1) of the map in the given\n coordinate system.\n\n If no crs is given, the extents' coordinate system will be assumed\n to be the Geodetic version of this axes' projection.\n\n \"\"\"\n # TODO: Implement the same semantics as plt.xlim and\n # plt.ylim - allowing users to set None for a minimum and/or\n # maximum value\n x1, x2, y1, y2 = extents\n domain_in_crs = shapely.geometry.LineString([[x1, y1], [x2, y1],\n [x2, y2], [x1, y2],\n [x1, y1]])\n\n r = self.projection.project_geometry(domain_in_crs, crs)\n x1, y1, x2, y2 = r.bounds\n self.set_xlim([x1, x2])\n self.set_ylim([y1, y2])\n\n def set_global(self):\n \"\"\"\n Set the extent of the Axes to the limits of the projection.\n\n .. note::\n\n In some cases where the projection has a limited sensible range\n the ``set_global`` method does not actually make the whole globe\n visible. Instead, the most appropriate extents will be used (e.g.\n Ordnance Survey UK will set the extents to be around the British\n Isles.\n\n \"\"\"\n self.set_xlim(self.projection.x_limits)\n self.set_ylim(self.projection.y_limits)\n\n def set_xticks(self, ticks, minor=False, crs=None):\n \"\"\"\n Set the x ticks.\n\n Args:\n\n * ticks - list of floats denoting the desired position of x ticks.\n\n Kwargs:\n\n * minor - boolean flag indicating whether the ticks should be minor\n ticks i.e. small and unlabelled (default is False).\n\n * crs - An instance of :class:`~cartopy.crs.CRS` indicating the\n coordinate system of the provided tick values. If no\n coordinate system is specified then the values are assumed\n to be in the coordinate system of the projection.\n\n .. note::\n\n This method is limited to cylindrical projections.\n\n .. note::\n\n This interface is subject to change whilst functionality is added\n to support other map projections.\n\n \"\"\"\n if not isinstance(self.projection, (ccrs._RectangularProjection,\n ccrs._CylindricalProjection,\n ccrs.OSGB)):\n raise RuntimeError('Cannot set xticks for not-cylindrical '\n 'coordinate systems.')\n\n # Switch on drawing of x axis\n self.xaxis.set_visible(True)\n\n # Project ticks if crs differs from axes' projection\n if crs is not None and crs != self.projection:\n proj_xyz = self.projection.transform_points(crs,\n numpy.asarray(ticks),\n numpy.zeros(len(ticks))\n )\n xticks = proj_xyz[..., 0]\n else:\n xticks = ticks\n\n return super(GeoAxes, self).set_xticks(xticks, minor)\n\n def set_yticks(self, ticks, minor=False, crs=None):\n \"\"\"\n Set the y ticks.\n\n Args:\n\n * ticks - list of floats denoting the desired position of y ticks.\n\n Kwargs:\n\n * minor - boolean flag indicating whether the ticks should be minor\n ticks i.e. small and unlabelled (default is False).\n\n * crs - An instance of :class:`~cartopy.crs.CRS` indicating the\n coordinate system of the provided tick values. If no\n coordinate system is specified then the values are assumed\n to be in the coordinate system of the projection.\n\n .. note::\n\n This method is limited to cylindrical projections.\n\n .. note::\n\n This interface is subject to change whilst functionality is added\n to support other map projections.\n\n \"\"\"\n if not isinstance(self.projection, (ccrs._RectangularProjection,\n ccrs._CylindricalProjection,\n ccrs.OSGB)):\n raise RuntimeError('Cannot set yticks for non-cylindrical '\n 'coordinate systems.')\n\n # Switch on drawing of y axis\n self.yaxis.set_visible(True)\n\n # Project ticks if crs differs from axes' projection\n if crs is not None and crs != self.projection:\n prj = self.projection\n proj_xyz = prj.transform_points(crs,\n numpy.zeros(len(ticks)),\n numpy.asarray(ticks))\n yticks = proj_xyz[..., 1]\n else:\n yticks = ticks\n\n return super(GeoAxes, self).set_yticks(yticks, minor)\n\n# def geod_circle_meters(self, lon_0, lat_0, radius, npts=80, **kwargs):\n# # radius is in meters\n# geod = self.projection.as_geodetic()\n#\n# az = numpy.linspace(0, 360, npts)\n# lats = numpy.zeros(npts) + lat_0\n# lons = numpy.zeros(npts) + lon_0\n# distances = numpy.zeros(npts) + radius\n#\n# lons, lats, _reverse_az = geod.fwd(lons, lats, az, distances,\n# radians=False)\n# ll = numpy.concatenate([lons[:, None], lats[:, None]], 1)\n# from matplotlib.patches import Polygon\n# poly = Polygon(ll, transform=cartopy.prj.PlateCarree(), **kwargs)\n# self.add_patch(poly)\n# return poly\n#\n# def gshhs_line(self, outline_color='k', domain=None,\n# resolution='low', **kwargs):\n# # domain is a shapely geometry (Polygon or MultiPolygon)\n# import cartopy.gshhs as gshhs\n## import cartopy.spherical as spherical\n# from matplotlib.collections import PatchCollection, LineCollection\n#\n# paths = []\n#\n# projection = self.projection\n#\n# if domain is None:\n# domain = self.map_domain(ccrs.PlateCarree())\n#\n# for points in gshhs.read_gshhc(gshhs.fnames[resolution],\n# poly=False, domain=domain):\n# paths.extend(patch.geos_to_path(\n# shapely.geometry.LineString(points))\n# )\n#\n## slinestring = shapely.geometry.LineString(points)\n## projected = projection.project_geometry(slinestring)\n## paths.extend(patch.geos_to_path(projected))\n#\n# collection = PatchCollection([mpatches.PathPatch(pth)\n# for pth in paths],\n# edgecolor=outline_color, facecolor='none',\n# transform=ccrs.PlateCarree(),\n# **kwargs\n# )\n#\n# self.add_collection(collection, autolim=False)\n\n def stock_img(self, name='ne_shaded'):\n \"\"\"\n Add a standard image to the map.\n\n Currently, the only (and default) option is a downsampled version of\n the Natural Earth shaded relief raster.\n\n \"\"\"\n if name == 'ne_shaded':\n import os\n source_proj = ccrs.PlateCarree()\n fname = os.path.join(os.path.dirname(os.path.dirname(__file__)),\n 'data', 'raster', 'natural_earth',\n '50-natural-earth-1-downsampled.png')\n img_origin = 'lower'\n img = imread(fname)\n img = img[::-1]\n return self.imshow(img, origin=img_origin, transform=source_proj,\n extent=[-180, 180, -90, 90])\n else:\n raise ValueError('Unknown stock image %r.' % name)\n\n def imshow(self, img, *args, **kwargs):\n \"\"\"\n Add the \"transform\" keyword to :func:`~matplotlib.pyplot.imshow'.\n\n Extra kwargs:\n\n transform - a :class:`~cartopy.crs.Projection`.\n\n regrid_shape - default is (750, 375). But may be changed to \"auto\"\n in the future...\n\n extent = (left, right, bottom, top) - transform coordinates for\n the extent of the source\n image.\n\n target_extent = (left, right, bottom, top) - native coordinates\n for the extent of\n the desired image.\n\n origin - default is changed to 'lower'\n\n update_datalim - flag whether the image should affect the data\n limits (default: True)\n\n \"\"\"\n transform = kwargs.pop('transform', None)\n regrid_shape = kwargs.pop('regrid_shape', (750, 375))\n update_datalim = kwargs.pop('update_datalim', True)\n\n kwargs.setdefault('origin', 'lower')\n\n same_projection = (isinstance(transform, ccrs.Projection) and\n self.projection == transform)\n\n if not update_datalim:\n data_lim = self.dataLim.frozen().get_points()\n view_lim = self.viewLim.frozen().get_points()\n\n if transform is None or transform == self.transData or same_projection:\n if isinstance(transform, ccrs.Projection):\n transform = transform._as_mpl_transform(self)\n result = matplotlib.axes.Axes.imshow(self, img, *args, **kwargs)\n else:\n extent = kwargs.pop('extent', None)\n\n if not isinstance(transform, ccrs.Projection):\n raise ValueError('Expected a projection subclass. Cannot '\n 'handle a %s in imshow.' % type(transform))\n\n warp_array = cartopy.img_transform.warp_array\n target_extent = self.get_extent(self.projection)\n # XXX adaptive resolution depending on incoming img?\n img, extent = warp_array(img,\n source_proj=transform,\n source_extent=extent,\n target_proj=self.projection,\n target_res=regrid_shape,\n target_extent=target_extent,\n )\n # as a workaround to a matplotlib limitation, turn any images\n # which are RGB with a mask into RGBA images with an alpha\n # channel.\n if (isinstance(img, numpy.ma.MaskedArray) and\n img.shape[2:3] == (3, ) and\n img.mask is not False):\n old_img = img\n img = numpy.zeros(img.shape[:2] + (4, ))\n img[:, :, 0:3] = old_img\n # put an alpha channel in if the image was masked\n img[:, :, 3] = ~ numpy.any(old_img.mask, axis=2)\n\n result = matplotlib.axes.Axes.imshow(self, img, *args,\n extent=extent, **kwargs)\n\n # clip the image. This does not work as the patch moves with mouse\n # movement, but the clip path doesn't\n # This could definitely be fixed in matplotlib\n# if result.get_clip_path() in [None, self.patch]:\n# # image does not already have clipping set, clip to axes patch\n# result.set_clip_path(self.outline_patch)\n\n if not update_datalim:\n self.dataLim.set_points(data_lim)\n self.viewLim.set_points(view_lim)\n\n return result\n\n def gridlines(self, crs=None, **kwargs):\n \"\"\"\n Automatically adds gridlines to the axes, in the given coordinate\n system, at draw time.\n\n ``**kwargs`` - are passed through to the created\n :class:`matplotlib.collections.Collection`\n allowing control of colors and linewidths etc.\n\n \"\"\"\n if crs is None:\n crs = ccrs.PlateCarree()\n from cartopy.mpl.gridliner import Gridliner\n gl = Gridliner(self, crs=crs, collection_kwargs=kwargs)\n self._gridliners.append(gl)\n return gl\n\n def _gen_axes_spines(self, locations=None, offset=0.0, units='inches'):\n # generate some axes spines, as some Axes super class machinery\n # requires them. Just make them invisible\n spines = matplotlib.axes.Axes._gen_axes_spines(self,\n locations=locations,\n offset=offset,\n units=units)\n for spine in spines.itervalues():\n spine.set_visible(False)\n return spines\n\n def _boundary(self):\n \"\"\"\n Adds the map's boundary.\n\n Note:\n\n The boundary is not the axes.patch, which provides rectilinear\n clipping for all of the map's artists.\n\n The axes.patch will have its visibility set to False inside\n GeoAxes.gca()\n \"\"\"\n import cartopy.mpl.patch as p\n path, = p.geos_to_path(self.projection.boundary)\n\n# from matplotlib.collections import PatchCollection\n\n sct = SimpleClippedTransform(self.transScale + self.transLimits,\n self.transAxes)\n\n # XXX Should be exactly one path...\n collection = mpatches.PathPatch(path,\n facecolor='none', edgecolor='k',\n zorder=1000,\n # transform=self.transData,\n transform=sct, clip_on=False,\n )\n self.outline_patch = collection\n # XXX autolim = False\n self.add_patch(collection)\n\n # put a color patch for background color\n # XXX Should be exactly one path...\n collection = mpatches.PathPatch(path,\n facecolor='w', edgecolor='none',\n zorder=-1, transform=sct,\n clip_on=False,\n )\n self.background_patch = collection\n # XXX autolim = False\n self.add_patch(collection)\n\n self.patch.set_facecolor((1, 1, 1, 0))\n self.patch.set_edgecolor((0.5, 0.5, 0.5))\n self.patch.set_linewidth(0.0)\n\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\n def contour(self, *args, **kwargs):\n \"\"\"\n Add the \"transform\" keyword to :func:`~matplotlib.pyplot.contour'.\n\n Extra kwargs:\n\n transform - a :class:`~cartopy.crs.Projection`.\n\n \"\"\"\n t = kwargs.get('transform', None)\n # Keep this bit - even at mpl v1.2\n if t is None:\n t = self.projection\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\n raise ValueError('invalid transform:'\n ' Spherical contouring is not supported - '\n ' consider using PlateCarree/RotatedPole.')\n if isinstance(t, ccrs.Projection):\n kwargs['transform'] = t._as_mpl_transform(self)\n else:\n kwargs['transform'] = t\n return matplotlib.axes.Axes.contour(self, *args, **kwargs)\n\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\n def contourf(self, *args, **kwargs):\n \"\"\"\n Add the \"transform\" keyword to :func:`~matplotlib.pyplot.contourf'.\n\n Extra kwargs:\n\n transform - a :class:`~cartopy.crs.Projection`.\n\n \"\"\"\n t = kwargs.get('transform', None)\n # Keep this bit - even at mpl v1.2\n if t is None:\n t = self.projection\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\n raise ValueError('invalid transform:'\n ' Spherical contouring is not supported - '\n ' consider using PlateCarree/RotatedPole.')\n if isinstance(t, ccrs.Projection):\n kwargs['transform'] = t._as_mpl_transform(self)\n else:\n kwargs['transform'] = t\n return matplotlib.axes.Axes.contourf(self, *args, **kwargs)\n\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\n def scatter(self, *args, **kwargs):\n \"\"\"\n Add the \"transform\" keyword to :func:`~matplotlib.pyplot.scatter'.\n\n Extra kwargs:\n\n transform - a :class:`~cartopy.crs.Projection`.\n\n \"\"\"\n t = kwargs.get('transform', None)\n # Keep this bit - even at mpl v1.2\n if t is None:\n t = self.projection\n if hasattr(t, '_as_mpl_transform'):\n kwargs['transform'] = t._as_mpl_transform(self)\n\n # exclude Geodetic as a vaild source CS\n if (isinstance(kwargs.get('transform', None),\n InterProjectionTransform) and\n kwargs['transform'].source_projection.is_geodetic()):\n raise ValueError('Cartopy cannot currently do spherical '\n 'contouring. The source CRS cannot be a '\n 'geodetic, consider using the cyllindrical form '\n '(PlateCarree or RotatedPole).')\n\n return matplotlib.axes.Axes.scatter(self, *args, **kwargs)\n\n def pcolormesh(self, *args, **kwargs):\n \"\"\"\n Add the \"transform\" keyword to :func:`~matplotlib.pyplot.pcolormesh'.\n\n Extra kwargs:\n\n transform - a :class:`~cartopy.crs.Projection`.\n\n \"\"\"\n t = kwargs.get('transform', None)\n if t is None:\n t = self.projection\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\n raise ValueError('invalid transform:'\n ' Spherical pcolormesh is not supported - '\n ' consider using PlateCarree/RotatedPole.')\n kwargs.setdefault('transform', t)\n return self._pcolormesh_patched(*args, **kwargs)\n\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\n def _pcolormesh_patched(self, *args, **kwargs):\n \"\"\"\n A temporary, modified duplicate of\n :func:`~matplotlib.pyplot.pcolormesh'.\n\n This function contains a workaround for a matplotlib issue\n and will be removed once the issue has been resolved.\n https://github.com/matplotlib/matplotlib/pull/1314\n\n \"\"\"\n import warnings\n import numpy as np\n import numpy.ma as ma\n import matplotlib as mpl\n import matplotlib.cbook as cbook\n import matplotlib.colors as mcolors\n import matplotlib.cm as cm\n from matplotlib import docstring\n import matplotlib.transforms as transforms\n import matplotlib.artist as artist\n from matplotlib.artist import allow_rasterization\n import matplotlib.backend_bases as backend_bases\n import matplotlib.path as mpath\n import matplotlib.mlab as mlab\n import matplotlib.collections as mcoll\n\n if not self._hold:\n self.cla()\n\n alpha = kwargs.pop('alpha', None)\n norm = kwargs.pop('norm', None)\n cmap = kwargs.pop('cmap', None)\n vmin = kwargs.pop('vmin', None)\n vmax = kwargs.pop('vmax', None)\n shading = kwargs.pop('shading', 'flat').lower()\n antialiased = kwargs.pop('antialiased', False)\n kwargs.setdefault('edgecolors', 'None')\n\n X, Y, C = self._pcolorargs('pcolormesh', *args)\n Ny, Nx = X.shape\n\n # convert to one dimensional arrays\n if shading != 'gouraud':\n # data point in each cell is value at lower left corner\n C = ma.ravel(C[0:Ny - 1, 0:Nx - 1])\n else:\n C = C.ravel()\n X = X.ravel()\n Y = Y.ravel()\n\n coords = np.zeros(((Nx * Ny), 2), dtype=float)\n coords[:, 0] = X\n coords[:, 1] = Y\n\n collection = mcoll.QuadMesh(\n Nx - 1, Ny - 1, coords,\n antialiased=antialiased, shading=shading, **kwargs)\n collection.set_alpha(alpha)\n collection.set_array(C)\n if norm is not None:\n assert(isinstance(norm, mcolors.Normalize))\n collection.set_cmap(cmap)\n collection.set_norm(norm)\n collection.set_clim(vmin, vmax)\n collection.autoscale_None()\n\n self.grid(False)\n\n ########################\n # PATCH FOR MPL 1.2.0rc2\n\n # Transform from native to data coordinates?\n t = collection._transform\n if (not isinstance(t, mtransforms.Transform)\n and hasattr(t, '_as_mpl_transform')):\n t = t._as_mpl_transform(self.axes)\n\n if t and any(t.contains_branch_seperately(self.transData)):\n trans_to_data = t - self.transData\n pts = np.vstack([X, Y]).T.astype(np.float)\n transformed_pts = trans_to_data.transform(pts)\n\n X = transformed_pts[..., 0]\n Y = transformed_pts[..., 1]\n\n # XXX Not a mpl 1.2 thing...\n no_inf = (X != np.inf) & (Y != np.inf)\n X = X[no_inf]\n Y = Y[no_inf]\n\n # END OF PATCH\n ##############\n\n minx = np.amin(X)\n maxx = np.amax(X)\n miny = np.amin(Y)\n maxy = np.amax(Y)\n\n corners = (minx, miny), (maxx, maxy)\n self.update_datalim(corners)\n self.autoscale_view()\n self.add_collection(collection)\n\n # XXX Non-standard matplotlib 1.2 thing.\n # Handle a possible wrap around for rectangular projections.\n t = kwargs.get('transform', None)\n if isinstance(t, ccrs.CRS):\n if isinstance(t, ccrs._RectangularProjection) and \\\n isinstance(self.projection, ccrs._RectangularProjection):\n\n C = C.reshape((Ny - 1, Nx - 1))\n transformed_pts = transformed_pts.reshape((Ny, Nx, 2))\n\n # compute the vertical line angles of the pcolor in\n # transformed coordinates\n with numpy.errstate(invalid='ignore'):\n horizontal_vert_angles = numpy.arctan2(\n numpy.diff(transformed_pts[..., 0], axis=1),\n numpy.diff(transformed_pts[..., 1], axis=1)\n )\n\n # if the change in angle is greater than 90 degrees (absolute),\n # then mark it for masking later on.\n dx_horizontal = numpy.diff(horizontal_vert_angles)\n to_mask = ((numpy.abs(dx_horizontal) > numpy.pi / 2) |\n numpy.isnan(dx_horizontal))\n\n if numpy.any(to_mask):\n # at this point C has a shape of (Ny-1, Nx-1), to_mask has\n # a shape of (Ny, Nx-2) and pts has a shape of (Ny*Nx, 2)\n\n mask = numpy.zeros(C.shape, dtype=numpy.bool)\n\n # mask out the neighbouring cells if there was a cell\n # found with an angle change of more than pi/2 . NB.\n # Masking too much only has a detrimental impact on\n # performance.\n to_mask_y_shift = to_mask[:-1, :]\n mask[:, :-1][to_mask_y_shift] = True\n mask[:, 1:][to_mask_y_shift] = True\n\n to_mask_x_shift = to_mask[1:, :]\n mask[:, :-1][to_mask_x_shift] = True\n mask[:, 1:][to_mask_x_shift] = True\n\n C_mask = getattr(C, 'mask', None)\n if C_mask is not None:\n dmask = mask | C_mask\n else:\n dmask = mask\n\n # print 'Ratio of masked data: ',\n # print numpy.sum(mask) / float(numpy.product(mask.shape))\n\n # create the masked array to be used with this pcolormesh\n pcolormesh_data = numpy.ma.array(C, mask=mask)\n\n collection.set_array(pcolormesh_data.ravel())\n\n # now that the pcolormesh has masked the bad values,\n # create a pcolor with just those values that were masked\n pcolor_data = pcolormesh_data.copy()\n # invert the mask\n pcolor_data.mask = ~pcolor_data.mask\n\n # remember to re-apply the original data mask to the array\n if C_mask is not None:\n pcolor_data.mask = pcolor_data.mask | C_mask\n\n pts = pts.reshape((Ny, Nx, 2))\n pcolor_col = self.pcolor(pts[..., 0], pts[..., 1],\n pcolor_data, **kwargs)\n pcolor_col.set_cmap(cmap)\n pcolor_col.set_norm(norm)\n pcolor_col.set_clim(vmin, vmax)\n # scale the data according to the *original* data\n pcolor_col.norm.autoscale_None(C)\n\n # put the pcolor_col on the pcolormesh collection so that\n # if really necessary, users can do things post this method\n collection._wrapped_collection_fix = pcolor_col\n\n return collection\n\n def pcolor(self, *args, **kwargs):\n \"\"\"\n Add the \"transform\" keyword to :func:`~matplotlib.pyplot.pcolor'.\n\n Extra kwargs:\n\n transform - a :class:`~cartopy.crs.Projection`.\n\n \"\"\"\n t = kwargs.get('transform', None)\n if t is None:\n t = self.projection\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\n raise ValueError('invalid transform:'\n ' Spherical pcolor is not supported - '\n ' consider using PlateCarree/RotatedPole.')\n kwargs.setdefault('transform', t)\n return self._pcolor_patched(*args, **kwargs)\n\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\n def _pcolor_patched(self, *args, **kwargs):\n \"\"\"\n A temporary, modified duplicate of :func:`~matplotlib.pyplot.pcolor'.\n\n This function contains a workaround for a matplotlib issue\n and will be removed once the issue has been resolved.\n https://github.com/matplotlib/matplotlib/pull/1314\n\n \"\"\"\n import warnings\n import numpy as np\n import numpy.ma as ma\n import matplotlib as mpl\n import matplotlib.cbook as cbook\n import matplotlib.colors as mcolors\n import matplotlib.cm as cm\n from matplotlib import docstring\n import matplotlib.transforms as transforms\n import matplotlib.artist as artist\n from matplotlib.artist import allow_rasterization\n import matplotlib.backend_bases as backend_bases\n import matplotlib.path as mpath\n import matplotlib.mlab as mlab\n import matplotlib.collections as mcoll\n\n if not self._hold:\n self.cla()\n\n alpha = kwargs.pop('alpha', None)\n norm = kwargs.pop('norm', None)\n cmap = kwargs.pop('cmap', None)\n vmin = kwargs.pop('vmin', None)\n vmax = kwargs.pop('vmax', None)\n shading = kwargs.pop('shading', 'flat')\n\n X, Y, C = self._pcolorargs('pcolor', *args)\n Ny, Nx = X.shape\n\n # convert to MA, if necessary.\n C = ma.asarray(C)\n X = ma.asarray(X)\n Y = ma.asarray(Y)\n mask = ma.getmaskarray(X) + ma.getmaskarray(Y)\n xymask = mask[0:-1, 0:-1] + mask[1:, 1:] + mask[0:-1, 1:] + \\\n mask[1:, 0:-1]\n # don't plot if C or any of the surrounding vertices are masked.\n mask = ma.getmaskarray(C)[0:Ny - 1, 0:Nx - 1] + xymask\n\n newaxis = np.newaxis\n compress = np.compress\n\n ravelmask = (mask == 0).ravel()\n X1 = compress(ravelmask, ma.filled(X[0:-1, 0:-1]).ravel())\n Y1 = compress(ravelmask, ma.filled(Y[0:-1, 0:-1]).ravel())\n X2 = compress(ravelmask, ma.filled(X[1:, 0:-1]).ravel())\n Y2 = compress(ravelmask, ma.filled(Y[1:, 0:-1]).ravel())\n X3 = compress(ravelmask, ma.filled(X[1:, 1:]).ravel())\n Y3 = compress(ravelmask, ma.filled(Y[1:, 1:]).ravel())\n X4 = compress(ravelmask, ma.filled(X[0:-1, 1:]).ravel())\n Y4 = compress(ravelmask, ma.filled(Y[0:-1, 1:]).ravel())\n npoly = len(X1)\n\n xy = np.concatenate((X1[:, newaxis], Y1[:, newaxis],\n X2[:, newaxis], Y2[:, newaxis],\n X3[:, newaxis], Y3[:, newaxis],\n X4[:, newaxis], Y4[:, newaxis],\n X1[:, newaxis], Y1[:, newaxis]),\n axis=1)\n verts = xy.reshape((npoly, 5, 2))\n\n C = compress(ravelmask, ma.filled(C[0:Ny - 1, 0:Nx - 1]).ravel())\n\n linewidths = (0.25,)\n if 'linewidth' in kwargs:\n kwargs['linewidths'] = kwargs.pop('linewidth')\n kwargs.setdefault('linewidths', linewidths)\n\n if shading == 'faceted':\n edgecolors = 'k',\n else:\n edgecolors = 'none'\n if 'edgecolor' in kwargs:\n kwargs['edgecolors'] = kwargs.pop('edgecolor')\n ec = kwargs.setdefault('edgecolors', edgecolors)\n\n # aa setting will default via collections to patch.antialiased\n # unless the boundary is not stroked, in which case the\n # default will be False; with unstroked boundaries, aa\n # makes artifacts that are often disturbing.\n if 'antialiased' in kwargs:\n kwargs['antialiaseds'] = kwargs.pop('antialiased')\n if 'antialiaseds' not in kwargs and ec.lower() == \"none\":\n kwargs['antialiaseds'] = False\n\n collection = mcoll.PolyCollection(verts, **kwargs)\n\n collection.set_alpha(alpha)\n collection.set_array(C)\n if norm is not None:\n assert(isinstance(norm, mcolors.Normalize))\n collection.set_cmap(cmap)\n collection.set_norm(norm)\n collection.set_clim(vmin, vmax)\n collection.autoscale_None()\n self.grid(False)\n\n x = X.compressed()\n y = Y.compressed()\n\n ########################\n # PATCH FOR MPL 1.2.0rc2\n\n # Transform from native to data coordinates?\n t = collection._transform\n if (not isinstance(t, mtransforms.Transform) and\n hasattr(t, '_as_mpl_transform')):\n t = t._as_mpl_transform(self.axes)\n\n if t and any(t.contains_branch_seperately(self.transData)):\n trans_to_data = t - self.transData\n pts = np.vstack([x, y]).T.astype(np.float)\n transformed_pts = trans_to_data.transform(pts)\n x = transformed_pts[..., 0]\n y = transformed_pts[..., 1]\n\n # XXX Not a mpl 1.2 thing...\n no_inf = (x != np.inf) & (y != np.inf)\n x = x[no_inf]\n y = y[no_inf]\n\n # END OF PATCH\n ##############\n\n minx = np.amin(x)\n maxx = np.amax(x)\n miny = np.amin(y)\n maxy = np.amax(y)\n\n corners = (minx, miny), (maxx, maxy)\n self.update_datalim(corners)\n self.autoscale_view()\n self.add_collection(collection)\n return collection\n\n\n# alias GeoAxes - NOTE: THIS WAS NOT IN v0.4.0rc1\nGenericProjectionAxes = GeoAxes\n\"\"\"(To be removed in v0.5) An alias to the :class:`GeoAxes` class.\"\"\"\n\n\nclass SimpleClippedTransform(mtransforms.Transform):\n \"\"\"\n Transforms the values using a pre transform, clips them, then post\n transforms them.\n\n This transform should not be widely used, but is useful for transforming\n a background patch and clipping the patch to a desired extent.\n\n \"\"\"\n input_dims = 2\n output_dims = 2\n has_inverse = True\n\n def __init__(self, pre_clip_transform, post_clip_transform,\n xclip=(0, 1), yclip=(0, 1)):\n \"\"\"\n Create the transform.\n\n Args:\n\n * pre_clip_transform - A :class:`matplotlib.transforms.Transform`.\n * post_clip_transform - A :class:`matplotlib.transforms.Transform`.\n * xclip - Defaults to (0,1).\n * yclip - Defaults to (0,1).\n\n \"\"\"\n mtransforms.Transform.__init__(self)\n self.pre_clip_transform = pre_clip_transform\n self.post_clip_transform = post_clip_transform\n\n self.x_clips = xclip\n self.y_clips = yclip\n\n def transform_non_affine(self, values):\n \"\"\"\n Transforms from source to target coordinates.\n\n Args:\n\n * value - An (n,2) array of points in source coordinates.\n\n Returns:\n\n * An (n,2) array of transformed points in target coordinates.\n\n \"\"\"\n new_vals = self.pre_clip_transform.transform(values)\n x, y = new_vals[:, 0:1], new_vals[:, 1:2]\n numpy.clip(x, self.x_clips[0], self.x_clips[1], x)\n numpy.clip(y, self.y_clips[0], self.y_clips[1], y)\n # XXX support ma's?\n return self.post_clip_transform.transform(new_vals)\n\n def inverted(self):\n \"\"\"\n Return a matplotlib :class:`~matplotlib.transforms.Transform` from\n target to source coordinates.\n\n \"\"\"\n return (self.pre_clip_transform + self.post_clip_transform).inverted()\n","path":"lib/cartopy/mpl/geoaxes.py"}],"string":"[\n {\n \"content\": \"# (C) British Crown Copyright 2011 - 2012, Met Office\\n#\\n# This file is part of cartopy.\\n#\\n# cartopy is free software: you can redistribute it and/or modify it under\\n# the terms of the GNU Lesser General Public License as published by the\\n# Free Software Foundation, either version 3 of the License, or\\n# (at your option) any later version.\\n#\\n# cartopy is distributed in the hope that it will be useful,\\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\\n# GNU Lesser General Public License for more details.\\n#\\n# You should have received a copy of the GNU Lesser General Public License\\n# along with cartopy. If not, see <http://www.gnu.org/licenses/>.\\n\\\"\\\"\\\"\\nThis module defines the :class:`GeoAxes` class, for use with matplotlib.\\n\\nWhen a matplotlib figure contains a GeoAxes the plotting commands can transform\\nplot results from source coordinates to the GeoAxes' target projection.\\n\\n\\\"\\\"\\\"\\nimport warnings\\nimport weakref\\n\\nimport matplotlib.axes\\nfrom matplotlib.image import imread\\nimport matplotlib.transforms as mtransforms\\nimport matplotlib.patches as mpatches\\nimport matplotlib.path as mpath\\nimport matplotlib.collections as mcollections\\nimport numpy\\nimport shapely.geometry\\n\\nimport cartopy.crs as ccrs\\nimport cartopy.feature\\nimport cartopy.img_transform\\nimport cartopy.mpl.feature_artist as feature_artist\\nimport cartopy.mpl.patch as patch\\n\\n\\nimport matplotlib\\nassert matplotlib.__version__ >= '1.2', ('Cartopy can only work with '\\n 'matplotlib 1.2 or greater.')\\n\\n\\n_PATH_TRANSFORM_CACHE = weakref.WeakKeyDictionary()\\n\\\"\\\"\\\"\\nA nested mapping from path, source CRS, and target projection to the\\nresulting transformed paths::\\n\\n {path: {(source_crs, target_projection): list_of_paths}}\\n\\nProvides a significant performance boost for contours which, at\\nmatplotlib 1.2.0 called transform_path_non_affine twice unnecessarily.\\n\\n\\\"\\\"\\\"\\n\\n\\n# XXX call this InterCRSTransform\\nclass InterProjectionTransform(mtransforms.Transform):\\n \\\"\\\"\\\"\\n Transforms coordinates from the source_projection to\\n the ``target_projection``.\\n\\n \\\"\\\"\\\"\\n input_dims = 2\\n output_dims = 2\\n is_separable = False\\n has_inverse = True\\n\\n def __init__(self, source_projection, target_projection):\\n \\\"\\\"\\\"\\n Create the transform object from the given projections.\\n\\n Args:\\n\\n * source_projection - A :class:`~cartopy.crs.CRS`.\\n * target_projection - A :class:`~cartopy.crs.CRS`.\\n\\n \\\"\\\"\\\"\\n # assert target_projection is cartopy.crs.Projection\\n # assert source_projection is cartopy.crs.CRS\\n self.source_projection = source_projection\\n self.target_projection = target_projection\\n mtransforms.Transform.__init__(self)\\n\\n def __repr__(self):\\n return ('< {!s} {!s} -> {!s} >'.format(self.__class__.__name__,\\n self.source_projection,\\n self.target_projection))\\n\\n def transform_non_affine(self, xy):\\n \\\"\\\"\\\"\\n Transforms from source to target coordinates.\\n\\n Args:\\n\\n * xy - An (n,2) array of points in source coordinates.\\n\\n Returns:\\n\\n * An (n,2) array of transformed points in target coordinates.\\n\\n \\\"\\\"\\\"\\n prj = self.target_projection\\n if isinstance(xy, numpy.ndarray):\\n return prj.transform_points(self.source_projection,\\n xy[:, 0], xy[:, 1])[:, 0:2]\\n else:\\n x, y = xy\\n x, y = prj.transform_point(x, y, self.source_projection)\\n return x, y\\n\\n def transform_path_non_affine(self, src_path):\\n \\\"\\\"\\\"\\n Transforms from source to target coordinates.\\n\\n Caches results, so subsequent calls with the same *src_path* argument\\n (and the same source and target projections) are faster.\\n\\n Args:\\n\\n * src_path - A matplotlib :class:`~matplotlib.path.Path` object\\n with vertices in source coordinates.\\n\\n Returns\\n\\n * A matplotlib :class:`~matplotlib.path.Path` with vertices\\n in target coordinates.\\n\\n \\\"\\\"\\\"\\n mapping = _PATH_TRANSFORM_CACHE.get(src_path)\\n if mapping is not None:\\n key = (self.source_projection, self.target_projection)\\n result = mapping.get(key)\\n if result is not None:\\n return result\\n\\n bypass = self.source_projection == self.target_projection\\n if bypass:\\n projection = self.source_projection\\n if isinstance(projection, ccrs._CylindricalProjection):\\n x = src_path.vertices[:, 0]\\n x_limits = projection.x_limits\\n bypass = x.min() >= x_limits[0] and x.max() <= x_limits[1]\\n if bypass:\\n return src_path\\n\\n if src_path.vertices.shape == (1, 2):\\n return mpath.Path(self.transform(src_path.vertices))\\n\\n transformed_geoms = []\\n for geom in patch.path_to_geos(src_path):\\n transformed_geoms.append(\\n self.target_projection.project_geometry(geom,\\n self.source_projection)\\n )\\n\\n if not transformed_geoms:\\n result = mpath.Path(numpy.empty([0, 2]))\\n else:\\n paths = patch.geos_to_path(transformed_geoms)\\n if not paths:\\n return mpath.Path(numpy.empty([0, 2]))\\n points, codes = zip(*[patch.path_segments(path, curves=False,\\n simplify=False)\\n for path in paths])\\n result = mpath.Path(numpy.concatenate(points, 0),\\n numpy.concatenate(codes))\\n\\n # store the result in the cache for future performance boosts\\n key = (self.source_projection, self.target_projection)\\n if mapping is None:\\n _PATH_TRANSFORM_CACHE[src_path] = {key: result}\\n else:\\n mapping[key] = result\\n\\n return result\\n\\n def inverted(self):\\n \\\"\\\"\\\"\\n Return a matplotlib :class:`~matplotlib.transforms.Transform`\\n from target to source coordinates.\\n\\n \\\"\\\"\\\"\\n return InterProjectionTransform(self.target_projection,\\n self.source_projection)\\n\\n\\nclass GeoAxes(matplotlib.axes.Axes):\\n \\\"\\\"\\\"\\n A subclass of :class:`matplotlib.axes.Axes` which represents a\\n map :class:`~cartopy.crs.Projection`.\\n\\n This class replaces the matplotlib :class:`~matplotlib.axes.Axes` class\\n when created with the *projection* keyword. For example:\\n\\n # Set up a standard map for latlon data.\\n geo_axes = pyplot.axes(projection=cartopy.crs.PlateCarree())\\n\\n # Set up an OSGB map.\\n geo_axes = pyplot.subplot(2, 2, 1, projection=cartopy.crs.OSGB())\\n\\n When a source projection is provided to one of it's plotting methods,\\n using the *transform* keyword, the standard matplotlib plot result is\\n transformed from source coordinates to the target projection. For example:\\n\\n # Plot latlon data on an OSGB map.\\n pyplot.axes(projection=cartopy.crs.OSGB())\\n pyplot.contourf(x, y, data, transform=cartopy.crs.PlateCarree())\\n\\n \\\"\\\"\\\"\\n def __init__(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Create a GeoAxes object using standard matplotlib\\n :class:`~matplotlib.axes.Axes` args and keywords.\\n\\n Kwargs:\\n\\n * map_projection - The target :class:`~cartopy.crs.Projection` of\\n this Axes object.\\n\\n All other args and keywords are passed straight through to\\n :class:`matplotlib.axes.Axes`.\\n\\n \\\"\\\"\\\"\\n self.projection = kwargs.pop('map_projection')\\n super(GeoAxes, self).__init__(*args, **kwargs)\\n self._gridliners = []\\n self.img_factories = []\\n self._done_img_factory = False\\n\\n def add_image(self, factory, *args, **kwargs):\\n \\\"\\\"\\\"\\n Adds an image \\\"factory\\\" to the Axes.\\n\\n Any image \\\"factory\\\" added, will be asked to retrieve an image\\n with associated metadata for a given bounding box at draw time.\\n The advantage of this approach is that the limits of the map\\n do not need to be known when adding the image factory, but can\\n be deferred until everything which can effect the limits has been\\n added.\\n\\n Currently an image \\\"factory\\\" is just an object with\\n a ``image_for_domain`` method. Examples of image factories\\n are :class:`cartopy.io.img_nest.NestedImageCollection` and\\n :class:`cartopy.io.image_tiles.GoogleTiles`.\\n\\n \\\"\\\"\\\"\\n # XXX TODO: Needs working on\\n self.img_factories.append([factory, args, kwargs])\\n\\n @matplotlib.axes.allow_rasterization\\n def draw(self, renderer=None, inframe=False):\\n \\\"\\\"\\\"\\n Extends the standard behaviour of :func:`matplotlib.axes.Axes.draw`.\\n\\n Draws grid lines and image factory results before invoking standard\\n matplotlib drawing. A global range is used if no limits have yet\\n been set.\\n\\n \\\"\\\"\\\"\\n # if no data has been added, and no extents set, then make the\\n # map global\\n if self.ignore_existing_data_limits and \\\\\\n self._autoscaleXon and self._autoscaleYon:\\n self.set_global()\\n self.ignore_existing_data_limits = True\\n\\n for gl in self._gridliners:\\n gl.do_gridlines(background_patch=self.background_patch)\\n self._gridliners = []\\n\\n # XXX This interface needs a tidy up:\\n # image drawing on pan/zoom;\\n # caching the resulting image;\\n # buffering the result by 10%...;\\n if not self._done_img_factory:\\n for factory, args, kwargs in self.img_factories:\\n img, extent, origin = factory.image_for_domain(\\n self._get_extent_geom(factory.crs), args[0])\\n self.imshow(img, extent=extent, origin=origin,\\n transform=factory.crs, *args[1:], **kwargs)\\n self._done_img_factory = True\\n\\n return matplotlib.axes.Axes.draw(self, renderer=renderer,\\n inframe=inframe)\\n\\n def __str__(self):\\n return '< GeoAxes: %s >' % self.projection\\n\\n def cla(self):\\n \\\"\\\"\\\"Clears the current axes and adds boundary lines.\\\"\\\"\\\"\\n result = matplotlib.axes.Axes.cla(self)\\n self.xaxis.set_visible(False)\\n self.yaxis.set_visible(False)\\n self.autoscale_view(tight=True)\\n self.set_aspect('equal')\\n\\n pre_bounary = self.ignore_existing_data_limits\\n self._boundary()\\n self.ignore_existing_data_limits = pre_bounary\\n\\n # XXX consider a margin - but only when the map is not global...\\n # self._xmargin = 0.15\\n # self._ymargin = 0.15\\n\\n return result\\n\\n def format_coord(self, x, y):\\n \\\"\\\"\\\"Return a string formatted for the matplotlib GUI status bar.\\\"\\\"\\\"\\n lon, lat = ccrs.Geodetic().transform_point(x, y, self.projection)\\n\\n ns = 'N' if lat >= 0.0 else 'S'\\n ew = 'E' if lon >= 0.0 else 'W'\\n\\n return u'%.4g, %.4g (%f\\\\u00b0%s, %f\\\\u00b0%s)' % (x, y, abs(lat),\\n ns, abs(lon), ew)\\n\\n def coastlines(self, resolution='110m', color='black', **kwargs):\\n \\\"\\\"\\\"\\n Adds coastal **outlines** to the current axes from the Natural Earth\\n \\\"coastline\\\" shapefile collection.\\n\\n Kwargs:\\n\\n * resolution - a named resolution to use from the Natural Earth\\n dataset. Currently can be one of \\\"110m\\\", \\\"50m\\\", and\\n \\\"10m\\\".\\n\\n .. note::\\n\\n Currently no clipping is done on the coastlines before adding\\n them to the axes. This means, if very high resolution coastlines\\n are being used, performance is likely to be severely effected.\\n This should be resolved transparently by v0.5.\\n\\n \\\"\\\"\\\"\\n kwargs['edgecolor'] = color\\n kwargs['facecolor'] = 'none'\\n feature = cartopy.feature.NaturalEarthFeature('physical', 'coastline',\\n resolution, **kwargs)\\n return self.add_feature(feature)\\n\\n def natural_earth_shp(self, name='land', resolution='110m',\\n category='physical', **kwargs):\\n \\\"\\\"\\\"\\n Adds the geometries from the specified Natural Earth shapefile to the\\n Axes as a :class:`~matplotlib.collections.PathCollection`.\\n\\n ``**kwargs`` are passed through to the\\n :class:`~matplotlib.collections.PathCollection` constructor.\\n\\n Returns the created :class:`~matplotlib.collections.PathCollection`.\\n\\n .. note::\\n\\n Currently no clipping is done on the geometries before adding them\\n to the axes. This means, if very high resolution geometries are\\n being used, performance is likely to be severely effected. This\\n should be resolved transparently by v0.5.\\n\\n \\\"\\\"\\\"\\n warnings.warn('This method has been deprecated.'\\n ' Please use `add_feature` instead.')\\n kwargs.setdefault('edgecolor', 'face')\\n kwargs.setdefault('facecolor', cartopy.feature._COLOURS['land'])\\n feature = cartopy.feature.NaturalEarthFeature(category, name,\\n resolution, **kwargs)\\n return self.add_feature(feature)\\n\\n def add_feature(self, feature, **kwargs):\\n \\\"\\\"\\\"\\n Adds the given :class:`~cartopy.feature.Feature` instance to the axes.\\n\\n Args:\\n\\n * feature:\\n An instance of :class:`~cartopy.feature.Feature`.\\n\\n Kwargs:\\n Keyword arguments to be used when drawing the feature. This allows\\n standard matplotlib control over aspects such as 'facecolor',\\n 'alpha', etc.\\n\\n Returns:\\n * A :class:`cartopy.mpl_integration.feature_artist.FeatureArtist`\\n instance responsible for drawing the feature.\\n\\n \\\"\\\"\\\"\\n # Instantiate an artist to draw the feature and add it to the axes.\\n artist = feature_artist.FeatureArtist(feature, **kwargs)\\n return self.add_artist(artist)\\n\\n def add_geometries(self, geoms, crs, **kwargs):\\n \\\"\\\"\\\"\\n Add the given shapely geometries (in the given crs) to the axes.\\n\\n Args:\\n\\n * geoms:\\n A collection of shapely geometries.\\n * crs:\\n The cartopy CRS in which the provided geometries are defined.\\n\\n Kwargs:\\n Keyword arguments to be used when drawing this feature.\\n\\n Returns:\\n * A :class:`cartopy.mpl_integration.feature_artist.FeatureArtist`\\n instance responsible for drawing the geometries.\\n\\n \\\"\\\"\\\"\\n feature = cartopy.feature.ShapelyFeature(geoms, crs, **kwargs)\\n return self.add_feature(feature)\\n\\n def get_extent(self, crs=None):\\n \\\"\\\"\\\"\\n Get the extent (x0, x1, y0, y1) of the map in the given coordinate\\n system.\\n\\n If no crs is given, the returned extents' coordinate system will be\\n assumed to be the Geodetic version of this axes' projection.\\n\\n \\\"\\\"\\\"\\n p = self._get_extent_geom(crs)\\n r = p.bounds\\n x1, y1, x2, y2 = r\\n return x1, x2, y1, y2\\n\\n def _get_extent_geom(self, crs=None):\\n # Perform the calculations for get_extent(), which just repackages it.\\n x1, x2 = self.get_xlim()\\n y1, y2 = self.get_ylim()\\n\\n if x1 == 0 and y1 == 0 and x2 == 1 and y2 == 1:\\n x1, x2 = self.projection.x_limits\\n y1, y2 = self.projection.y_limits\\n\\n domain_in_src_proj = shapely.geometry.Polygon([[x1, y1], [x2, y1],\\n [x2, y2], [x1, y2],\\n [x1, y1]])\\n\\n # Determine target projection based on requested CRS.\\n if crs is None:\\n proj = self.projection\\n elif isinstance(crs, ccrs.Projection):\\n proj = crs\\n else:\\n # Attempt to select suitable projection for\\n # non-projection CRS.\\n if isinstance(crs, ccrs.RotatedGeodetic):\\n proj = ccrs.RotatedPole(crs.proj4_params['lon_0'] - 180,\\n crs.proj4_params['o_lat_p'])\\n warnings.warn('Approximating coordinate system {!r} with a '\\n 'RotatedPole projection.'.format(crs))\\n elif hasattr(crs, 'is_geodetic') and crs.is_geodetic():\\n proj = ccrs.PlateCarree()\\n warnings.warn('Approximating coordinate system {!r} with the '\\n 'PlateCarree projection.'.format(crs))\\n else:\\n raise ValueError('Cannot determine extent in'\\n ' coordinate system {!r}'.format(crs))\\n\\n # Calculate intersection with boundary and project if necesary.\\n boundary_poly = shapely.geometry.Polygon(self.projection.boundary)\\n if proj != self.projection:\\n # Erode boundary by threshold to avoid transform issues.\\n # This is a workaround for numerical issues at the boundary.\\n eroded_boundary = boundary_poly.buffer(-self.projection.threshold)\\n geom_in_src_proj = eroded_boundary.intersection(\\n domain_in_src_proj)\\n geom_in_crs = proj.project_geometry(geom_in_src_proj,\\n self.projection)\\n else:\\n geom_in_crs = boundary_poly.intersection(domain_in_src_proj)\\n\\n return geom_in_crs\\n\\n def set_extent(self, extents, crs=None):\\n \\\"\\\"\\\"\\n Set the extent (x0, x1, y0, y1) of the map in the given\\n coordinate system.\\n\\n If no crs is given, the extents' coordinate system will be assumed\\n to be the Geodetic version of this axes' projection.\\n\\n \\\"\\\"\\\"\\n # TODO: Implement the same semantics as plt.xlim and\\n # plt.ylim - allowing users to set None for a minimum and/or\\n # maximum value\\n x1, x2, y1, y2 = extents\\n domain_in_crs = shapely.geometry.LineString([[x1, y1], [x2, y1],\\n [x2, y2], [x1, y2],\\n [x1, y1]])\\n\\n r = self.projection.project_geometry(domain_in_crs, crs)\\n x1, y1, x2, y2 = r.bounds\\n self.set_xlim([x1, x2])\\n self.set_ylim([y1, y2])\\n\\n def set_global(self):\\n \\\"\\\"\\\"\\n Set the extent of the Axes to the limits of the projection.\\n\\n .. note::\\n\\n In some cases where the projection has a limited sensible range\\n the ``set_global`` method does not actually make the whole globe\\n visible. Instead, the most appropriate extents will be used (e.g.\\n Ordnance Survey UK will set the extents to be around the British\\n Isles.\\n\\n \\\"\\\"\\\"\\n self.set_xlim(self.projection.x_limits)\\n self.set_ylim(self.projection.y_limits)\\n\\n def set_xticks(self, ticks, minor=False, crs=None):\\n \\\"\\\"\\\"\\n Set the x ticks.\\n\\n Args:\\n\\n * ticks - list of floats denoting the desired position of x ticks.\\n\\n Kwargs:\\n\\n * minor - boolean flag indicating whether the ticks should be minor\\n ticks i.e. small and unlabelled (default is False).\\n\\n * crs - An instance of :class:`~cartopy.crs.CRS` indicating the\\n coordinate system of the provided tick values. If no\\n coordinate system is specified then the values are assumed\\n to be in the coordinate system of the projection.\\n\\n .. note::\\n\\n This method is limited to cylindrical projections.\\n\\n .. note::\\n\\n This interface is subject to change whilst functionality is added\\n to support other map projections.\\n\\n \\\"\\\"\\\"\\n if not isinstance(self.projection, (ccrs._RectangularProjection,\\n ccrs._CylindricalProjection,\\n ccrs.OSGB)):\\n raise RuntimeError('Cannot set xticks for not-cylindrical '\\n 'coordinate systems.')\\n\\n # Switch on drawing of x axis\\n self.xaxis.set_visible(True)\\n\\n # Project ticks if crs differs from axes' projection\\n if crs is not None and crs != self.projection:\\n proj_xyz = self.projection.transform_points(crs,\\n numpy.asarray(ticks),\\n numpy.zeros(len(ticks))\\n )\\n xticks = proj_xyz[..., 0]\\n else:\\n xticks = ticks\\n\\n return super(GeoAxes, self).set_xticks(xticks, minor)\\n\\n def set_yticks(self, ticks, minor=False, crs=None):\\n \\\"\\\"\\\"\\n Set the y ticks.\\n\\n Args:\\n\\n * ticks - list of floats denoting the desired position of y ticks.\\n\\n Kwargs:\\n\\n * minor - boolean flag indicating whether the ticks should be minor\\n ticks i.e. small and unlabelled (default is False).\\n\\n * crs - An instance of :class:`~cartopy.crs.CRS` indicating the\\n coordinate system of the provided tick values. If no\\n coordinate system is specified then the values are assumed\\n to be in the coordinate system of the projection.\\n\\n .. note::\\n\\n This method is limited to cylindrical projections.\\n\\n .. note::\\n\\n This interface is subject to change whilst functionality is added\\n to support other map projections.\\n\\n \\\"\\\"\\\"\\n if not isinstance(self.projection, (ccrs._RectangularProjection,\\n ccrs._CylindricalProjection,\\n ccrs.OSGB)):\\n raise RuntimeError('Cannot set yticks for non-cylindrical '\\n 'coordinate systems.')\\n\\n # Switch on drawing of y axis\\n self.yaxis.set_visible(True)\\n\\n # Project ticks if crs differs from axes' projection\\n if crs is not None and crs != self.projection:\\n prj = self.projection\\n proj_xyz = prj.transform_points(crs,\\n numpy.zeros(len(ticks)),\\n numpy.asarray(ticks))\\n yticks = proj_xyz[..., 1]\\n else:\\n yticks = ticks\\n\\n return super(GeoAxes, self).set_yticks(yticks, minor)\\n\\n# def geod_circle_meters(self, lon_0, lat_0, radius, npts=80, **kwargs):\\n# # radius is in meters\\n# geod = self.projection.as_geodetic()\\n#\\n# az = numpy.linspace(0, 360, npts)\\n# lats = numpy.zeros(npts) + lat_0\\n# lons = numpy.zeros(npts) + lon_0\\n# distances = numpy.zeros(npts) + radius\\n#\\n# lons, lats, _reverse_az = geod.fwd(lons, lats, az, distances,\\n# radians=False)\\n# ll = numpy.concatenate([lons[:, None], lats[:, None]], 1)\\n# from matplotlib.patches import Polygon\\n# poly = Polygon(ll, transform=cartopy.prj.PlateCarree(), **kwargs)\\n# self.add_patch(poly)\\n# return poly\\n#\\n# def gshhs_line(self, outline_color='k', domain=None,\\n# resolution='low', **kwargs):\\n# # domain is a shapely geometry (Polygon or MultiPolygon)\\n# import cartopy.gshhs as gshhs\\n## import cartopy.spherical as spherical\\n# from matplotlib.collections import PatchCollection, LineCollection\\n#\\n# paths = []\\n#\\n# projection = self.projection\\n#\\n# if domain is None:\\n# domain = self.map_domain(ccrs.PlateCarree())\\n#\\n# for points in gshhs.read_gshhc(gshhs.fnames[resolution],\\n# poly=False, domain=domain):\\n# paths.extend(patch.geos_to_path(\\n# shapely.geometry.LineString(points))\\n# )\\n#\\n## slinestring = shapely.geometry.LineString(points)\\n## projected = projection.project_geometry(slinestring)\\n## paths.extend(patch.geos_to_path(projected))\\n#\\n# collection = PatchCollection([mpatches.PathPatch(pth)\\n# for pth in paths],\\n# edgecolor=outline_color, facecolor='none',\\n# transform=ccrs.PlateCarree(),\\n# **kwargs\\n# )\\n#\\n# self.add_collection(collection, autolim=False)\\n\\n def stock_img(self, name='ne_shaded'):\\n \\\"\\\"\\\"\\n Add a standard image to the map.\\n\\n Currently, the only (and default) option is a downsampled version of\\n the Natural Earth shaded relief raster.\\n\\n \\\"\\\"\\\"\\n if name == 'ne_shaded':\\n import os\\n source_proj = ccrs.PlateCarree()\\n fname = os.path.join(os.path.dirname(os.path.dirname(__file__)),\\n 'data', 'raster', 'natural_earth',\\n '50-natural-earth-1-downsampled.png')\\n img_origin = 'lower'\\n img = imread(fname)\\n img = img[::-1]\\n return self.imshow(img, origin=img_origin, transform=source_proj,\\n extent=[-180, 180, -90, 90])\\n else:\\n raise ValueError('Unknown stock image %r.' % name)\\n\\n def imshow(self, img, *args, **kwargs):\\n \\\"\\\"\\\"\\n Add the \\\"transform\\\" keyword to :func:`~matplotlib.pyplot.imshow'.\\n\\n Extra kwargs:\\n\\n transform - a :class:`~cartopy.crs.Projection`.\\n\\n regrid_shape - default is (750, 375). But may be changed to \\\"auto\\\"\\n in the future...\\n\\n extent = (left, right, bottom, top) - transform coordinates for\\n the extent of the source\\n image.\\n\\n target_extent = (left, right, bottom, top) - native coordinates\\n for the extent of\\n the desired image.\\n\\n origin - default is changed to 'lower'\\n\\n update_datalim - flag whether the image should affect the data\\n limits (default: True)\\n\\n \\\"\\\"\\\"\\n transform = kwargs.pop('transform', None)\\n regrid_shape = kwargs.pop('regrid_shape', (750, 375))\\n update_datalim = kwargs.pop('update_datalim', True)\\n\\n kwargs.setdefault('origin', 'lower')\\n\\n same_projection = (isinstance(transform, ccrs.Projection) and\\n self.projection == transform)\\n\\n if not update_datalim:\\n data_lim = self.dataLim.frozen().get_points()\\n view_lim = self.viewLim.frozen().get_points()\\n\\n if transform is None or transform == self.transData or same_projection:\\n if isinstance(transform, ccrs.Projection):\\n transform = transform._as_mpl_transform(self)\\n result = matplotlib.axes.Axes.imshow(self, img, *args, **kwargs)\\n else:\\n extent = kwargs.pop('extent', None)\\n\\n if not isinstance(transform, ccrs.Projection):\\n raise ValueError('Expected a projection subclass. Cannot '\\n 'handle a %s in imshow.' % type(transform))\\n\\n warp_array = cartopy.img_transform.warp_array\\n target_extent = self.get_extent(self.projection)\\n # XXX adaptive resolution depending on incoming img?\\n img, extent = warp_array(img,\\n source_proj=transform,\\n source_extent=extent,\\n target_proj=self.projection,\\n target_res=regrid_shape,\\n target_extent=target_extent,\\n )\\n # as a workaround to a matplotlib limitation, turn any images\\n # which are RGB with a mask into RGBA images with an alpha\\n # channel.\\n if (isinstance(img, numpy.ma.MaskedArray) and\\n img.shape[2:3] == (3, ) and\\n img.mask is not False):\\n old_img = img\\n img = numpy.zeros(img.shape[:2] + (4, ))\\n img[:, :, 0:3] = old_img\\n # put an alpha channel in if the image was masked\\n img[:, :, 3] = ~ numpy.any(old_img.mask, axis=2)\\n\\n result = matplotlib.axes.Axes.imshow(self, img, *args,\\n extent=extent, **kwargs)\\n\\n # clip the image. This does not work as the patch moves with mouse\\n # movement, but the clip path doesn't\\n # This could definitely be fixed in matplotlib\\n# if result.get_clip_path() in [None, self.patch]:\\n# # image does not already have clipping set, clip to axes patch\\n# result.set_clip_path(self.outline_patch)\\n\\n if not update_datalim:\\n self.dataLim.set_points(data_lim)\\n self.viewLim.set_points(view_lim)\\n\\n return result\\n\\n def gridlines(self, crs=None, **kwargs):\\n \\\"\\\"\\\"\\n Automatically adds gridlines to the axes, in the given coordinate\\n system, at draw time.\\n\\n ``**kwargs`` - are passed through to the created\\n :class:`matplotlib.collections.Collection`\\n allowing control of colors and linewidths etc.\\n\\n \\\"\\\"\\\"\\n if crs is None:\\n crs = ccrs.PlateCarree()\\n from cartopy.mpl.gridliner import Gridliner\\n gl = Gridliner(self, crs=crs, collection_kwargs=kwargs)\\n self._gridliners.append(gl)\\n return gl\\n\\n def _gen_axes_spines(self, locations=None, offset=0.0, units='inches'):\\n # generate some axes spines, as some Axes super class machinery\\n # requires them. Just make them invisible\\n spines = matplotlib.axes.Axes._gen_axes_spines(self,\\n locations=locations,\\n offset=offset,\\n units=units)\\n for spine in spines.itervalues():\\n spine.set_visible(False)\\n return spines\\n\\n def _boundary(self):\\n \\\"\\\"\\\"\\n Adds the map's boundary.\\n\\n Note:\\n\\n The boundary is not the axes.patch, which provides rectilinear\\n clipping for all of the map's artists.\\n\\n The axes.patch will have its visibility set to False inside\\n GeoAxes.gca()\\n \\\"\\\"\\\"\\n import cartopy.mpl.patch as p\\n path, = p.geos_to_path(self.projection.boundary)\\n\\n# from matplotlib.collections import PatchCollection\\n\\n sct = SimpleClippedTransform(self.transScale + self.transLimits,\\n self.transAxes)\\n\\n # XXX Should be exactly one path...\\n collection = mpatches.PathPatch(path,\\n facecolor='none', edgecolor='k',\\n zorder=1000,\\n # transform=self.transData,\\n transform=sct, clip_on=False,\\n )\\n self.outline_patch = collection\\n # XXX autolim = False\\n self.add_patch(collection)\\n\\n # put a color patch for background color\\n # XXX Should be exactly one path...\\n collection = mpatches.PathPatch(path,\\n facecolor='w', edgecolor='none',\\n zorder=-1, transform=sct,\\n clip_on=False,\\n )\\n self.background_patch = collection\\n # XXX autolim = False\\n self.add_patch(collection)\\n\\n self.patch.set_facecolor((1, 1, 1, 0))\\n self.patch.set_edgecolor((0.5, 0.5, 0.5))\\n self.patch.set_linewidth(0.0)\\n\\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\\n def contour(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Add the \\\"transform\\\" keyword to :func:`~matplotlib.pyplot.contour'.\\n\\n Extra kwargs:\\n\\n transform - a :class:`~cartopy.crs.Projection`.\\n\\n \\\"\\\"\\\"\\n t = kwargs.get('transform', None)\\n # Keep this bit - even at mpl v1.2\\n if t is None:\\n t = self.projection\\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\\n raise ValueError('invalid transform:'\\n ' Spherical contouring is not supported - '\\n ' consider using PlateCarree/RotatedPole.')\\n if isinstance(t, ccrs.Projection):\\n kwargs['transform'] = t._as_mpl_transform(self)\\n else:\\n kwargs['transform'] = t\\n return matplotlib.axes.Axes.contour(self, *args, **kwargs)\\n\\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\\n def contourf(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Add the \\\"transform\\\" keyword to :func:`~matplotlib.pyplot.contourf'.\\n\\n Extra kwargs:\\n\\n transform - a :class:`~cartopy.crs.Projection`.\\n\\n \\\"\\\"\\\"\\n t = kwargs.get('transform', None)\\n # Keep this bit - even at mpl v1.2\\n if t is None:\\n t = self.projection\\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\\n raise ValueError('invalid transform:'\\n ' Spherical contouring is not supported - '\\n ' consider using PlateCarree/RotatedPole.')\\n if isinstance(t, ccrs.Projection):\\n kwargs['transform'] = t._as_mpl_transform(self)\\n else:\\n kwargs['transform'] = t\\n return matplotlib.axes.Axes.contourf(self, *args, **kwargs)\\n\\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\\n def scatter(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Add the \\\"transform\\\" keyword to :func:`~matplotlib.pyplot.scatter'.\\n\\n Extra kwargs:\\n\\n transform - a :class:`~cartopy.crs.Projection`.\\n\\n \\\"\\\"\\\"\\n t = kwargs.get('transform', None)\\n # Keep this bit - even at mpl v1.2\\n if t is None:\\n t = self.projection\\n if hasattr(t, '_as_mpl_transform'):\\n kwargs['transform'] = t._as_mpl_transform(self)\\n\\n # exclude Geodetic as a vaild source CS\\n if (isinstance(kwargs.get('transform', None),\\n InterProjectionTransform) and\\n kwargs['transform'].source_projection.is_geodetic()):\\n raise ValueError('Cartopy cannot currently do spherical '\\n 'contouring. The source CRS cannot be a '\\n 'geodetic, consider using the cyllindrical form '\\n '(PlateCarree or RotatedPole).')\\n\\n return matplotlib.axes.Axes.scatter(self, *args, **kwargs)\\n\\n def pcolormesh(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Add the \\\"transform\\\" keyword to :func:`~matplotlib.pyplot.pcolormesh'.\\n\\n Extra kwargs:\\n\\n transform - a :class:`~cartopy.crs.Projection`.\\n\\n \\\"\\\"\\\"\\n t = kwargs.get('transform', None)\\n if t is None:\\n t = self.projection\\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\\n raise ValueError('invalid transform:'\\n ' Spherical pcolormesh is not supported - '\\n ' consider using PlateCarree/RotatedPole.')\\n kwargs.setdefault('transform', t)\\n return self._pcolormesh_patched(*args, **kwargs)\\n\\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\\n def _pcolormesh_patched(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n A temporary, modified duplicate of\\n :func:`~matplotlib.pyplot.pcolormesh'.\\n\\n This function contains a workaround for a matplotlib issue\\n and will be removed once the issue has been resolved.\\n https://github.com/matplotlib/matplotlib/pull/1314\\n\\n \\\"\\\"\\\"\\n import warnings\\n import numpy as np\\n import numpy.ma as ma\\n import matplotlib as mpl\\n import matplotlib.cbook as cbook\\n import matplotlib.colors as mcolors\\n import matplotlib.cm as cm\\n from matplotlib import docstring\\n import matplotlib.transforms as transforms\\n import matplotlib.artist as artist\\n from matplotlib.artist import allow_rasterization\\n import matplotlib.backend_bases as backend_bases\\n import matplotlib.path as mpath\\n import matplotlib.mlab as mlab\\n import matplotlib.collections as mcoll\\n\\n if not self._hold:\\n self.cla()\\n\\n alpha = kwargs.pop('alpha', None)\\n norm = kwargs.pop('norm', None)\\n cmap = kwargs.pop('cmap', None)\\n vmin = kwargs.pop('vmin', None)\\n vmax = kwargs.pop('vmax', None)\\n shading = kwargs.pop('shading', 'flat').lower()\\n antialiased = kwargs.pop('antialiased', False)\\n kwargs.setdefault('edgecolors', 'None')\\n\\n X, Y, C = self._pcolorargs('pcolormesh', *args)\\n Ny, Nx = X.shape\\n\\n # convert to one dimensional arrays\\n if shading != 'gouraud':\\n # data point in each cell is value at lower left corner\\n C = ma.ravel(C[0:Ny - 1, 0:Nx - 1])\\n else:\\n C = C.ravel()\\n X = X.ravel()\\n Y = Y.ravel()\\n\\n coords = np.zeros(((Nx * Ny), 2), dtype=float)\\n coords[:, 0] = X\\n coords[:, 1] = Y\\n\\n collection = mcoll.QuadMesh(\\n Nx - 1, Ny - 1, coords,\\n antialiased=antialiased, shading=shading, **kwargs)\\n collection.set_alpha(alpha)\\n collection.set_array(C)\\n if norm is not None:\\n assert(isinstance(norm, mcolors.Normalize))\\n collection.set_cmap(cmap)\\n collection.set_norm(norm)\\n collection.set_clim(vmin, vmax)\\n collection.autoscale_None()\\n\\n self.grid(False)\\n\\n ########################\\n # PATCH FOR MPL 1.2.0rc2\\n\\n # Transform from native to data coordinates?\\n t = collection._transform\\n if (not isinstance(t, mtransforms.Transform)\\n and hasattr(t, '_as_mpl_transform')):\\n t = t._as_mpl_transform(self.axes)\\n\\n if t and any(t.contains_branch_seperately(self.transData)):\\n trans_to_data = t - self.transData\\n pts = np.vstack([X, Y]).T.astype(np.float)\\n transformed_pts = trans_to_data.transform(pts)\\n\\n X = transformed_pts[..., 0]\\n Y = transformed_pts[..., 1]\\n\\n # XXX Not a mpl 1.2 thing...\\n no_inf = (X != np.inf) & (Y != np.inf)\\n X = X[no_inf]\\n Y = Y[no_inf]\\n\\n # END OF PATCH\\n ##############\\n\\n minx = np.amin(X)\\n maxx = np.amax(X)\\n miny = np.amin(Y)\\n maxy = np.amax(Y)\\n\\n corners = (minx, miny), (maxx, maxy)\\n self.update_datalim(corners)\\n self.autoscale_view()\\n self.add_collection(collection)\\n\\n # XXX Non-standard matplotlib 1.2 thing.\\n # Handle a possible wrap around for rectangular projections.\\n t = kwargs.get('transform', None)\\n if isinstance(t, ccrs.CRS):\\n if isinstance(t, ccrs._RectangularProjection) and \\\\\\n isinstance(self.projection, ccrs._RectangularProjection):\\n\\n C = C.reshape((Ny - 1, Nx - 1))\\n transformed_pts = transformed_pts.reshape((Ny, Nx, 2))\\n\\n # compute the vertical line angles of the pcolor in\\n # transformed coordinates\\n with numpy.errstate(invalid='ignore'):\\n horizontal_vert_angles = numpy.arctan2(\\n numpy.diff(transformed_pts[..., 0], axis=1),\\n numpy.diff(transformed_pts[..., 1], axis=1)\\n )\\n\\n # if the change in angle is greater than 90 degrees (absolute),\\n # then mark it for masking later on.\\n dx_horizontal = numpy.diff(horizontal_vert_angles)\\n to_mask = ((numpy.abs(dx_horizontal) > numpy.pi / 2) |\\n numpy.isnan(dx_horizontal))\\n\\n if numpy.any(to_mask):\\n # at this point C has a shape of (Ny-1, Nx-1), to_mask has\\n # a shape of (Ny, Nx-2) and pts has a shape of (Ny*Nx, 2)\\n\\n mask = numpy.zeros(C.shape, dtype=numpy.bool)\\n\\n # mask out the neighbouring cells if there was a cell\\n # found with an angle change of more than pi/2 . NB.\\n # Masking too much only has a detrimental impact on\\n # performance.\\n to_mask_y_shift = to_mask[:-1, :]\\n mask[:, :-1][to_mask_y_shift] = True\\n mask[:, 1:][to_mask_y_shift] = True\\n\\n to_mask_x_shift = to_mask[1:, :]\\n mask[:, :-1][to_mask_x_shift] = True\\n mask[:, 1:][to_mask_x_shift] = True\\n\\n C_mask = getattr(C, 'mask', None)\\n if C_mask is not None:\\n dmask = mask | C_mask\\n else:\\n dmask = mask\\n\\n # print 'Ratio of masked data: ',\\n # print numpy.sum(mask) / float(numpy.product(mask.shape))\\n\\n # create the masked array to be used with this pcolormesh\\n pcolormesh_data = numpy.ma.array(C, mask=mask)\\n\\n collection.set_array(pcolormesh_data.ravel())\\n\\n # now that the pcolormesh has masked the bad values,\\n # create a pcolor with just those values that were masked\\n pcolor_data = pcolormesh_data.copy()\\n # invert the mask\\n pcolor_data.mask = ~pcolor_data.mask\\n\\n # remember to re-apply the original data mask to the array\\n if C_mask is not None:\\n pcolor_data.mask = pcolor_data.mask | C_mask\\n\\n pts = pts.reshape((Ny, Nx, 2))\\n pcolor_col = self.pcolor(pts[..., 0], pts[..., 1],\\n pcolor_data, **kwargs)\\n pcolor_col.set_cmap(cmap)\\n pcolor_col.set_norm(norm)\\n pcolor_col.set_clim(vmin, vmax)\\n # scale the data according to the *original* data\\n pcolor_col.norm.autoscale_None(C)\\n\\n # put the pcolor_col on the pcolormesh collection so that\\n # if really necessary, users can do things post this method\\n collection._wrapped_collection_fix = pcolor_col\\n\\n return collection\\n\\n def pcolor(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Add the \\\"transform\\\" keyword to :func:`~matplotlib.pyplot.pcolor'.\\n\\n Extra kwargs:\\n\\n transform - a :class:`~cartopy.crs.Projection`.\\n\\n \\\"\\\"\\\"\\n t = kwargs.get('transform', None)\\n if t is None:\\n t = self.projection\\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\\n raise ValueError('invalid transform:'\\n ' Spherical pcolor is not supported - '\\n ' consider using PlateCarree/RotatedPole.')\\n kwargs.setdefault('transform', t)\\n return self._pcolor_patched(*args, **kwargs)\\n\\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\\n def _pcolor_patched(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n A temporary, modified duplicate of :func:`~matplotlib.pyplot.pcolor'.\\n\\n This function contains a workaround for a matplotlib issue\\n and will be removed once the issue has been resolved.\\n https://github.com/matplotlib/matplotlib/pull/1314\\n\\n \\\"\\\"\\\"\\n import warnings\\n import numpy as np\\n import numpy.ma as ma\\n import matplotlib as mpl\\n import matplotlib.cbook as cbook\\n import matplotlib.colors as mcolors\\n import matplotlib.cm as cm\\n from matplotlib import docstring\\n import matplotlib.transforms as transforms\\n import matplotlib.artist as artist\\n from matplotlib.artist import allow_rasterization\\n import matplotlib.backend_bases as backend_bases\\n import matplotlib.path as mpath\\n import matplotlib.mlab as mlab\\n import matplotlib.collections as mcoll\\n\\n if not self._hold:\\n self.cla()\\n\\n alpha = kwargs.pop('alpha', None)\\n norm = kwargs.pop('norm', None)\\n cmap = kwargs.pop('cmap', None)\\n vmin = kwargs.pop('vmin', None)\\n vmax = kwargs.pop('vmax', None)\\n shading = kwargs.pop('shading', 'flat')\\n\\n X, Y, C = self._pcolorargs('pcolor', *args)\\n Ny, Nx = X.shape\\n\\n # convert to MA, if necessary.\\n C = ma.asarray(C)\\n X = ma.asarray(X)\\n Y = ma.asarray(Y)\\n mask = ma.getmaskarray(X) + ma.getmaskarray(Y)\\n xymask = mask[0:-1, 0:-1] + mask[1:, 1:] + mask[0:-1, 1:] + \\\\\\n mask[1:, 0:-1]\\n # don't plot if C or any of the surrounding vertices are masked.\\n mask = ma.getmaskarray(C)[0:Ny - 1, 0:Nx - 1] + xymask\\n\\n newaxis = np.newaxis\\n compress = np.compress\\n\\n ravelmask = (mask == 0).ravel()\\n X1 = compress(ravelmask, ma.filled(X[0:-1, 0:-1]).ravel())\\n Y1 = compress(ravelmask, ma.filled(Y[0:-1, 0:-1]).ravel())\\n X2 = compress(ravelmask, ma.filled(X[1:, 0:-1]).ravel())\\n Y2 = compress(ravelmask, ma.filled(Y[1:, 0:-1]).ravel())\\n X3 = compress(ravelmask, ma.filled(X[1:, 1:]).ravel())\\n Y3 = compress(ravelmask, ma.filled(Y[1:, 1:]).ravel())\\n X4 = compress(ravelmask, ma.filled(X[0:-1, 1:]).ravel())\\n Y4 = compress(ravelmask, ma.filled(Y[0:-1, 1:]).ravel())\\n npoly = len(X1)\\n\\n xy = np.concatenate((X1[:, newaxis], Y1[:, newaxis],\\n X2[:, newaxis], Y2[:, newaxis],\\n X3[:, newaxis], Y3[:, newaxis],\\n X4[:, newaxis], Y4[:, newaxis],\\n X1[:, newaxis], Y1[:, newaxis]),\\n axis=1)\\n verts = xy.reshape((npoly, 5, 2))\\n\\n C = compress(ravelmask, ma.filled(C[0:Ny - 1, 0:Nx - 1]).ravel())\\n\\n linewidths = (0.25,)\\n if 'linewidth' in kwargs:\\n kwargs['linewidths'] = kwargs.pop('linewidth')\\n kwargs.setdefault('linewidths', linewidths)\\n\\n if shading == 'faceted':\\n edgecolors = 'k',\\n else:\\n edgecolors = 'none'\\n if 'edgecolor' in kwargs:\\n kwargs['edgecolors'] = kwargs.pop('edgecolor')\\n ec = kwargs.setdefault('edgecolors', edgecolors)\\n\\n # aa setting will default via collections to patch.antialiased\\n # unless the boundary is not stroked, in which case the\\n # default will be False; with unstroked boundaries, aa\\n # makes artifacts that are often disturbing.\\n if 'antialiased' in kwargs:\\n kwargs['antialiaseds'] = kwargs.pop('antialiased')\\n if 'antialiaseds' not in kwargs and ec.lower() == \\\"none\\\":\\n kwargs['antialiaseds'] = False\\n\\n collection = mcoll.PolyCollection(verts, **kwargs)\\n\\n collection.set_alpha(alpha)\\n collection.set_array(C)\\n if norm is not None:\\n assert(isinstance(norm, mcolors.Normalize))\\n collection.set_cmap(cmap)\\n collection.set_norm(norm)\\n collection.set_clim(vmin, vmax)\\n collection.autoscale_None()\\n self.grid(False)\\n\\n x = X.compressed()\\n y = Y.compressed()\\n\\n ########################\\n # PATCH FOR MPL 1.2.0rc2\\n\\n # Transform from native to data coordinates?\\n t = collection._transform\\n if (not isinstance(t, mtransforms.Transform) and\\n hasattr(t, '_as_mpl_transform')):\\n t = t._as_mpl_transform(self.axes)\\n\\n if t and any(t.contains_branch_seperately(self.transData)):\\n trans_to_data = t - self.transData\\n pts = np.vstack([x, y]).T.astype(np.float)\\n transformed_pts = trans_to_data.transform(pts)\\n x = transformed_pts[..., 0]\\n y = transformed_pts[..., 1]\\n\\n # XXX Not a mpl 1.2 thing...\\n no_inf = (x != np.inf) & (y != np.inf)\\n x = x[no_inf]\\n y = y[no_inf]\\n\\n # END OF PATCH\\n ##############\\n\\n minx = np.amin(x)\\n maxx = np.amax(x)\\n miny = np.amin(y)\\n maxy = np.amax(y)\\n\\n corners = (minx, miny), (maxx, maxy)\\n self.update_datalim(corners)\\n self.autoscale_view()\\n self.add_collection(collection)\\n return collection\\n\\n\\n# alias GeoAxes - NOTE: THIS WAS NOT IN v0.4.0rc1\\nGenericProjectionAxes = GeoAxes\\n\\\"\\\"\\\"(To be removed in v0.5) An alias to the :class:`GeoAxes` class.\\\"\\\"\\\"\\n\\n\\nclass SimpleClippedTransform(mtransforms.Transform):\\n \\\"\\\"\\\"\\n Transforms the values using a pre transform, clips them, then post\\n transforms them.\\n\\n This transform should not be widely used, but is useful for transforming\\n a background patch and clipping the patch to a desired extent.\\n\\n \\\"\\\"\\\"\\n input_dims = 2\\n output_dims = 2\\n has_inverse = True\\n\\n def __init__(self, pre_clip_transform, post_clip_transform,\\n xclip=(0, 1), yclip=(0, 1)):\\n \\\"\\\"\\\"\\n Create the transform.\\n\\n Args:\\n\\n * pre_clip_transform - A :class:`matplotlib.transforms.Transform`.\\n * post_clip_transform - A :class:`matplotlib.transforms.Transform`.\\n * xclip - Defaults to (0,1).\\n * yclip - Defaults to (0,1).\\n\\n \\\"\\\"\\\"\\n mtransforms.Transform.__init__(self)\\n self.pre_clip_transform = pre_clip_transform\\n self.post_clip_transform = post_clip_transform\\n\\n self.x_clips = xclip\\n self.y_clips = yclip\\n\\n def transform_non_affine(self, values):\\n \\\"\\\"\\\"\\n Transforms from source to target coordinates.\\n\\n Args:\\n\\n * value - An (n,2) array of points in source coordinates.\\n\\n Returns:\\n\\n * An (n,2) array of transformed points in target coordinates.\\n\\n \\\"\\\"\\\"\\n new_vals = self.pre_clip_transform.transform(values)\\n x, y = new_vals[:, 0:1], new_vals[:, 1:2]\\n numpy.clip(x, self.x_clips[0], self.x_clips[1], x)\\n numpy.clip(y, self.y_clips[0], self.y_clips[1], y)\\n # XXX support ma's?\\n return self.post_clip_transform.transform(new_vals)\\n\\n def inverted(self):\\n \\\"\\\"\\\"\\n Return a matplotlib :class:`~matplotlib.transforms.Transform` from\\n target to source coordinates.\\n\\n \\\"\\\"\\\"\\n return (self.pre_clip_transform + self.post_clip_transform).inverted()\\n\",\n \"path\": \"lib/cartopy/mpl/geoaxes.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# (C) British Crown Copyright 2011 - 2012, Met Office\n#\n# This file is part of cartopy.\n#\n# cartopy is free software: you can redistribute it and/or modify it under\n# the terms of the GNU Lesser General Public License as published by the\n# Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# cartopy is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Lesser General Public License for more details.\n#\n# You should have received a copy of the GNU Lesser General Public License\n# along with cartopy. If not, see <http://www.gnu.org/licenses/>.\n\"\"\"\nThis module defines the :class:`GeoAxes` class, for use with matplotlib.\n\nWhen a matplotlib figure contains a GeoAxes the plotting commands can transform\nplot results from source coordinates to the GeoAxes' target projection.\n\n\"\"\"\nimport warnings\nimport weakref\n\nimport matplotlib.axes\nfrom matplotlib.image import imread\nimport matplotlib.transforms as mtransforms\nimport matplotlib.patches as mpatches\nimport matplotlib.path as mpath\nimport matplotlib.collections as mcollections\nimport numpy\nimport shapely.geometry\n\nimport cartopy.crs as ccrs\nimport cartopy.feature\nimport cartopy.img_transform\nimport cartopy.mpl.feature_artist as feature_artist\nimport cartopy.mpl.patch as patch\n\n\nimport matplotlib\nassert matplotlib.__version__ >= '1.2', ('Cartopy can only work with '\n 'matplotlib 1.2 or greater.')\n\n\n_PATH_TRANSFORM_CACHE = weakref.WeakKeyDictionary()\n\"\"\"\nA nested mapping from path, source CRS, and target projection to the\nresulting transformed paths::\n\n {path: {(source_crs, target_projection): list_of_paths}}\n\nProvides a significant performance boost for contours which, at\nmatplotlib 1.2.0 called transform_path_non_affine twice unnecessarily.\n\n\"\"\"\n\n\n# XXX call this InterCRSTransform\nclass InterProjectionTransform(mtransforms.Transform):\n \"\"\"\n Transforms coordinates from the source_projection to\n the ``target_projection``.\n\n \"\"\"\n input_dims = 2\n output_dims = 2\n is_separable = False\n has_inverse = True\n\n def __init__(self, source_projection, target_projection):\n \"\"\"\n Create the transform object from the given projections.\n\n Args:\n\n * source_projection - A :class:`~cartopy.crs.CRS`.\n * target_projection - A :class:`~cartopy.crs.CRS`.\n\n \"\"\"\n # assert target_projection is cartopy.crs.Projection\n # assert source_projection is cartopy.crs.CRS\n self.source_projection = source_projection\n self.target_projection = target_projection\n mtransforms.Transform.__init__(self)\n\n def __repr__(self):\n return ('< {!s} {!s} -> {!s} >'.format(self.__class__.__name__,\n self.source_projection,\n self.target_projection))\n\n def transform_non_affine(self, xy):\n \"\"\"\n Transforms from source to target coordinates.\n\n Args:\n\n * xy - An (n,2) array of points in source coordinates.\n\n Returns:\n\n * An (n,2) array of transformed points in target coordinates.\n\n \"\"\"\n prj = self.target_projection\n if isinstance(xy, numpy.ndarray):\n return prj.transform_points(self.source_projection,\n xy[:, 0], xy[:, 1])[:, 0:2]\n else:\n x, y = xy\n x, y = prj.transform_point(x, y, self.source_projection)\n return x, y\n\n def transform_path_non_affine(self, src_path):\n \"\"\"\n Transforms from source to target coordinates.\n\n Caches results, so subsequent calls with the same *src_path* argument\n (and the same source and target projections) are faster.\n\n Args:\n\n * src_path - A matplotlib :class:`~matplotlib.path.Path` object\n with vertices in source coordinates.\n\n Returns\n\n * A matplotlib :class:`~matplotlib.path.Path` with vertices\n in target coordinates.\n\n \"\"\"\n mapping = _PATH_TRANSFORM_CACHE.get(src_path)\n if mapping is not None:\n key = (self.source_projection, self.target_projection)\n result = mapping.get(key)\n if result is not None:\n return result\n\n bypass = self.source_projection == self.target_projection\n if bypass:\n projection = self.source_projection\n if isinstance(projection, ccrs._CylindricalProjection):\n x = src_path.vertices[:, 0]\n x_limits = projection.x_limits\n bypass = x.min() >= x_limits[0] and x.max() <= x_limits[1]\n if bypass:\n return src_path\n\n if src_path.vertices.shape == (1, 2):\n return mpath.Path(self.transform(src_path.vertices))\n\n transformed_geoms = []\n for geom in patch.path_to_geos(src_path):\n transformed_geoms.append(\n self.target_projection.project_geometry(geom,\n self.source_projection)\n )\n\n if not transformed_geoms:\n result = mpath.Path(numpy.empty([0, 2]))\n else:\n paths = patch.geos_to_path(transformed_geoms)\n if not paths:\n return mpath.Path(numpy.empty([0, 2]))\n points, codes = zip(*[patch.path_segments(path, curves=False,\n simplify=False)\n for path in paths])\n result = mpath.Path(numpy.concatenate(points, 0),\n numpy.concatenate(codes))\n\n # store the result in the cache for future performance boosts\n key = (self.source_projection, self.target_projection)\n if mapping is None:\n _PATH_TRANSFORM_CACHE[src_path] = {key: result}\n else:\n mapping[key] = result\n\n return result\n\n def inverted(self):\n \"\"\"\n Return a matplotlib :class:`~matplotlib.transforms.Transform`\n from target to source coordinates.\n\n \"\"\"\n return InterProjectionTransform(self.target_projection,\n self.source_projection)\n\n\nclass GeoAxes(matplotlib.axes.Axes):\n \"\"\"\n A subclass of :class:`matplotlib.axes.Axes` which represents a\n map :class:`~cartopy.crs.Projection`.\n\n This class replaces the matplotlib :class:`~matplotlib.axes.Axes` class\n when created with the *projection* keyword. For example:\n\n # Set up a standard map for latlon data.\n geo_axes = pyplot.axes(projection=cartopy.crs.PlateCarree())\n\n # Set up an OSGB map.\n geo_axes = pyplot.subplot(2, 2, 1, projection=cartopy.crs.OSGB())\n\n When a source projection is provided to one of it's plotting methods,\n using the *transform* keyword, the standard matplotlib plot result is\n transformed from source coordinates to the target projection. For example:\n\n # Plot latlon data on an OSGB map.\n pyplot.axes(projection=cartopy.crs.OSGB())\n pyplot.contourf(x, y, data, transform=cartopy.crs.PlateCarree())\n\n \"\"\"\n def __init__(self, *args, **kwargs):\n \"\"\"\n Create a GeoAxes object using standard matplotlib\n :class:`~matplotlib.axes.Axes` args and keywords.\n\n Kwargs:\n\n * map_projection - The target :class:`~cartopy.crs.Projection` of\n this Axes object.\n\n All other args and keywords are passed straight through to\n :class:`matplotlib.axes.Axes`.\n\n \"\"\"\n self.projection = kwargs.pop('map_projection')\n super(GeoAxes, self).__init__(*args, **kwargs)\n self._gridliners = []\n self.img_factories = []\n self._done_img_factory = False\n\n def add_image(self, factory, *args, **kwargs):\n \"\"\"\n Adds an image \"factory\" to the Axes.\n\n Any image \"factory\" added, will be asked to retrieve an image\n with associated metadata for a given bounding box at draw time.\n The advantage of this approach is that the limits of the map\n do not need to be known when adding the image factory, but can\n be deferred until everything which can effect the limits has been\n added.\n\n Currently an image \"factory\" is just an object with\n a ``image_for_domain`` method. Examples of image factories\n are :class:`cartopy.io.img_nest.NestedImageCollection` and\n :class:`cartopy.io.image_tiles.GoogleTiles`.\n\n \"\"\"\n # XXX TODO: Needs working on\n self.img_factories.append([factory, args, kwargs])\n\n @matplotlib.axes.allow_rasterization\n def draw(self, renderer=None, inframe=False):\n \"\"\"\n Extends the standard behaviour of :func:`matplotlib.axes.Axes.draw`.\n\n Draws grid lines and image factory results before invoking standard\n matplotlib drawing. A global range is used if no limits have yet\n been set.\n\n \"\"\"\n # if no data has been added, and no extents set, then make the\n # map global\n if self.ignore_existing_data_limits and \\\n self._autoscaleXon and self._autoscaleYon:\n self.set_global()\n self.ignore_existing_data_limits = True\n\n for gl in self._gridliners:\n gl.do_gridlines(background_patch=self.background_patch)\n self._gridliners = []\n\n # XXX This interface needs a tidy up:\n # image drawing on pan/zoom;\n # caching the resulting image;\n # buffering the result by 10%...;\n if not self._done_img_factory:\n for factory, args, kwargs in self.img_factories:\n img, extent, origin = factory.image_for_domain(\n self._get_extent_geom(factory.crs), args[0])\n self.imshow(img, extent=extent, origin=origin,\n transform=factory.crs, *args[1:], **kwargs)\n self._done_img_factory = True\n\n return matplotlib.axes.Axes.draw(self, renderer=renderer,\n inframe=inframe)\n\n def __str__(self):\n return '< GeoAxes: %s >' % self.projection\n\n def cla(self):\n \"\"\"Clears the current axes and adds boundary lines.\"\"\"\n result = matplotlib.axes.Axes.cla(self)\n self.xaxis.set_visible(False)\n self.yaxis.set_visible(False)\n self.autoscale_view(tight=True)\n self.set_aspect('equal')\n\n pre_bounary = self.ignore_existing_data_limits\n self._boundary()\n self.ignore_existing_data_limits = pre_bounary\n\n # XXX consider a margin - but only when the map is not global...\n # self._xmargin = 0.15\n # self._ymargin = 0.15\n\n return result\n\n def format_coord(self, x, y):\n \"\"\"Return a string formatted for the matplotlib GUI status bar.\"\"\"\n lon, lat = ccrs.Geodetic().transform_point(x, y, self.projection)\n\n ns = 'N' if lat >= 0.0 else 'S'\n ew = 'E' if lon >= 0.0 else 'W'\n\n return u'%.4g, %.4g (%f\\u00b0%s, %f\\u00b0%s)' % (x, y, abs(lat),\n ns, abs(lon), ew)\n\n def coastlines(self, resolution='110m', color='black', **kwargs):\n \"\"\"\n Adds coastal **outlines** to the current axes from the Natural Earth\n \"coastline\" shapefile collection.\n\n Kwargs:\n\n * resolution - a named resolution to use from the Natural Earth\n dataset. Currently can be one of \"110m\", \"50m\", and\n \"10m\".\n\n .. note::\n\n Currently no clipping is done on the coastlines before adding\n them to the axes. This means, if very high resolution coastlines\n are being used, performance is likely to be severely effected.\n This should be resolved transparently by v0.5.\n\n \"\"\"\n kwargs['edgecolor'] = color\n kwargs['facecolor'] = 'none'\n feature = cartopy.feature.NaturalEarthFeature('physical', 'coastline',\n resolution, **kwargs)\n return self.add_feature(feature)\n\n def natural_earth_shp(self, name='land', resolution='110m',\n category='physical', **kwargs):\n \"\"\"\n Adds the geometries from the specified Natural Earth shapefile to the\n Axes as a :class:`~matplotlib.collections.PathCollection`.\n\n ``**kwargs`` are passed through to the\n :class:`~matplotlib.collections.PathCollection` constructor.\n\n Returns the created :class:`~matplotlib.collections.PathCollection`.\n\n .. note::\n\n Currently no clipping is done on the geometries before adding them\n to the axes. This means, if very high resolution geometries are\n being used, performance is likely to be severely effected. This\n should be resolved transparently by v0.5.\n\n \"\"\"\n warnings.warn('This method has been deprecated.'\n ' Please use `add_feature` instead.')\n kwargs.setdefault('edgecolor', 'face')\n kwargs.setdefault('facecolor', cartopy.feature._COLOURS['land'])\n feature = cartopy.feature.NaturalEarthFeature(category, name,\n resolution, **kwargs)\n return self.add_feature(feature)\n\n def add_feature(self, feature, **kwargs):\n \"\"\"\n Adds the given :class:`~cartopy.feature.Feature` instance to the axes.\n\n Args:\n\n * feature:\n An instance of :class:`~cartopy.feature.Feature`.\n\n Kwargs:\n Keyword arguments to be used when drawing the feature. This allows\n standard matplotlib control over aspects such as 'facecolor',\n 'alpha', etc.\n\n Returns:\n * A :class:`cartopy.mpl_integration.feature_artist.FeatureArtist`\n instance responsible for drawing the feature.\n\n \"\"\"\n # Instantiate an artist to draw the feature and add it to the axes.\n artist = feature_artist.FeatureArtist(feature, **kwargs)\n return self.add_artist(artist)\n\n def add_geometries(self, geoms, crs, **kwargs):\n \"\"\"\n Add the given shapely geometries (in the given crs) to the axes.\n\n Args:\n\n * geoms:\n A collection of shapely geometries.\n * crs:\n The cartopy CRS in which the provided geometries are defined.\n\n Kwargs:\n Keyword arguments to be used when drawing this feature.\n\n Returns:\n * A :class:`cartopy.mpl_integration.feature_artist.FeatureArtist`\n instance responsible for drawing the geometries.\n\n \"\"\"\n feature = cartopy.feature.ShapelyFeature(geoms, crs, **kwargs)\n return self.add_feature(feature)\n\n def get_extent(self, crs=None):\n \"\"\"\n Get the extent (x0, x1, y0, y1) of the map in the given coordinate\n system.\n\n If no crs is given, the returned extents' coordinate system will be\n assumed to be the Geodetic version of this axes' projection.\n\n \"\"\"\n p = self._get_extent_geom(crs)\n r = p.bounds\n x1, y1, x2, y2 = r\n return x1, x2, y1, y2\n\n def _get_extent_geom(self, crs=None):\n # Perform the calculations for get_extent(), which just repackages it.\n x1, x2 = self.get_xlim()\n y1, y2 = self.get_ylim()\n\n if x1 == 0 and y1 == 0 and x2 == 1 and y2 == 1:\n x1, x2 = self.projection.x_limits\n y1, y2 = self.projection.y_limits\n\n domain_in_src_proj = shapely.geometry.Polygon([[x1, y1], [x2, y1],\n [x2, y2], [x1, y2],\n [x1, y1]])\n\n # Determine target projection based on requested CRS.\n if crs is None:\n proj = self.projection\n elif isinstance(crs, ccrs.Projection):\n proj = crs\n else:\n # Attempt to select suitable projection for\n # non-projection CRS.\n if isinstance(crs, ccrs.RotatedGeodetic):\n proj = ccrs.RotatedPole(crs.proj4_params['lon_0'] - 180,\n crs.proj4_params['o_lat_p'])\n warnings.warn('Approximating coordinate system {!r} with a '\n 'RotatedPole projection.'.format(crs))\n elif hasattr(crs, 'is_geodetic') and crs.is_geodetic():\n proj = ccrs.PlateCarree()\n warnings.warn('Approximating coordinate system {!r} with the '\n 'PlateCarree projection.'.format(crs))\n else:\n raise ValueError('Cannot determine extent in'\n ' coordinate system {!r}'.format(crs))\n\n # Calculate intersection with boundary and project if necesary.\n boundary_poly = shapely.geometry.Polygon(self.projection.boundary)\n if proj != self.projection:\n # Erode boundary by threshold to avoid transform issues.\n # This is a workaround for numerical issues at the boundary.\n eroded_boundary = boundary_poly.buffer(-self.projection.threshold)\n geom_in_src_proj = eroded_boundary.intersection(\n domain_in_src_proj)\n geom_in_crs = proj.project_geometry(geom_in_src_proj,\n self.projection)\n else:\n geom_in_crs = boundary_poly.intersection(domain_in_src_proj)\n\n return geom_in_crs\n\n def set_extent(self, extents, crs=None):\n \"\"\"\n Set the extent (x0, x1, y0, y1) of the map in the given\n coordinate system.\n\n If no crs is given, the extents' coordinate system will be assumed\n to be the Geodetic version of this axes' projection.\n\n \"\"\"\n # TODO: Implement the same semantics as plt.xlim and\n # plt.ylim - allowing users to set None for a minimum and/or\n # maximum value\n x1, x2, y1, y2 = extents\n domain_in_crs = shapely.geometry.LineString([[x1, y1], [x2, y1],\n [x2, y2], [x1, y2],\n [x1, y1]])\n\n r = self.projection.project_geometry(domain_in_crs, crs)\n x1, y1, x2, y2 = r.bounds\n self.set_xlim([x1, x2])\n self.set_ylim([y1, y2])\n\n def set_global(self):\n \"\"\"\n Set the extent of the Axes to the limits of the projection.\n\n .. note::\n\n In some cases where the projection has a limited sensible range\n the ``set_global`` method does not actually make the whole globe\n visible. Instead, the most appropriate extents will be used (e.g.\n Ordnance Survey UK will set the extents to be around the British\n Isles.\n\n \"\"\"\n self.set_xlim(self.projection.x_limits)\n self.set_ylim(self.projection.y_limits)\n\n def set_xticks(self, ticks, minor=False, crs=None):\n \"\"\"\n Set the x ticks.\n\n Args:\n\n * ticks - list of floats denoting the desired position of x ticks.\n\n Kwargs:\n\n * minor - boolean flag indicating whether the ticks should be minor\n ticks i.e. small and unlabelled (default is False).\n\n * crs - An instance of :class:`~cartopy.crs.CRS` indicating the\n coordinate system of the provided tick values. If no\n coordinate system is specified then the values are assumed\n to be in the coordinate system of the projection.\n\n .. note::\n\n This method is limited to cylindrical projections.\n\n .. note::\n\n This interface is subject to change whilst functionality is added\n to support other map projections.\n\n \"\"\"\n if not isinstance(self.projection, (ccrs._RectangularProjection,\n ccrs._CylindricalProjection,\n ccrs.OSGB)):\n raise RuntimeError('Cannot set xticks for not-cylindrical '\n 'coordinate systems.')\n\n # Switch on drawing of x axis\n self.xaxis.set_visible(True)\n\n # Project ticks if crs differs from axes' projection\n if crs is not None and crs != self.projection:\n proj_xyz = self.projection.transform_points(crs,\n numpy.asarray(ticks),\n numpy.zeros(len(ticks))\n )\n xticks = proj_xyz[..., 0]\n else:\n xticks = ticks\n\n return super(GeoAxes, self).set_xticks(xticks, minor)\n\n def set_yticks(self, ticks, minor=False, crs=None):\n \"\"\"\n Set the y ticks.\n\n Args:\n\n * ticks - list of floats denoting the desired position of y ticks.\n\n Kwargs:\n\n * minor - boolean flag indicating whether the ticks should be minor\n ticks i.e. small and unlabelled (default is False).\n\n * crs - An instance of :class:`~cartopy.crs.CRS` indicating the\n coordinate system of the provided tick values. If no\n coordinate system is specified then the values are assumed\n to be in the coordinate system of the projection.\n\n .. note::\n\n This method is limited to cylindrical projections.\n\n .. note::\n\n This interface is subject to change whilst functionality is added\n to support other map projections.\n\n \"\"\"\n if not isinstance(self.projection, (ccrs._RectangularProjection,\n ccrs._CylindricalProjection,\n ccrs.OSGB)):\n raise RuntimeError('Cannot set yticks for non-cylindrical '\n 'coordinate systems.')\n\n # Switch on drawing of y axis\n self.yaxis.set_visible(True)\n\n # Project ticks if crs differs from axes' projection\n if crs is not None and crs != self.projection:\n prj = self.projection\n proj_xyz = prj.transform_points(crs,\n numpy.zeros(len(ticks)),\n numpy.asarray(ticks))\n yticks = proj_xyz[..., 1]\n else:\n yticks = ticks\n\n return super(GeoAxes, self).set_yticks(yticks, minor)\n\n# def geod_circle_meters(self, lon_0, lat_0, radius, npts=80, **kwargs):\n# # radius is in meters\n# geod = self.projection.as_geodetic()\n#\n# az = numpy.linspace(0, 360, npts)\n# lats = numpy.zeros(npts) + lat_0\n# lons = numpy.zeros(npts) + lon_0\n# distances = numpy.zeros(npts) + radius\n#\n# lons, lats, _reverse_az = geod.fwd(lons, lats, az, distances,\n# radians=False)\n# ll = numpy.concatenate([lons[:, None], lats[:, None]], 1)\n# from matplotlib.patches import Polygon\n# poly = Polygon(ll, transform=cartopy.prj.PlateCarree(), **kwargs)\n# self.add_patch(poly)\n# return poly\n#\n# def gshhs_line(self, outline_color='k', domain=None,\n# resolution='low', **kwargs):\n# # domain is a shapely geometry (Polygon or MultiPolygon)\n# import cartopy.gshhs as gshhs\n## import cartopy.spherical as spherical\n# from matplotlib.collections import PatchCollection, LineCollection\n#\n# paths = []\n#\n# projection = self.projection\n#\n# if domain is None:\n# domain = self.map_domain(ccrs.PlateCarree())\n#\n# for points in gshhs.read_gshhc(gshhs.fnames[resolution],\n# poly=False, domain=domain):\n# paths.extend(patch.geos_to_path(\n# shapely.geometry.LineString(points))\n# )\n#\n## slinestring = shapely.geometry.LineString(points)\n## projected = projection.project_geometry(slinestring)\n## paths.extend(patch.geos_to_path(projected))\n#\n# collection = PatchCollection([mpatches.PathPatch(pth)\n# for pth in paths],\n# edgecolor=outline_color, facecolor='none',\n# transform=ccrs.PlateCarree(),\n# **kwargs\n# )\n#\n# self.add_collection(collection, autolim=False)\n\n def stock_img(self, name='ne_shaded'):\n \"\"\"\n Add a standard image to the map.\n\n Currently, the only (and default) option is a downsampled version of\n the Natural Earth shaded relief raster.\n\n \"\"\"\n if name == 'ne_shaded':\n import os\n source_proj = ccrs.PlateCarree()\n fname = os.path.join(os.path.dirname(os.path.dirname(__file__)),\n 'data', 'raster', 'natural_earth',\n '50-natural-earth-1-downsampled.png')\n img_origin = 'lower'\n img = imread(fname)\n img = img[::-1]\n return self.imshow(img, origin=img_origin, transform=source_proj,\n extent=[-180, 180, -90, 90])\n else:\n raise ValueError('Unknown stock image %r.' % name)\n\n def imshow(self, img, *args, **kwargs):\n \"\"\"\n Add the \"transform\" keyword to :func:`~matplotlib.pyplot.imshow'.\n\n Extra kwargs:\n\n transform - a :class:`~cartopy.crs.Projection`.\n\n regrid_shape - default is (750, 375). But may be changed to \"auto\"\n in the future...\n\n extent = (left, right, bottom, top) - transform coordinates for\n the extent of the source\n image.\n\n target_extent = (left, right, bottom, top) - native coordinates\n for the extent of\n the desired image.\n\n origin - default is changed to 'lower'\n\n update_datalim - flag whether the image should affect the data\n limits (default: True)\n\n \"\"\"\n transform = kwargs.pop('transform', None)\n regrid_shape = kwargs.pop('regrid_shape', (750, 375))\n update_datalim = kwargs.pop('update_datalim', True)\n\n kwargs.setdefault('origin', 'lower')\n\n same_projection = (isinstance(transform, ccrs.Projection) and\n self.projection == transform)\n\n if not update_datalim:\n data_lim = self.dataLim.frozen().get_points()\n view_lim = self.viewLim.frozen().get_points()\n\n if transform is None or transform == self.transData or same_projection:\n if isinstance(transform, ccrs.Projection):\n transform = transform._as_mpl_transform(self)\n result = matplotlib.axes.Axes.imshow(self, img, *args, **kwargs)\n else:\n extent = kwargs.pop('extent', None)\n\n if not isinstance(transform, ccrs.Projection):\n raise ValueError('Expected a projection subclass. Cannot '\n 'handle a %s in imshow.' % type(transform))\n\n warp_array = cartopy.img_transform.warp_array\n target_extent = self.get_extent(self.projection)\n # XXX adaptive resolution depending on incoming img?\n img, extent = warp_array(img,\n source_proj=transform,\n source_extent=extent,\n target_proj=self.projection,\n target_res=regrid_shape,\n target_extent=target_extent,\n )\n # as a workaround to a matplotlib limitation, turn any images\n # which are RGB with a mask into RGBA images with an alpha\n # channel.\n if (isinstance(img, numpy.ma.MaskedArray) and\n img.shape[2:3] == (3, ) and\n img.mask is not False):\n old_img = img\n img = numpy.zeros(img.shape[:2] + (4, ))\n img[:, :, 0:3] = old_img\n # put an alpha channel in if the image was masked\n img[:, :, 3] = ~ numpy.any(old_img.mask, axis=2)\n\n result = matplotlib.axes.Axes.imshow(self, img, *args,\n extent=extent, **kwargs)\n\n # clip the image. This does not work as the patch moves with mouse\n # movement, but the clip path doesn't\n # This could definitely be fixed in matplotlib\n# if result.get_clip_path() in [None, self.patch]:\n# # image does not already have clipping set, clip to axes patch\n# result.set_clip_path(self.outline_patch)\n\n if not update_datalim:\n self.dataLim.set_points(data_lim)\n self.viewLim.set_points(view_lim)\n\n return result\n\n def gridlines(self, crs=None, **kwargs):\n \"\"\"\n Automatically adds gridlines to the axes, in the given coordinate\n system, at draw time.\n\n ``**kwargs`` - are passed through to the created\n :class:`matplotlib.collections.Collection`\n allowing control of colors and linewidths etc.\n\n \"\"\"\n if crs is None:\n crs = ccrs.PlateCarree()\n from cartopy.mpl.gridliner import Gridliner\n gl = Gridliner(self, crs=crs, collection_kwargs=kwargs)\n self._gridliners.append(gl)\n return gl\n\n def _gen_axes_spines(self, locations=None, offset=0.0, units='inches'):\n # generate some axes spines, as some Axes super class machinery\n # requires them. Just make them invisible\n spines = matplotlib.axes.Axes._gen_axes_spines(self,\n locations=locations,\n offset=offset,\n units=units)\n for spine in spines.itervalues():\n spine.set_visible(False)\n return spines\n\n def _boundary(self):\n \"\"\"\n Adds the map's boundary.\n\n Note:\n\n The boundary is not the axes.patch, which provides rectilinear\n clipping for all of the map's artists.\n\n The axes.patch will have its visibility set to False inside\n GeoAxes.gca()\n \"\"\"\n import cartopy.mpl.patch as p\n path, = p.geos_to_path(self.projection.boundary)\n\n# from matplotlib.collections import PatchCollection\n\n sct = SimpleClippedTransform(self.transScale + self.transLimits,\n self.transAxes)\n\n # XXX Should be exactly one path...\n collection = mpatches.PathPatch(path,\n facecolor='none', edgecolor='k',\n zorder=1000,\n # transform=self.transData,\n transform=sct, clip_on=False,\n )\n self.outline_patch = collection\n # XXX autolim = False\n self.add_patch(collection)\n\n # put a color patch for background color\n # XXX Should be exactly one path...\n collection = mpatches.PathPatch(path,\n facecolor='w', edgecolor='none',\n zorder=-1, transform=sct,\n clip_on=False,\n )\n self.background_patch = collection\n # XXX autolim = False\n self.add_patch(collection)\n\n self.patch.set_facecolor((1, 1, 1, 0))\n self.patch.set_edgecolor((0.5, 0.5, 0.5))\n self.patch.set_linewidth(0.0)\n\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\n def contour(self, *args, **kwargs):\n \"\"\"\n Add the \"transform\" keyword to :func:`~matplotlib.pyplot.contour'.\n\n Extra kwargs:\n\n transform - a :class:`~cartopy.crs.Projection`.\n\n \"\"\"\n t = kwargs.get('transform', None)\n # Keep this bit - even at mpl v1.2\n if t is None:\n t = self.projection\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\n raise ValueError('invalid transform:'\n ' Spherical contouring is not supported - '\n ' consider using PlateCarree/RotatedPole.')\n if isinstance(t, ccrs.Projection):\n kwargs['transform'] = t._as_mpl_transform(self)\n else:\n kwargs['transform'] = t\n return matplotlib.axes.Axes.contour(self, *args, **kwargs)\n\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\n def contourf(self, *args, **kwargs):\n \"\"\"\n Add the \"transform\" keyword to :func:`~matplotlib.pyplot.contourf'.\n\n Extra kwargs:\n\n transform - a :class:`~cartopy.crs.Projection`.\n\n \"\"\"\n t = kwargs.get('transform', None)\n # Keep this bit - even at mpl v1.2\n if t is None:\n t = self.projection\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\n raise ValueError('invalid transform:'\n ' Spherical contouring is not supported - '\n ' consider using PlateCarree/RotatedPole.')\n if isinstance(t, ccrs.Projection):\n kwargs['transform'] = t._as_mpl_transform(self)\n else:\n kwargs['transform'] = t\n return matplotlib.axes.Axes.contourf(self, *args, **kwargs)\n\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\n def scatter(self, *args, **kwargs):\n \"\"\"\n Add the \"transform\" keyword to :func:`~matplotlib.pyplot.scatter'.\n\n Extra kwargs:\n\n transform - a :class:`~cartopy.crs.Projection`.\n\n \"\"\"\n t = kwargs.get('transform', None)\n # Keep this bit - even at mpl v1.2\n if t is None:\n t = self.projection\n if hasattr(t, '_as_mpl_transform'):\n kwargs['transform'] = t._as_mpl_transform(self)\n\n # exclude Geodetic as a vaild source CS\n if (isinstance(kwargs.get('transform', None),\n InterProjectionTransform) and\n kwargs['transform'].source_projection.is_geodetic()):\n raise ValueError('Cartopy cannot currently do spherical '\n 'contouring. The source CRS cannot be a '\n 'geodetic, consider using the cyllindrical form '\n '(PlateCarree or RotatedPole).')\n\n return matplotlib.axes.Axes.scatter(self, *args, **kwargs)\n\n def pcolormesh(self, *args, **kwargs):\n \"\"\"\n Add the \"transform\" keyword to :func:`~matplotlib.pyplot.pcolormesh'.\n\n Extra kwargs:\n\n transform - a :class:`~cartopy.crs.Projection`.\n\n \"\"\"\n t = kwargs.get('transform', None)\n if t is None:\n t = self.projection\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\n raise ValueError('invalid transform:'\n ' Spherical pcolormesh is not supported - '\n ' consider using PlateCarree/RotatedPole.')\n kwargs.setdefault('transform', t)\n return self._pcolormesh_patched(*args, **kwargs)\n\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\n def _pcolormesh_patched(self, *args, **kwargs):\n \"\"\"\n A temporary, modified duplicate of\n :func:`~matplotlib.pyplot.pcolormesh'.\n\n This function contains a workaround for a matplotlib issue\n and will be removed once the issue has been resolved.\n https://github.com/matplotlib/matplotlib/pull/1314\n\n \"\"\"\n import warnings\n import numpy as np\n import numpy.ma as ma\n import matplotlib as mpl\n import matplotlib.cbook as cbook\n import matplotlib.colors as mcolors\n import matplotlib.cm as cm\n from matplotlib import docstring\n import matplotlib.transforms as transforms\n import matplotlib.artist as artist\n from matplotlib.artist import allow_rasterization\n import matplotlib.backend_bases as backend_bases\n import matplotlib.path as mpath\n import matplotlib.mlab as mlab\n import matplotlib.collections as mcoll\n\n if not self._hold:\n self.cla()\n\n alpha = kwargs.pop('alpha', None)\n norm = kwargs.pop('norm', None)\n cmap = kwargs.pop('cmap', None)\n vmin = kwargs.pop('vmin', None)\n vmax = kwargs.pop('vmax', None)\n shading = kwargs.pop('shading', 'flat').lower()\n antialiased = kwargs.pop('antialiased', False)\n kwargs.setdefault('edgecolors', 'None')\n\n X, Y, C = self._pcolorargs('pcolormesh', *args)\n Ny, Nx = X.shape\n\n # convert to one dimensional arrays\n if shading != 'gouraud':\n # data point in each cell is value at lower left corner\n C = ma.ravel(C[0:Ny - 1, 0:Nx - 1])\n else:\n C = C.ravel()\n X = X.ravel()\n Y = Y.ravel()\n\n coords = np.zeros(((Nx * Ny), 2), dtype=float)\n coords[:, 0] = X\n coords[:, 1] = Y\n\n collection = mcoll.QuadMesh(\n Nx - 1, Ny - 1, coords,\n antialiased=antialiased, shading=shading, **kwargs)\n collection.set_alpha(alpha)\n collection.set_array(C)\n if norm is not None:\n assert(isinstance(norm, mcolors.Normalize))\n collection.set_cmap(cmap)\n collection.set_norm(norm)\n collection.set_clim(vmin, vmax)\n collection.autoscale_None()\n\n self.grid(False)\n\n ########################\n # PATCH FOR MPL 1.2.0rc2\n\n # Transform from native to data coordinates?\n t = collection._transform\n if (not isinstance(t, mtransforms.Transform)\n and hasattr(t, '_as_mpl_transform')):\n t = t._as_mpl_transform(self.axes)\n\n if t and any(t.contains_branch_seperately(self.transData)):\n trans_to_data = t - self.transData\n pts = np.vstack([X, Y]).T.astype(np.float)\n transformed_pts = trans_to_data.transform(pts)\n\n X = transformed_pts[..., 0]\n Y = transformed_pts[..., 1]\n\n # XXX Not a mpl 1.2 thing...\n no_inf = (X != np.inf) & (Y != np.inf)\n X = X[no_inf]\n Y = Y[no_inf]\n\n # END OF PATCH\n ##############\n\n minx = np.amin(X)\n maxx = np.amax(X)\n miny = np.amin(Y)\n maxy = np.amax(Y)\n\n corners = (minx, miny), (maxx, maxy)\n self.update_datalim(corners)\n self.autoscale_view()\n self.add_collection(collection)\n\n # XXX Non-standard matplotlib 1.2 thing.\n # Handle a possible wrap around for rectangular projections.\n t = kwargs.get('transform', None)\n if isinstance(t, ccrs.CRS):\n if isinstance(t, ccrs._RectangularProjection) and \\\n isinstance(self.projection, ccrs._RectangularProjection):\n\n C = C.reshape((Ny - 1, Nx - 1))\n transformed_pts = transformed_pts.reshape((Ny, Nx, 2))\n\n # compute the vertical line angles of the pcolor in\n # transformed coordinates\n with numpy.errstate(invalid='ignore'):\n horizontal_vert_angles = numpy.arctan2(\n numpy.diff(transformed_pts[..., 0], axis=1),\n numpy.diff(transformed_pts[..., 1], axis=1)\n )\n\n # if the change in angle is greater than 90 degrees (absolute),\n # then mark it for masking later on.\n dx_horizontal = numpy.diff(horizontal_vert_angles)\n to_mask = ((numpy.abs(dx_horizontal) > numpy.pi / 2) |\n numpy.isnan(dx_horizontal))\n\n if numpy.any(to_mask):\n # at this point C has a shape of (Ny-1, Nx-1), to_mask has\n # a shape of (Ny, Nx-2) and pts has a shape of (Ny*Nx, 2)\n\n mask = numpy.zeros(C.shape, dtype=numpy.bool)\n\n # mask out the neighbouring cells if there was a cell\n # found with an angle change of more than pi/2 . NB.\n # Masking too much only has a detrimental impact on\n # performance.\n to_mask_y_shift = to_mask[:-1, :]\n mask[:, :-1][to_mask_y_shift] = True\n mask[:, 1:][to_mask_y_shift] = True\n\n to_mask_x_shift = to_mask[1:, :]\n mask[:, :-1][to_mask_x_shift] = True\n mask[:, 1:][to_mask_x_shift] = True\n\n C_mask = getattr(C, 'mask', None)\n if C_mask is not None:\n dmask = mask | C_mask\n else:\n dmask = mask\n\n # print 'Ratio of masked data: ',\n # print numpy.sum(mask) / float(numpy.product(mask.shape))\n\n # create the masked array to be used with this pcolormesh\n pcolormesh_data = numpy.ma.array(C, mask=mask)\n\n collection.set_array(pcolormesh_data.ravel())\n\n # now that the pcolormesh has masked the bad values,\n # create a pcolor with just those values that were masked\n pcolor_data = pcolormesh_data.copy()\n # invert the mask\n pcolor_data.mask = ~pcolor_data.mask\n\n # remember to re-apply the original data mask to the array\n if C_mask is not None:\n pcolor_data.mask = pcolor_data.mask | C_mask\n\n pts = pts.reshape((Ny, Nx, 2))\n pcolor_col = self.pcolor(pts[..., 0], pts[..., 1],\n pcolor_data, **kwargs)\n pcolor_col.set_cmap(cmap)\n pcolor_col.set_norm(norm)\n pcolor_col.set_clim(vmin, vmax)\n # scale the data according to the *original* data\n pcolor_col.norm.autoscale_None(C)\n\n # put the pcolor_col on the pcolormesh collection so that\n # if really necessary, users can do things post this method\n collection._wrapped_collection_fix = pcolor_col\n\n return collection\n\n def pcolor(self, *args, **kwargs):\n \"\"\"\n Add the \"transform\" keyword to :func:`~matplotlib.pyplot.pcolor'.\n\n Extra kwargs:\n\n transform - a :class:`~cartopy.crs.Projection`.\n\n \"\"\"\n t = kwargs.get('transform', None)\n if t is None:\n t = self.projection\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\n raise ValueError('invalid transform:'\n ' Spherical pcolor is not supported - '\n ' consider using PlateCarree/RotatedPole.')\n kwargs.setdefault('transform', t)\n return self._pcolor_patched(*args, **kwargs)\n\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\n def _pcolor_patched(self, *args, **kwargs):\n \"\"\"\n A temporary, modified duplicate of :func:`~matplotlib.pyplot.pcolor'.\n\n This function contains a workaround for a matplotlib issue\n and will be removed once the issue has been resolved.\n https://github.com/matplotlib/matplotlib/pull/1314\n\n \"\"\"\n import warnings\n import numpy as np\n import numpy.ma as ma\n import matplotlib as mpl\n import matplotlib.cbook as cbook\n import matplotlib.colors as mcolors\n import matplotlib.cm as cm\n from matplotlib import docstring\n import matplotlib.transforms as transforms\n import matplotlib.artist as artist\n from matplotlib.artist import allow_rasterization\n import matplotlib.backend_bases as backend_bases\n import matplotlib.path as mpath\n import matplotlib.mlab as mlab\n import matplotlib.collections as mcoll\n\n if not self._hold:\n self.cla()\n\n alpha = kwargs.pop('alpha', None)\n norm = kwargs.pop('norm', None)\n cmap = kwargs.pop('cmap', None)\n vmin = kwargs.pop('vmin', None)\n vmax = kwargs.pop('vmax', None)\n shading = kwargs.pop('shading', 'flat')\n\n X, Y, C = self._pcolorargs('pcolor', *args)\n Ny, Nx = X.shape\n\n # convert to MA, if necessary.\n C = ma.asarray(C)\n X = ma.asarray(X)\n Y = ma.asarray(Y)\n mask = ma.getmaskarray(X) + ma.getmaskarray(Y)\n xymask = mask[0:-1, 0:-1] + mask[1:, 1:] + mask[0:-1, 1:] + \\\n mask[1:, 0:-1]\n # don't plot if C or any of the surrounding vertices are masked.\n mask = ma.getmaskarray(C)[0:Ny - 1, 0:Nx - 1] + xymask\n\n newaxis = np.newaxis\n compress = np.compress\n\n ravelmask = (mask == 0).ravel()\n X1 = compress(ravelmask, ma.filled(X[0:-1, 0:-1]).ravel())\n Y1 = compress(ravelmask, ma.filled(Y[0:-1, 0:-1]).ravel())\n X2 = compress(ravelmask, ma.filled(X[1:, 0:-1]).ravel())\n Y2 = compress(ravelmask, ma.filled(Y[1:, 0:-1]).ravel())\n X3 = compress(ravelmask, ma.filled(X[1:, 1:]).ravel())\n Y3 = compress(ravelmask, ma.filled(Y[1:, 1:]).ravel())\n X4 = compress(ravelmask, ma.filled(X[0:-1, 1:]).ravel())\n Y4 = compress(ravelmask, ma.filled(Y[0:-1, 1:]).ravel())\n npoly = len(X1)\n\n xy = np.concatenate((X1[:, newaxis], Y1[:, newaxis],\n X2[:, newaxis], Y2[:, newaxis],\n X3[:, newaxis], Y3[:, newaxis],\n X4[:, newaxis], Y4[:, newaxis],\n X1[:, newaxis], Y1[:, newaxis]),\n axis=1)\n verts = xy.reshape((npoly, 5, 2))\n\n C = compress(ravelmask, ma.filled(C[0:Ny - 1, 0:Nx - 1]).ravel())\n\n linewidths = (0.25,)\n if 'linewidth' in kwargs:\n kwargs['linewidths'] = kwargs.pop('linewidth')\n kwargs.setdefault('linewidths', linewidths)\n\n if shading == 'faceted':\n edgecolors = 'k',\n else:\n edgecolors = 'none'\n if 'edgecolor' in kwargs:\n kwargs['edgecolors'] = kwargs.pop('edgecolor')\n ec = kwargs.setdefault('edgecolors', edgecolors)\n\n # aa setting will default via collections to patch.antialiased\n # unless the boundary is not stroked, in which case the\n # default will be False; with unstroked boundaries, aa\n # makes artifacts that are often disturbing.\n if 'antialiased' in kwargs:\n kwargs['antialiaseds'] = kwargs.pop('antialiased')\n if 'antialiaseds' not in kwargs and ec.lower() == \"none\":\n kwargs['antialiaseds'] = False\n\n collection = mcoll.PolyCollection(verts, **kwargs)\n\n collection.set_alpha(alpha)\n collection.set_array(C)\n if norm is not None:\n assert(isinstance(norm, mcolors.Normalize))\n collection.set_cmap(cmap)\n collection.set_norm(norm)\n collection.set_clim(vmin, vmax)\n collection.autoscale_None()\n self.grid(False)\n\n x = X.compressed()\n y = Y.compressed()\n\n ########################\n # PATCH FOR MPL 1.2.0rc2\n\n # Transform from native to data coordinates?\n t = collection._transform\n if (not isinstance(t, mtransforms.Transform) and\n hasattr(t, '_as_mpl_transform')):\n t = t._as_mpl_transform(self.axes)\n\n if t and any(t.contains_branch_seperately(self.transData)):\n trans_to_data = t - self.transData\n pts = np.vstack([x, y]).T.astype(np.float)\n transformed_pts = trans_to_data.transform(pts)\n x = transformed_pts[..., 0]\n y = transformed_pts[..., 1]\n\n # XXX Not a mpl 1.2 thing...\n no_inf = (x != np.inf) & (y != np.inf)\n x = x[no_inf]\n y = y[no_inf]\n\n # END OF PATCH\n ##############\n\n minx = np.amin(x)\n maxx = np.amax(x)\n miny = np.amin(y)\n maxy = np.amax(y)\n\n corners = (minx, miny), (maxx, maxy)\n self.update_datalim(corners)\n self.autoscale_view()\n self.add_collection(collection)\n return collection\n\n\nclass SimpleClippedTransform(mtransforms.Transform):\n \"\"\"\n Transforms the values using a pre transform, clips them, then post\n transforms them.\n\n This transform should not be widely used, but is useful for transforming\n a background patch and clipping the patch to a desired extent.\n\n \"\"\"\n input_dims = 2\n output_dims = 2\n has_inverse = True\n\n def __init__(self, pre_clip_transform, post_clip_transform,\n xclip=(0, 1), yclip=(0, 1)):\n \"\"\"\n Create the transform.\n\n Args:\n\n * pre_clip_transform - A :class:`matplotlib.transforms.Transform`.\n * post_clip_transform - A :class:`matplotlib.transforms.Transform`.\n * xclip - Defaults to (0,1).\n * yclip - Defaults to (0,1).\n\n \"\"\"\n mtransforms.Transform.__init__(self)\n self.pre_clip_transform = pre_clip_transform\n self.post_clip_transform = post_clip_transform\n\n self.x_clips = xclip\n self.y_clips = yclip\n\n def transform_non_affine(self, values):\n \"\"\"\n Transforms from source to target coordinates.\n\n Args:\n\n * value - An (n,2) array of points in source coordinates.\n\n Returns:\n\n * An (n,2) array of transformed points in target coordinates.\n\n \"\"\"\n new_vals = self.pre_clip_transform.transform(values)\n x, y = new_vals[:, 0:1], new_vals[:, 1:2]\n numpy.clip(x, self.x_clips[0], self.x_clips[1], x)\n numpy.clip(y, self.y_clips[0], self.y_clips[1], y)\n # XXX support ma's?\n return self.post_clip_transform.transform(new_vals)\n\n def inverted(self):\n \"\"\"\n Return a matplotlib :class:`~matplotlib.transforms.Transform` from\n target to source coordinates.\n\n \"\"\"\n return (self.pre_clip_transform + self.post_clip_transform).inverted()\n","path":"lib/cartopy/mpl/geoaxes.py"}],"string":"[\n {\n \"content\": \"# (C) British Crown Copyright 2011 - 2012, Met Office\\n#\\n# This file is part of cartopy.\\n#\\n# cartopy is free software: you can redistribute it and/or modify it under\\n# the terms of the GNU Lesser General Public License as published by the\\n# Free Software Foundation, either version 3 of the License, or\\n# (at your option) any later version.\\n#\\n# cartopy is distributed in the hope that it will be useful,\\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\\n# GNU Lesser General Public License for more details.\\n#\\n# You should have received a copy of the GNU Lesser General Public License\\n# along with cartopy. If not, see <http://www.gnu.org/licenses/>.\\n\\\"\\\"\\\"\\nThis module defines the :class:`GeoAxes` class, for use with matplotlib.\\n\\nWhen a matplotlib figure contains a GeoAxes the plotting commands can transform\\nplot results from source coordinates to the GeoAxes' target projection.\\n\\n\\\"\\\"\\\"\\nimport warnings\\nimport weakref\\n\\nimport matplotlib.axes\\nfrom matplotlib.image import imread\\nimport matplotlib.transforms as mtransforms\\nimport matplotlib.patches as mpatches\\nimport matplotlib.path as mpath\\nimport matplotlib.collections as mcollections\\nimport numpy\\nimport shapely.geometry\\n\\nimport cartopy.crs as ccrs\\nimport cartopy.feature\\nimport cartopy.img_transform\\nimport cartopy.mpl.feature_artist as feature_artist\\nimport cartopy.mpl.patch as patch\\n\\n\\nimport matplotlib\\nassert matplotlib.__version__ >= '1.2', ('Cartopy can only work with '\\n 'matplotlib 1.2 or greater.')\\n\\n\\n_PATH_TRANSFORM_CACHE = weakref.WeakKeyDictionary()\\n\\\"\\\"\\\"\\nA nested mapping from path, source CRS, and target projection to the\\nresulting transformed paths::\\n\\n {path: {(source_crs, target_projection): list_of_paths}}\\n\\nProvides a significant performance boost for contours which, at\\nmatplotlib 1.2.0 called transform_path_non_affine twice unnecessarily.\\n\\n\\\"\\\"\\\"\\n\\n\\n# XXX call this InterCRSTransform\\nclass InterProjectionTransform(mtransforms.Transform):\\n \\\"\\\"\\\"\\n Transforms coordinates from the source_projection to\\n the ``target_projection``.\\n\\n \\\"\\\"\\\"\\n input_dims = 2\\n output_dims = 2\\n is_separable = False\\n has_inverse = True\\n\\n def __init__(self, source_projection, target_projection):\\n \\\"\\\"\\\"\\n Create the transform object from the given projections.\\n\\n Args:\\n\\n * source_projection - A :class:`~cartopy.crs.CRS`.\\n * target_projection - A :class:`~cartopy.crs.CRS`.\\n\\n \\\"\\\"\\\"\\n # assert target_projection is cartopy.crs.Projection\\n # assert source_projection is cartopy.crs.CRS\\n self.source_projection = source_projection\\n self.target_projection = target_projection\\n mtransforms.Transform.__init__(self)\\n\\n def __repr__(self):\\n return ('< {!s} {!s} -> {!s} >'.format(self.__class__.__name__,\\n self.source_projection,\\n self.target_projection))\\n\\n def transform_non_affine(self, xy):\\n \\\"\\\"\\\"\\n Transforms from source to target coordinates.\\n\\n Args:\\n\\n * xy - An (n,2) array of points in source coordinates.\\n\\n Returns:\\n\\n * An (n,2) array of transformed points in target coordinates.\\n\\n \\\"\\\"\\\"\\n prj = self.target_projection\\n if isinstance(xy, numpy.ndarray):\\n return prj.transform_points(self.source_projection,\\n xy[:, 0], xy[:, 1])[:, 0:2]\\n else:\\n x, y = xy\\n x, y = prj.transform_point(x, y, self.source_projection)\\n return x, y\\n\\n def transform_path_non_affine(self, src_path):\\n \\\"\\\"\\\"\\n Transforms from source to target coordinates.\\n\\n Caches results, so subsequent calls with the same *src_path* argument\\n (and the same source and target projections) are faster.\\n\\n Args:\\n\\n * src_path - A matplotlib :class:`~matplotlib.path.Path` object\\n with vertices in source coordinates.\\n\\n Returns\\n\\n * A matplotlib :class:`~matplotlib.path.Path` with vertices\\n in target coordinates.\\n\\n \\\"\\\"\\\"\\n mapping = _PATH_TRANSFORM_CACHE.get(src_path)\\n if mapping is not None:\\n key = (self.source_projection, self.target_projection)\\n result = mapping.get(key)\\n if result is not None:\\n return result\\n\\n bypass = self.source_projection == self.target_projection\\n if bypass:\\n projection = self.source_projection\\n if isinstance(projection, ccrs._CylindricalProjection):\\n x = src_path.vertices[:, 0]\\n x_limits = projection.x_limits\\n bypass = x.min() >= x_limits[0] and x.max() <= x_limits[1]\\n if bypass:\\n return src_path\\n\\n if src_path.vertices.shape == (1, 2):\\n return mpath.Path(self.transform(src_path.vertices))\\n\\n transformed_geoms = []\\n for geom in patch.path_to_geos(src_path):\\n transformed_geoms.append(\\n self.target_projection.project_geometry(geom,\\n self.source_projection)\\n )\\n\\n if not transformed_geoms:\\n result = mpath.Path(numpy.empty([0, 2]))\\n else:\\n paths = patch.geos_to_path(transformed_geoms)\\n if not paths:\\n return mpath.Path(numpy.empty([0, 2]))\\n points, codes = zip(*[patch.path_segments(path, curves=False,\\n simplify=False)\\n for path in paths])\\n result = mpath.Path(numpy.concatenate(points, 0),\\n numpy.concatenate(codes))\\n\\n # store the result in the cache for future performance boosts\\n key = (self.source_projection, self.target_projection)\\n if mapping is None:\\n _PATH_TRANSFORM_CACHE[src_path] = {key: result}\\n else:\\n mapping[key] = result\\n\\n return result\\n\\n def inverted(self):\\n \\\"\\\"\\\"\\n Return a matplotlib :class:`~matplotlib.transforms.Transform`\\n from target to source coordinates.\\n\\n \\\"\\\"\\\"\\n return InterProjectionTransform(self.target_projection,\\n self.source_projection)\\n\\n\\nclass GeoAxes(matplotlib.axes.Axes):\\n \\\"\\\"\\\"\\n A subclass of :class:`matplotlib.axes.Axes` which represents a\\n map :class:`~cartopy.crs.Projection`.\\n\\n This class replaces the matplotlib :class:`~matplotlib.axes.Axes` class\\n when created with the *projection* keyword. For example:\\n\\n # Set up a standard map for latlon data.\\n geo_axes = pyplot.axes(projection=cartopy.crs.PlateCarree())\\n\\n # Set up an OSGB map.\\n geo_axes = pyplot.subplot(2, 2, 1, projection=cartopy.crs.OSGB())\\n\\n When a source projection is provided to one of it's plotting methods,\\n using the *transform* keyword, the standard matplotlib plot result is\\n transformed from source coordinates to the target projection. For example:\\n\\n # Plot latlon data on an OSGB map.\\n pyplot.axes(projection=cartopy.crs.OSGB())\\n pyplot.contourf(x, y, data, transform=cartopy.crs.PlateCarree())\\n\\n \\\"\\\"\\\"\\n def __init__(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Create a GeoAxes object using standard matplotlib\\n :class:`~matplotlib.axes.Axes` args and keywords.\\n\\n Kwargs:\\n\\n * map_projection - The target :class:`~cartopy.crs.Projection` of\\n this Axes object.\\n\\n All other args and keywords are passed straight through to\\n :class:`matplotlib.axes.Axes`.\\n\\n \\\"\\\"\\\"\\n self.projection = kwargs.pop('map_projection')\\n super(GeoAxes, self).__init__(*args, **kwargs)\\n self._gridliners = []\\n self.img_factories = []\\n self._done_img_factory = False\\n\\n def add_image(self, factory, *args, **kwargs):\\n \\\"\\\"\\\"\\n Adds an image \\\"factory\\\" to the Axes.\\n\\n Any image \\\"factory\\\" added, will be asked to retrieve an image\\n with associated metadata for a given bounding box at draw time.\\n The advantage of this approach is that the limits of the map\\n do not need to be known when adding the image factory, but can\\n be deferred until everything which can effect the limits has been\\n added.\\n\\n Currently an image \\\"factory\\\" is just an object with\\n a ``image_for_domain`` method. Examples of image factories\\n are :class:`cartopy.io.img_nest.NestedImageCollection` and\\n :class:`cartopy.io.image_tiles.GoogleTiles`.\\n\\n \\\"\\\"\\\"\\n # XXX TODO: Needs working on\\n self.img_factories.append([factory, args, kwargs])\\n\\n @matplotlib.axes.allow_rasterization\\n def draw(self, renderer=None, inframe=False):\\n \\\"\\\"\\\"\\n Extends the standard behaviour of :func:`matplotlib.axes.Axes.draw`.\\n\\n Draws grid lines and image factory results before invoking standard\\n matplotlib drawing. A global range is used if no limits have yet\\n been set.\\n\\n \\\"\\\"\\\"\\n # if no data has been added, and no extents set, then make the\\n # map global\\n if self.ignore_existing_data_limits and \\\\\\n self._autoscaleXon and self._autoscaleYon:\\n self.set_global()\\n self.ignore_existing_data_limits = True\\n\\n for gl in self._gridliners:\\n gl.do_gridlines(background_patch=self.background_patch)\\n self._gridliners = []\\n\\n # XXX This interface needs a tidy up:\\n # image drawing on pan/zoom;\\n # caching the resulting image;\\n # buffering the result by 10%...;\\n if not self._done_img_factory:\\n for factory, args, kwargs in self.img_factories:\\n img, extent, origin = factory.image_for_domain(\\n self._get_extent_geom(factory.crs), args[0])\\n self.imshow(img, extent=extent, origin=origin,\\n transform=factory.crs, *args[1:], **kwargs)\\n self._done_img_factory = True\\n\\n return matplotlib.axes.Axes.draw(self, renderer=renderer,\\n inframe=inframe)\\n\\n def __str__(self):\\n return '< GeoAxes: %s >' % self.projection\\n\\n def cla(self):\\n \\\"\\\"\\\"Clears the current axes and adds boundary lines.\\\"\\\"\\\"\\n result = matplotlib.axes.Axes.cla(self)\\n self.xaxis.set_visible(False)\\n self.yaxis.set_visible(False)\\n self.autoscale_view(tight=True)\\n self.set_aspect('equal')\\n\\n pre_bounary = self.ignore_existing_data_limits\\n self._boundary()\\n self.ignore_existing_data_limits = pre_bounary\\n\\n # XXX consider a margin - but only when the map is not global...\\n # self._xmargin = 0.15\\n # self._ymargin = 0.15\\n\\n return result\\n\\n def format_coord(self, x, y):\\n \\\"\\\"\\\"Return a string formatted for the matplotlib GUI status bar.\\\"\\\"\\\"\\n lon, lat = ccrs.Geodetic().transform_point(x, y, self.projection)\\n\\n ns = 'N' if lat >= 0.0 else 'S'\\n ew = 'E' if lon >= 0.0 else 'W'\\n\\n return u'%.4g, %.4g (%f\\\\u00b0%s, %f\\\\u00b0%s)' % (x, y, abs(lat),\\n ns, abs(lon), ew)\\n\\n def coastlines(self, resolution='110m', color='black', **kwargs):\\n \\\"\\\"\\\"\\n Adds coastal **outlines** to the current axes from the Natural Earth\\n \\\"coastline\\\" shapefile collection.\\n\\n Kwargs:\\n\\n * resolution - a named resolution to use from the Natural Earth\\n dataset. Currently can be one of \\\"110m\\\", \\\"50m\\\", and\\n \\\"10m\\\".\\n\\n .. note::\\n\\n Currently no clipping is done on the coastlines before adding\\n them to the axes. This means, if very high resolution coastlines\\n are being used, performance is likely to be severely effected.\\n This should be resolved transparently by v0.5.\\n\\n \\\"\\\"\\\"\\n kwargs['edgecolor'] = color\\n kwargs['facecolor'] = 'none'\\n feature = cartopy.feature.NaturalEarthFeature('physical', 'coastline',\\n resolution, **kwargs)\\n return self.add_feature(feature)\\n\\n def natural_earth_shp(self, name='land', resolution='110m',\\n category='physical', **kwargs):\\n \\\"\\\"\\\"\\n Adds the geometries from the specified Natural Earth shapefile to the\\n Axes as a :class:`~matplotlib.collections.PathCollection`.\\n\\n ``**kwargs`` are passed through to the\\n :class:`~matplotlib.collections.PathCollection` constructor.\\n\\n Returns the created :class:`~matplotlib.collections.PathCollection`.\\n\\n .. note::\\n\\n Currently no clipping is done on the geometries before adding them\\n to the axes. This means, if very high resolution geometries are\\n being used, performance is likely to be severely effected. This\\n should be resolved transparently by v0.5.\\n\\n \\\"\\\"\\\"\\n warnings.warn('This method has been deprecated.'\\n ' Please use `add_feature` instead.')\\n kwargs.setdefault('edgecolor', 'face')\\n kwargs.setdefault('facecolor', cartopy.feature._COLOURS['land'])\\n feature = cartopy.feature.NaturalEarthFeature(category, name,\\n resolution, **kwargs)\\n return self.add_feature(feature)\\n\\n def add_feature(self, feature, **kwargs):\\n \\\"\\\"\\\"\\n Adds the given :class:`~cartopy.feature.Feature` instance to the axes.\\n\\n Args:\\n\\n * feature:\\n An instance of :class:`~cartopy.feature.Feature`.\\n\\n Kwargs:\\n Keyword arguments to be used when drawing the feature. This allows\\n standard matplotlib control over aspects such as 'facecolor',\\n 'alpha', etc.\\n\\n Returns:\\n * A :class:`cartopy.mpl_integration.feature_artist.FeatureArtist`\\n instance responsible for drawing the feature.\\n\\n \\\"\\\"\\\"\\n # Instantiate an artist to draw the feature and add it to the axes.\\n artist = feature_artist.FeatureArtist(feature, **kwargs)\\n return self.add_artist(artist)\\n\\n def add_geometries(self, geoms, crs, **kwargs):\\n \\\"\\\"\\\"\\n Add the given shapely geometries (in the given crs) to the axes.\\n\\n Args:\\n\\n * geoms:\\n A collection of shapely geometries.\\n * crs:\\n The cartopy CRS in which the provided geometries are defined.\\n\\n Kwargs:\\n Keyword arguments to be used when drawing this feature.\\n\\n Returns:\\n * A :class:`cartopy.mpl_integration.feature_artist.FeatureArtist`\\n instance responsible for drawing the geometries.\\n\\n \\\"\\\"\\\"\\n feature = cartopy.feature.ShapelyFeature(geoms, crs, **kwargs)\\n return self.add_feature(feature)\\n\\n def get_extent(self, crs=None):\\n \\\"\\\"\\\"\\n Get the extent (x0, x1, y0, y1) of the map in the given coordinate\\n system.\\n\\n If no crs is given, the returned extents' coordinate system will be\\n assumed to be the Geodetic version of this axes' projection.\\n\\n \\\"\\\"\\\"\\n p = self._get_extent_geom(crs)\\n r = p.bounds\\n x1, y1, x2, y2 = r\\n return x1, x2, y1, y2\\n\\n def _get_extent_geom(self, crs=None):\\n # Perform the calculations for get_extent(), which just repackages it.\\n x1, x2 = self.get_xlim()\\n y1, y2 = self.get_ylim()\\n\\n if x1 == 0 and y1 == 0 and x2 == 1 and y2 == 1:\\n x1, x2 = self.projection.x_limits\\n y1, y2 = self.projection.y_limits\\n\\n domain_in_src_proj = shapely.geometry.Polygon([[x1, y1], [x2, y1],\\n [x2, y2], [x1, y2],\\n [x1, y1]])\\n\\n # Determine target projection based on requested CRS.\\n if crs is None:\\n proj = self.projection\\n elif isinstance(crs, ccrs.Projection):\\n proj = crs\\n else:\\n # Attempt to select suitable projection for\\n # non-projection CRS.\\n if isinstance(crs, ccrs.RotatedGeodetic):\\n proj = ccrs.RotatedPole(crs.proj4_params['lon_0'] - 180,\\n crs.proj4_params['o_lat_p'])\\n warnings.warn('Approximating coordinate system {!r} with a '\\n 'RotatedPole projection.'.format(crs))\\n elif hasattr(crs, 'is_geodetic') and crs.is_geodetic():\\n proj = ccrs.PlateCarree()\\n warnings.warn('Approximating coordinate system {!r} with the '\\n 'PlateCarree projection.'.format(crs))\\n else:\\n raise ValueError('Cannot determine extent in'\\n ' coordinate system {!r}'.format(crs))\\n\\n # Calculate intersection with boundary and project if necesary.\\n boundary_poly = shapely.geometry.Polygon(self.projection.boundary)\\n if proj != self.projection:\\n # Erode boundary by threshold to avoid transform issues.\\n # This is a workaround for numerical issues at the boundary.\\n eroded_boundary = boundary_poly.buffer(-self.projection.threshold)\\n geom_in_src_proj = eroded_boundary.intersection(\\n domain_in_src_proj)\\n geom_in_crs = proj.project_geometry(geom_in_src_proj,\\n self.projection)\\n else:\\n geom_in_crs = boundary_poly.intersection(domain_in_src_proj)\\n\\n return geom_in_crs\\n\\n def set_extent(self, extents, crs=None):\\n \\\"\\\"\\\"\\n Set the extent (x0, x1, y0, y1) of the map in the given\\n coordinate system.\\n\\n If no crs is given, the extents' coordinate system will be assumed\\n to be the Geodetic version of this axes' projection.\\n\\n \\\"\\\"\\\"\\n # TODO: Implement the same semantics as plt.xlim and\\n # plt.ylim - allowing users to set None for a minimum and/or\\n # maximum value\\n x1, x2, y1, y2 = extents\\n domain_in_crs = shapely.geometry.LineString([[x1, y1], [x2, y1],\\n [x2, y2], [x1, y2],\\n [x1, y1]])\\n\\n r = self.projection.project_geometry(domain_in_crs, crs)\\n x1, y1, x2, y2 = r.bounds\\n self.set_xlim([x1, x2])\\n self.set_ylim([y1, y2])\\n\\n def set_global(self):\\n \\\"\\\"\\\"\\n Set the extent of the Axes to the limits of the projection.\\n\\n .. note::\\n\\n In some cases where the projection has a limited sensible range\\n the ``set_global`` method does not actually make the whole globe\\n visible. Instead, the most appropriate extents will be used (e.g.\\n Ordnance Survey UK will set the extents to be around the British\\n Isles.\\n\\n \\\"\\\"\\\"\\n self.set_xlim(self.projection.x_limits)\\n self.set_ylim(self.projection.y_limits)\\n\\n def set_xticks(self, ticks, minor=False, crs=None):\\n \\\"\\\"\\\"\\n Set the x ticks.\\n\\n Args:\\n\\n * ticks - list of floats denoting the desired position of x ticks.\\n\\n Kwargs:\\n\\n * minor - boolean flag indicating whether the ticks should be minor\\n ticks i.e. small and unlabelled (default is False).\\n\\n * crs - An instance of :class:`~cartopy.crs.CRS` indicating the\\n coordinate system of the provided tick values. If no\\n coordinate system is specified then the values are assumed\\n to be in the coordinate system of the projection.\\n\\n .. note::\\n\\n This method is limited to cylindrical projections.\\n\\n .. note::\\n\\n This interface is subject to change whilst functionality is added\\n to support other map projections.\\n\\n \\\"\\\"\\\"\\n if not isinstance(self.projection, (ccrs._RectangularProjection,\\n ccrs._CylindricalProjection,\\n ccrs.OSGB)):\\n raise RuntimeError('Cannot set xticks for not-cylindrical '\\n 'coordinate systems.')\\n\\n # Switch on drawing of x axis\\n self.xaxis.set_visible(True)\\n\\n # Project ticks if crs differs from axes' projection\\n if crs is not None and crs != self.projection:\\n proj_xyz = self.projection.transform_points(crs,\\n numpy.asarray(ticks),\\n numpy.zeros(len(ticks))\\n )\\n xticks = proj_xyz[..., 0]\\n else:\\n xticks = ticks\\n\\n return super(GeoAxes, self).set_xticks(xticks, minor)\\n\\n def set_yticks(self, ticks, minor=False, crs=None):\\n \\\"\\\"\\\"\\n Set the y ticks.\\n\\n Args:\\n\\n * ticks - list of floats denoting the desired position of y ticks.\\n\\n Kwargs:\\n\\n * minor - boolean flag indicating whether the ticks should be minor\\n ticks i.e. small and unlabelled (default is False).\\n\\n * crs - An instance of :class:`~cartopy.crs.CRS` indicating the\\n coordinate system of the provided tick values. If no\\n coordinate system is specified then the values are assumed\\n to be in the coordinate system of the projection.\\n\\n .. note::\\n\\n This method is limited to cylindrical projections.\\n\\n .. note::\\n\\n This interface is subject to change whilst functionality is added\\n to support other map projections.\\n\\n \\\"\\\"\\\"\\n if not isinstance(self.projection, (ccrs._RectangularProjection,\\n ccrs._CylindricalProjection,\\n ccrs.OSGB)):\\n raise RuntimeError('Cannot set yticks for non-cylindrical '\\n 'coordinate systems.')\\n\\n # Switch on drawing of y axis\\n self.yaxis.set_visible(True)\\n\\n # Project ticks if crs differs from axes' projection\\n if crs is not None and crs != self.projection:\\n prj = self.projection\\n proj_xyz = prj.transform_points(crs,\\n numpy.zeros(len(ticks)),\\n numpy.asarray(ticks))\\n yticks = proj_xyz[..., 1]\\n else:\\n yticks = ticks\\n\\n return super(GeoAxes, self).set_yticks(yticks, minor)\\n\\n# def geod_circle_meters(self, lon_0, lat_0, radius, npts=80, **kwargs):\\n# # radius is in meters\\n# geod = self.projection.as_geodetic()\\n#\\n# az = numpy.linspace(0, 360, npts)\\n# lats = numpy.zeros(npts) + lat_0\\n# lons = numpy.zeros(npts) + lon_0\\n# distances = numpy.zeros(npts) + radius\\n#\\n# lons, lats, _reverse_az = geod.fwd(lons, lats, az, distances,\\n# radians=False)\\n# ll = numpy.concatenate([lons[:, None], lats[:, None]], 1)\\n# from matplotlib.patches import Polygon\\n# poly = Polygon(ll, transform=cartopy.prj.PlateCarree(), **kwargs)\\n# self.add_patch(poly)\\n# return poly\\n#\\n# def gshhs_line(self, outline_color='k', domain=None,\\n# resolution='low', **kwargs):\\n# # domain is a shapely geometry (Polygon or MultiPolygon)\\n# import cartopy.gshhs as gshhs\\n## import cartopy.spherical as spherical\\n# from matplotlib.collections import PatchCollection, LineCollection\\n#\\n# paths = []\\n#\\n# projection = self.projection\\n#\\n# if domain is None:\\n# domain = self.map_domain(ccrs.PlateCarree())\\n#\\n# for points in gshhs.read_gshhc(gshhs.fnames[resolution],\\n# poly=False, domain=domain):\\n# paths.extend(patch.geos_to_path(\\n# shapely.geometry.LineString(points))\\n# )\\n#\\n## slinestring = shapely.geometry.LineString(points)\\n## projected = projection.project_geometry(slinestring)\\n## paths.extend(patch.geos_to_path(projected))\\n#\\n# collection = PatchCollection([mpatches.PathPatch(pth)\\n# for pth in paths],\\n# edgecolor=outline_color, facecolor='none',\\n# transform=ccrs.PlateCarree(),\\n# **kwargs\\n# )\\n#\\n# self.add_collection(collection, autolim=False)\\n\\n def stock_img(self, name='ne_shaded'):\\n \\\"\\\"\\\"\\n Add a standard image to the map.\\n\\n Currently, the only (and default) option is a downsampled version of\\n the Natural Earth shaded relief raster.\\n\\n \\\"\\\"\\\"\\n if name == 'ne_shaded':\\n import os\\n source_proj = ccrs.PlateCarree()\\n fname = os.path.join(os.path.dirname(os.path.dirname(__file__)),\\n 'data', 'raster', 'natural_earth',\\n '50-natural-earth-1-downsampled.png')\\n img_origin = 'lower'\\n img = imread(fname)\\n img = img[::-1]\\n return self.imshow(img, origin=img_origin, transform=source_proj,\\n extent=[-180, 180, -90, 90])\\n else:\\n raise ValueError('Unknown stock image %r.' % name)\\n\\n def imshow(self, img, *args, **kwargs):\\n \\\"\\\"\\\"\\n Add the \\\"transform\\\" keyword to :func:`~matplotlib.pyplot.imshow'.\\n\\n Extra kwargs:\\n\\n transform - a :class:`~cartopy.crs.Projection`.\\n\\n regrid_shape - default is (750, 375). But may be changed to \\\"auto\\\"\\n in the future...\\n\\n extent = (left, right, bottom, top) - transform coordinates for\\n the extent of the source\\n image.\\n\\n target_extent = (left, right, bottom, top) - native coordinates\\n for the extent of\\n the desired image.\\n\\n origin - default is changed to 'lower'\\n\\n update_datalim - flag whether the image should affect the data\\n limits (default: True)\\n\\n \\\"\\\"\\\"\\n transform = kwargs.pop('transform', None)\\n regrid_shape = kwargs.pop('regrid_shape', (750, 375))\\n update_datalim = kwargs.pop('update_datalim', True)\\n\\n kwargs.setdefault('origin', 'lower')\\n\\n same_projection = (isinstance(transform, ccrs.Projection) and\\n self.projection == transform)\\n\\n if not update_datalim:\\n data_lim = self.dataLim.frozen().get_points()\\n view_lim = self.viewLim.frozen().get_points()\\n\\n if transform is None or transform == self.transData or same_projection:\\n if isinstance(transform, ccrs.Projection):\\n transform = transform._as_mpl_transform(self)\\n result = matplotlib.axes.Axes.imshow(self, img, *args, **kwargs)\\n else:\\n extent = kwargs.pop('extent', None)\\n\\n if not isinstance(transform, ccrs.Projection):\\n raise ValueError('Expected a projection subclass. Cannot '\\n 'handle a %s in imshow.' % type(transform))\\n\\n warp_array = cartopy.img_transform.warp_array\\n target_extent = self.get_extent(self.projection)\\n # XXX adaptive resolution depending on incoming img?\\n img, extent = warp_array(img,\\n source_proj=transform,\\n source_extent=extent,\\n target_proj=self.projection,\\n target_res=regrid_shape,\\n target_extent=target_extent,\\n )\\n # as a workaround to a matplotlib limitation, turn any images\\n # which are RGB with a mask into RGBA images with an alpha\\n # channel.\\n if (isinstance(img, numpy.ma.MaskedArray) and\\n img.shape[2:3] == (3, ) and\\n img.mask is not False):\\n old_img = img\\n img = numpy.zeros(img.shape[:2] + (4, ))\\n img[:, :, 0:3] = old_img\\n # put an alpha channel in if the image was masked\\n img[:, :, 3] = ~ numpy.any(old_img.mask, axis=2)\\n\\n result = matplotlib.axes.Axes.imshow(self, img, *args,\\n extent=extent, **kwargs)\\n\\n # clip the image. This does not work as the patch moves with mouse\\n # movement, but the clip path doesn't\\n # This could definitely be fixed in matplotlib\\n# if result.get_clip_path() in [None, self.patch]:\\n# # image does not already have clipping set, clip to axes patch\\n# result.set_clip_path(self.outline_patch)\\n\\n if not update_datalim:\\n self.dataLim.set_points(data_lim)\\n self.viewLim.set_points(view_lim)\\n\\n return result\\n\\n def gridlines(self, crs=None, **kwargs):\\n \\\"\\\"\\\"\\n Automatically adds gridlines to the axes, in the given coordinate\\n system, at draw time.\\n\\n ``**kwargs`` - are passed through to the created\\n :class:`matplotlib.collections.Collection`\\n allowing control of colors and linewidths etc.\\n\\n \\\"\\\"\\\"\\n if crs is None:\\n crs = ccrs.PlateCarree()\\n from cartopy.mpl.gridliner import Gridliner\\n gl = Gridliner(self, crs=crs, collection_kwargs=kwargs)\\n self._gridliners.append(gl)\\n return gl\\n\\n def _gen_axes_spines(self, locations=None, offset=0.0, units='inches'):\\n # generate some axes spines, as some Axes super class machinery\\n # requires them. Just make them invisible\\n spines = matplotlib.axes.Axes._gen_axes_spines(self,\\n locations=locations,\\n offset=offset,\\n units=units)\\n for spine in spines.itervalues():\\n spine.set_visible(False)\\n return spines\\n\\n def _boundary(self):\\n \\\"\\\"\\\"\\n Adds the map's boundary.\\n\\n Note:\\n\\n The boundary is not the axes.patch, which provides rectilinear\\n clipping for all of the map's artists.\\n\\n The axes.patch will have its visibility set to False inside\\n GeoAxes.gca()\\n \\\"\\\"\\\"\\n import cartopy.mpl.patch as p\\n path, = p.geos_to_path(self.projection.boundary)\\n\\n# from matplotlib.collections import PatchCollection\\n\\n sct = SimpleClippedTransform(self.transScale + self.transLimits,\\n self.transAxes)\\n\\n # XXX Should be exactly one path...\\n collection = mpatches.PathPatch(path,\\n facecolor='none', edgecolor='k',\\n zorder=1000,\\n # transform=self.transData,\\n transform=sct, clip_on=False,\\n )\\n self.outline_patch = collection\\n # XXX autolim = False\\n self.add_patch(collection)\\n\\n # put a color patch for background color\\n # XXX Should be exactly one path...\\n collection = mpatches.PathPatch(path,\\n facecolor='w', edgecolor='none',\\n zorder=-1, transform=sct,\\n clip_on=False,\\n )\\n self.background_patch = collection\\n # XXX autolim = False\\n self.add_patch(collection)\\n\\n self.patch.set_facecolor((1, 1, 1, 0))\\n self.patch.set_edgecolor((0.5, 0.5, 0.5))\\n self.patch.set_linewidth(0.0)\\n\\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\\n def contour(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Add the \\\"transform\\\" keyword to :func:`~matplotlib.pyplot.contour'.\\n\\n Extra kwargs:\\n\\n transform - a :class:`~cartopy.crs.Projection`.\\n\\n \\\"\\\"\\\"\\n t = kwargs.get('transform', None)\\n # Keep this bit - even at mpl v1.2\\n if t is None:\\n t = self.projection\\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\\n raise ValueError('invalid transform:'\\n ' Spherical contouring is not supported - '\\n ' consider using PlateCarree/RotatedPole.')\\n if isinstance(t, ccrs.Projection):\\n kwargs['transform'] = t._as_mpl_transform(self)\\n else:\\n kwargs['transform'] = t\\n return matplotlib.axes.Axes.contour(self, *args, **kwargs)\\n\\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\\n def contourf(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Add the \\\"transform\\\" keyword to :func:`~matplotlib.pyplot.contourf'.\\n\\n Extra kwargs:\\n\\n transform - a :class:`~cartopy.crs.Projection`.\\n\\n \\\"\\\"\\\"\\n t = kwargs.get('transform', None)\\n # Keep this bit - even at mpl v1.2\\n if t is None:\\n t = self.projection\\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\\n raise ValueError('invalid transform:'\\n ' Spherical contouring is not supported - '\\n ' consider using PlateCarree/RotatedPole.')\\n if isinstance(t, ccrs.Projection):\\n kwargs['transform'] = t._as_mpl_transform(self)\\n else:\\n kwargs['transform'] = t\\n return matplotlib.axes.Axes.contourf(self, *args, **kwargs)\\n\\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\\n def scatter(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Add the \\\"transform\\\" keyword to :func:`~matplotlib.pyplot.scatter'.\\n\\n Extra kwargs:\\n\\n transform - a :class:`~cartopy.crs.Projection`.\\n\\n \\\"\\\"\\\"\\n t = kwargs.get('transform', None)\\n # Keep this bit - even at mpl v1.2\\n if t is None:\\n t = self.projection\\n if hasattr(t, '_as_mpl_transform'):\\n kwargs['transform'] = t._as_mpl_transform(self)\\n\\n # exclude Geodetic as a vaild source CS\\n if (isinstance(kwargs.get('transform', None),\\n InterProjectionTransform) and\\n kwargs['transform'].source_projection.is_geodetic()):\\n raise ValueError('Cartopy cannot currently do spherical '\\n 'contouring. The source CRS cannot be a '\\n 'geodetic, consider using the cyllindrical form '\\n '(PlateCarree or RotatedPole).')\\n\\n return matplotlib.axes.Axes.scatter(self, *args, **kwargs)\\n\\n def pcolormesh(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Add the \\\"transform\\\" keyword to :func:`~matplotlib.pyplot.pcolormesh'.\\n\\n Extra kwargs:\\n\\n transform - a :class:`~cartopy.crs.Projection`.\\n\\n \\\"\\\"\\\"\\n t = kwargs.get('transform', None)\\n if t is None:\\n t = self.projection\\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\\n raise ValueError('invalid transform:'\\n ' Spherical pcolormesh is not supported - '\\n ' consider using PlateCarree/RotatedPole.')\\n kwargs.setdefault('transform', t)\\n return self._pcolormesh_patched(*args, **kwargs)\\n\\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\\n def _pcolormesh_patched(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n A temporary, modified duplicate of\\n :func:`~matplotlib.pyplot.pcolormesh'.\\n\\n This function contains a workaround for a matplotlib issue\\n and will be removed once the issue has been resolved.\\n https://github.com/matplotlib/matplotlib/pull/1314\\n\\n \\\"\\\"\\\"\\n import warnings\\n import numpy as np\\n import numpy.ma as ma\\n import matplotlib as mpl\\n import matplotlib.cbook as cbook\\n import matplotlib.colors as mcolors\\n import matplotlib.cm as cm\\n from matplotlib import docstring\\n import matplotlib.transforms as transforms\\n import matplotlib.artist as artist\\n from matplotlib.artist import allow_rasterization\\n import matplotlib.backend_bases as backend_bases\\n import matplotlib.path as mpath\\n import matplotlib.mlab as mlab\\n import matplotlib.collections as mcoll\\n\\n if not self._hold:\\n self.cla()\\n\\n alpha = kwargs.pop('alpha', None)\\n norm = kwargs.pop('norm', None)\\n cmap = kwargs.pop('cmap', None)\\n vmin = kwargs.pop('vmin', None)\\n vmax = kwargs.pop('vmax', None)\\n shading = kwargs.pop('shading', 'flat').lower()\\n antialiased = kwargs.pop('antialiased', False)\\n kwargs.setdefault('edgecolors', 'None')\\n\\n X, Y, C = self._pcolorargs('pcolormesh', *args)\\n Ny, Nx = X.shape\\n\\n # convert to one dimensional arrays\\n if shading != 'gouraud':\\n # data point in each cell is value at lower left corner\\n C = ma.ravel(C[0:Ny - 1, 0:Nx - 1])\\n else:\\n C = C.ravel()\\n X = X.ravel()\\n Y = Y.ravel()\\n\\n coords = np.zeros(((Nx * Ny), 2), dtype=float)\\n coords[:, 0] = X\\n coords[:, 1] = Y\\n\\n collection = mcoll.QuadMesh(\\n Nx - 1, Ny - 1, coords,\\n antialiased=antialiased, shading=shading, **kwargs)\\n collection.set_alpha(alpha)\\n collection.set_array(C)\\n if norm is not None:\\n assert(isinstance(norm, mcolors.Normalize))\\n collection.set_cmap(cmap)\\n collection.set_norm(norm)\\n collection.set_clim(vmin, vmax)\\n collection.autoscale_None()\\n\\n self.grid(False)\\n\\n ########################\\n # PATCH FOR MPL 1.2.0rc2\\n\\n # Transform from native to data coordinates?\\n t = collection._transform\\n if (not isinstance(t, mtransforms.Transform)\\n and hasattr(t, '_as_mpl_transform')):\\n t = t._as_mpl_transform(self.axes)\\n\\n if t and any(t.contains_branch_seperately(self.transData)):\\n trans_to_data = t - self.transData\\n pts = np.vstack([X, Y]).T.astype(np.float)\\n transformed_pts = trans_to_data.transform(pts)\\n\\n X = transformed_pts[..., 0]\\n Y = transformed_pts[..., 1]\\n\\n # XXX Not a mpl 1.2 thing...\\n no_inf = (X != np.inf) & (Y != np.inf)\\n X = X[no_inf]\\n Y = Y[no_inf]\\n\\n # END OF PATCH\\n ##############\\n\\n minx = np.amin(X)\\n maxx = np.amax(X)\\n miny = np.amin(Y)\\n maxy = np.amax(Y)\\n\\n corners = (minx, miny), (maxx, maxy)\\n self.update_datalim(corners)\\n self.autoscale_view()\\n self.add_collection(collection)\\n\\n # XXX Non-standard matplotlib 1.2 thing.\\n # Handle a possible wrap around for rectangular projections.\\n t = kwargs.get('transform', None)\\n if isinstance(t, ccrs.CRS):\\n if isinstance(t, ccrs._RectangularProjection) and \\\\\\n isinstance(self.projection, ccrs._RectangularProjection):\\n\\n C = C.reshape((Ny - 1, Nx - 1))\\n transformed_pts = transformed_pts.reshape((Ny, Nx, 2))\\n\\n # compute the vertical line angles of the pcolor in\\n # transformed coordinates\\n with numpy.errstate(invalid='ignore'):\\n horizontal_vert_angles = numpy.arctan2(\\n numpy.diff(transformed_pts[..., 0], axis=1),\\n numpy.diff(transformed_pts[..., 1], axis=1)\\n )\\n\\n # if the change in angle is greater than 90 degrees (absolute),\\n # then mark it for masking later on.\\n dx_horizontal = numpy.diff(horizontal_vert_angles)\\n to_mask = ((numpy.abs(dx_horizontal) > numpy.pi / 2) |\\n numpy.isnan(dx_horizontal))\\n\\n if numpy.any(to_mask):\\n # at this point C has a shape of (Ny-1, Nx-1), to_mask has\\n # a shape of (Ny, Nx-2) and pts has a shape of (Ny*Nx, 2)\\n\\n mask = numpy.zeros(C.shape, dtype=numpy.bool)\\n\\n # mask out the neighbouring cells if there was a cell\\n # found with an angle change of more than pi/2 . NB.\\n # Masking too much only has a detrimental impact on\\n # performance.\\n to_mask_y_shift = to_mask[:-1, :]\\n mask[:, :-1][to_mask_y_shift] = True\\n mask[:, 1:][to_mask_y_shift] = True\\n\\n to_mask_x_shift = to_mask[1:, :]\\n mask[:, :-1][to_mask_x_shift] = True\\n mask[:, 1:][to_mask_x_shift] = True\\n\\n C_mask = getattr(C, 'mask', None)\\n if C_mask is not None:\\n dmask = mask | C_mask\\n else:\\n dmask = mask\\n\\n # print 'Ratio of masked data: ',\\n # print numpy.sum(mask) / float(numpy.product(mask.shape))\\n\\n # create the masked array to be used with this pcolormesh\\n pcolormesh_data = numpy.ma.array(C, mask=mask)\\n\\n collection.set_array(pcolormesh_data.ravel())\\n\\n # now that the pcolormesh has masked the bad values,\\n # create a pcolor with just those values that were masked\\n pcolor_data = pcolormesh_data.copy()\\n # invert the mask\\n pcolor_data.mask = ~pcolor_data.mask\\n\\n # remember to re-apply the original data mask to the array\\n if C_mask is not None:\\n pcolor_data.mask = pcolor_data.mask | C_mask\\n\\n pts = pts.reshape((Ny, Nx, 2))\\n pcolor_col = self.pcolor(pts[..., 0], pts[..., 1],\\n pcolor_data, **kwargs)\\n pcolor_col.set_cmap(cmap)\\n pcolor_col.set_norm(norm)\\n pcolor_col.set_clim(vmin, vmax)\\n # scale the data according to the *original* data\\n pcolor_col.norm.autoscale_None(C)\\n\\n # put the pcolor_col on the pcolormesh collection so that\\n # if really necessary, users can do things post this method\\n collection._wrapped_collection_fix = pcolor_col\\n\\n return collection\\n\\n def pcolor(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Add the \\\"transform\\\" keyword to :func:`~matplotlib.pyplot.pcolor'.\\n\\n Extra kwargs:\\n\\n transform - a :class:`~cartopy.crs.Projection`.\\n\\n \\\"\\\"\\\"\\n t = kwargs.get('transform', None)\\n if t is None:\\n t = self.projection\\n if isinstance(t, ccrs.CRS) and not isinstance(t, ccrs.Projection):\\n raise ValueError('invalid transform:'\\n ' Spherical pcolor is not supported - '\\n ' consider using PlateCarree/RotatedPole.')\\n kwargs.setdefault('transform', t)\\n return self._pcolor_patched(*args, **kwargs)\\n\\n # mpl 1.2.0rc2 compatibility. To be removed once 1.2 is released\\n def _pcolor_patched(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n A temporary, modified duplicate of :func:`~matplotlib.pyplot.pcolor'.\\n\\n This function contains a workaround for a matplotlib issue\\n and will be removed once the issue has been resolved.\\n https://github.com/matplotlib/matplotlib/pull/1314\\n\\n \\\"\\\"\\\"\\n import warnings\\n import numpy as np\\n import numpy.ma as ma\\n import matplotlib as mpl\\n import matplotlib.cbook as cbook\\n import matplotlib.colors as mcolors\\n import matplotlib.cm as cm\\n from matplotlib import docstring\\n import matplotlib.transforms as transforms\\n import matplotlib.artist as artist\\n from matplotlib.artist import allow_rasterization\\n import matplotlib.backend_bases as backend_bases\\n import matplotlib.path as mpath\\n import matplotlib.mlab as mlab\\n import matplotlib.collections as mcoll\\n\\n if not self._hold:\\n self.cla()\\n\\n alpha = kwargs.pop('alpha', None)\\n norm = kwargs.pop('norm', None)\\n cmap = kwargs.pop('cmap', None)\\n vmin = kwargs.pop('vmin', None)\\n vmax = kwargs.pop('vmax', None)\\n shading = kwargs.pop('shading', 'flat')\\n\\n X, Y, C = self._pcolorargs('pcolor', *args)\\n Ny, Nx = X.shape\\n\\n # convert to MA, if necessary.\\n C = ma.asarray(C)\\n X = ma.asarray(X)\\n Y = ma.asarray(Y)\\n mask = ma.getmaskarray(X) + ma.getmaskarray(Y)\\n xymask = mask[0:-1, 0:-1] + mask[1:, 1:] + mask[0:-1, 1:] + \\\\\\n mask[1:, 0:-1]\\n # don't plot if C or any of the surrounding vertices are masked.\\n mask = ma.getmaskarray(C)[0:Ny - 1, 0:Nx - 1] + xymask\\n\\n newaxis = np.newaxis\\n compress = np.compress\\n\\n ravelmask = (mask == 0).ravel()\\n X1 = compress(ravelmask, ma.filled(X[0:-1, 0:-1]).ravel())\\n Y1 = compress(ravelmask, ma.filled(Y[0:-1, 0:-1]).ravel())\\n X2 = compress(ravelmask, ma.filled(X[1:, 0:-1]).ravel())\\n Y2 = compress(ravelmask, ma.filled(Y[1:, 0:-1]).ravel())\\n X3 = compress(ravelmask, ma.filled(X[1:, 1:]).ravel())\\n Y3 = compress(ravelmask, ma.filled(Y[1:, 1:]).ravel())\\n X4 = compress(ravelmask, ma.filled(X[0:-1, 1:]).ravel())\\n Y4 = compress(ravelmask, ma.filled(Y[0:-1, 1:]).ravel())\\n npoly = len(X1)\\n\\n xy = np.concatenate((X1[:, newaxis], Y1[:, newaxis],\\n X2[:, newaxis], Y2[:, newaxis],\\n X3[:, newaxis], Y3[:, newaxis],\\n X4[:, newaxis], Y4[:, newaxis],\\n X1[:, newaxis], Y1[:, newaxis]),\\n axis=1)\\n verts = xy.reshape((npoly, 5, 2))\\n\\n C = compress(ravelmask, ma.filled(C[0:Ny - 1, 0:Nx - 1]).ravel())\\n\\n linewidths = (0.25,)\\n if 'linewidth' in kwargs:\\n kwargs['linewidths'] = kwargs.pop('linewidth')\\n kwargs.setdefault('linewidths', linewidths)\\n\\n if shading == 'faceted':\\n edgecolors = 'k',\\n else:\\n edgecolors = 'none'\\n if 'edgecolor' in kwargs:\\n kwargs['edgecolors'] = kwargs.pop('edgecolor')\\n ec = kwargs.setdefault('edgecolors', edgecolors)\\n\\n # aa setting will default via collections to patch.antialiased\\n # unless the boundary is not stroked, in which case the\\n # default will be False; with unstroked boundaries, aa\\n # makes artifacts that are often disturbing.\\n if 'antialiased' in kwargs:\\n kwargs['antialiaseds'] = kwargs.pop('antialiased')\\n if 'antialiaseds' not in kwargs and ec.lower() == \\\"none\\\":\\n kwargs['antialiaseds'] = False\\n\\n collection = mcoll.PolyCollection(verts, **kwargs)\\n\\n collection.set_alpha(alpha)\\n collection.set_array(C)\\n if norm is not None:\\n assert(isinstance(norm, mcolors.Normalize))\\n collection.set_cmap(cmap)\\n collection.set_norm(norm)\\n collection.set_clim(vmin, vmax)\\n collection.autoscale_None()\\n self.grid(False)\\n\\n x = X.compressed()\\n y = Y.compressed()\\n\\n ########################\\n # PATCH FOR MPL 1.2.0rc2\\n\\n # Transform from native to data coordinates?\\n t = collection._transform\\n if (not isinstance(t, mtransforms.Transform) and\\n hasattr(t, '_as_mpl_transform')):\\n t = t._as_mpl_transform(self.axes)\\n\\n if t and any(t.contains_branch_seperately(self.transData)):\\n trans_to_data = t - self.transData\\n pts = np.vstack([x, y]).T.astype(np.float)\\n transformed_pts = trans_to_data.transform(pts)\\n x = transformed_pts[..., 0]\\n y = transformed_pts[..., 1]\\n\\n # XXX Not a mpl 1.2 thing...\\n no_inf = (x != np.inf) & (y != np.inf)\\n x = x[no_inf]\\n y = y[no_inf]\\n\\n # END OF PATCH\\n ##############\\n\\n minx = np.amin(x)\\n maxx = np.amax(x)\\n miny = np.amin(y)\\n maxy = np.amax(y)\\n\\n corners = (minx, miny), (maxx, maxy)\\n self.update_datalim(corners)\\n self.autoscale_view()\\n self.add_collection(collection)\\n return collection\\n\\n\\nclass SimpleClippedTransform(mtransforms.Transform):\\n \\\"\\\"\\\"\\n Transforms the values using a pre transform, clips them, then post\\n transforms them.\\n\\n This transform should not be widely used, but is useful for transforming\\n a background patch and clipping the patch to a desired extent.\\n\\n \\\"\\\"\\\"\\n input_dims = 2\\n output_dims = 2\\n has_inverse = True\\n\\n def __init__(self, pre_clip_transform, post_clip_transform,\\n xclip=(0, 1), yclip=(0, 1)):\\n \\\"\\\"\\\"\\n Create the transform.\\n\\n Args:\\n\\n * pre_clip_transform - A :class:`matplotlib.transforms.Transform`.\\n * post_clip_transform - A :class:`matplotlib.transforms.Transform`.\\n * xclip - Defaults to (0,1).\\n * yclip - Defaults to (0,1).\\n\\n \\\"\\\"\\\"\\n mtransforms.Transform.__init__(self)\\n self.pre_clip_transform = pre_clip_transform\\n self.post_clip_transform = post_clip_transform\\n\\n self.x_clips = xclip\\n self.y_clips = yclip\\n\\n def transform_non_affine(self, values):\\n \\\"\\\"\\\"\\n Transforms from source to target coordinates.\\n\\n Args:\\n\\n * value - An (n,2) array of points in source coordinates.\\n\\n Returns:\\n\\n * An (n,2) array of transformed points in target coordinates.\\n\\n \\\"\\\"\\\"\\n new_vals = self.pre_clip_transform.transform(values)\\n x, y = new_vals[:, 0:1], new_vals[:, 1:2]\\n numpy.clip(x, self.x_clips[0], self.x_clips[1], x)\\n numpy.clip(y, self.y_clips[0], self.y_clips[1], y)\\n # XXX support ma's?\\n return self.post_clip_transform.transform(new_vals)\\n\\n def inverted(self):\\n \\\"\\\"\\\"\\n Return a matplotlib :class:`~matplotlib.transforms.Transform` from\\n target to source coordinates.\\n\\n \\\"\\\"\\\"\\n return (self.pre_clip_transform + self.post_clip_transform).inverted()\\n\",\n \"path\": \"lib/cartopy/mpl/geoaxes.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/lib/cartopy/mpl/geoaxes.py b/lib/cartopy/mpl/geoaxes.py\nindex 61d6232b8..d6e06022f 100644\n--- a/lib/cartopy/mpl/geoaxes.py\n+++ b/lib/cartopy/mpl/geoaxes.py\n@@ -1293,11 +1293,6 @@ def _pcolor_patched(self, *args, **kwargs):\n return collection\n \n \n-# alias GeoAxes - NOTE: THIS WAS NOT IN v0.4.0rc1\n-GenericProjectionAxes = GeoAxes\n-\"\"\"(To be removed in v0.5) An alias to the :class:`GeoAxes` class.\"\"\"\n-\n-\n class SimpleClippedTransform(mtransforms.Transform):\n \"\"\"\n Transforms the values using a pre transform, clips them, then post\n"}}},{"rowIdx":4664,"cells":{"in_source_id":{"kind":"string","value":"kubeflow__pipelines-4134"},"issue":{"kind":"string","value":"allow output artifact store configuration (vs hard coded)\nit seems like the output artifacts are always stored in a specific minio service, port, namespace, bucket, secrets, etc (`minio-service.kubeflow:9000`). \r\n\r\nsee: https://github.com/kubeflow/pipelines/blob/f40a22a3f4a8e06d20cf3e3f425b5058d5c87e0b/sdk/python/kfp/compiler/_op_to_template.py#L148\r\n\r\nit would be great to make it flexible, e.g. allow using S3, or change namespace or bucket names.\r\ni suggest making it configurable, i can do such PR if we agree its needed. \nflexible pipeline service (host) path in client SDK \nwhen creating an SDK `Client()` the path to `ml-pipeline` API service is loaded from a hard coded value (`ml-pipeline.kubeflow.svc.cluster.local:8888`) which indicate a specific k8s namespace. it can be valuable to load that default value from an env variable, i.e. changing the line in `_client.py` from:\r\n\r\n`config.host = host if host else Client.IN_CLUSTER_DNS_NAME`\r\n\r\nto:\r\n\r\n`config.host = host or os.environ.get('ML_PIPELINE_DNS_NAME',Client.IN_CLUSTER_DNS_NAME)`\r\n\r\nalso note that when a user provide the `host` parameter, the ipython output points to the API server and not to the UI service (see the logic in `_get_url_prefix()`), it seems like a potential bug\r\n\r\nif its acceptable i can submit a PR for the line change above\r\n \n"},"before_files":{"kind":"list like","value":[{"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 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\nfrom kubernetes.client import V1Toleration, V1Affinity, V1NodeAffinity, \\\n V1NodeSelector, V1NodeSelectorTerm, V1NodeSelectorRequirement, V1PreferredSchedulingTerm\n\ndef use_gcp_secret(secret_name='user-gcp-sa', secret_file_path_in_volume=None, volume_name=None, secret_volume_mount_path='/secret/gcp-credentials'):\n \"\"\"An operator that configures the container to use GCP service account by service account key\n stored in a Kubernetes secret.\n\n For cluster setup and alternatives to using service account key, check https://www.kubeflow.org/docs/gke/authentication-pipelines/.\n \"\"\"\n\n # permitted values for secret_name = ['admin-gcp-sa', 'user-gcp-sa']\n if secret_file_path_in_volume is None:\n secret_file_path_in_volume = '/' + secret_name + '.json'\n\n if volume_name is None:\n volume_name = 'gcp-credentials-' + secret_name\n\n else:\n import warnings\n warnings.warn('The volume_name parameter is deprecated and will be removed in next release. The volume names are now generated automatically.', DeprecationWarning)\n \n def _use_gcp_secret(task):\n from kubernetes import client as k8s_client\n task = task.add_volume(\n k8s_client.V1Volume(\n name=volume_name,\n secret=k8s_client.V1SecretVolumeSource(\n secret_name=secret_name,\n )\n )\n )\n task.container \\\n .add_volume_mount(\n k8s_client.V1VolumeMount(\n name=volume_name,\n mount_path=secret_volume_mount_path,\n )\n ) \\\n .add_env_variable(\n k8s_client.V1EnvVar(\n name='GOOGLE_APPLICATION_CREDENTIALS',\n value=secret_volume_mount_path + secret_file_path_in_volume,\n )\n ) \\\n .add_env_variable(\n k8s_client.V1EnvVar(\n name='CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE',\n value=secret_volume_mount_path + secret_file_path_in_volume,\n )\n ) # Set GCloud Credentials by using the env var override.\n # TODO: Is there a better way for GCloud to pick up the credential?\n return task\n \n return _use_gcp_secret\n\ndef use_tpu(tpu_cores: int, tpu_resource: str, tf_version: str):\n \"\"\"An operator that configures GCP TPU spec in a container op.\n\n Args:\n tpu_cores: Required. The number of cores of TPU resource. \n For example, the value can be '8', '32', '128', etc.\n Check more details at: https://cloud.google.com/tpu/docs/kubernetes-engine-setup#pod-spec.\n tpu_resource: Required. The resource name of the TPU resource. \n For example, the value can be 'v2', 'preemptible-v1', 'v3' or 'preemptible-v3'.\n Check more details at: https://cloud.google.com/tpu/docs/kubernetes-engine-setup#pod-spec.\n tf_version: Required. The TensorFlow version that the TPU nodes use.\n For example, the value can be '1.12', '1.11', '1.9' or '1.8'.\n Check more details at: https://cloud.google.com/tpu/docs/supported-versions.\n \"\"\"\n\n def _set_tpu_spec(task):\n task.add_pod_annotation('tf-version.cloud-tpus.google.com', tf_version)\n task.add_resource_limit('cloud-tpus.google.com/{}'.format(tpu_resource), str(tpu_cores))\n return task\n\n return _set_tpu_spec\n\ndef use_preemptible_nodepool(toleration: V1Toleration = V1Toleration(effect='NoSchedule',\n key='preemptible',\n operator='Equal',\n value='true'),\n hard_constraint: bool = False):\n \"\"\"An operator that configures the GKE preemptible in a container op.\n Args:\n toleration (V1Toleration): toleration to pods, default is the preemptible label.\n hard_constraint (bool): the constraint of scheduling the pods on preemptible\n nodepools is hard. (Default: False)\n \"\"\"\n\n def _set_preemptible(task):\n task.add_toleration(toleration)\n node_selector_term = V1NodeSelectorTerm(match_expressions=[\n V1NodeSelectorRequirement(key='cloud.google.com/gke-preemptible',\n operator='In',\n values=['true'])]\n )\n if hard_constraint:\n node_affinity = V1NodeAffinity(required_during_scheduling_ignored_during_execution=\n V1NodeSelector(node_selector_terms=[node_selector_term]))\n else:\n node_affinity = V1NodeAffinity(preferred_during_scheduling_ignored_during_execution=[\n V1PreferredSchedulingTerm(preference=node_selector_term,\n weight=50)\n ])\n affinity = V1Affinity(node_affinity=node_affinity)\n task.add_affinity(affinity=affinity)\n return task\n\n return _set_preemptible\n\ndef add_gpu_toleration(toleration: V1Toleration = V1Toleration(\n effect='NoSchedule', key='nvidia.com/gpu', operator='Equal', value='true')):\n \"\"\"An operator that configures the GKE GPU nodes in a container op.\n\n Args:\n toleration {V1Toleration} -- toleration to pods, default is the nvidia.com/gpu label.\n \"\"\"\n\n def _set_toleration(task):\n task.add_toleration(toleration)\n\n return _set_toleration\n","path":"sdk/python/kfp/gcp.py"}],"string":"[\n {\n \"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 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\\nfrom kubernetes.client import V1Toleration, V1Affinity, V1NodeAffinity, \\\\\\n V1NodeSelector, V1NodeSelectorTerm, V1NodeSelectorRequirement, V1PreferredSchedulingTerm\\n\\ndef use_gcp_secret(secret_name='user-gcp-sa', secret_file_path_in_volume=None, volume_name=None, secret_volume_mount_path='/secret/gcp-credentials'):\\n \\\"\\\"\\\"An operator that configures the container to use GCP service account by service account key\\n stored in a Kubernetes secret.\\n\\n For cluster setup and alternatives to using service account key, check https://www.kubeflow.org/docs/gke/authentication-pipelines/.\\n \\\"\\\"\\\"\\n\\n # permitted values for secret_name = ['admin-gcp-sa', 'user-gcp-sa']\\n if secret_file_path_in_volume is None:\\n secret_file_path_in_volume = '/' + secret_name + '.json'\\n\\n if volume_name is None:\\n volume_name = 'gcp-credentials-' + secret_name\\n\\n else:\\n import warnings\\n warnings.warn('The volume_name parameter is deprecated and will be removed in next release. The volume names are now generated automatically.', DeprecationWarning)\\n \\n def _use_gcp_secret(task):\\n from kubernetes import client as k8s_client\\n task = task.add_volume(\\n k8s_client.V1Volume(\\n name=volume_name,\\n secret=k8s_client.V1SecretVolumeSource(\\n secret_name=secret_name,\\n )\\n )\\n )\\n task.container \\\\\\n .add_volume_mount(\\n k8s_client.V1VolumeMount(\\n name=volume_name,\\n mount_path=secret_volume_mount_path,\\n )\\n ) \\\\\\n .add_env_variable(\\n k8s_client.V1EnvVar(\\n name='GOOGLE_APPLICATION_CREDENTIALS',\\n value=secret_volume_mount_path + secret_file_path_in_volume,\\n )\\n ) \\\\\\n .add_env_variable(\\n k8s_client.V1EnvVar(\\n name='CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE',\\n value=secret_volume_mount_path + secret_file_path_in_volume,\\n )\\n ) # Set GCloud Credentials by using the env var override.\\n # TODO: Is there a better way for GCloud to pick up the credential?\\n return task\\n \\n return _use_gcp_secret\\n\\ndef use_tpu(tpu_cores: int, tpu_resource: str, tf_version: str):\\n \\\"\\\"\\\"An operator that configures GCP TPU spec in a container op.\\n\\n Args:\\n tpu_cores: Required. The number of cores of TPU resource. \\n For example, the value can be '8', '32', '128', etc.\\n Check more details at: https://cloud.google.com/tpu/docs/kubernetes-engine-setup#pod-spec.\\n tpu_resource: Required. The resource name of the TPU resource. \\n For example, the value can be 'v2', 'preemptible-v1', 'v3' or 'preemptible-v3'.\\n Check more details at: https://cloud.google.com/tpu/docs/kubernetes-engine-setup#pod-spec.\\n tf_version: Required. The TensorFlow version that the TPU nodes use.\\n For example, the value can be '1.12', '1.11', '1.9' or '1.8'.\\n Check more details at: https://cloud.google.com/tpu/docs/supported-versions.\\n \\\"\\\"\\\"\\n\\n def _set_tpu_spec(task):\\n task.add_pod_annotation('tf-version.cloud-tpus.google.com', tf_version)\\n task.add_resource_limit('cloud-tpus.google.com/{}'.format(tpu_resource), str(tpu_cores))\\n return task\\n\\n return _set_tpu_spec\\n\\ndef use_preemptible_nodepool(toleration: V1Toleration = V1Toleration(effect='NoSchedule',\\n key='preemptible',\\n operator='Equal',\\n value='true'),\\n hard_constraint: bool = False):\\n \\\"\\\"\\\"An operator that configures the GKE preemptible in a container op.\\n Args:\\n toleration (V1Toleration): toleration to pods, default is the preemptible label.\\n hard_constraint (bool): the constraint of scheduling the pods on preemptible\\n nodepools is hard. (Default: False)\\n \\\"\\\"\\\"\\n\\n def _set_preemptible(task):\\n task.add_toleration(toleration)\\n node_selector_term = V1NodeSelectorTerm(match_expressions=[\\n V1NodeSelectorRequirement(key='cloud.google.com/gke-preemptible',\\n operator='In',\\n values=['true'])]\\n )\\n if hard_constraint:\\n node_affinity = V1NodeAffinity(required_during_scheduling_ignored_during_execution=\\n V1NodeSelector(node_selector_terms=[node_selector_term]))\\n else:\\n node_affinity = V1NodeAffinity(preferred_during_scheduling_ignored_during_execution=[\\n V1PreferredSchedulingTerm(preference=node_selector_term,\\n weight=50)\\n ])\\n affinity = V1Affinity(node_affinity=node_affinity)\\n task.add_affinity(affinity=affinity)\\n return task\\n\\n return _set_preemptible\\n\\ndef add_gpu_toleration(toleration: V1Toleration = V1Toleration(\\n effect='NoSchedule', key='nvidia.com/gpu', operator='Equal', value='true')):\\n \\\"\\\"\\\"An operator that configures the GKE GPU nodes in a container op.\\n\\n Args:\\n toleration {V1Toleration} -- toleration to pods, default is the nvidia.com/gpu label.\\n \\\"\\\"\\\"\\n\\n def _set_toleration(task):\\n task.add_toleration(toleration)\\n\\n return _set_toleration\\n\",\n \"path\": \"sdk/python/kfp/gcp.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"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 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\nfrom kubernetes.client import V1Toleration, V1Affinity, V1NodeAffinity, \\\n V1NodeSelector, V1NodeSelectorTerm, V1NodeSelectorRequirement, V1PreferredSchedulingTerm\n\ndef use_gcp_secret(secret_name='user-gcp-sa', secret_file_path_in_volume=None, volume_name=None, secret_volume_mount_path='/secret/gcp-credentials'):\n \"\"\"An operator that configures the container to use GCP service account by service account key\n stored in a Kubernetes secret.\n\n For cluster setup and alternatives to using service account key, check https://www.kubeflow.org/docs/gke/authentication-pipelines/.\n \"\"\"\n\n # permitted values for secret_name = ['admin-gcp-sa', 'user-gcp-sa']\n if secret_file_path_in_volume is None:\n secret_file_path_in_volume = '/' + secret_name + '.json'\n\n if volume_name is None:\n volume_name = 'gcp-credentials-' + secret_name\n\n else:\n import warnings\n warnings.warn('The volume_name parameter is deprecated and will be removed in next release. The volume names are now generated automatically.', DeprecationWarning)\n \n def _use_gcp_secret(task):\n from kubernetes import client as k8s_client\n task = task.add_volume(\n k8s_client.V1Volume(\n name=volume_name,\n secret=k8s_client.V1SecretVolumeSource(\n secret_name=secret_name,\n )\n )\n )\n task.container \\\n .add_volume_mount(\n k8s_client.V1VolumeMount(\n name=volume_name,\n mount_path=secret_volume_mount_path,\n )\n ) \\\n .add_env_variable(\n k8s_client.V1EnvVar(\n name='GOOGLE_APPLICATION_CREDENTIALS',\n value=secret_volume_mount_path + secret_file_path_in_volume,\n )\n ) \\\n .add_env_variable(\n k8s_client.V1EnvVar(\n name='CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE',\n value=secret_volume_mount_path + secret_file_path_in_volume,\n )\n ) # Set GCloud Credentials by using the env var override.\n # TODO: Is there a better way for GCloud to pick up the credential?\n return task\n \n return _use_gcp_secret\n\ndef use_tpu(tpu_cores: int, tpu_resource: str, tf_version: str):\n \"\"\"An operator that configures GCP TPU spec in a container op.\n\n Args:\n tpu_cores: Required. The number of cores of TPU resource. \n For example, the value can be '8', '32', '128', etc.\n Check more details at: https://cloud.google.com/tpu/docs/kubernetes-engine-setup#pod-spec.\n tpu_resource: Required. The resource name of the TPU resource. \n For example, the value can be 'v2', 'preemptible-v1', 'v3' or 'preemptible-v3'.\n Check more details at: https://cloud.google.com/tpu/docs/kubernetes-engine-setup#pod-spec.\n tf_version: Required. The TensorFlow version that the TPU nodes use.\n For example, the value can be '1.12', '1.11', '1.9' or '1.8'.\n Check more details at: https://cloud.google.com/tpu/docs/supported-versions.\n \"\"\"\n\n def _set_tpu_spec(task):\n task.add_pod_annotation('tf-version.cloud-tpus.google.com', tf_version)\n task.container.add_resource_limit('cloud-tpus.google.com/{}'.format(tpu_resource), str(tpu_cores))\n return task\n\n return _set_tpu_spec\n\ndef use_preemptible_nodepool(toleration: V1Toleration = V1Toleration(effect='NoSchedule',\n key='preemptible',\n operator='Equal',\n value='true'),\n hard_constraint: bool = False):\n \"\"\"An operator that configures the GKE preemptible in a container op.\n Args:\n toleration (V1Toleration): toleration to pods, default is the preemptible label.\n hard_constraint (bool): the constraint of scheduling the pods on preemptible\n nodepools is hard. (Default: False)\n \"\"\"\n\n def _set_preemptible(task):\n task.add_toleration(toleration)\n node_selector_term = V1NodeSelectorTerm(match_expressions=[\n V1NodeSelectorRequirement(key='cloud.google.com/gke-preemptible',\n operator='In',\n values=['true'])]\n )\n if hard_constraint:\n node_affinity = V1NodeAffinity(required_during_scheduling_ignored_during_execution=\n V1NodeSelector(node_selector_terms=[node_selector_term]))\n else:\n node_affinity = V1NodeAffinity(preferred_during_scheduling_ignored_during_execution=[\n V1PreferredSchedulingTerm(preference=node_selector_term,\n weight=50)\n ])\n affinity = V1Affinity(node_affinity=node_affinity)\n task.add_affinity(affinity=affinity)\n return task\n\n return _set_preemptible\n\ndef add_gpu_toleration(toleration: V1Toleration = V1Toleration(\n effect='NoSchedule', key='nvidia.com/gpu', operator='Equal', value='true')):\n \"\"\"An operator that configures the GKE GPU nodes in a container op.\n\n Args:\n toleration {V1Toleration} -- toleration to pods, default is the nvidia.com/gpu label.\n \"\"\"\n\n def _set_toleration(task):\n task.add_toleration(toleration)\n\n return _set_toleration\n","path":"sdk/python/kfp/gcp.py"}],"string":"[\n {\n \"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 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\\nfrom kubernetes.client import V1Toleration, V1Affinity, V1NodeAffinity, \\\\\\n V1NodeSelector, V1NodeSelectorTerm, V1NodeSelectorRequirement, V1PreferredSchedulingTerm\\n\\ndef use_gcp_secret(secret_name='user-gcp-sa', secret_file_path_in_volume=None, volume_name=None, secret_volume_mount_path='/secret/gcp-credentials'):\\n \\\"\\\"\\\"An operator that configures the container to use GCP service account by service account key\\n stored in a Kubernetes secret.\\n\\n For cluster setup and alternatives to using service account key, check https://www.kubeflow.org/docs/gke/authentication-pipelines/.\\n \\\"\\\"\\\"\\n\\n # permitted values for secret_name = ['admin-gcp-sa', 'user-gcp-sa']\\n if secret_file_path_in_volume is None:\\n secret_file_path_in_volume = '/' + secret_name + '.json'\\n\\n if volume_name is None:\\n volume_name = 'gcp-credentials-' + secret_name\\n\\n else:\\n import warnings\\n warnings.warn('The volume_name parameter is deprecated and will be removed in next release. The volume names are now generated automatically.', DeprecationWarning)\\n \\n def _use_gcp_secret(task):\\n from kubernetes import client as k8s_client\\n task = task.add_volume(\\n k8s_client.V1Volume(\\n name=volume_name,\\n secret=k8s_client.V1SecretVolumeSource(\\n secret_name=secret_name,\\n )\\n )\\n )\\n task.container \\\\\\n .add_volume_mount(\\n k8s_client.V1VolumeMount(\\n name=volume_name,\\n mount_path=secret_volume_mount_path,\\n )\\n ) \\\\\\n .add_env_variable(\\n k8s_client.V1EnvVar(\\n name='GOOGLE_APPLICATION_CREDENTIALS',\\n value=secret_volume_mount_path + secret_file_path_in_volume,\\n )\\n ) \\\\\\n .add_env_variable(\\n k8s_client.V1EnvVar(\\n name='CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE',\\n value=secret_volume_mount_path + secret_file_path_in_volume,\\n )\\n ) # Set GCloud Credentials by using the env var override.\\n # TODO: Is there a better way for GCloud to pick up the credential?\\n return task\\n \\n return _use_gcp_secret\\n\\ndef use_tpu(tpu_cores: int, tpu_resource: str, tf_version: str):\\n \\\"\\\"\\\"An operator that configures GCP TPU spec in a container op.\\n\\n Args:\\n tpu_cores: Required. The number of cores of TPU resource. \\n For example, the value can be '8', '32', '128', etc.\\n Check more details at: https://cloud.google.com/tpu/docs/kubernetes-engine-setup#pod-spec.\\n tpu_resource: Required. The resource name of the TPU resource. \\n For example, the value can be 'v2', 'preemptible-v1', 'v3' or 'preemptible-v3'.\\n Check more details at: https://cloud.google.com/tpu/docs/kubernetes-engine-setup#pod-spec.\\n tf_version: Required. The TensorFlow version that the TPU nodes use.\\n For example, the value can be '1.12', '1.11', '1.9' or '1.8'.\\n Check more details at: https://cloud.google.com/tpu/docs/supported-versions.\\n \\\"\\\"\\\"\\n\\n def _set_tpu_spec(task):\\n task.add_pod_annotation('tf-version.cloud-tpus.google.com', tf_version)\\n task.container.add_resource_limit('cloud-tpus.google.com/{}'.format(tpu_resource), str(tpu_cores))\\n return task\\n\\n return _set_tpu_spec\\n\\ndef use_preemptible_nodepool(toleration: V1Toleration = V1Toleration(effect='NoSchedule',\\n key='preemptible',\\n operator='Equal',\\n value='true'),\\n hard_constraint: bool = False):\\n \\\"\\\"\\\"An operator that configures the GKE preemptible in a container op.\\n Args:\\n toleration (V1Toleration): toleration to pods, default is the preemptible label.\\n hard_constraint (bool): the constraint of scheduling the pods on preemptible\\n nodepools is hard. (Default: False)\\n \\\"\\\"\\\"\\n\\n def _set_preemptible(task):\\n task.add_toleration(toleration)\\n node_selector_term = V1NodeSelectorTerm(match_expressions=[\\n V1NodeSelectorRequirement(key='cloud.google.com/gke-preemptible',\\n operator='In',\\n values=['true'])]\\n )\\n if hard_constraint:\\n node_affinity = V1NodeAffinity(required_during_scheduling_ignored_during_execution=\\n V1NodeSelector(node_selector_terms=[node_selector_term]))\\n else:\\n node_affinity = V1NodeAffinity(preferred_during_scheduling_ignored_during_execution=[\\n V1PreferredSchedulingTerm(preference=node_selector_term,\\n weight=50)\\n ])\\n affinity = V1Affinity(node_affinity=node_affinity)\\n task.add_affinity(affinity=affinity)\\n return task\\n\\n return _set_preemptible\\n\\ndef add_gpu_toleration(toleration: V1Toleration = V1Toleration(\\n effect='NoSchedule', key='nvidia.com/gpu', operator='Equal', value='true')):\\n \\\"\\\"\\\"An operator that configures the GKE GPU nodes in a container op.\\n\\n Args:\\n toleration {V1Toleration} -- toleration to pods, default is the nvidia.com/gpu label.\\n \\\"\\\"\\\"\\n\\n def _set_toleration(task):\\n task.add_toleration(toleration)\\n\\n return _set_toleration\\n\",\n \"path\": \"sdk/python/kfp/gcp.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/samples/tutorials/gpu/gpu.ipynb b/samples/tutorials/gpu/gpu.ipynb\nindex 80053bab436..3aa6fad5295 100644\n--- a/samples/tutorials/gpu/gpu.ipynb\n+++ b/samples/tutorials/gpu/gpu.ipynb\n@@ -163,7 +163,7 @@\n \" image='tensorflow/tensorflow:latest-gpu',\\n\",\n \" command=['sh', '-c'],\\n\",\n \" arguments=['nvidia-smi']\\n\",\n- \" ).set_gpu_limit(1).add_node_selector_constraint('cloud.google.com/gke-accelerator', 'nvidia-tesla-p100')\\n\",\n+ \" ).add_node_selector_constraint('cloud.google.com/gke-accelerator', 'nvidia-tesla-p100').container.set_gpu_limit(1)\\n\",\n \"\\n\",\n \"def gpu_v100_op():\\n\",\n \" return dsl.ContainerOp(\\n\",\n@@ -171,7 +171,7 @@\n \" image='tensorflow/tensorflow:latest-gpu',\\n\",\n \" command=['sh', '-c'],\\n\",\n \" arguments=['nvidia-smi']\\n\",\n- \" ).set_gpu_limit(1).add_node_selector_constraint('cloud.google.com/gke-accelerator', 'nvidia-tesla-v100')\\n\",\n+ \" ).add_node_selector_constraint('cloud.google.com/gke-accelerator', 'nvidia-tesla-v100').container.set_gpu_limit(1)\\n\",\n \"\\n\",\n \"@dsl.pipeline(\\n\",\n \" name='GPU smoke check',\\n\",\n@@ -237,7 +237,7 @@\n \" image='tensorflow/tensorflow:latest-gpu',\\n\",\n \" command=['sh', '-c'],\\n\",\n \" arguments=['nvidia-smi']\\n\",\n- \" ).set_gpu_limit(1).add_node_selector_constraint('cloud.google.com/gke-accelerator', 'nvidia-tesla-p100')\\n\",\n+ \" ).add_node_selector_constraint('cloud.google.com/gke-accelerator', 'nvidia-tesla-p100').container.set_gpu_limit(1)\\n\",\n \"\\n\",\n \"def gpu_v100_op():\\n\",\n \" return dsl.ContainerOp(\\n\",\n@@ -245,7 +245,7 @@\n \" image='tensorflow/tensorflow:latest-gpu',\\n\",\n \" command=['sh', '-c'],\\n\",\n \" arguments=['nvidia-smi']\\n\",\n- \" ).set_gpu_limit(1).add_node_selector_constraint('cloud.google.com/gke-accelerator', 'nvidia-tesla-v100')\\n\",\n+ \" ).add_node_selector_constraint('cloud.google.com/gke-accelerator', 'nvidia-tesla-v100').container.set_gpu_limit(1)\\n\",\n \"\\n\",\n \"def gpu_v100_preemptible_op():\\n\",\n \" v100_op = dsl.ContainerOp(\\n\",\n@@ -253,7 +253,7 @@\n \" image='tensorflow/tensorflow:latest-gpu',\\n\",\n \" command=['sh', '-c'],\\n\",\n \" arguments=['nvidia-smi'])\\n\",\n- \" v100_op.set_gpu_limit(1)\\n\",\n+ \" v100_op.container.set_gpu_limit(1)\\n\",\n \" v100_op.add_node_selector_constraint('cloud.google.com/gke-accelerator', 'nvidia-tesla-v100')\\n\",\n \" v100_op.apply(gcp.use_preemptible_nodepool(hard_constraint=True))\\n\",\n \" return v100_op\\n\",\n@@ -309,4 +309,4 @@\n },\n \"nbformat\": 4,\n \"nbformat_minor\": 4\n-}\n+}\n\\ No newline at end of file\ndiff --git a/sdk/python/kfp/gcp.py b/sdk/python/kfp/gcp.py\nindex cdf924fef0f..aaca532af52 100644\n--- a/sdk/python/kfp/gcp.py\n+++ b/sdk/python/kfp/gcp.py\n@@ -84,7 +84,7 @@ def use_tpu(tpu_cores: int, tpu_resource: str, tf_version: str):\n \n def _set_tpu_spec(task):\n task.add_pod_annotation('tf-version.cloud-tpus.google.com', tf_version)\n- task.add_resource_limit('cloud-tpus.google.com/{}'.format(tpu_resource), str(tpu_cores))\n+ task.container.add_resource_limit('cloud-tpus.google.com/{}'.format(tpu_resource), str(tpu_cores))\n return task\n \n return _set_tpu_spec\ndiff --git a/sdk/python/tests/compiler/testdata/basic.py b/sdk/python/tests/compiler/testdata/basic.py\nindex a81cf3a4d1f..ae8b1d1e22a 100644\n--- a/sdk/python/tests/compiler/testdata/basic.py\n+++ b/sdk/python/tests/compiler/testdata/basic.py\n@@ -79,13 +79,13 @@ def save_most_frequent_word(message: str, outputpath: str):\n counter = GetFrequentWordOp(\n name='get-Frequent',\n message=message)\n- counter.set_memory_request('200M')\n+ counter.container.set_memory_request('200M')\n \n saver = SaveMessageOp(\n name='save',\n message=counter.output,\n output_path=outputpath)\n- saver.set_cpu_limit('0.5')\n- saver.set_gpu_limit('2')\n+ saver.container.set_cpu_limit('0.5')\n+ saver.container.set_gpu_limit('2')\n saver.add_node_selector_constraint('cloud.google.com/gke-accelerator', 'nvidia-tesla-k80')\n saver.apply(gcp.use_tpu(tpu_cores = 8, tpu_resource = 'v2', tf_version = '1.12'))\ndiff --git a/sdk/python/tests/compiler/testdata/basic_no_decorator.py b/sdk/python/tests/compiler/testdata/basic_no_decorator.py\nindex 7e4cad22bcd..c7afe0e8370 100644\n--- a/sdk/python/tests/compiler/testdata/basic_no_decorator.py\n+++ b/sdk/python/tests/compiler/testdata/basic_no_decorator.py\n@@ -76,14 +76,14 @@ def save_most_frequent_word():\n counter = GetFrequentWordOp(\n name='get-Frequent',\n message=message_param)\n- counter.set_memory_request('200M')\n+ counter.container.set_memory_request('200M')\n \n saver = SaveMessageOp(\n name='save',\n message=counter.output,\n output_path=output_path_param)\n- saver.set_cpu_limit('0.5')\n- saver.set_gpu_limit('2')\n+ saver.container.set_cpu_limit('0.5')\n+ saver.container.set_gpu_limit('2')\n saver.add_node_selector_constraint(\n 'cloud.google.com/gke-accelerator',\n 'nvidia-tesla-k80')\n"}}},{"rowIdx":4665,"cells":{"in_source_id":{"kind":"string","value":"zenml-io__zenml-317"},"issue":{"kind":"string","value":"Repeated Paragraph in the documentation for `core-concepts`\nIn the file `core-concepts.md`, the section on [`Pipeline`](https://github.com/zenml-io/zenml/blob/b94dff83f0e7c8ab29e99d6b42a0c906a3512b63/docs/book/introduction/core-concepts.md?plain=1#L27-L41) includes a repeated paragraph. The first paragraph in the the pipeline section is repeated in the 3rd paragraph of the same section. \r\n\r\n```markdown\r\nWithin your repository, you will have one or more pipelines as part of your experimentation workflow. A ZenML \r\npipeline is a sequence of tasks that execute in a specific order and yield artifacts. The artifacts are stored \r\nwithin the artifact store and indexed via the metadata store. Each individual task within a pipeline is known as a \r\nstep. The standard pipelines within ZenML are designed to have easy interfaces to add pre-decided steps, with the \r\norder also pre-decided. Other sorts of pipelines can be created as well from scratch.\r\n\r\nPipelines are designed as simple functions. They are created by using decorators appropriate to the specific use case \r\nyou have. The moment it is `run`, a pipeline is compiled and passed directly to the orchestrator, to be run in the \r\norchestrator environment.\r\n\r\nWithin your repository, you will have one or more pipelines as part of your experimentation workflow. A ZenML \r\npipeline is a sequence of tasks that execute in a specific order and yield artifacts. The artifacts are stored \r\nwithin the artifact store and indexed via the metadata store. Each individual task within a pipeline is known as a \r\nstep. The standard pipelines (like `TrainingPipeline`) within ZenML are designed to have easy interfaces to add \r\npre-decided steps, with the order also pre-decided. Other sorts of pipelines can be created as well from scratch.\r\n```\n"},"before_files":{"kind":"list like","value":[{"content":"# Copyright (c) ZenML GmbH 2021. All Rights Reserved.\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# https://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\n# or implied. See the License for the specific language governing\n# permissions and limitations under the License.\nimport os\nfrom typing import Any, Type\n\nfrom zenml.artifacts import DataAnalysisArtifact, DataArtifact\nfrom zenml.logger import get_logger\nfrom zenml.materializers.base_materializer import BaseMaterializer\nfrom zenml.utils import yaml_utils\n\nlogger = get_logger(__name__)\nDEFAULT_FILENAME = \"data.json\"\n\n\nclass BuiltInMaterializer(BaseMaterializer):\n \"\"\"Read/Write JSON files.\"\"\"\n\n # TODO [LOW]: consider adding typing.Dict and typing.List\n # since these are the 'correct' way to annotate these types.\n\n ASSOCIATED_ARTIFACT_TYPES = [\n DataArtifact,\n DataAnalysisArtifact,\n ]\n ASSOCIATED_TYPES = [\n int,\n str,\n bytes,\n dict,\n float,\n list,\n tuple,\n bool,\n ]\n\n def handle_input(self, data_type: Type[Any]) -> Any:\n \"\"\"Reads basic primitive types from json.\"\"\"\n super().handle_input(data_type)\n filepath = os.path.join(self.artifact.uri, DEFAULT_FILENAME)\n contents = yaml_utils.read_json(filepath)\n if type(contents) != data_type:\n # TODO [ENG-142]: Raise error or try to coerce\n logger.debug(\n f\"Contents {contents} was type {type(contents)} but expected \"\n f\"{data_type}\"\n )\n return contents\n\n def handle_return(self, data: Any) -> None:\n \"\"\"Handles basic built-in types and stores them as json\"\"\"\n super().handle_return(data)\n filepath = os.path.join(self.artifact.uri, DEFAULT_FILENAME)\n yaml_utils.write_json(filepath, data)\n","path":"src/zenml/materializers/built_in_materializer.py"}],"string":"[\n {\n \"content\": \"# Copyright (c) ZenML GmbH 2021. All Rights Reserved.\\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# https://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\\n# or implied. See the License for the specific language governing\\n# permissions and limitations under the License.\\nimport os\\nfrom typing import Any, Type\\n\\nfrom zenml.artifacts import DataAnalysisArtifact, DataArtifact\\nfrom zenml.logger import get_logger\\nfrom zenml.materializers.base_materializer import BaseMaterializer\\nfrom zenml.utils import yaml_utils\\n\\nlogger = get_logger(__name__)\\nDEFAULT_FILENAME = \\\"data.json\\\"\\n\\n\\nclass BuiltInMaterializer(BaseMaterializer):\\n \\\"\\\"\\\"Read/Write JSON files.\\\"\\\"\\\"\\n\\n # TODO [LOW]: consider adding typing.Dict and typing.List\\n # since these are the 'correct' way to annotate these types.\\n\\n ASSOCIATED_ARTIFACT_TYPES = [\\n DataArtifact,\\n DataAnalysisArtifact,\\n ]\\n ASSOCIATED_TYPES = [\\n int,\\n str,\\n bytes,\\n dict,\\n float,\\n list,\\n tuple,\\n bool,\\n ]\\n\\n def handle_input(self, data_type: Type[Any]) -> Any:\\n \\\"\\\"\\\"Reads basic primitive types from json.\\\"\\\"\\\"\\n super().handle_input(data_type)\\n filepath = os.path.join(self.artifact.uri, DEFAULT_FILENAME)\\n contents = yaml_utils.read_json(filepath)\\n if type(contents) != data_type:\\n # TODO [ENG-142]: Raise error or try to coerce\\n logger.debug(\\n f\\\"Contents {contents} was type {type(contents)} but expected \\\"\\n f\\\"{data_type}\\\"\\n )\\n return contents\\n\\n def handle_return(self, data: Any) -> None:\\n \\\"\\\"\\\"Handles basic built-in types and stores them as json\\\"\\\"\\\"\\n super().handle_return(data)\\n filepath = os.path.join(self.artifact.uri, DEFAULT_FILENAME)\\n yaml_utils.write_json(filepath, data)\\n\",\n \"path\": \"src/zenml/materializers/built_in_materializer.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# Copyright (c) ZenML GmbH 2021. All Rights Reserved.\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# https://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\n# or implied. See the License for the specific language governing\n# permissions and limitations under the License.\nimport os\nfrom typing import Any, Type\n\nfrom zenml.artifacts import DataAnalysisArtifact, DataArtifact\nfrom zenml.logger import get_logger\nfrom zenml.materializers.base_materializer import BaseMaterializer\nfrom zenml.utils import yaml_utils\n\nlogger = get_logger(__name__)\nDEFAULT_FILENAME = \"data.json\"\n\n\nclass BuiltInMaterializer(BaseMaterializer):\n \"\"\"Read/Write JSON files.\"\"\"\n\n # TODO [ENG-322]: consider adding typing.Dict and typing.List\n # since these are the 'correct' way to annotate these types.\n\n ASSOCIATED_ARTIFACT_TYPES = [\n DataArtifact,\n DataAnalysisArtifact,\n ]\n ASSOCIATED_TYPES = [\n int,\n str,\n bytes,\n dict,\n float,\n list,\n tuple,\n bool,\n ]\n\n def handle_input(self, data_type: Type[Any]) -> Any:\n \"\"\"Reads basic primitive types from json.\"\"\"\n super().handle_input(data_type)\n filepath = os.path.join(self.artifact.uri, DEFAULT_FILENAME)\n contents = yaml_utils.read_json(filepath)\n if type(contents) != data_type:\n # TODO [ENG-142]: Raise error or try to coerce\n logger.debug(\n f\"Contents {contents} was type {type(contents)} but expected \"\n f\"{data_type}\"\n )\n return contents\n\n def handle_return(self, data: Any) -> None:\n \"\"\"Handles basic built-in types and stores them as json\"\"\"\n super().handle_return(data)\n filepath = os.path.join(self.artifact.uri, DEFAULT_FILENAME)\n yaml_utils.write_json(filepath, data)\n","path":"src/zenml/materializers/built_in_materializer.py"}],"string":"[\n {\n \"content\": \"# Copyright (c) ZenML GmbH 2021. All Rights Reserved.\\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# https://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\\n# or implied. See the License for the specific language governing\\n# permissions and limitations under the License.\\nimport os\\nfrom typing import Any, Type\\n\\nfrom zenml.artifacts import DataAnalysisArtifact, DataArtifact\\nfrom zenml.logger import get_logger\\nfrom zenml.materializers.base_materializer import BaseMaterializer\\nfrom zenml.utils import yaml_utils\\n\\nlogger = get_logger(__name__)\\nDEFAULT_FILENAME = \\\"data.json\\\"\\n\\n\\nclass BuiltInMaterializer(BaseMaterializer):\\n \\\"\\\"\\\"Read/Write JSON files.\\\"\\\"\\\"\\n\\n # TODO [ENG-322]: consider adding typing.Dict and typing.List\\n # since these are the 'correct' way to annotate these types.\\n\\n ASSOCIATED_ARTIFACT_TYPES = [\\n DataArtifact,\\n DataAnalysisArtifact,\\n ]\\n ASSOCIATED_TYPES = [\\n int,\\n str,\\n bytes,\\n dict,\\n float,\\n list,\\n tuple,\\n bool,\\n ]\\n\\n def handle_input(self, data_type: Type[Any]) -> Any:\\n \\\"\\\"\\\"Reads basic primitive types from json.\\\"\\\"\\\"\\n super().handle_input(data_type)\\n filepath = os.path.join(self.artifact.uri, DEFAULT_FILENAME)\\n contents = yaml_utils.read_json(filepath)\\n if type(contents) != data_type:\\n # TODO [ENG-142]: Raise error or try to coerce\\n logger.debug(\\n f\\\"Contents {contents} was type {type(contents)} but expected \\\"\\n f\\\"{data_type}\\\"\\n )\\n return contents\\n\\n def handle_return(self, data: Any) -> None:\\n \\\"\\\"\\\"Handles basic built-in types and stores them as json\\\"\\\"\\\"\\n super().handle_return(data)\\n filepath = os.path.join(self.artifact.uri, DEFAULT_FILENAME)\\n yaml_utils.write_json(filepath, data)\\n\",\n \"path\": \"src/zenml/materializers/built_in_materializer.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/docs/book/introduction/core-concepts.md b/docs/book/introduction/core-concepts.md\nindex 4f1703d8d38..290a63c6e3c 100644\n--- a/docs/book/introduction/core-concepts.md\n+++ b/docs/book/introduction/core-concepts.md\n@@ -24,12 +24,6 @@ e.g., the active [Stack](guides/deploy\\_to\\_production.md) that you are using to\n \n **Pipeline**\n \n-Within your repository, you will have one or more pipelines as part of your experimentation workflow. A ZenML \n-pipeline is a sequence of tasks that execute in a specific order and yield artifacts. The artifacts are stored \n-within the artifact store and indexed via the metadata store. Each individual task within a pipeline is known as a \n-step. The standard pipelines within ZenML are designed to have easy interfaces to add pre-decided steps, with the \n-order also pre-decided. Other sorts of pipelines can be created as well from scratch.\n-\n Pipelines are designed as simple functions. They are created by using decorators appropriate to the specific use case \n you have. The moment it is `run`, a pipeline is compiled and passed directly to the orchestrator, to be run in the \n orchestrator environment.\ndiff --git a/src/zenml/materializers/built_in_materializer.py b/src/zenml/materializers/built_in_materializer.py\nindex aa7f0392667..ed9b65f7abd 100644\n--- a/src/zenml/materializers/built_in_materializer.py\n+++ b/src/zenml/materializers/built_in_materializer.py\n@@ -26,7 +26,7 @@\n class BuiltInMaterializer(BaseMaterializer):\n \"\"\"Read/Write JSON files.\"\"\"\n \n- # TODO [LOW]: consider adding typing.Dict and typing.List\n+ # TODO [ENG-322]: consider adding typing.Dict and typing.List\n # since these are the 'correct' way to annotate these types.\n \n ASSOCIATED_ARTIFACT_TYPES = [\n"}}},{"rowIdx":4666,"cells":{"in_source_id":{"kind":"string","value":"Mailu__Mailu-1910"},"issue":{"kind":"string","value":"Rate limiting changes for 1.8\nCopied from #1582. For 1.8 we will for now increase rate limiting value and disable rate limiting for the subnet. \r\n\r\n- Rate limiting\r\n - Document rate limiting\r\n - Currently the subnet is included in the rate limiting. This means that a user who repeatly fails to login the webmail, blocks the webmail for ALL users.\r\n\r\n- For 1.8 and master\r\n - in mailu.env set the rate limit to a high value.\r\n - in mailu.env disable the rate limiter for the subnet.\r\n - And document this of course and change this in the documentation\r\n - Set status blocked on lubs pull request and request to further discuss this for mailu 1.9.\r\n - Make authentication fast #1745 is a draft pr from nextgens which contains a solution for this problem.\r\n - We need a new issue and PR for making these changes.\n"},"before_files":{"kind":"list like","value":[{"content":"import os\n\nfrom datetime import timedelta\nfrom socrate import system\n\nDEFAULT_CONFIG = {\n # Specific to the admin UI\n 'DOCKER_SOCKET': 'unix:///var/run/docker.sock',\n 'BABEL_DEFAULT_LOCALE': 'en',\n 'BABEL_DEFAULT_TIMEZONE': 'UTC',\n 'BOOTSTRAP_SERVE_LOCAL': True,\n 'RATELIMIT_STORAGE_URL': '',\n 'QUOTA_STORAGE_URL': '',\n 'DEBUG': False,\n 'DOMAIN_REGISTRATION': False,\n 'TEMPLATES_AUTO_RELOAD': True,\n 'MEMORY_SESSIONS': False,\n # Database settings\n 'DB_FLAVOR': None,\n 'DB_USER': 'mailu',\n 'DB_PW': None,\n 'DB_HOST': 'database',\n 'DB_NAME': 'mailu',\n 'SQLITE_DATABASE_FILE':'data/main.db',\n 'SQLALCHEMY_DATABASE_URI': 'sqlite:////data/main.db',\n 'SQLALCHEMY_TRACK_MODIFICATIONS': False,\n # Statistics management\n 'INSTANCE_ID_PATH': '/data/instance',\n 'STATS_ENDPOINT': '18.{}.stats.mailu.io',\n # Common configuration variables\n 'SECRET_KEY': 'changeMe',\n 'DOMAIN': 'mailu.io',\n 'HOSTNAMES': 'mail.mailu.io,alternative.mailu.io,yetanother.mailu.io',\n 'POSTMASTER': 'postmaster',\n 'TLS_FLAVOR': 'cert',\n 'INBOUND_TLS_ENFORCE': False,\n 'AUTH_RATELIMIT': '10/minute;1000/hour',\n 'AUTH_RATELIMIT_SUBNET': True,\n 'DISABLE_STATISTICS': False,\n # Mail settings\n 'DMARC_RUA': None,\n 'DMARC_RUF': None,\n 'WELCOME': False,\n 'WELCOME_SUBJECT': 'Dummy welcome topic',\n 'WELCOME_BODY': 'Dummy welcome body',\n 'DKIM_SELECTOR': 'dkim',\n 'DKIM_PATH': '/dkim/{domain}.{selector}.key',\n 'DEFAULT_QUOTA': 1000000000,\n # Web settings\n 'SITENAME': 'Mailu',\n 'WEBSITE': 'https://mailu.io',\n 'WEB_ADMIN': '/admin',\n 'WEB_WEBMAIL': '/webmail',\n 'WEBMAIL': 'none',\n 'RECAPTCHA_PUBLIC_KEY': '',\n 'RECAPTCHA_PRIVATE_KEY': '',\n # Advanced settings\n 'LOG_LEVEL': 'WARNING',\n 'SESSION_KEY_BITS': 128,\n 'SESSION_LIFETIME': 24,\n 'SESSION_COOKIE_SECURE': True,\n 'CREDENTIAL_ROUNDS': 12,\n # Host settings\n 'HOST_IMAP': 'imap',\n 'HOST_LMTP': 'imap:2525',\n 'HOST_POP3': 'imap',\n 'HOST_SMTP': 'smtp',\n 'HOST_AUTHSMTP': 'smtp',\n 'HOST_ADMIN': 'admin',\n 'HOST_WEBMAIL': 'webmail',\n 'HOST_WEBDAV': 'webdav:5232',\n 'HOST_REDIS': 'redis',\n 'HOST_FRONT': 'front',\n 'SUBNET': '192.168.203.0/24',\n 'SUBNET6': None,\n 'POD_ADDRESS_RANGE': None\n}\n\nclass ConfigManager(dict):\n \"\"\" Naive configuration manager that uses environment only\n \"\"\"\n\n DB_TEMPLATES = {\n 'sqlite': 'sqlite:////{SQLITE_DATABASE_FILE}',\n 'postgresql': 'postgresql://{DB_USER}:{DB_PW}@{DB_HOST}/{DB_NAME}',\n 'mysql': 'mysql://{DB_USER}:{DB_PW}@{DB_HOST}/{DB_NAME}'\n }\n\n def __init__(self):\n self.config = dict()\n\n def get_host_address(self, name):\n # if MYSERVICE_ADDRESS is defined, use this\n if '{}_ADDRESS'.format(name) in os.environ:\n return os.environ.get('{}_ADDRESS'.format(name))\n # otherwise use the host name and resolve it\n return system.resolve_address(self.config['HOST_{}'.format(name)])\n\n def resolve_hosts(self):\n self.config[\"IMAP_ADDRESS\"] = self.get_host_address(\"IMAP\")\n self.config[\"POP3_ADDRESS\"] = self.get_host_address(\"POP3\")\n self.config[\"AUTHSMTP_ADDRESS\"] = self.get_host_address(\"AUTHSMTP\")\n self.config[\"SMTP_ADDRESS\"] = self.get_host_address(\"SMTP\")\n self.config[\"REDIS_ADDRESS\"] = self.get_host_address(\"REDIS\")\n if self.config[\"WEBMAIL\"] != \"none\":\n self.config[\"WEBMAIL_ADDRESS\"] = self.get_host_address(\"WEBMAIL\")\n\n def __get_env(self, key, value):\n key_file = key + \"_FILE\"\n if key_file in os.environ:\n with open(os.environ.get(key_file)) as file:\n value_from_file = file.read()\n return value_from_file.strip()\n else:\n return os.environ.get(key, value)\n\n def __coerce_value(self, value):\n if isinstance(value, str) and value.lower() in ('true','yes'):\n return True\n elif isinstance(value, str) and value.lower() in ('false', 'no'):\n return False\n return value\n\n def init_app(self, app):\n self.config.update(app.config)\n # get environment variables\n self.config.update({\n key: self.__coerce_value(self.__get_env(key, value))\n for key, value in DEFAULT_CONFIG.items()\n })\n self.resolve_hosts()\n\n # automatically set the sqlalchemy string\n if self.config['DB_FLAVOR']:\n template = self.DB_TEMPLATES[self.config['DB_FLAVOR']]\n self.config['SQLALCHEMY_DATABASE_URI'] = template.format(**self.config)\n\n self.config['RATELIMIT_STORAGE_URL'] = 'redis://{0}/2'.format(self.config['REDIS_ADDRESS'])\n self.config['QUOTA_STORAGE_URL'] = 'redis://{0}/1'.format(self.config['REDIS_ADDRESS'])\n self.config['SESSION_STORAGE_URL'] = 'redis://{0}/3'.format(self.config['REDIS_ADDRESS'])\n self.config['SESSION_COOKIE_SAMESITE'] = 'Strict'\n self.config['SESSION_COOKIE_HTTPONLY'] = True\n self.config['PERMANENT_SESSION_LIFETIME'] = timedelta(hours=int(self.config['SESSION_LIFETIME']))\n # update the app config itself\n app.config = self\n\n def setdefault(self, key, value):\n if key not in self.config:\n self.config[key] = value\n return self.config[key]\n\n def get(self, *args):\n return self.config.get(*args)\n\n def keys(self):\n return self.config.keys()\n\n def __getitem__(self, key):\n return self.config.get(key)\n\n def __setitem__(self, key, value):\n self.config[key] = value\n\n def __contains__(self, key):\n return key in self.config\n","path":"core/admin/mailu/configuration.py"}],"string":"[\n {\n \"content\": \"import os\\n\\nfrom datetime import timedelta\\nfrom socrate import system\\n\\nDEFAULT_CONFIG = {\\n # Specific to the admin UI\\n 'DOCKER_SOCKET': 'unix:///var/run/docker.sock',\\n 'BABEL_DEFAULT_LOCALE': 'en',\\n 'BABEL_DEFAULT_TIMEZONE': 'UTC',\\n 'BOOTSTRAP_SERVE_LOCAL': True,\\n 'RATELIMIT_STORAGE_URL': '',\\n 'QUOTA_STORAGE_URL': '',\\n 'DEBUG': False,\\n 'DOMAIN_REGISTRATION': False,\\n 'TEMPLATES_AUTO_RELOAD': True,\\n 'MEMORY_SESSIONS': False,\\n # Database settings\\n 'DB_FLAVOR': None,\\n 'DB_USER': 'mailu',\\n 'DB_PW': None,\\n 'DB_HOST': 'database',\\n 'DB_NAME': 'mailu',\\n 'SQLITE_DATABASE_FILE':'data/main.db',\\n 'SQLALCHEMY_DATABASE_URI': 'sqlite:////data/main.db',\\n 'SQLALCHEMY_TRACK_MODIFICATIONS': False,\\n # Statistics management\\n 'INSTANCE_ID_PATH': '/data/instance',\\n 'STATS_ENDPOINT': '18.{}.stats.mailu.io',\\n # Common configuration variables\\n 'SECRET_KEY': 'changeMe',\\n 'DOMAIN': 'mailu.io',\\n 'HOSTNAMES': 'mail.mailu.io,alternative.mailu.io,yetanother.mailu.io',\\n 'POSTMASTER': 'postmaster',\\n 'TLS_FLAVOR': 'cert',\\n 'INBOUND_TLS_ENFORCE': False,\\n 'AUTH_RATELIMIT': '10/minute;1000/hour',\\n 'AUTH_RATELIMIT_SUBNET': True,\\n 'DISABLE_STATISTICS': False,\\n # Mail settings\\n 'DMARC_RUA': None,\\n 'DMARC_RUF': None,\\n 'WELCOME': False,\\n 'WELCOME_SUBJECT': 'Dummy welcome topic',\\n 'WELCOME_BODY': 'Dummy welcome body',\\n 'DKIM_SELECTOR': 'dkim',\\n 'DKIM_PATH': '/dkim/{domain}.{selector}.key',\\n 'DEFAULT_QUOTA': 1000000000,\\n # Web settings\\n 'SITENAME': 'Mailu',\\n 'WEBSITE': 'https://mailu.io',\\n 'WEB_ADMIN': '/admin',\\n 'WEB_WEBMAIL': '/webmail',\\n 'WEBMAIL': 'none',\\n 'RECAPTCHA_PUBLIC_KEY': '',\\n 'RECAPTCHA_PRIVATE_KEY': '',\\n # Advanced settings\\n 'LOG_LEVEL': 'WARNING',\\n 'SESSION_KEY_BITS': 128,\\n 'SESSION_LIFETIME': 24,\\n 'SESSION_COOKIE_SECURE': True,\\n 'CREDENTIAL_ROUNDS': 12,\\n # Host settings\\n 'HOST_IMAP': 'imap',\\n 'HOST_LMTP': 'imap:2525',\\n 'HOST_POP3': 'imap',\\n 'HOST_SMTP': 'smtp',\\n 'HOST_AUTHSMTP': 'smtp',\\n 'HOST_ADMIN': 'admin',\\n 'HOST_WEBMAIL': 'webmail',\\n 'HOST_WEBDAV': 'webdav:5232',\\n 'HOST_REDIS': 'redis',\\n 'HOST_FRONT': 'front',\\n 'SUBNET': '192.168.203.0/24',\\n 'SUBNET6': None,\\n 'POD_ADDRESS_RANGE': None\\n}\\n\\nclass ConfigManager(dict):\\n \\\"\\\"\\\" Naive configuration manager that uses environment only\\n \\\"\\\"\\\"\\n\\n DB_TEMPLATES = {\\n 'sqlite': 'sqlite:////{SQLITE_DATABASE_FILE}',\\n 'postgresql': 'postgresql://{DB_USER}:{DB_PW}@{DB_HOST}/{DB_NAME}',\\n 'mysql': 'mysql://{DB_USER}:{DB_PW}@{DB_HOST}/{DB_NAME}'\\n }\\n\\n def __init__(self):\\n self.config = dict()\\n\\n def get_host_address(self, name):\\n # if MYSERVICE_ADDRESS is defined, use this\\n if '{}_ADDRESS'.format(name) in os.environ:\\n return os.environ.get('{}_ADDRESS'.format(name))\\n # otherwise use the host name and resolve it\\n return system.resolve_address(self.config['HOST_{}'.format(name)])\\n\\n def resolve_hosts(self):\\n self.config[\\\"IMAP_ADDRESS\\\"] = self.get_host_address(\\\"IMAP\\\")\\n self.config[\\\"POP3_ADDRESS\\\"] = self.get_host_address(\\\"POP3\\\")\\n self.config[\\\"AUTHSMTP_ADDRESS\\\"] = self.get_host_address(\\\"AUTHSMTP\\\")\\n self.config[\\\"SMTP_ADDRESS\\\"] = self.get_host_address(\\\"SMTP\\\")\\n self.config[\\\"REDIS_ADDRESS\\\"] = self.get_host_address(\\\"REDIS\\\")\\n if self.config[\\\"WEBMAIL\\\"] != \\\"none\\\":\\n self.config[\\\"WEBMAIL_ADDRESS\\\"] = self.get_host_address(\\\"WEBMAIL\\\")\\n\\n def __get_env(self, key, value):\\n key_file = key + \\\"_FILE\\\"\\n if key_file in os.environ:\\n with open(os.environ.get(key_file)) as file:\\n value_from_file = file.read()\\n return value_from_file.strip()\\n else:\\n return os.environ.get(key, value)\\n\\n def __coerce_value(self, value):\\n if isinstance(value, str) and value.lower() in ('true','yes'):\\n return True\\n elif isinstance(value, str) and value.lower() in ('false', 'no'):\\n return False\\n return value\\n\\n def init_app(self, app):\\n self.config.update(app.config)\\n # get environment variables\\n self.config.update({\\n key: self.__coerce_value(self.__get_env(key, value))\\n for key, value in DEFAULT_CONFIG.items()\\n })\\n self.resolve_hosts()\\n\\n # automatically set the sqlalchemy string\\n if self.config['DB_FLAVOR']:\\n template = self.DB_TEMPLATES[self.config['DB_FLAVOR']]\\n self.config['SQLALCHEMY_DATABASE_URI'] = template.format(**self.config)\\n\\n self.config['RATELIMIT_STORAGE_URL'] = 'redis://{0}/2'.format(self.config['REDIS_ADDRESS'])\\n self.config['QUOTA_STORAGE_URL'] = 'redis://{0}/1'.format(self.config['REDIS_ADDRESS'])\\n self.config['SESSION_STORAGE_URL'] = 'redis://{0}/3'.format(self.config['REDIS_ADDRESS'])\\n self.config['SESSION_COOKIE_SAMESITE'] = 'Strict'\\n self.config['SESSION_COOKIE_HTTPONLY'] = True\\n self.config['PERMANENT_SESSION_LIFETIME'] = timedelta(hours=int(self.config['SESSION_LIFETIME']))\\n # update the app config itself\\n app.config = self\\n\\n def setdefault(self, key, value):\\n if key not in self.config:\\n self.config[key] = value\\n return self.config[key]\\n\\n def get(self, *args):\\n return self.config.get(*args)\\n\\n def keys(self):\\n return self.config.keys()\\n\\n def __getitem__(self, key):\\n return self.config.get(key)\\n\\n def __setitem__(self, key, value):\\n self.config[key] = value\\n\\n def __contains__(self, key):\\n return key in self.config\\n\",\n \"path\": \"core/admin/mailu/configuration.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import os\n\nfrom datetime import timedelta\nfrom socrate import system\n\nDEFAULT_CONFIG = {\n # Specific to the admin UI\n 'DOCKER_SOCKET': 'unix:///var/run/docker.sock',\n 'BABEL_DEFAULT_LOCALE': 'en',\n 'BABEL_DEFAULT_TIMEZONE': 'UTC',\n 'BOOTSTRAP_SERVE_LOCAL': True,\n 'RATELIMIT_STORAGE_URL': '',\n 'QUOTA_STORAGE_URL': '',\n 'DEBUG': False,\n 'DOMAIN_REGISTRATION': False,\n 'TEMPLATES_AUTO_RELOAD': True,\n 'MEMORY_SESSIONS': False,\n # Database settings\n 'DB_FLAVOR': None,\n 'DB_USER': 'mailu',\n 'DB_PW': None,\n 'DB_HOST': 'database',\n 'DB_NAME': 'mailu',\n 'SQLITE_DATABASE_FILE':'data/main.db',\n 'SQLALCHEMY_DATABASE_URI': 'sqlite:////data/main.db',\n 'SQLALCHEMY_TRACK_MODIFICATIONS': False,\n # Statistics management\n 'INSTANCE_ID_PATH': '/data/instance',\n 'STATS_ENDPOINT': '18.{}.stats.mailu.io',\n # Common configuration variables\n 'SECRET_KEY': 'changeMe',\n 'DOMAIN': 'mailu.io',\n 'HOSTNAMES': 'mail.mailu.io,alternative.mailu.io,yetanother.mailu.io',\n 'POSTMASTER': 'postmaster',\n 'TLS_FLAVOR': 'cert',\n 'INBOUND_TLS_ENFORCE': False,\n 'AUTH_RATELIMIT': '1000/minute;10000/hour',\n 'AUTH_RATELIMIT_SUBNET': False,\n 'DISABLE_STATISTICS': False,\n # Mail settings\n 'DMARC_RUA': None,\n 'DMARC_RUF': None,\n 'WELCOME': False,\n 'WELCOME_SUBJECT': 'Dummy welcome topic',\n 'WELCOME_BODY': 'Dummy welcome body',\n 'DKIM_SELECTOR': 'dkim',\n 'DKIM_PATH': '/dkim/{domain}.{selector}.key',\n 'DEFAULT_QUOTA': 1000000000,\n # Web settings\n 'SITENAME': 'Mailu',\n 'WEBSITE': 'https://mailu.io',\n 'WEB_ADMIN': '/admin',\n 'WEB_WEBMAIL': '/webmail',\n 'WEBMAIL': 'none',\n 'RECAPTCHA_PUBLIC_KEY': '',\n 'RECAPTCHA_PRIVATE_KEY': '',\n # Advanced settings\n 'LOG_LEVEL': 'WARNING',\n 'SESSION_KEY_BITS': 128,\n 'SESSION_LIFETIME': 24,\n 'SESSION_COOKIE_SECURE': True,\n 'CREDENTIAL_ROUNDS': 12,\n # Host settings\n 'HOST_IMAP': 'imap',\n 'HOST_LMTP': 'imap:2525',\n 'HOST_POP3': 'imap',\n 'HOST_SMTP': 'smtp',\n 'HOST_AUTHSMTP': 'smtp',\n 'HOST_ADMIN': 'admin',\n 'HOST_WEBMAIL': 'webmail',\n 'HOST_WEBDAV': 'webdav:5232',\n 'HOST_REDIS': 'redis',\n 'HOST_FRONT': 'front',\n 'SUBNET': '192.168.203.0/24',\n 'SUBNET6': None,\n 'POD_ADDRESS_RANGE': None\n}\n\nclass ConfigManager(dict):\n \"\"\" Naive configuration manager that uses environment only\n \"\"\"\n\n DB_TEMPLATES = {\n 'sqlite': 'sqlite:////{SQLITE_DATABASE_FILE}',\n 'postgresql': 'postgresql://{DB_USER}:{DB_PW}@{DB_HOST}/{DB_NAME}',\n 'mysql': 'mysql://{DB_USER}:{DB_PW}@{DB_HOST}/{DB_NAME}'\n }\n\n def __init__(self):\n self.config = dict()\n\n def get_host_address(self, name):\n # if MYSERVICE_ADDRESS is defined, use this\n if '{}_ADDRESS'.format(name) in os.environ:\n return os.environ.get('{}_ADDRESS'.format(name))\n # otherwise use the host name and resolve it\n return system.resolve_address(self.config['HOST_{}'.format(name)])\n\n def resolve_hosts(self):\n self.config[\"IMAP_ADDRESS\"] = self.get_host_address(\"IMAP\")\n self.config[\"POP3_ADDRESS\"] = self.get_host_address(\"POP3\")\n self.config[\"AUTHSMTP_ADDRESS\"] = self.get_host_address(\"AUTHSMTP\")\n self.config[\"SMTP_ADDRESS\"] = self.get_host_address(\"SMTP\")\n self.config[\"REDIS_ADDRESS\"] = self.get_host_address(\"REDIS\")\n if self.config[\"WEBMAIL\"] != \"none\":\n self.config[\"WEBMAIL_ADDRESS\"] = self.get_host_address(\"WEBMAIL\")\n\n def __get_env(self, key, value):\n key_file = key + \"_FILE\"\n if key_file in os.environ:\n with open(os.environ.get(key_file)) as file:\n value_from_file = file.read()\n return value_from_file.strip()\n else:\n return os.environ.get(key, value)\n\n def __coerce_value(self, value):\n if isinstance(value, str) and value.lower() in ('true','yes'):\n return True\n elif isinstance(value, str) and value.lower() in ('false', 'no'):\n return False\n return value\n\n def init_app(self, app):\n self.config.update(app.config)\n # get environment variables\n self.config.update({\n key: self.__coerce_value(self.__get_env(key, value))\n for key, value in DEFAULT_CONFIG.items()\n })\n self.resolve_hosts()\n\n # automatically set the sqlalchemy string\n if self.config['DB_FLAVOR']:\n template = self.DB_TEMPLATES[self.config['DB_FLAVOR']]\n self.config['SQLALCHEMY_DATABASE_URI'] = template.format(**self.config)\n\n self.config['RATELIMIT_STORAGE_URL'] = 'redis://{0}/2'.format(self.config['REDIS_ADDRESS'])\n self.config['QUOTA_STORAGE_URL'] = 'redis://{0}/1'.format(self.config['REDIS_ADDRESS'])\n self.config['SESSION_STORAGE_URL'] = 'redis://{0}/3'.format(self.config['REDIS_ADDRESS'])\n self.config['SESSION_COOKIE_SAMESITE'] = 'Strict'\n self.config['SESSION_COOKIE_HTTPONLY'] = True\n self.config['PERMANENT_SESSION_LIFETIME'] = timedelta(hours=int(self.config['SESSION_LIFETIME']))\n # update the app config itself\n app.config = self\n\n def setdefault(self, key, value):\n if key not in self.config:\n self.config[key] = value\n return self.config[key]\n\n def get(self, *args):\n return self.config.get(*args)\n\n def keys(self):\n return self.config.keys()\n\n def __getitem__(self, key):\n return self.config.get(key)\n\n def __setitem__(self, key, value):\n self.config[key] = value\n\n def __contains__(self, key):\n return key in self.config\n","path":"core/admin/mailu/configuration.py"}],"string":"[\n {\n \"content\": \"import os\\n\\nfrom datetime import timedelta\\nfrom socrate import system\\n\\nDEFAULT_CONFIG = {\\n # Specific to the admin UI\\n 'DOCKER_SOCKET': 'unix:///var/run/docker.sock',\\n 'BABEL_DEFAULT_LOCALE': 'en',\\n 'BABEL_DEFAULT_TIMEZONE': 'UTC',\\n 'BOOTSTRAP_SERVE_LOCAL': True,\\n 'RATELIMIT_STORAGE_URL': '',\\n 'QUOTA_STORAGE_URL': '',\\n 'DEBUG': False,\\n 'DOMAIN_REGISTRATION': False,\\n 'TEMPLATES_AUTO_RELOAD': True,\\n 'MEMORY_SESSIONS': False,\\n # Database settings\\n 'DB_FLAVOR': None,\\n 'DB_USER': 'mailu',\\n 'DB_PW': None,\\n 'DB_HOST': 'database',\\n 'DB_NAME': 'mailu',\\n 'SQLITE_DATABASE_FILE':'data/main.db',\\n 'SQLALCHEMY_DATABASE_URI': 'sqlite:////data/main.db',\\n 'SQLALCHEMY_TRACK_MODIFICATIONS': False,\\n # Statistics management\\n 'INSTANCE_ID_PATH': '/data/instance',\\n 'STATS_ENDPOINT': '18.{}.stats.mailu.io',\\n # Common configuration variables\\n 'SECRET_KEY': 'changeMe',\\n 'DOMAIN': 'mailu.io',\\n 'HOSTNAMES': 'mail.mailu.io,alternative.mailu.io,yetanother.mailu.io',\\n 'POSTMASTER': 'postmaster',\\n 'TLS_FLAVOR': 'cert',\\n 'INBOUND_TLS_ENFORCE': False,\\n 'AUTH_RATELIMIT': '1000/minute;10000/hour',\\n 'AUTH_RATELIMIT_SUBNET': False,\\n 'DISABLE_STATISTICS': False,\\n # Mail settings\\n 'DMARC_RUA': None,\\n 'DMARC_RUF': None,\\n 'WELCOME': False,\\n 'WELCOME_SUBJECT': 'Dummy welcome topic',\\n 'WELCOME_BODY': 'Dummy welcome body',\\n 'DKIM_SELECTOR': 'dkim',\\n 'DKIM_PATH': '/dkim/{domain}.{selector}.key',\\n 'DEFAULT_QUOTA': 1000000000,\\n # Web settings\\n 'SITENAME': 'Mailu',\\n 'WEBSITE': 'https://mailu.io',\\n 'WEB_ADMIN': '/admin',\\n 'WEB_WEBMAIL': '/webmail',\\n 'WEBMAIL': 'none',\\n 'RECAPTCHA_PUBLIC_KEY': '',\\n 'RECAPTCHA_PRIVATE_KEY': '',\\n # Advanced settings\\n 'LOG_LEVEL': 'WARNING',\\n 'SESSION_KEY_BITS': 128,\\n 'SESSION_LIFETIME': 24,\\n 'SESSION_COOKIE_SECURE': True,\\n 'CREDENTIAL_ROUNDS': 12,\\n # Host settings\\n 'HOST_IMAP': 'imap',\\n 'HOST_LMTP': 'imap:2525',\\n 'HOST_POP3': 'imap',\\n 'HOST_SMTP': 'smtp',\\n 'HOST_AUTHSMTP': 'smtp',\\n 'HOST_ADMIN': 'admin',\\n 'HOST_WEBMAIL': 'webmail',\\n 'HOST_WEBDAV': 'webdav:5232',\\n 'HOST_REDIS': 'redis',\\n 'HOST_FRONT': 'front',\\n 'SUBNET': '192.168.203.0/24',\\n 'SUBNET6': None,\\n 'POD_ADDRESS_RANGE': None\\n}\\n\\nclass ConfigManager(dict):\\n \\\"\\\"\\\" Naive configuration manager that uses environment only\\n \\\"\\\"\\\"\\n\\n DB_TEMPLATES = {\\n 'sqlite': 'sqlite:////{SQLITE_DATABASE_FILE}',\\n 'postgresql': 'postgresql://{DB_USER}:{DB_PW}@{DB_HOST}/{DB_NAME}',\\n 'mysql': 'mysql://{DB_USER}:{DB_PW}@{DB_HOST}/{DB_NAME}'\\n }\\n\\n def __init__(self):\\n self.config = dict()\\n\\n def get_host_address(self, name):\\n # if MYSERVICE_ADDRESS is defined, use this\\n if '{}_ADDRESS'.format(name) in os.environ:\\n return os.environ.get('{}_ADDRESS'.format(name))\\n # otherwise use the host name and resolve it\\n return system.resolve_address(self.config['HOST_{}'.format(name)])\\n\\n def resolve_hosts(self):\\n self.config[\\\"IMAP_ADDRESS\\\"] = self.get_host_address(\\\"IMAP\\\")\\n self.config[\\\"POP3_ADDRESS\\\"] = self.get_host_address(\\\"POP3\\\")\\n self.config[\\\"AUTHSMTP_ADDRESS\\\"] = self.get_host_address(\\\"AUTHSMTP\\\")\\n self.config[\\\"SMTP_ADDRESS\\\"] = self.get_host_address(\\\"SMTP\\\")\\n self.config[\\\"REDIS_ADDRESS\\\"] = self.get_host_address(\\\"REDIS\\\")\\n if self.config[\\\"WEBMAIL\\\"] != \\\"none\\\":\\n self.config[\\\"WEBMAIL_ADDRESS\\\"] = self.get_host_address(\\\"WEBMAIL\\\")\\n\\n def __get_env(self, key, value):\\n key_file = key + \\\"_FILE\\\"\\n if key_file in os.environ:\\n with open(os.environ.get(key_file)) as file:\\n value_from_file = file.read()\\n return value_from_file.strip()\\n else:\\n return os.environ.get(key, value)\\n\\n def __coerce_value(self, value):\\n if isinstance(value, str) and value.lower() in ('true','yes'):\\n return True\\n elif isinstance(value, str) and value.lower() in ('false', 'no'):\\n return False\\n return value\\n\\n def init_app(self, app):\\n self.config.update(app.config)\\n # get environment variables\\n self.config.update({\\n key: self.__coerce_value(self.__get_env(key, value))\\n for key, value in DEFAULT_CONFIG.items()\\n })\\n self.resolve_hosts()\\n\\n # automatically set the sqlalchemy string\\n if self.config['DB_FLAVOR']:\\n template = self.DB_TEMPLATES[self.config['DB_FLAVOR']]\\n self.config['SQLALCHEMY_DATABASE_URI'] = template.format(**self.config)\\n\\n self.config['RATELIMIT_STORAGE_URL'] = 'redis://{0}/2'.format(self.config['REDIS_ADDRESS'])\\n self.config['QUOTA_STORAGE_URL'] = 'redis://{0}/1'.format(self.config['REDIS_ADDRESS'])\\n self.config['SESSION_STORAGE_URL'] = 'redis://{0}/3'.format(self.config['REDIS_ADDRESS'])\\n self.config['SESSION_COOKIE_SAMESITE'] = 'Strict'\\n self.config['SESSION_COOKIE_HTTPONLY'] = True\\n self.config['PERMANENT_SESSION_LIFETIME'] = timedelta(hours=int(self.config['SESSION_LIFETIME']))\\n # update the app config itself\\n app.config = self\\n\\n def setdefault(self, key, value):\\n if key not in self.config:\\n self.config[key] = value\\n return self.config[key]\\n\\n def get(self, *args):\\n return self.config.get(*args)\\n\\n def keys(self):\\n return self.config.keys()\\n\\n def __getitem__(self, key):\\n return self.config.get(key)\\n\\n def __setitem__(self, key, value):\\n self.config[key] = value\\n\\n def __contains__(self, key):\\n return key in self.config\\n\",\n \"path\": \"core/admin/mailu/configuration.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/core/admin/mailu/configuration.py b/core/admin/mailu/configuration.py\nindex 3d1b4fb51..d2d34d882 100644\n--- a/core/admin/mailu/configuration.py\n+++ b/core/admin/mailu/configuration.py\n@@ -34,8 +34,8 @@\n 'POSTMASTER': 'postmaster',\n 'TLS_FLAVOR': 'cert',\n 'INBOUND_TLS_ENFORCE': False,\n- 'AUTH_RATELIMIT': '10/minute;1000/hour',\n- 'AUTH_RATELIMIT_SUBNET': True,\n+ 'AUTH_RATELIMIT': '1000/minute;10000/hour',\n+ 'AUTH_RATELIMIT_SUBNET': False,\n 'DISABLE_STATISTICS': False,\n # Mail settings\n 'DMARC_RUA': None,\ndiff --git a/docs/configuration.rst b/docs/configuration.rst\nindex 16ea23c3a..d7ebfc118 100644\n--- a/docs/configuration.rst\n+++ b/docs/configuration.rst\n@@ -41,7 +41,7 @@ The ``AUTH_RATELIMIT`` holds a security setting for fighting attackers that\n try to guess user passwords. The value is the limit of failed authentication attempts\n that a single IP address can perform against IMAP, POP and SMTP authentication endpoints.\n \n-If ``AUTH_RATELIMIT_SUBNET`` is ``True`` (which is the default), the ``AUTH_RATELIMIT``\n+If ``AUTH_RATELIMIT_SUBNET`` is ``True`` (default: False), the ``AUTH_RATELIMIT``\n rules does also apply to auth requests coming from ``SUBNET``, especially for the webmail.\n If you disable this, ensure that the rate limit on the webmail is enforced in a different\n way (e.g. roundcube plug-in), otherwise an attacker can simply bypass the limit using webmail.\ndiff --git a/setup/templates/steps/config.html b/setup/templates/steps/config.html\nindex 3769a2108..72b83915b 100644\n--- a/setup/templates/steps/config.html\n+++ b/setup/templates/steps/config.html\n@@ -50,8 +50,8 @@\n <div class=\"form-group\">\n <label>Authentication rate limit (per source IP address)</label>\n <!-- Validates number input only -->\n- <p><input class=\"form-control\" style=\"width: 7%; display: inline;\" type=\"number\" name=\"auth_ratelimit_pm\"\n- \t\tvalue=\"10\" required > / minute\n+ <p><input class=\"form-control\" style=\"width: 9%; display: inline;\" type=\"number\" name=\"auth_ratelimit_pm\"\n+ \t\tvalue=\"10000\" required > / minute\n </p>\n </div>\n \ndiff --git a/towncrier/newsfragments/1867.feature b/towncrier/newsfragments/1867.feature\nnew file mode 100644\nindex 000000000..fbd3a7d79\n--- /dev/null\n+++ b/towncrier/newsfragments/1867.feature\n@@ -0,0 +1 @@\n+Changed default value of AUTH_RATELIMIT_SUBNET to false. Increased default value of the rate limit in setup utility (AUTH_RATELIMIT) to a higher value.\n"}}},{"rowIdx":4667,"cells":{"in_source_id":{"kind":"string","value":"certbot__certbot-9802"},"issue":{"kind":"string","value":"certbot-dns-ovh failed with Error adding TXT record: Expecting value: line 1 column 1 (char 0)\n## My operating system is (include version):\r\n\r\nMacoSX 13.6 using docker latest image : https://hub.docker.com/r/certbot/dns-ovh\r\n\r\n## I installed Certbot with (snap, OS package manager, pip, certbot-auto, etc):\r\n\r\nDocker\r\n\r\n## I ran this command and it produced this output:\r\n\r\nCommand :\r\ndocker run -it --rm --name certbot \\\r\n -v \"/Users/mguyard/Documents/Docker/certbot/etc/letsencrypt:/etc/letsencrypt\" \\\r\n -v \"/Users/mguyard/Documents/Docker/certbot/var/lib/letsencrypt:/var/lib/letsencrypt\" \\\r\n certbot/certbot certonly --dns-ovh --dns-ovh-credentials \"/etc/letsencrypt/.ovhapi\" --non-interactive --agree-tos --email me@mydomain.com -d '*.mydomain.com' --logs-dir \"/etc/letsencrypt/logs\" --config-dir \"/etc/letsencrypt/config\" --work-dir \"/etc/letsencrypt/work\" -v\r\n\r\nResult :\r\n```\r\nSaving debug log to /etc/letsencrypt/logs/letsencrypt.log\r\nPlugins selected: Authenticator dns-ovh, Installer None\r\nCertificate is due for renewal, auto-renewing...\r\nRenewing an existing certificate for *.mguyard.com\r\nPerforming the following challenges:\r\ndns-01 challenge for mguyard.com\r\nCleaning up challenges\r\nError adding TXT record: Expecting value: line 1 column 1 (char 0)\r\nAsk for help or search for solutions at https://community.letsencrypt.org. See the logfile /etc/letsencrypt/logs/letsencrypt.log or re-run Certbot with -v for more details.\r\n```\r\n\r\n\r\n## Certbot's behavior differed from what I expected because:\r\n\r\nCertificate end with error and isn't renew\r\n\r\n## Here is a Certbot log showing the issue (if available):\r\n###### Logs are stored in `/var/log/letsencrypt` by default. Feel free to redact domains, e-mail and IP addresses as you see fit.\r\n\r\n```\r\n2023-10-12 17:11:48,231:DEBUG:certbot._internal.main:certbot version: 2.7.1\r\n2023-10-12 17:11:48,231:DEBUG:certbot._internal.main:Location of certbot entry point: /usr/local/bin/certbot\r\n2023-10-12 17:11:48,231:DEBUG:certbot._internal.main:Arguments: ['--dns-ovh', '--dns-ovh-credentials', '/etc/letsencrypt/.ovhapi', '--non-interactive', '--agree-tos', '--email', 'marc@mydomain.com', '-d', '*.mydomain.com', '--logs-dir', '/etc/letsencrypt/logs', '--config-dir', '/etc/letsencrypt/config', '--work-dir', '/etc/letsencrypt/work', '-v']\r\n2023-10-12 17:11:48,231:DEBUG:certbot._internal.main:Discovered plugins: PluginsRegistry(PluginEntryPoint#dns-ovh,PluginEntryPoint#manual,PluginEntryPoint#null,PluginEntryPoint#standalone,PluginEntryPoint#webroot)\r\n2023-10-12 17:11:48,318:DEBUG:certbot._internal.log:Root logging level set at 20\r\n2023-10-12 17:11:48,321:DEBUG:certbot._internal.plugins.selection:Requested authenticator dns-ovh and installer None\r\n2023-10-12 17:11:48,322:DEBUG:certbot._internal.plugins.selection:Single candidate plugin: * dns-ovh\r\nDescription: Obtain certificates using a DNS TXT record (if you are using OVH for DNS).\r\nInterfaces: Authenticator, Plugin\r\nEntry point: EntryPoint(name='dns-ovh', value='certbot_dns_ovh._internal.dns_ovh:Authenticator', group='certbot.plugins')\r\nInitialized: <certbot_dns_ovh._internal.dns_ovh.Authenticator object at 0xffff8fefa410>\r\nPrep: True\r\n2023-10-12 17:11:48,322:DEBUG:certbot._internal.plugins.selection:Selected authenticator <certbot_dns_ovh._internal.dns_ovh.Authenticator object at 0xffff8fefa410> and installer None\r\n2023-10-12 17:11:48,322:INFO:certbot._internal.plugins.selection:Plugins selected: Authenticator dns-ovh, Installer None\r\n2023-10-12 17:11:48,367:DEBUG:certbot._internal.main:Picked account: <Account(RegistrationResource(body=Registration(key=None, contact=(), agreement=None, status=None, terms_of_service_agreed=None, only_return_existing=None, external_account_binding=None), uri='https://acme-v02.api.letsencrypt.org/acme/acct/728015997', new_authzr_uri=None, terms_of_service=None), 17a77fe8ee348e150aac144f5edce683, Meta(creation_dt=datetime.datetime(2022, 9, 12, 8, 25, tzinfo=<UTC>), creation_host='3bbceec2dec9', register_to_eff=None))>\r\n2023-10-12 17:11:48,368:DEBUG:acme.client:Sending GET request to https://acme-v02.api.letsencrypt.org/directory.\r\n2023-10-12 17:11:48,369:DEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): acme-v02.api.letsencrypt.org:443\r\n2023-10-12 17:11:49,128:DEBUG:urllib3.connectionpool:https://acme-v02.api.letsencrypt.org:443 \"GET /directory HTTP/1.1\" 200 752\r\n2023-10-12 17:11:49,129:DEBUG:acme.client:Received response:\r\nHTTP 200\r\nServer: nginx\r\nDate: Thu, 12 Oct 2023 17:11:49 GMT\r\nContent-Type: application/json\r\nContent-Length: 752\r\nConnection: keep-alive\r\nCache-Control: public, max-age=0, no-cache\r\nX-Frame-Options: DENY\r\nStrict-Transport-Security: max-age=604800\r\n\r\n{\r\n \"Q5kkPCShlRQ\": \"https://community.letsencrypt.org/t/adding-random-entries-to-the-directory/33417\",\r\n \"keyChange\": \"https://acme-v02.api.letsencrypt.org/acme/key-change\",\r\n \"meta\": {\r\n \"caaIdentities\": [\r\n \"letsencrypt.org\"\r\n ],\r\n \"termsOfService\": \"https://letsencrypt.org/documents/LE-SA-v1.3-September-21-2022.pdf\",\r\n \"website\": \"https://letsencrypt.org\"\r\n },\r\n \"newAccount\": \"https://acme-v02.api.letsencrypt.org/acme/new-acct\",\r\n \"newNonce\": \"https://acme-v02.api.letsencrypt.org/acme/new-nonce\",\r\n \"newOrder\": \"https://acme-v02.api.letsencrypt.org/acme/new-order\",\r\n \"renewalInfo\": \"https://acme-v02.api.letsencrypt.org/draft-ietf-acme-ari-01/renewalInfo/\",\r\n \"revokeCert\": \"https://acme-v02.api.letsencrypt.org/acme/revoke-cert\"\r\n}\r\n2023-10-12 17:11:49,201:DEBUG:certbot._internal.storage:Should renew, less than 30 days before certificate expiry 2023-10-10 11:53:51 UTC.\r\n2023-10-12 17:11:49,201:INFO:certbot._internal.renewal:Certificate is due for renewal, auto-renewing...\r\n2023-10-12 17:11:49,202:DEBUG:certbot._internal.display.obj:Notifying user: Renewing an existing certificate for *.mydomain.com\r\n2023-10-12 17:11:49,223:DEBUG:acme.client:Requesting fresh nonce\r\n2023-10-12 17:11:49,223:DEBUG:acme.client:Sending HEAD request to https://acme-v02.api.letsencrypt.org/acme/new-nonce.\r\n2023-10-12 17:11:49,381:DEBUG:urllib3.connectionpool:https://acme-v02.api.letsencrypt.org:443 \"HEAD /acme/new-nonce HTTP/1.1\" 200 0\r\n2023-10-12 17:11:49,382:DEBUG:acme.client:Received response:\r\nHTTP 200\r\nServer: nginx\r\nDate: Thu, 12 Oct 2023 17:11:49 GMT\r\nConnection: keep-alive\r\nCache-Control: public, max-age=0, no-cache\r\nLink: <https://acme-v02.api.letsencrypt.org/directory>;rel=\"index\"\r\nReplay-Nonce: _s_5u1NQesnT8oZjPBpqAaEhMw2v6CydHCwhnmR5XInLyyHRIPE\r\nX-Frame-Options: DENY\r\nStrict-Transport-Security: max-age=604800\r\n\r\n\r\n2023-10-12 17:11:49,382:DEBUG:acme.client:Storing nonce: _s_5u1NQesnT8oZjPBpqAaEhMw2v6CydHCwhnmR5XInLyyHRIPE\r\n2023-10-12 17:11:49,383:DEBUG:acme.client:JWS payload:\r\nb'{\\n \"identifiers\": [\\n {\\n \"type\": \"dns\",\\n \"value\": \"*.mydomain.com\"\\n }\\n ]\\n}'\r\n2023-10-12 17:11:49,386:DEBUG:acme.client:Sending POST request to https://acme-v02.api.letsencrypt.org/acme/new-order:\r\n{\r\n \"protected\": \"eyJhbGciOiAiUlMyNTYiLCAia2lkIjogImh0dHBzOi8vYWNtZS12MDIuYXBpLmxldHNlbmNyeXB0Lm9yZy9hY21lL2FjY3QvNzI4MDE1OTk3IiwgIm5vbmNlIjogIl9zXzV1MU5RZXNuVDhvWmpQQnBxQWFFaE13MnY2Q3lkSEN3aG5tUjVYSW5MeXlIUklQRSIsICJ1cmwiOiAiaHR0cHM6Ly9hY21lLXYwMi5hcGkubGV0c2VuY3J5cHQub3JnL2FjbWUvbmV3LW9yZGVyIn0\",\r\n \"signature\": \"Jj0Sp2hzhdI2hDnBEFcqvMhhIf0mPsH89YUFw-7Se-rglCtsxrxrituJzMpx2ES2FiMiCJYu-f8DKtVxM2hYSbxpho0Uhn0eWtmIUjkHZvZZs54cYQR7CLP2hZ37mn9eq-Jlb1GFLPTEqbgIUhel90RM09mLPEa2O-sq0S9RamdDlAHGqd3EpHGUQG4VqMxXYD7SGRMkQA2fLMJgoh1wdrWOKKfU_UbdXF-qG4DyBWSjSAc2HzXMRSRoc-6xIcXO2mjFz4jG9mA3fFT7WCCKf2MzPpqyeWyIBY1a7nK0VkQrvqjoa3WsHXx0XTMZUwUBST2raKGKUdnMwu4R8dqx4g\",\r\n \"payload\": \"ewogICJpZGVudGlmaWVycyI6IFsKICAgIHsKICAgICAgInR5cGUiOiAiZG5zIiwKICAgICAgInZhbHVlIjogIioubWd1eWFyZC5jb20iCiAgICB9CiAgXQp9\"\r\n}\r\n2023-10-12 17:11:49,565:DEBUG:urllib3.connectionpool:https://acme-v02.api.letsencrypt.org:443 \"POST /acme/new-order HTTP/1.1\" 201 338\r\n2023-10-12 17:11:49,566:DEBUG:acme.client:Received response:\r\nHTTP 201\r\nServer: nginx\r\nDate: Thu, 12 Oct 2023 17:11:49 GMT\r\nContent-Type: application/json\r\nContent-Length: 338\r\nConnection: keep-alive\r\nBoulder-Requester: 728015997\r\nCache-Control: public, max-age=0, no-cache\r\nLink: <https://acme-v02.api.letsencrypt.org/directory>;rel=\"index\"\r\nLocation: https://acme-v02.api.letsencrypt.org/acme/order/728015997/214563998906\r\nReplay-Nonce: _s_5u1NQdwW67X0xzS5_dSAlKHRVyVeyJKM_Zg4ZROl40Auts9w\r\nX-Frame-Options: DENY\r\nStrict-Transport-Security: max-age=604800\r\n\r\n{\r\n \"status\": \"pending\",\r\n \"expires\": \"2023-10-19T11:11:26Z\",\r\n \"identifiers\": [\r\n {\r\n \"type\": \"dns\",\r\n \"value\": \"*.mydomain.com\"\r\n }\r\n ],\r\n \"authorizations\": [\r\n \"https://acme-v02.api.letsencrypt.org/acme/authz-v3/273135072886\"\r\n ],\r\n \"finalize\": \"https://acme-v02.api.letsencrypt.org/acme/finalize/728015997/214563998906\"\r\n}\r\n2023-10-12 17:11:49,567:DEBUG:acme.client:Storing nonce: _s_5u1NQdwW67X0xzS5_dSAlKHRVyVeyJKM_Zg4ZROl40Auts9w\r\n2023-10-12 17:11:49,568:DEBUG:acme.client:JWS payload:\r\nb''\r\n2023-10-12 17:11:49,571:DEBUG:acme.client:Sending POST request to https://acme-v02.api.letsencrypt.org/acme/authz-v3/273135072886:\r\n{\r\n \"protected\": \"eyJhbGciOiAiUlMyNTYiLCAia2lkIjogImh0dHBzOi8vYWNtZS12MDIuYXBpLmxldHNlbmNyeXB0Lm9yZy9hY21lL2FjY3QvNzI4MDE1OTk3IiwgIm5vbmNlIjogIl9zXzV1MU5RZHdXNjdYMHh6UzVfZFNBbEtIUlZ5VmV5SktNX1pnNFpST2w0MEF1dHM5dyIsICJ1cmwiOiAiaHR0cHM6Ly9hY21lLXYwMi5hcGkubGV0c2VuY3J5cHQub3JnL2FjbWUvYXV0aHotdjMvMjczMTM1MDcyODg2In0\",\r\n \"signature\": \"Xd5zPjUSbV039jIfs_bOBd2bajp8iiAQoKaRWLzZHkSMvbnTRliGzedTaQo9b01qiI-J1USTkbqdlXq15RujAhh-CdmD70qCVGup8-K5R-gfWsCBl5DwmUdA5ytGmRhbQCLSZt40OaNvAlfD3HwLeeAwg43yR7UcHfz1Mk-Pa4Lc-70TxaBImNlVeMM5G4UbR0Bb03o10OW8_krdXPz-NYssLiIDV9T-_sfP7zB_D2CJ54o2zHx5oeM3DWnHCQCprcbPlGlgi4IVzr3hhhq_AkpxI6IIvl_F9ziKiYI2-DecfPbSVt9sczs5wrb4wwOx7kOKWTVkwwZjD_46JAVjlg\",\r\n \"payload\": \"\"\r\n}\r\n2023-10-12 17:11:49,732:DEBUG:urllib3.connectionpool:https://acme-v02.api.letsencrypt.org:443 \"POST /acme/authz-v3/273135072886 HTTP/1.1\" 200 385\r\n2023-10-12 17:11:49,733:DEBUG:acme.client:Received response:\r\nHTTP 200\r\nServer: nginx\r\nDate: Thu, 12 Oct 2023 17:11:49 GMT\r\nContent-Type: application/json\r\nContent-Length: 385\r\nConnection: keep-alive\r\nBoulder-Requester: 728015997\r\nCache-Control: public, max-age=0, no-cache\r\nLink: <https://acme-v02.api.letsencrypt.org/directory>;rel=\"index\"\r\nReplay-Nonce: _s_5u1NQSMtSKKLPhg0YW4NUXu-3WtIhNW_K3-1HP9ItVKD_ItQ\r\nX-Frame-Options: DENY\r\nStrict-Transport-Security: max-age=604800\r\n\r\n{\r\n \"identifier\": {\r\n \"type\": \"dns\",\r\n \"value\": \"mydomain.com\"\r\n },\r\n \"status\": \"pending\",\r\n \"expires\": \"2023-10-19T11:11:26Z\",\r\n \"challenges\": [\r\n {\r\n \"type\": \"dns-01\",\r\n \"status\": \"pending\",\r\n \"url\": \"https://acme-v02.api.letsencrypt.org/acme/chall-v3/273135072886/g5IbYA\",\r\n \"token\": \"glIZphzibloH4KOTCCnIEVniRVcNdyghsHABrcOhIM8\"\r\n }\r\n ],\r\n \"wildcard\": true\r\n}\r\n2023-10-12 17:11:49,734:DEBUG:acme.client:Storing nonce: _s_5u1NQSMtSKKLPhg0YW4NUXu-3WtIhNW_K3-1HP9ItVKD_ItQ\r\n2023-10-12 17:11:49,734:INFO:certbot._internal.auth_handler:Performing the following challenges:\r\n2023-10-12 17:11:49,735:INFO:certbot._internal.auth_handler:dns-01 challenge for mydomain.com\r\n2023-10-12 17:11:49,786:DEBUG:filelock:Attempting to acquire lock 281473097129776 on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:49,787:DEBUG:filelock:Lock 281473097129776 acquired on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:49,788:DEBUG:filelock:Attempting to acquire lock 281473097131936 on /root/.lexicon_tld_set/urls/62bf135d1c2f3d4db4228b9ecaf507a2.tldextract.json.lock\r\n2023-10-12 17:11:49,788:DEBUG:filelock:Lock 281473097131936 acquired on /root/.lexicon_tld_set/urls/62bf135d1c2f3d4db4228b9ecaf507a2.tldextract.json.lock\r\n2023-10-12 17:11:49,789:DEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): publicsuffix.org:443\r\n2023-10-12 17:11:50,376:DEBUG:urllib3.connectionpool:https://publicsuffix.org:443 \"GET /list/public_suffix_list.dat HTTP/1.1\" 200 81964\r\n2023-10-12 17:11:50,404:DEBUG:filelock:Attempting to release lock 281473097131936 on /root/.lexicon_tld_set/urls/62bf135d1c2f3d4db4228b9ecaf507a2.tldextract.json.lock\r\n2023-10-12 17:11:50,405:DEBUG:filelock:Lock 281473097131936 released on /root/.lexicon_tld_set/urls/62bf135d1c2f3d4db4228b9ecaf507a2.tldextract.json.lock\r\n2023-10-12 17:11:50,421:DEBUG:filelock:Attempting to release lock 281473097129776 on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:50,422:DEBUG:filelock:Lock 281473097129776 released on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:50,458:DEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): eu.api.ovh.com:443\r\n2023-10-12 17:11:50,730:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"GET /1.0/auth/time HTTP/1.1\" 200 10\r\n2023-10-12 17:11:50,779:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"GET /1.0/domain/zone/ HTTP/1.1\" 200 None\r\n2023-10-12 17:11:50,901:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"GET /1.0/domain/zone/mydomain.com/status HTTP/1.1\" 200 None\r\n2023-10-12 17:11:50,942:DEBUG:filelock:Attempting to acquire lock 281473084944640 on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:50,943:DEBUG:filelock:Lock 281473084944640 acquired on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:50,944:DEBUG:filelock:Attempting to release lock 281473084944640 on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:50,944:DEBUG:filelock:Lock 281473084944640 released on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:50,961:DEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): eu.api.ovh.com:443\r\n2023-10-12 17:11:51,229:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"GET /1.0/auth/time HTTP/1.1\" 200 10\r\n2023-10-12 17:11:51,264:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"GET /1.0/domain/zone/ HTTP/1.1\" 200 None\r\n2023-10-12 17:11:51,339:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"GET /1.0/domain/zone/mydomain.com/status HTTP/1.1\" 200 None\r\n2023-10-12 17:11:51,394:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"GET /1.0/domain/zone/mydomain.com/record?fieldType=TXT&subDomain=_acme-challenge HTTP/1.1\" 200 2\r\n2023-10-12 17:11:51,396:DEBUG:lexicon._private.providers.ovh:list_records: []\r\n2023-10-12 17:11:51,544:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"POST /1.0/domain/zone/mydomain.com/record HTTP/1.1\" 200 None\r\n2023-10-12 17:11:51,652:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"POST /1.0/domain/zone/mydomain.com/refresh HTTP/1.1\" 204 0\r\n2023-10-12 17:11:51,654:DEBUG:certbot.plugins.dns_common_lexicon:Encountered error adding TXT record: Expecting value: line 1 column 1 (char 0)\r\nTraceback (most recent call last):\r\n File \"/usr/local/lib/python3.10/site-packages/requests/models.py\", line 971, in json\r\n return complexjson.loads(self.text, **kwargs)\r\n File \"/usr/local/lib/python3.10/json/__init__.py\", line 346, in loads\r\n return _default_decoder.decode(s)\r\n File \"/usr/local/lib/python3.10/json/decoder.py\", line 337, in decode\r\n obj, end = self.raw_decode(s, idx=_w(s, 0).end())\r\n File \"/usr/local/lib/python3.10/json/decoder.py\", line 355, in raw_decode\r\n raise JSONDecodeError(\"Expecting value\", s, err.value) from None\r\njson.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0)\r\n\r\nDuring handling of the above exception, another exception occurred:\r\n\r\nTraceback (most recent call last):\r\n File \"/opt/certbot/src/certbot/certbot/plugins/dns_common_lexicon.py\", line 221, in _perform\r\n operations.create_record(rtype='TXT', name=validation_name, content=validation)\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/client.py\", line 34, in create_record\r\n return self.provider.create_record(rtype, name, content)\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/_private/providers/ovh.py\", line 129, in create_record\r\n self._post(f\"/domain/zone/{domain}/refresh\")\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/interfaces.py\", line 168, in _post\r\n return self._request(\"POST\", url, data=data, query_params=query_params)\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/_private/providers/ovh.py\", line 260, in _request\r\n return result.json()\r\n File \"/usr/local/lib/python3.10/site-packages/requests/models.py\", line 975, in json\r\n raise RequestsJSONDecodeError(e.msg, e.doc, e.pos)\r\nrequests.exceptions.JSONDecodeError: Expecting value: line 1 column 1 (char 0)\r\n2023-10-12 17:11:51,658:DEBUG:certbot._internal.error_handler:Encountered exception:\r\nTraceback (most recent call last):\r\n File \"/usr/local/lib/python3.10/site-packages/requests/models.py\", line 971, in json\r\n return complexjson.loads(self.text, **kwargs)\r\n File \"/usr/local/lib/python3.10/json/__init__.py\", line 346, in loads\r\n return _default_decoder.decode(s)\r\n File \"/usr/local/lib/python3.10/json/decoder.py\", line 337, in decode\r\n obj, end = self.raw_decode(s, idx=_w(s, 0).end())\r\n File \"/usr/local/lib/python3.10/json/decoder.py\", line 355, in raw_decode\r\n raise JSONDecodeError(\"Expecting value\", s, err.value) from None\r\njson.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0)\r\n\r\nDuring handling of the above exception, another exception occurred:\r\n\r\nTraceback (most recent call last):\r\n File \"/opt/certbot/src/certbot/certbot/plugins/dns_common_lexicon.py\", line 221, in _perform\r\n operations.create_record(rtype='TXT', name=validation_name, content=validation)\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/client.py\", line 34, in create_record\r\n return self.provider.create_record(rtype, name, content)\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/_private/providers/ovh.py\", line 129, in create_record\r\n self._post(f\"/domain/zone/{domain}/refresh\")\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/interfaces.py\", line 168, in _post\r\n return self._request(\"POST\", url, data=data, query_params=query_params)\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/_private/providers/ovh.py\", line 260, in _request\r\n return result.json()\r\n File \"/usr/local/lib/python3.10/site-packages/requests/models.py\", line 975, in json\r\n raise RequestsJSONDecodeError(e.msg, e.doc, e.pos)\r\nrequests.exceptions.JSONDecodeError: Expecting value: line 1 column 1 (char 0)\r\n\r\nDuring handling of the above exception, another exception occurred:\r\n\r\nTraceback (most recent call last):\r\n File \"/opt/certbot/src/certbot/certbot/_internal/auth_handler.py\", line 88, in handle_authorizations\r\n resps = self.auth.perform(achalls)\r\n File \"/opt/certbot/src/certbot/certbot/plugins/dns_common.py\", line 76, in perform\r\n self._perform(domain, validation_domain_name, validation)\r\n File \"/opt/certbot/src/certbot/certbot/plugins/dns_common_lexicon.py\", line 224, in _perform\r\n raise errors.PluginError('Error adding TXT record: {0}'.format(e))\r\ncertbot.errors.PluginError: Error adding TXT record: Expecting value: line 1 column 1 (char 0)\r\n\r\n2023-10-12 17:11:51,659:DEBUG:certbot._internal.error_handler:Calling registered functions\r\n2023-10-12 17:11:51,659:INFO:certbot._internal.auth_handler:Cleaning up challenges\r\n2023-10-12 17:11:51,695:DEBUG:filelock:Attempting to acquire lock 281473082809680 on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:51,696:DEBUG:filelock:Lock 281473082809680 acquired on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:51,697:DEBUG:filelock:Attempting to release lock 281473082809680 on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:51,697:DEBUG:filelock:Lock 281473082809680 released on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:51,720:DEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): eu.api.ovh.com:443\r\n2023-10-12 17:11:52,034:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"GET /1.0/auth/time HTTP/1.1\" 200 10\r\n2023-10-12 17:11:52,110:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"GET /1.0/domain/zone/ HTTP/1.1\" 200 None\r\n2023-10-12 17:11:52,199:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"GET /1.0/domain/zone/mydomain.com/status HTTP/1.1\" 200 None\r\n2023-10-12 17:11:52,242:DEBUG:filelock:Attempting to acquire lock 281473085303072 on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:52,243:DEBUG:filelock:Lock 281473085303072 acquired on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:52,244:DEBUG:filelock:Attempting to release lock 281473085303072 on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:52,244:DEBUG:filelock:Lock 281473085303072 released on /root/.lexicon_tld_set/publicsuffix.org-tlds/de84b5ca2167d4c83e38fb162f2e8738.tldextract.json.lock\r\n2023-10-12 17:11:52,261:DEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): eu.api.ovh.com:443\r\n2023-10-12 17:11:52,559:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"GET /1.0/auth/time HTTP/1.1\" 200 10\r\n2023-10-12 17:11:52,618:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"GET /1.0/domain/zone/ HTTP/1.1\" 200 None\r\n2023-10-12 17:11:52,689:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"GET /1.0/domain/zone/mydomain.com/status HTTP/1.1\" 200 None\r\n2023-10-12 17:11:52,759:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"GET /1.0/domain/zone/mydomain.com/record?fieldType=TXT&subDomain=_acme-challenge HTTP/1.1\" 200 12\r\n2023-10-12 17:11:52,812:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"GET /1.0/domain/zone/mydomain.com/record/5288946926 HTTP/1.1\" 200 None\r\n2023-10-12 17:11:52,813:DEBUG:lexicon._private.providers.ovh:list_records: [{'type': 'TXT', 'name': '_acme-challenge.mydomain.com', 'ttl': 60, 'content': 'XUBy2LmYnK0XEIf5m3C55irRFyXmqQioIy_YcxCyy6E', 'id': 5288946926}]\r\n2023-10-12 17:11:52,814:DEBUG:lexicon._private.providers.ovh:delete_records: [5288946926]\r\n2023-10-12 17:11:52,936:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"DELETE /1.0/domain/zone/mydomain.com/record/5288946926 HTTP/1.1\" 200 4\r\n2023-10-12 17:11:53,031:DEBUG:urllib3.connectionpool:https://eu.api.ovh.com:443 \"POST /1.0/domain/zone/mydomain.com/refresh HTTP/1.1\" 204 0\r\n2023-10-12 17:11:53,033:DEBUG:certbot.plugins.dns_common_lexicon:Encountered error deleting TXT record: Expecting value: line 1 column 1 (char 0)\r\nTraceback (most recent call last):\r\n File \"/usr/local/lib/python3.10/site-packages/requests/models.py\", line 971, in json\r\n return complexjson.loads(self.text, **kwargs)\r\n File \"/usr/local/lib/python3.10/json/__init__.py\", line 346, in loads\r\n return _default_decoder.decode(s)\r\n File \"/usr/local/lib/python3.10/json/decoder.py\", line 337, in decode\r\n obj, end = self.raw_decode(s, idx=_w(s, 0).end())\r\n File \"/usr/local/lib/python3.10/json/decoder.py\", line 355, in raw_decode\r\n raise JSONDecodeError(\"Expecting value\", s, err.value) from None\r\njson.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0)\r\n\r\nDuring handling of the above exception, another exception occurred:\r\n\r\nTraceback (most recent call last):\r\n File \"/opt/certbot/src/certbot/certbot/plugins/dns_common_lexicon.py\", line 236, in _cleanup\r\n operations.delete_record(rtype='TXT', name=validation_name, content=validation)\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/client.py\", line 73, in delete_record\r\n return self.provider.delete_record(identifier, rtype, name, content)\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/_private/providers/ovh.py\", line 210, in delete_record\r\n self._post(f\"/domain/zone/{domain}/refresh\")\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/interfaces.py\", line 168, in _post\r\n return self._request(\"POST\", url, data=data, query_params=query_params)\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/_private/providers/ovh.py\", line 260, in _request\r\n return result.json()\r\n File \"/usr/local/lib/python3.10/site-packages/requests/models.py\", line 975, in json\r\n raise RequestsJSONDecodeError(e.msg, e.doc, e.pos)\r\nrequests.exceptions.JSONDecodeError: Expecting value: line 1 column 1 (char 0)\r\n2023-10-12 17:11:53,037:DEBUG:certbot._internal.log:Exiting abnormally:\r\nTraceback (most recent call last):\r\n File \"/usr/local/lib/python3.10/site-packages/requests/models.py\", line 971, in json\r\n return complexjson.loads(self.text, **kwargs)\r\n File \"/usr/local/lib/python3.10/json/__init__.py\", line 346, in loads\r\n return _default_decoder.decode(s)\r\n File \"/usr/local/lib/python3.10/json/decoder.py\", line 337, in decode\r\n obj, end = self.raw_decode(s, idx=_w(s, 0).end())\r\n File \"/usr/local/lib/python3.10/json/decoder.py\", line 355, in raw_decode\r\n raise JSONDecodeError(\"Expecting value\", s, err.value) from None\r\njson.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0)\r\n\r\nDuring handling of the above exception, another exception occurred:\r\n\r\nTraceback (most recent call last):\r\n File \"/opt/certbot/src/certbot/certbot/plugins/dns_common_lexicon.py\", line 221, in _perform\r\n operations.create_record(rtype='TXT', name=validation_name, content=validation)\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/client.py\", line 34, in create_record\r\n return self.provider.create_record(rtype, name, content)\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/_private/providers/ovh.py\", line 129, in create_record\r\n self._post(f\"/domain/zone/{domain}/refresh\")\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/interfaces.py\", line 168, in _post\r\n return self._request(\"POST\", url, data=data, query_params=query_params)\r\n File \"/usr/local/lib/python3.10/site-packages/lexicon/_private/providers/ovh.py\", line 260, in _request\r\n return result.json()\r\n File \"/usr/local/lib/python3.10/site-packages/requests/models.py\", line 975, in json\r\n raise RequestsJSONDecodeError(e.msg, e.doc, e.pos)\r\nrequests.exceptions.JSONDecodeError: Expecting value: line 1 column 1 (char 0)\r\n\r\nDuring handling of the above exception, another exception occurred:\r\n\r\nTraceback (most recent call last):\r\n File \"/usr/local/bin/certbot\", line 33, in <module>\r\n sys.exit(load_entry_point('certbot', 'console_scripts', 'certbot')())\r\n File \"/opt/certbot/src/certbot/certbot/main.py\", line 19, in main\r\n return internal_main.main(cli_args)\r\n File \"/opt/certbot/src/certbot/certbot/_internal/main.py\", line 1873, in main\r\n return config.func(config, plugins)\r\n File \"/opt/certbot/src/certbot/certbot/_internal/main.py\", line 1600, in certonly\r\n lineage = _get_and_save_cert(le_client, config, domains, certname, lineage)\r\n File \"/opt/certbot/src/certbot/certbot/_internal/main.py\", line 131, in _get_and_save_cert\r\n renewal.renew_cert(config, domains, le_client, lineage)\r\n File \"/opt/certbot/src/certbot/certbot/_internal/renewal.py\", line 396, in renew_cert\r\n new_cert, new_chain, new_key, _ = le_client.obtain_certificate(domains, new_key)\r\n File \"/opt/certbot/src/certbot/certbot/_internal/client.py\", line 428, in obtain_certificate\r\n orderr = self._get_order_and_authorizations(csr.data, self.config.allow_subset_of_names)\r\n File \"/opt/certbot/src/certbot/certbot/_internal/client.py\", line 496, in _get_order_and_authorizations\r\n authzr = self.auth_handler.handle_authorizations(orderr, self.config, best_effort)\r\n File \"/opt/certbot/src/certbot/certbot/_internal/auth_handler.py\", line 88, in handle_authorizations\r\n resps = self.auth.perform(achalls)\r\n File \"/opt/certbot/src/certbot/certbot/plugins/dns_common.py\", line 76, in perform\r\n self._perform(domain, validation_domain_name, validation)\r\n File \"/opt/certbot/src/certbot/certbot/plugins/dns_common_lexicon.py\", line 224, in _perform\r\n raise errors.PluginError('Error adding TXT record: {0}'.format(e))\r\ncertbot.errors.PluginError: Error adding TXT record: Expecting value: line 1 column 1 (char 0)\r\n2023-10-12 17:11:53,039:ERROR:certbot._internal.log:Error adding TXT record: Expecting value: line 1 column 1 (char 0)\r\n```\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"from setuptools import find_packages\nfrom setuptools import setup\n\nversion = '0.32.0.dev0'\n\ninstall_requires = [\n 'coverage',\n 'cryptography',\n 'importlib_resources>=1.3.1; python_version < \"3.9\"',\n 'pyopenssl',\n 'pytest',\n 'pytest-cov',\n # This version is needed for \"worker\" attributes we currently use like\n # \"workerinput\". See https://github.com/pytest-dev/pytest-xdist/pull/268.\n 'pytest-xdist>=1.22.1',\n 'python-dateutil',\n # This dependency needs to be added using environment markers to avoid its\n # installation on Linux.\n 'pywin32>=300 ; sys_platform == \"win32\"',\n 'pyyaml',\n 'pytz>=2019.3',\n 'requests',\n 'setuptools',\n 'types-python-dateutil'\n]\n\nsetup(\n name='certbot-ci',\n version=version,\n description=\"Certbot continuous integration framework\",\n url='https://github.com/certbot/certbot',\n author=\"Certbot Project\",\n author_email='certbot-dev@eff.org',\n license='Apache License 2.0',\n python_requires='>=3.8',\n classifiers=[\n 'Development Status :: 3 - Alpha',\n 'Intended Audience :: Developers',\n 'License :: OSI Approved :: Apache Software License',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Programming Language :: Python :: 3.11',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Security',\n ],\n\n packages=find_packages(),\n include_package_data=True,\n install_requires=install_requires,\n\n entry_points={\n 'console_scripts': [\n 'certbot_test=certbot_integration_tests.utils.certbot_call:main',\n 'run_acme_server=certbot_integration_tests.utils.acme_server:main',\n ],\n }\n)\n","path":"certbot-ci/setup.py"},{"content":"import os\nimport sys\n\nfrom setuptools import find_packages\nfrom setuptools import setup\n\nversion = '2.8.0.dev0'\n\ninstall_requires = [\n 'dns-lexicon>=3.14.1',\n 'setuptools>=41.6.0',\n]\n\nif os.environ.get('SNAP_BUILD'):\n install_requires.append('packaging')\nelse:\n install_requires.extend([\n # We specify the minimum acme and certbot version as the current plugin\n # version for simplicity. See\n # https://github.com/certbot/certbot/issues/8761 for more info.\n f'acme>={version}',\n f'certbot>={version}',\n ])\n\ndocs_extras = [\n 'Sphinx>=1.0', # autodoc_member_order = 'bysource', autodoc_default_flags\n 'sphinx_rtd_theme',\n]\n\ntest_extras = [\n 'pytest',\n]\n\nsetup(\n name='certbot-dns-ovh',\n version=version,\n description=\"OVH DNS Authenticator plugin for Certbot\",\n url='https://github.com/certbot/certbot',\n author=\"Certbot Project\",\n author_email='certbot-dev@eff.org',\n license='Apache License 2.0',\n python_requires='>=3.8',\n classifiers=[\n 'Development Status :: 5 - Production/Stable',\n 'Environment :: Plugins',\n 'Intended Audience :: System Administrators',\n 'License :: OSI Approved :: Apache Software License',\n 'Operating System :: POSIX :: Linux',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Programming Language :: Python :: 3.11',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Security',\n 'Topic :: System :: Installation/Setup',\n 'Topic :: System :: Networking',\n 'Topic :: System :: Systems Administration',\n 'Topic :: Utilities',\n ],\n\n packages=find_packages(),\n include_package_data=True,\n install_requires=install_requires,\n extras_require={\n 'docs': docs_extras,\n 'test': test_extras,\n },\n entry_points={\n 'certbot.plugins': [\n 'dns-ovh = certbot_dns_ovh._internal.dns_ovh:Authenticator',\n ],\n },\n)\n","path":"certbot-dns-ovh/setup.py"}],"string":"[\n {\n \"content\": \"from setuptools import find_packages\\nfrom setuptools import setup\\n\\nversion = '0.32.0.dev0'\\n\\ninstall_requires = [\\n 'coverage',\\n 'cryptography',\\n 'importlib_resources>=1.3.1; python_version < \\\"3.9\\\"',\\n 'pyopenssl',\\n 'pytest',\\n 'pytest-cov',\\n # This version is needed for \\\"worker\\\" attributes we currently use like\\n # \\\"workerinput\\\". See https://github.com/pytest-dev/pytest-xdist/pull/268.\\n 'pytest-xdist>=1.22.1',\\n 'python-dateutil',\\n # This dependency needs to be added using environment markers to avoid its\\n # installation on Linux.\\n 'pywin32>=300 ; sys_platform == \\\"win32\\\"',\\n 'pyyaml',\\n 'pytz>=2019.3',\\n 'requests',\\n 'setuptools',\\n 'types-python-dateutil'\\n]\\n\\nsetup(\\n name='certbot-ci',\\n version=version,\\n description=\\\"Certbot continuous integration framework\\\",\\n url='https://github.com/certbot/certbot',\\n author=\\\"Certbot Project\\\",\\n author_email='certbot-dev@eff.org',\\n license='Apache License 2.0',\\n python_requires='>=3.8',\\n classifiers=[\\n 'Development Status :: 3 - Alpha',\\n 'Intended Audience :: Developers',\\n 'License :: OSI Approved :: Apache Software License',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Programming Language :: Python :: 3.11',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Security',\\n ],\\n\\n packages=find_packages(),\\n include_package_data=True,\\n install_requires=install_requires,\\n\\n entry_points={\\n 'console_scripts': [\\n 'certbot_test=certbot_integration_tests.utils.certbot_call:main',\\n 'run_acme_server=certbot_integration_tests.utils.acme_server:main',\\n ],\\n }\\n)\\n\",\n \"path\": \"certbot-ci/setup.py\"\n },\n {\n \"content\": \"import os\\nimport sys\\n\\nfrom setuptools import find_packages\\nfrom setuptools import setup\\n\\nversion = '2.8.0.dev0'\\n\\ninstall_requires = [\\n 'dns-lexicon>=3.14.1',\\n 'setuptools>=41.6.0',\\n]\\n\\nif os.environ.get('SNAP_BUILD'):\\n install_requires.append('packaging')\\nelse:\\n install_requires.extend([\\n # We specify the minimum acme and certbot version as the current plugin\\n # version for simplicity. See\\n # https://github.com/certbot/certbot/issues/8761 for more info.\\n f'acme>={version}',\\n f'certbot>={version}',\\n ])\\n\\ndocs_extras = [\\n 'Sphinx>=1.0', # autodoc_member_order = 'bysource', autodoc_default_flags\\n 'sphinx_rtd_theme',\\n]\\n\\ntest_extras = [\\n 'pytest',\\n]\\n\\nsetup(\\n name='certbot-dns-ovh',\\n version=version,\\n description=\\\"OVH DNS Authenticator plugin for Certbot\\\",\\n url='https://github.com/certbot/certbot',\\n author=\\\"Certbot Project\\\",\\n author_email='certbot-dev@eff.org',\\n license='Apache License 2.0',\\n python_requires='>=3.8',\\n classifiers=[\\n 'Development Status :: 5 - Production/Stable',\\n 'Environment :: Plugins',\\n 'Intended Audience :: System Administrators',\\n 'License :: OSI Approved :: Apache Software License',\\n 'Operating System :: POSIX :: Linux',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Programming Language :: Python :: 3.11',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Security',\\n 'Topic :: System :: Installation/Setup',\\n 'Topic :: System :: Networking',\\n 'Topic :: System :: Systems Administration',\\n 'Topic :: Utilities',\\n ],\\n\\n packages=find_packages(),\\n include_package_data=True,\\n install_requires=install_requires,\\n extras_require={\\n 'docs': docs_extras,\\n 'test': test_extras,\\n },\\n entry_points={\\n 'certbot.plugins': [\\n 'dns-ovh = certbot_dns_ovh._internal.dns_ovh:Authenticator',\\n ],\\n },\\n)\\n\",\n \"path\": \"certbot-dns-ovh/setup.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"from setuptools import find_packages\nfrom setuptools import setup\n\nversion = '0.32.0.dev0'\n\ninstall_requires = [\n 'coverage',\n 'cryptography',\n 'importlib_resources>=1.3.1; python_version < \"3.9\"',\n 'pyopenssl',\n 'pytest',\n 'pytest-cov',\n # This version is needed for \"worker\" attributes we currently use like\n # \"workerinput\". See https://github.com/pytest-dev/pytest-xdist/pull/268.\n 'pytest-xdist>=1.22.1',\n 'python-dateutil',\n # This dependency needs to be added using environment markers to avoid its\n # installation on Linux.\n 'pywin32>=300 ; sys_platform == \"win32\"',\n 'pyyaml',\n 'pytz>=2019.3',\n 'requests',\n 'setuptools',\n 'types-python-dateutil',\n]\n\nsetup(\n name='certbot-ci',\n version=version,\n description=\"Certbot continuous integration framework\",\n url='https://github.com/certbot/certbot',\n author=\"Certbot Project\",\n author_email='certbot-dev@eff.org',\n license='Apache License 2.0',\n python_requires='>=3.8',\n classifiers=[\n 'Development Status :: 3 - Alpha',\n 'Intended Audience :: Developers',\n 'License :: OSI Approved :: Apache Software License',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Programming Language :: Python :: 3.11',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Security',\n ],\n\n packages=find_packages(),\n include_package_data=True,\n install_requires=install_requires,\n\n entry_points={\n 'console_scripts': [\n 'certbot_test=certbot_integration_tests.utils.certbot_call:main',\n 'run_acme_server=certbot_integration_tests.utils.acme_server:main',\n ],\n }\n)\n","path":"certbot-ci/setup.py"},{"content":"import os\nimport sys\n\nfrom setuptools import find_packages\nfrom setuptools import setup\n\nversion = '2.8.0.dev0'\n\ninstall_requires = [\n 'dns-lexicon>=3.15.1',\n 'setuptools>=41.6.0',\n]\n\nif os.environ.get('SNAP_BUILD'):\n install_requires.append('packaging')\nelse:\n install_requires.extend([\n # We specify the minimum acme and certbot version as the current plugin\n # version for simplicity. See\n # https://github.com/certbot/certbot/issues/8761 for more info.\n f'acme>={version}',\n f'certbot>={version}',\n ])\n\ndocs_extras = [\n 'Sphinx>=1.0', # autodoc_member_order = 'bysource', autodoc_default_flags\n 'sphinx_rtd_theme',\n]\n\ntest_extras = [\n 'pytest',\n]\n\nsetup(\n name='certbot-dns-ovh',\n version=version,\n description=\"OVH DNS Authenticator plugin for Certbot\",\n url='https://github.com/certbot/certbot',\n author=\"Certbot Project\",\n author_email='certbot-dev@eff.org',\n license='Apache License 2.0',\n python_requires='>=3.8',\n classifiers=[\n 'Development Status :: 5 - Production/Stable',\n 'Environment :: Plugins',\n 'Intended Audience :: System Administrators',\n 'License :: OSI Approved :: Apache Software License',\n 'Operating System :: POSIX :: Linux',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Programming Language :: Python :: 3.11',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Security',\n 'Topic :: System :: Installation/Setup',\n 'Topic :: System :: Networking',\n 'Topic :: System :: Systems Administration',\n 'Topic :: Utilities',\n ],\n\n packages=find_packages(),\n include_package_data=True,\n install_requires=install_requires,\n extras_require={\n 'docs': docs_extras,\n 'test': test_extras,\n },\n entry_points={\n 'certbot.plugins': [\n 'dns-ovh = certbot_dns_ovh._internal.dns_ovh:Authenticator',\n ],\n },\n)\n","path":"certbot-dns-ovh/setup.py"}],"string":"[\n {\n \"content\": \"from setuptools import find_packages\\nfrom setuptools import setup\\n\\nversion = '0.32.0.dev0'\\n\\ninstall_requires = [\\n 'coverage',\\n 'cryptography',\\n 'importlib_resources>=1.3.1; python_version < \\\"3.9\\\"',\\n 'pyopenssl',\\n 'pytest',\\n 'pytest-cov',\\n # This version is needed for \\\"worker\\\" attributes we currently use like\\n # \\\"workerinput\\\". See https://github.com/pytest-dev/pytest-xdist/pull/268.\\n 'pytest-xdist>=1.22.1',\\n 'python-dateutil',\\n # This dependency needs to be added using environment markers to avoid its\\n # installation on Linux.\\n 'pywin32>=300 ; sys_platform == \\\"win32\\\"',\\n 'pyyaml',\\n 'pytz>=2019.3',\\n 'requests',\\n 'setuptools',\\n 'types-python-dateutil',\\n]\\n\\nsetup(\\n name='certbot-ci',\\n version=version,\\n description=\\\"Certbot continuous integration framework\\\",\\n url='https://github.com/certbot/certbot',\\n author=\\\"Certbot Project\\\",\\n author_email='certbot-dev@eff.org',\\n license='Apache License 2.0',\\n python_requires='>=3.8',\\n classifiers=[\\n 'Development Status :: 3 - Alpha',\\n 'Intended Audience :: Developers',\\n 'License :: OSI Approved :: Apache Software License',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Programming Language :: Python :: 3.11',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Security',\\n ],\\n\\n packages=find_packages(),\\n include_package_data=True,\\n install_requires=install_requires,\\n\\n entry_points={\\n 'console_scripts': [\\n 'certbot_test=certbot_integration_tests.utils.certbot_call:main',\\n 'run_acme_server=certbot_integration_tests.utils.acme_server:main',\\n ],\\n }\\n)\\n\",\n \"path\": \"certbot-ci/setup.py\"\n },\n {\n \"content\": \"import os\\nimport sys\\n\\nfrom setuptools import find_packages\\nfrom setuptools import setup\\n\\nversion = '2.8.0.dev0'\\n\\ninstall_requires = [\\n 'dns-lexicon>=3.15.1',\\n 'setuptools>=41.6.0',\\n]\\n\\nif os.environ.get('SNAP_BUILD'):\\n install_requires.append('packaging')\\nelse:\\n install_requires.extend([\\n # We specify the minimum acme and certbot version as the current plugin\\n # version for simplicity. See\\n # https://github.com/certbot/certbot/issues/8761 for more info.\\n f'acme>={version}',\\n f'certbot>={version}',\\n ])\\n\\ndocs_extras = [\\n 'Sphinx>=1.0', # autodoc_member_order = 'bysource', autodoc_default_flags\\n 'sphinx_rtd_theme',\\n]\\n\\ntest_extras = [\\n 'pytest',\\n]\\n\\nsetup(\\n name='certbot-dns-ovh',\\n version=version,\\n description=\\\"OVH DNS Authenticator plugin for Certbot\\\",\\n url='https://github.com/certbot/certbot',\\n author=\\\"Certbot Project\\\",\\n author_email='certbot-dev@eff.org',\\n license='Apache License 2.0',\\n python_requires='>=3.8',\\n classifiers=[\\n 'Development Status :: 5 - Production/Stable',\\n 'Environment :: Plugins',\\n 'Intended Audience :: System Administrators',\\n 'License :: OSI Approved :: Apache Software License',\\n 'Operating System :: POSIX :: Linux',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Programming Language :: Python :: 3.11',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Security',\\n 'Topic :: System :: Installation/Setup',\\n 'Topic :: System :: Networking',\\n 'Topic :: System :: Systems Administration',\\n 'Topic :: Utilities',\\n ],\\n\\n packages=find_packages(),\\n include_package_data=True,\\n install_requires=install_requires,\\n extras_require={\\n 'docs': docs_extras,\\n 'test': test_extras,\\n },\\n entry_points={\\n 'certbot.plugins': [\\n 'dns-ovh = certbot_dns_ovh._internal.dns_ovh:Authenticator',\\n ],\\n },\\n)\\n\",\n \"path\": \"certbot-dns-ovh/setup.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/certbot-ci/certbot_integration_tests/utils/misc.py b/certbot-ci/certbot_integration_tests/utils/misc.py\nindex 8260ccf5e58..dfeda4cda5b 100644\n--- a/certbot-ci/certbot_integration_tests/utils/misc.py\n+++ b/certbot-ci/certbot_integration_tests/utils/misc.py\n@@ -52,10 +52,10 @@ def _suppress_x509_verification_warnings() -> None:\n urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)\n except ImportError:\n # Handle old versions of request with vendorized urllib3\n- # pylint: disable=no-member\n- from requests.packages.urllib3.exceptions import InsecureRequestWarning\n- requests.packages.urllib3.disable_warnings( # type: ignore[attr-defined]\n- InsecureRequestWarning)\n+ # pylint: disable=no-member,line-too-long\n+ from requests.packages.urllib3.exceptions import InsecureRequestWarning # type: ignore[import-untyped]\n+ requests.packages.urllib3.disable_warnings(InsecureRequestWarning) # type: ignore[attr-defined]\n+ # pylint: enable=no-member,line-too-long\n \n \n def check_until_timeout(url: str, attempts: int = 30) -> None:\ndiff --git a/certbot-ci/setup.py b/certbot-ci/setup.py\nindex 2cb8308c115..81feeb7cfef 100644\n--- a/certbot-ci/setup.py\n+++ b/certbot-ci/setup.py\n@@ -21,7 +21,7 @@\n 'pytz>=2019.3',\n 'requests',\n 'setuptools',\n- 'types-python-dateutil'\n+ 'types-python-dateutil',\n ]\n \n setup(\ndiff --git a/certbot-dns-ovh/setup.py b/certbot-dns-ovh/setup.py\nindex e4c615f3f0e..e3fe41d8287 100644\n--- a/certbot-dns-ovh/setup.py\n+++ b/certbot-dns-ovh/setup.py\n@@ -7,7 +7,7 @@\n version = '2.8.0.dev0'\n \n install_requires = [\n- 'dns-lexicon>=3.14.1',\n+ 'dns-lexicon>=3.15.1',\n 'setuptools>=41.6.0',\n ]\n \ndiff --git a/certbot/CHANGELOG.md b/certbot/CHANGELOG.md\nindex 92ceba3fb3b..900948fc635 100644\n--- a/certbot/CHANGELOG.md\n+++ b/certbot/CHANGELOG.md\n@@ -14,6 +14,7 @@ Certbot adheres to [Semantic Versioning](https://semver.org/).\n \n ### Fixed\n \n+* `certbot-dns-ovh` plugin now requires `lexicon>=3.15.1` to ensure a consistent behavior with OVH APIs.\n * Fixed a bug where argument sources weren't correctly detected in abbreviated\n arguments, short arguments, and some other circumstances\n \ndiff --git a/tools/oldest_constraints.txt b/tools/oldest_constraints.txt\nindex d667873d48c..2f09901a159 100644\n--- a/tools/oldest_constraints.txt\n+++ b/tools/oldest_constraints.txt\n@@ -20,7 +20,7 @@ cython==0.29.36 ; python_version >= \"3.8\" and python_version < \"3.9\"\n dill==0.3.7 ; python_version >= \"3.8\" and python_version < \"3.9\"\n distlib==0.3.7 ; python_version >= \"3.8\" and python_version < \"3.9\"\n distro==1.0.1 ; python_version >= \"3.8\" and python_version < \"3.9\"\n-dns-lexicon==3.14.1 ; python_version >= \"3.8\" and python_version < \"3.9\"\n+dns-lexicon==3.15.1 ; python_version >= \"3.8\" and python_version < \"3.9\"\n dnspython==1.15.0 ; python_version >= \"3.8\" and python_version < \"3.9\"\n exceptiongroup==1.1.3 ; python_version >= \"3.8\" and python_version < \"3.9\"\n execnet==2.0.2 ; python_version >= \"3.8\" and python_version < \"3.9\"\n@@ -41,7 +41,7 @@ josepy==1.13.0 ; python_version >= \"3.8\" and python_version < \"3.9\"\n logger==1.4 ; python_version >= \"3.8\" and python_version < \"3.9\"\n mccabe==0.7.0 ; python_version >= \"3.8\" and python_version < \"3.9\"\n mypy-extensions==1.0.0 ; python_version >= \"3.8\" and python_version < \"3.9\"\n-mypy==1.5.1 ; python_version >= \"3.8\" and python_version < \"3.9\"\n+mypy==1.6.0 ; python_version >= \"3.8\" and python_version < \"3.9\"\n ndg-httpsclient==0.3.2 ; python_version >= \"3.8\" and python_version < \"3.9\"\n oauth2client==4.1.3 ; python_version >= \"3.8\" and python_version < \"3.9\"\n packaging==23.2 ; python_version >= \"3.8\" and python_version < \"3.9\"\n@@ -57,6 +57,7 @@ pyasn1==0.4.8 ; python_version >= \"3.8\" and python_version < \"3.9\"\n pycparser==2.14 ; python_version >= \"3.8\" and python_version < \"3.9\"\n pylint==3.0.1 ; python_version >= \"3.8\" and python_version < \"3.9\"\n pyopenssl==17.5.0 ; python_version >= \"3.8\" and python_version < \"3.9\"\n+pyotp==2.9.0 ; python_version >= \"3.8\" and python_version < \"3.9\"\n pyparsing==2.2.1 ; python_version >= \"3.8\" and python_version < \"3.9\"\n pyrfc3339==1.0 ; python_version >= \"3.8\" and python_version < \"3.9\"\n pytest-cov==4.1.0 ; python_version >= \"3.8\" and python_version < \"3.9\"\n@@ -75,7 +76,7 @@ s3transfer==0.3.7 ; python_version >= \"3.8\" and python_version < \"3.9\"\n setuptools==41.6.0 ; python_version >= \"3.8\" and python_version < \"3.9\"\n six==1.11.0 ; python_version >= \"3.8\" and python_version < \"3.9\"\n soupsieve==2.5 ; python_version >= \"3.8\" and python_version < \"3.9\"\n-tldextract==3.6.0 ; python_version >= \"3.8\" and python_version < \"3.9\"\n+tldextract==5.0.0 ; python_version >= \"3.8\" and python_version < \"3.9\"\n tomli==2.0.1 ; python_version >= \"3.8\" and python_version < \"3.9\"\n tomlkit==0.12.1 ; python_version >= \"3.8\" and python_version < \"3.9\"\n tox==1.9.2 ; python_version >= \"3.8\" and python_version < \"3.9\"\ndiff --git a/tools/pinning/oldest/pyproject.toml b/tools/pinning/oldest/pyproject.toml\nindex 302014ae595..1a4d7d71f38 100644\n--- a/tools/pinning/oldest/pyproject.toml\n+++ b/tools/pinning/oldest/pyproject.toml\n@@ -54,7 +54,7 @@ cloudflare = \"1.5.1\"\n configobj = \"5.0.6\"\n cryptography = \"3.2.1\"\n distro = \"1.0.1\"\n-dns-lexicon = \"3.14.1\"\n+dns-lexicon = \"3.15.1\"\n dnspython = \"1.15.0\"\n funcsigs = \"0.4\"\n google-api-python-client = \"1.6.5\"\ndiff --git a/tools/requirements.txt b/tools/requirements.txt\nindex af906a4ba21..1ed0ca0ee78 100644\n--- a/tools/requirements.txt\n+++ b/tools/requirements.txt\n@@ -17,8 +17,8 @@ babel==2.13.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n backcall==0.2.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n bcrypt==4.0.1 ; python_version >= \"3.8\" and python_version < \"4.0\"\n beautifulsoup4==4.12.2 ; python_version >= \"3.8\" and python_version < \"4.0\"\n-boto3==1.28.62 ; python_version >= \"3.8\" and python_version < \"4.0\"\n-botocore==1.31.62 ; python_version >= \"3.8\" and python_version < \"4.0\"\n+boto3==1.28.63 ; python_version >= \"3.8\" and python_version < \"4.0\"\n+botocore==1.31.63 ; python_version >= \"3.8\" and python_version < \"4.0\"\n cachecontrol==0.12.14 ; python_version >= \"3.8\" and python_version < \"4.0\"\n cachetools==5.3.1 ; python_version >= \"3.8\" and python_version < \"4.0\"\n cachy==0.3.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n@@ -39,7 +39,7 @@ deprecated==1.2.14 ; python_version >= \"3.8\" and python_version < \"4.0\"\n dill==0.3.7 ; python_version >= \"3.8\" and python_version < \"4.0\"\n distlib==0.3.7 ; python_version >= \"3.8\" and python_version < \"4.0\"\n distro==1.8.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n-dns-lexicon==3.15.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n+dns-lexicon==3.15.1 ; python_version >= \"3.8\" and python_version < \"4.0\"\n dnspython==2.4.2 ; python_version >= \"3.8\" and python_version < \"4.0\"\n docutils==0.18.1 ; python_version >= \"3.8\" and python_version < \"4.0\"\n dulwich==0.20.50 ; python_version >= \"3.8\" and python_version < \"4.0\"\n@@ -49,10 +49,10 @@ executing==2.0.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n fabric==3.2.2 ; python_version >= \"3.8\" and python_version < \"4.0\"\n filelock==3.12.4 ; python_version >= \"3.8\" and python_version < \"4.0\"\n google-api-core==2.12.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n-google-api-python-client==2.102.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n+google-api-python-client==2.103.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n google-auth-httplib2==0.1.1 ; python_version >= \"3.8\" and python_version < \"4.0\"\n google-auth==2.23.3 ; python_version >= \"3.8\" and python_version < \"4.0\"\n-googleapis-common-protos==1.60.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n+googleapis-common-protos==1.61.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n html5lib==1.1 ; python_version >= \"3.8\" and python_version < \"4.0\"\n httplib2==0.22.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n idna==3.4 ; python_version >= \"3.8\" and python_version < \"4.0\"\n@@ -87,7 +87,7 @@ more-itertools==10.1.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n msgpack==1.0.7 ; python_version >= \"3.8\" and python_version < \"4.0\"\n msrest==0.7.1 ; python_version >= \"3.8\" and python_version < \"4.0\"\n mypy-extensions==1.0.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n-mypy==1.5.1 ; python_version >= \"3.8\" and python_version < \"4.0\"\n+mypy==1.6.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n nh3==0.2.14 ; python_version >= \"3.8\" and python_version < \"4.0\"\n oauthlib==3.2.2 ; python_version >= \"3.8\" and python_version < \"4.0\"\n packaging==23.2 ; python_version >= \"3.8\" and python_version < \"4.0\"\n@@ -141,7 +141,7 @@ requests-toolbelt==0.9.1 ; python_version >= \"3.8\" and python_version < \"4.0\"\n requests==2.31.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n rfc3986==2.0.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n rich==13.6.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n-rpds-py==0.10.4 ; python_version >= \"3.8\" and python_version < \"4.0\"\n+rpds-py==0.10.6 ; python_version >= \"3.8\" and python_version < \"4.0\"\n rsa==4.9 ; python_version >= \"3.8\" and python_version < \"4\"\n s3transfer==0.7.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n secretstorage==3.3.3 ; python_version >= \"3.8\" and python_version < \"4.0\" and sys_platform == \"linux\"\n@@ -162,7 +162,7 @@ sphinxcontrib-jsmath==1.0.1 ; python_version >= \"3.8\" and python_version < \"4.0\"\n sphinxcontrib-qthelp==1.0.3 ; python_version >= \"3.8\" and python_version < \"4.0\"\n sphinxcontrib-serializinghtml==1.1.5 ; python_version >= \"3.8\" and python_version < \"4.0\"\n stack-data==0.6.3 ; python_version >= \"3.8\" and python_version < \"4.0\"\n-tldextract==3.6.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n+tldextract==5.0.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n tomli==2.0.1 ; python_version >= \"3.8\" and python_full_version <= \"3.11.0a6\"\n tomlkit==0.12.1 ; python_version >= \"3.8\" and python_version < \"4.0\"\n tox==3.28.0 ; python_version >= \"3.8\" and python_version < \"4.0\"\n"}}},{"rowIdx":4668,"cells":{"in_source_id":{"kind":"string","value":"statsmodels__statsmodels-5648"},"issue":{"kind":"string","value":"Missing \\\\\\ in summary2 as_latex function\nI found that the .as_latex() function failed when implemented, due to an issue coming from the line including \\midline. It is a simple fix -- just required an extra \\\\\\ before each \\midline call, and it compiles.\n"},"before_files":{"kind":"list like","value":[{"content":"from statsmodels.compat.python import (lrange, iterkeys, iteritems, lzip,\n reduce, itervalues, zip, string_types,\n range)\n\nfrom collections import OrderedDict\nimport datetime\nimport re\nimport textwrap\n\nimport numpy as np\nimport pandas as pd\n\nfrom .table import SimpleTable\nfrom .tableformatting import fmt_latex, fmt_txt\n\n\nclass Summary(object):\n def __init__(self):\n self.tables = []\n self.settings = []\n self.extra_txt = []\n self.title = None\n self._merge_latex = False\n\n def __str__(self):\n return self.as_text()\n\n def __repr__(self):\n return str(type(self)) + '\\n\"\"\"\\n' + self.__str__() + '\\n\"\"\"'\n\n def _repr_html_(self):\n '''Display as HTML in IPython notebook.'''\n return self.as_html()\n\n def add_df(self, df, index=True, header=True, float_format='%.4f',\n align='r'):\n '''Add the contents of a DataFrame to summary table\n\n Parameters\n ----------\n df : DataFrame\n header: bool\n Reproduce the DataFrame column labels in summary table\n index: bool\n Reproduce the DataFrame row labels in summary table\n float_format: string\n Formatting to float data columns\n align : string\n Data alignment (l/c/r)\n '''\n\n settings = {'index': index, 'header': header,\n 'float_format': float_format, 'align': align}\n self.tables.append(df)\n self.settings.append(settings)\n\n def add_array(self, array, align='r', float_format=\"%.4f\"):\n '''Add the contents of a Numpy array to summary table\n\n Parameters\n ----------\n array : numpy array (2D)\n float_format: string\n Formatting to array if type is float\n align : string\n Data alignment (l/c/r)\n '''\n\n table = pd.DataFrame(array)\n self.add_df(table, index=False, header=False,\n float_format=float_format, align=align)\n\n def add_dict(self, d, ncols=2, align='l', float_format=\"%.4f\"):\n '''Add the contents of a Dict to summary table\n\n Parameters\n ----------\n d : dict\n Keys and values are automatically coerced to strings with str().\n Users are encouraged to format them before using add_dict.\n ncols: int\n Number of columns of the output table\n align : string\n Data alignment (l/c/r)\n '''\n\n keys = [_formatter(x, float_format) for x in iterkeys(d)]\n vals = [_formatter(x, float_format) for x in itervalues(d)]\n data = np.array(lzip(keys, vals))\n\n if data.shape[0] % ncols != 0:\n pad = ncols - (data.shape[0] % ncols)\n data = np.vstack([data, np.array(pad * [['', '']])])\n\n data = np.split(data, ncols)\n data = reduce(lambda x, y: np.hstack([x, y]), data)\n self.add_array(data, align=align)\n\n def add_text(self, string):\n '''Append a note to the bottom of the summary table. In ASCII tables,\n the note will be wrapped to table width. Notes are not indendented.\n '''\n self.extra_txt.append(string)\n\n def add_title(self, title=None, results=None):\n '''Insert a title on top of the summary table. If a string is provided\n in the title argument, that string is printed. If no title string is\n provided but a results instance is provided, statsmodels attempts\n to construct a useful title automatically.\n '''\n if isinstance(title, string_types):\n self.title = title\n else:\n try:\n model = results.model.__class__.__name__\n if model in _model_types:\n model = _model_types[model]\n self.title = 'Results: ' + model\n except:\n self.title = ''\n\n def add_base(self, results, alpha=0.05, float_format=\"%.4f\", title=None,\n xname=None, yname=None):\n '''Try to construct a basic summary instance.\n\n Parameters\n ----------\n results : Model results instance\n alpha : float\n significance level for the confidence intervals (optional)\n float_formatting: string\n Float formatting for summary of parameters (optional)\n title : string\n Title of the summary table (optional)\n xname : List of strings of length equal to the number of parameters\n Names of the independent variables (optional)\n yname : string\n Name of the dependent variable (optional)\n '''\n\n param = summary_params(results, alpha=alpha, use_t=results.use_t)\n info = summary_model(results)\n if xname is not None:\n param.index = xname\n if yname is not None:\n info['Dependent Variable:'] = yname\n self.add_dict(info, align='l')\n self.add_df(param, float_format=float_format)\n self.add_title(title=title, results=results)\n\n def as_text(self):\n '''Generate ASCII Summary Table\n '''\n\n tables = self.tables\n settings = self.settings\n title = self.title\n extra_txt = self.extra_txt\n\n pad_col, pad_index, widest = _measure_tables(tables, settings)\n\n rule_equal = widest * '='\n\n simple_tables = _simple_tables(tables, settings, pad_col, pad_index)\n tab = [x.as_text() for x in simple_tables]\n\n tab = '\\n'.join(tab)\n tab = tab.split('\\n')\n tab[0] = rule_equal\n tab.append(rule_equal)\n tab = '\\n'.join(tab)\n\n if title is not None:\n title = title\n if len(title) < widest:\n title = ' ' * int(widest/2 - len(title)/2) + title\n else:\n title = ''\n\n txt = [textwrap.wrap(x, widest) for x in extra_txt]\n txt = ['\\n'.join(x) for x in txt]\n txt = '\\n'.join(txt)\n\n out = '\\n'.join([title, tab, txt])\n\n return out\n\n def as_html(self):\n '''Generate HTML Summary Table\n '''\n\n tables = self.tables\n settings = self.settings\n #TODO: this isn't used anywhere\n title = self.title\n\n simple_tables = _simple_tables(tables, settings)\n tab = [x.as_html() for x in simple_tables]\n tab = '\\n'.join(tab)\n\n return tab\n\n def as_latex(self):\n '''Generate LaTeX Summary Table\n '''\n tables = self.tables\n settings = self.settings\n title = self.title\n\n if title is not None:\n title = '\\\\caption{' + title + '}'\n else:\n title = '\\\\caption{}'\n\n simple_tables = _simple_tables(tables, settings)\n tab = [x.as_latex_tabular() for x in simple_tables]\n tab = '\\n\\\\hline\\n'.join(tab)\n\n to_replace = ('\\\\\\\\hline\\\\n\\\\\\\\hline\\\\n\\\\\\\\'\n 'end{tabular}\\\\n\\\\\\\\begin{tabular}{.*}\\\\n')\n\n if self._merge_latex:\n # create single tabular object for summary_col\n tab = re.sub(to_replace,r'\\\\midrule\\n\\\\midrule\\n', tab)\n\n out = '\\\\begin{table}', title, tab, '\\\\end{table}'\n out = '\\n'.join(out)\n return out\n\n\ndef _measure_tables(tables, settings):\n '''Compare width of ascii tables in a list and calculate padding values.\n We add space to each col_sep to get us as close as possible to the\n width of the largest table. Then, we add a few spaces to the first\n column to pad the rest.\n '''\n\n simple_tables = _simple_tables(tables, settings)\n tab = [x.as_text() for x in simple_tables]\n\n length = [len(x.splitlines()[0]) for x in tab]\n len_max = max(length)\n pad_sep = []\n pad_index = []\n\n for i in range(len(tab)):\n nsep = max(tables[i].shape[1] - 1, 1)\n pad = int((len_max - length[i]) / nsep)\n pad_sep.append(pad)\n len_new = length[i] + nsep * pad\n pad_index.append(len_max - len_new)\n\n return pad_sep, pad_index, max(length)\n\n\n# Useful stuff\n_model_types = {'OLS': 'Ordinary least squares',\n 'GLS': 'Generalized least squares',\n 'GLSAR' : 'Generalized least squares with AR(p)',\n 'WLS': 'Weighted least squares',\n 'RLM': 'Robust linear model',\n 'NBin': 'Negative binomial model',\n 'GLM': 'Generalized linear model'\n }\n\n\ndef summary_model(results):\n '''Create a dict with information about the model\n '''\n\n def time_now(*args, **kwds):\n now = datetime.datetime.now()\n return now.strftime('%Y-%m-%d %H:%M')\n\n info = OrderedDict()\n info['Model:'] = lambda x: x.model.__class__.__name__\n info['Model Family:'] = lambda x: x.family.__class.__name__\n info['Link Function:'] = lambda x: x.family.link.__class__.__name__\n info['Dependent Variable:'] = lambda x: x.model.endog_names\n info['Date:'] = time_now\n info['No. Observations:'] = lambda x: \"%#6d\" % x.nobs\n info['Df Model:'] = lambda x: \"%#6d\" % x.df_model\n info['Df Residuals:'] = lambda x: \"%#6d\" % x.df_resid\n info['Converged:'] = lambda x: x.mle_retvals['converged']\n info['No. Iterations:'] = lambda x: x.mle_retvals['iterations']\n info['Method:'] = lambda x: x.method\n info['Norm:'] = lambda x: x.fit_options['norm']\n info['Scale Est.:'] = lambda x: x.fit_options['scale_est']\n info['Cov. Type:'] = lambda x: x.fit_options['cov']\n\n rsquared_type = '' if results.k_constant else ' (uncentered)'\n info['R-squared' + rsquared_type + ':'] = lambda x: \"%#8.3f\" % x.rsquared\n info['Adj. R-squared' + rsquared_type + ':'] = lambda x: \"%#8.3f\" % x.rsquared_adj\n info['Pseudo R-squared:'] = lambda x: \"%#8.3f\" % x.prsquared\n info['AIC:'] = lambda x: \"%8.4f\" % x.aic\n info['BIC:'] = lambda x: \"%8.4f\" % x.bic\n info['Log-Likelihood:'] = lambda x: \"%#8.5g\" % x.llf\n info['LL-Null:'] = lambda x: \"%#8.5g\" % x.llnull\n info['LLR p-value:'] = lambda x: \"%#8.5g\" % x.llr_pvalue\n info['Deviance:'] = lambda x: \"%#8.5g\" % x.deviance\n info['Pearson chi2:'] = lambda x: \"%#6.3g\" % x.pearson_chi2\n info['F-statistic:'] = lambda x: \"%#8.4g\" % x.fvalue\n info['Prob (F-statistic):'] = lambda x: \"%#6.3g\" % x.f_pvalue\n info['Scale:'] = lambda x: \"%#8.5g\" % x.scale\n out = OrderedDict()\n for key, func in iteritems(info):\n try:\n out[key] = func(results)\n except (AttributeError, KeyError, NotImplementedError):\n # NOTE: some models don't have loglike defined (RLM),\n # so raise NotImplementedError\n pass\n return out\n\n\ndef summary_params(results, yname=None, xname=None, alpha=.05, use_t=True,\n skip_header=False, float_format=\"%.4f\"):\n '''create a summary table of parameters from results instance\n\n Parameters\n ----------\n res : results instance\n some required information is directly taken from the result\n instance\n yname : string or None\n optional name for the endogenous variable, default is \"y\"\n xname : list of strings or None\n optional names for the exogenous variables, default is \"var_xx\"\n alpha : float\n significance level for the confidence intervals\n use_t : bool\n indicator whether the p-values are based on the Student-t\n distribution (if True) or on the normal distribution (if False)\n skip_headers : bool\n If false (default), then the header row is added. If true, then no\n header row is added.\n float_format : string\n float formatting options (e.g. \".3g\")\n\n Returns\n -------\n params_table : SimpleTable instance\n '''\n\n if isinstance(results, tuple):\n results, params, bse, tvalues, pvalues, conf_int = results\n else:\n params = results.params\n bse = results.bse\n tvalues = results.tvalues\n pvalues = results.pvalues\n conf_int = results.conf_int(alpha)\n\n data = np.array([params, bse, tvalues, pvalues]).T\n data = np.hstack([data, conf_int])\n data = pd.DataFrame(data)\n\n if use_t:\n data.columns = ['Coef.', 'Std.Err.', 't', 'P>|t|',\n '[' + str(alpha/2), str(1-alpha/2) + ']']\n else:\n data.columns = ['Coef.', 'Std.Err.', 'z', 'P>|z|',\n '[' + str(alpha/2), str(1-alpha/2) + ']']\n\n if not xname:\n try:\n data.index = results.model.data.param_names\n except AttributeError:\n data.index = results.model.exog_names\n else:\n data.index = xname\n\n return data\n\n\n# Vertical summary instance for multiple models\ndef _col_params(result, float_format='%.4f', stars=True):\n '''Stack coefficients and standard errors in single column\n '''\n\n # Extract parameters\n res = summary_params(result)\n # Format float\n for col in res.columns[:2]:\n res[col] = res[col].apply(lambda x: float_format % x)\n # Std.Errors in parentheses\n res.iloc[:, 1] = '(' + res.iloc[:, 1] + ')'\n # Significance stars\n if stars:\n idx = res.iloc[:, 3] < .1\n res.loc[idx, res.columns[0]] = res.loc[idx, res.columns[0]] + '*'\n idx = res.iloc[:, 3] < .05\n res.loc[idx, res.columns[0]] = res.loc[idx, res.columns[0]] + '*'\n idx = res.iloc[:, 3] < .01\n res.loc[idx, res.columns[0]] = res.loc[idx, res.columns[0]] + '*'\n # Stack Coefs and Std.Errors\n res = res.iloc[:, :2]\n res = res.stack()\n res = pd.DataFrame(res)\n res.columns = [str(result.model.endog_names)]\n return res\n\n\ndef _col_info(result, info_dict=None):\n '''Stack model info in a column\n '''\n\n if info_dict is None:\n info_dict = {}\n out = []\n index = []\n for i in info_dict:\n if isinstance(info_dict[i], dict):\n # this is a specific model info_dict, but not for this result...\n continue\n try:\n out.append(info_dict[i](result))\n except:\n out.append('')\n index.append(i)\n out = pd.DataFrame({str(result.model.endog_names): out}, index=index)\n return out\n\n\ndef _make_unique(list_of_names):\n if len(set(list_of_names)) == len(list_of_names):\n return list_of_names\n # pandas does not like it if multiple columns have the same names\n from collections import defaultdict\n name_counter = defaultdict(str)\n header = []\n for _name in list_of_names:\n name_counter[_name] += \"I\"\n header.append(_name+\" \" + name_counter[_name])\n return header\n\n\ndef summary_col(results, float_format='%.4f', model_names=(), stars=False,\n info_dict=None, regressor_order=(), drop_omitted=False):\n \"\"\"\n Summarize multiple results instances side-by-side (coefs and SEs)\n\n Parameters\n ----------\n results : statsmodels results instance or list of result instances\n float_format : string, optional\n float format for coefficients and standard errors\n Default : '%.4f'\n model_names : list of strings, optional\n Must have same length as the number of results. If the names are not\n unique, a roman number will be appended to all model names\n stars : bool\n print significance stars\n info_dict : dict\n dict of functions to be applied to results instances to retrieve\n model info. To use specific information for different models, add a\n (nested) info_dict with model name as the key.\n Example: `info_dict = {\"N\":..., \"R2\": ..., \"OLS\":{\"R2\":...}}` would\n only show `R2` for OLS regression models, but additionally `N` for\n all other results.\n Default : None (use the info_dict specified in\n result.default_model_infos, if this property exists)\n regressor_order : list of strings, optional\n list of names of the regressors in the desired order. All regressors\n not specified will be appended to the end of the list.\n drop_omitted : bool, optional\n Includes regressors that are not specified in regressor_order. If False,\n regressors not specified will be appended to end of the list. If True,\n only regressors in regressors_list will be included.\n \"\"\"\n\n if not isinstance(results, list):\n results = [results]\n\n cols = [_col_params(x, stars=stars, float_format=float_format) for x in\n results]\n\n # Unique column names (pandas has problems merging otherwise)\n if model_names:\n colnames = _make_unique(model_names)\n else:\n colnames = _make_unique([x.columns[0] for x in cols])\n for i in range(len(cols)):\n cols[i].columns = [colnames[i]]\n\n merg = lambda x, y: x.merge(y, how='outer', right_index=True,\n left_index=True)\n summ = reduce(merg, cols)\n\n if regressor_order:\n varnames = summ.index.get_level_values(0).tolist()\n ordered = [x for x in regressor_order if x in varnames]\n unordered = [x for x in varnames if x not in regressor_order + ['']]\n order = ordered + list(np.unique(unordered))\n\n f = lambda idx: sum([[x + 'coef', x + 'stde'] for x in idx], [])\n summ.index = f(pd.unique(varnames))\n summ = summ.reindex(f(order))\n summ.index = [x[:-4] for x in summ.index]\n if drop_omitted:\n summ = summ.loc[regressor_order]\n\n idx = pd.Series(lrange(summ.shape[0])) % 2 == 1\n summ.index = np.where(idx, '', summ.index.get_level_values(0))\n\n # add infos about the models.\n if info_dict:\n cols = [_col_info(x, info_dict.get(x.model.__class__.__name__,\n info_dict)) for x in results]\n else:\n cols = [_col_info(x, getattr(x, \"default_model_infos\", None)) for x in\n results]\n # use unique column names, otherwise the merge will not succeed\n for df, name in zip(cols, _make_unique([df.columns[0] for df in cols])):\n df.columns = [name]\n merg = lambda x, y: x.merge(y, how='outer', right_index=True,\n left_index=True)\n info = reduce(merg, cols)\n dat = pd.DataFrame(np.vstack([summ, info])) # pd.concat better, but error\n dat.columns = summ.columns\n dat.index = pd.Index(summ.index.tolist() + info.index.tolist())\n summ = dat\n\n summ = summ.fillna('')\n\n smry = Summary()\n smry._merge_latex = True\n smry.add_df(summ, header=True, align='l')\n smry.add_text('Standard errors in parentheses.')\n if stars:\n smry.add_text('* p<.1, ** p<.05, ***p<.01')\n\n return smry\n\n\ndef _formatter(element, float_format='%.4f'):\n try:\n out = float_format % element\n except:\n out = str(element)\n return out.strip()\n\n\ndef _df_to_simpletable(df, align='r', float_format=\"%.4f\", header=True,\n index=True, table_dec_above='-', table_dec_below=None,\n header_dec_below='-', pad_col=0, pad_index=0):\n dat = df.copy()\n dat = dat.applymap(lambda x: _formatter(x, float_format))\n if header:\n headers = [str(x) for x in dat.columns.tolist()]\n else:\n headers = None\n if index:\n stubs = [str(x) + int(pad_index) * ' ' for x in dat.index.tolist()]\n else:\n dat.iloc[:, 0] = [str(x) + int(pad_index) * ' ' for x in dat.iloc[:, 0]]\n stubs = None\n st = SimpleTable(np.array(dat), headers=headers, stubs=stubs,\n ltx_fmt=fmt_latex, txt_fmt=fmt_txt)\n st.output_formats['latex']['data_aligns'] = align\n st.output_formats['txt']['data_aligns'] = align\n st.output_formats['txt']['table_dec_above'] = table_dec_above\n st.output_formats['txt']['table_dec_below'] = table_dec_below\n st.output_formats['txt']['header_dec_below'] = header_dec_below\n st.output_formats['txt']['colsep'] = ' ' * int(pad_col + 1)\n return st\n\n\ndef _simple_tables(tables, settings, pad_col=None, pad_index=None):\n simple_tables = []\n float_format = '%.4f'\n if pad_col is None:\n pad_col = [0] * len(tables)\n if pad_index is None:\n pad_index = [0] * len(tables)\n for i, v in enumerate(tables):\n index = settings[i]['index']\n header = settings[i]['header']\n align = settings[i]['align']\n simple_tables.append(_df_to_simpletable(v, align=align,\n float_format=float_format,\n header=header, index=index,\n pad_col=pad_col[i],\n pad_index=pad_index[i]))\n return simple_tables\n","path":"statsmodels/iolib/summary2.py"}],"string":"[\n {\n \"content\": \"from statsmodels.compat.python import (lrange, iterkeys, iteritems, lzip,\\n reduce, itervalues, zip, string_types,\\n range)\\n\\nfrom collections import OrderedDict\\nimport datetime\\nimport re\\nimport textwrap\\n\\nimport numpy as np\\nimport pandas as pd\\n\\nfrom .table import SimpleTable\\nfrom .tableformatting import fmt_latex, fmt_txt\\n\\n\\nclass Summary(object):\\n def __init__(self):\\n self.tables = []\\n self.settings = []\\n self.extra_txt = []\\n self.title = None\\n self._merge_latex = False\\n\\n def __str__(self):\\n return self.as_text()\\n\\n def __repr__(self):\\n return str(type(self)) + '\\\\n\\\"\\\"\\\"\\\\n' + self.__str__() + '\\\\n\\\"\\\"\\\"'\\n\\n def _repr_html_(self):\\n '''Display as HTML in IPython notebook.'''\\n return self.as_html()\\n\\n def add_df(self, df, index=True, header=True, float_format='%.4f',\\n align='r'):\\n '''Add the contents of a DataFrame to summary table\\n\\n Parameters\\n ----------\\n df : DataFrame\\n header: bool\\n Reproduce the DataFrame column labels in summary table\\n index: bool\\n Reproduce the DataFrame row labels in summary table\\n float_format: string\\n Formatting to float data columns\\n align : string\\n Data alignment (l/c/r)\\n '''\\n\\n settings = {'index': index, 'header': header,\\n 'float_format': float_format, 'align': align}\\n self.tables.append(df)\\n self.settings.append(settings)\\n\\n def add_array(self, array, align='r', float_format=\\\"%.4f\\\"):\\n '''Add the contents of a Numpy array to summary table\\n\\n Parameters\\n ----------\\n array : numpy array (2D)\\n float_format: string\\n Formatting to array if type is float\\n align : string\\n Data alignment (l/c/r)\\n '''\\n\\n table = pd.DataFrame(array)\\n self.add_df(table, index=False, header=False,\\n float_format=float_format, align=align)\\n\\n def add_dict(self, d, ncols=2, align='l', float_format=\\\"%.4f\\\"):\\n '''Add the contents of a Dict to summary table\\n\\n Parameters\\n ----------\\n d : dict\\n Keys and values are automatically coerced to strings with str().\\n Users are encouraged to format them before using add_dict.\\n ncols: int\\n Number of columns of the output table\\n align : string\\n Data alignment (l/c/r)\\n '''\\n\\n keys = [_formatter(x, float_format) for x in iterkeys(d)]\\n vals = [_formatter(x, float_format) for x in itervalues(d)]\\n data = np.array(lzip(keys, vals))\\n\\n if data.shape[0] % ncols != 0:\\n pad = ncols - (data.shape[0] % ncols)\\n data = np.vstack([data, np.array(pad * [['', '']])])\\n\\n data = np.split(data, ncols)\\n data = reduce(lambda x, y: np.hstack([x, y]), data)\\n self.add_array(data, align=align)\\n\\n def add_text(self, string):\\n '''Append a note to the bottom of the summary table. In ASCII tables,\\n the note will be wrapped to table width. Notes are not indendented.\\n '''\\n self.extra_txt.append(string)\\n\\n def add_title(self, title=None, results=None):\\n '''Insert a title on top of the summary table. If a string is provided\\n in the title argument, that string is printed. If no title string is\\n provided but a results instance is provided, statsmodels attempts\\n to construct a useful title automatically.\\n '''\\n if isinstance(title, string_types):\\n self.title = title\\n else:\\n try:\\n model = results.model.__class__.__name__\\n if model in _model_types:\\n model = _model_types[model]\\n self.title = 'Results: ' + model\\n except:\\n self.title = ''\\n\\n def add_base(self, results, alpha=0.05, float_format=\\\"%.4f\\\", title=None,\\n xname=None, yname=None):\\n '''Try to construct a basic summary instance.\\n\\n Parameters\\n ----------\\n results : Model results instance\\n alpha : float\\n significance level for the confidence intervals (optional)\\n float_formatting: string\\n Float formatting for summary of parameters (optional)\\n title : string\\n Title of the summary table (optional)\\n xname : List of strings of length equal to the number of parameters\\n Names of the independent variables (optional)\\n yname : string\\n Name of the dependent variable (optional)\\n '''\\n\\n param = summary_params(results, alpha=alpha, use_t=results.use_t)\\n info = summary_model(results)\\n if xname is not None:\\n param.index = xname\\n if yname is not None:\\n info['Dependent Variable:'] = yname\\n self.add_dict(info, align='l')\\n self.add_df(param, float_format=float_format)\\n self.add_title(title=title, results=results)\\n\\n def as_text(self):\\n '''Generate ASCII Summary Table\\n '''\\n\\n tables = self.tables\\n settings = self.settings\\n title = self.title\\n extra_txt = self.extra_txt\\n\\n pad_col, pad_index, widest = _measure_tables(tables, settings)\\n\\n rule_equal = widest * '='\\n\\n simple_tables = _simple_tables(tables, settings, pad_col, pad_index)\\n tab = [x.as_text() for x in simple_tables]\\n\\n tab = '\\\\n'.join(tab)\\n tab = tab.split('\\\\n')\\n tab[0] = rule_equal\\n tab.append(rule_equal)\\n tab = '\\\\n'.join(tab)\\n\\n if title is not None:\\n title = title\\n if len(title) < widest:\\n title = ' ' * int(widest/2 - len(title)/2) + title\\n else:\\n title = ''\\n\\n txt = [textwrap.wrap(x, widest) for x in extra_txt]\\n txt = ['\\\\n'.join(x) for x in txt]\\n txt = '\\\\n'.join(txt)\\n\\n out = '\\\\n'.join([title, tab, txt])\\n\\n return out\\n\\n def as_html(self):\\n '''Generate HTML Summary Table\\n '''\\n\\n tables = self.tables\\n settings = self.settings\\n #TODO: this isn't used anywhere\\n title = self.title\\n\\n simple_tables = _simple_tables(tables, settings)\\n tab = [x.as_html() for x in simple_tables]\\n tab = '\\\\n'.join(tab)\\n\\n return tab\\n\\n def as_latex(self):\\n '''Generate LaTeX Summary Table\\n '''\\n tables = self.tables\\n settings = self.settings\\n title = self.title\\n\\n if title is not None:\\n title = '\\\\\\\\caption{' + title + '}'\\n else:\\n title = '\\\\\\\\caption{}'\\n\\n simple_tables = _simple_tables(tables, settings)\\n tab = [x.as_latex_tabular() for x in simple_tables]\\n tab = '\\\\n\\\\\\\\hline\\\\n'.join(tab)\\n\\n to_replace = ('\\\\\\\\\\\\\\\\hline\\\\\\\\n\\\\\\\\\\\\\\\\hline\\\\\\\\n\\\\\\\\\\\\\\\\'\\n 'end{tabular}\\\\\\\\n\\\\\\\\\\\\\\\\begin{tabular}{.*}\\\\\\\\n')\\n\\n if self._merge_latex:\\n # create single tabular object for summary_col\\n tab = re.sub(to_replace,r'\\\\\\\\midrule\\\\n\\\\\\\\midrule\\\\n', tab)\\n\\n out = '\\\\\\\\begin{table}', title, tab, '\\\\\\\\end{table}'\\n out = '\\\\n'.join(out)\\n return out\\n\\n\\ndef _measure_tables(tables, settings):\\n '''Compare width of ascii tables in a list and calculate padding values.\\n We add space to each col_sep to get us as close as possible to the\\n width of the largest table. Then, we add a few spaces to the first\\n column to pad the rest.\\n '''\\n\\n simple_tables = _simple_tables(tables, settings)\\n tab = [x.as_text() for x in simple_tables]\\n\\n length = [len(x.splitlines()[0]) for x in tab]\\n len_max = max(length)\\n pad_sep = []\\n pad_index = []\\n\\n for i in range(len(tab)):\\n nsep = max(tables[i].shape[1] - 1, 1)\\n pad = int((len_max - length[i]) / nsep)\\n pad_sep.append(pad)\\n len_new = length[i] + nsep * pad\\n pad_index.append(len_max - len_new)\\n\\n return pad_sep, pad_index, max(length)\\n\\n\\n# Useful stuff\\n_model_types = {'OLS': 'Ordinary least squares',\\n 'GLS': 'Generalized least squares',\\n 'GLSAR' : 'Generalized least squares with AR(p)',\\n 'WLS': 'Weighted least squares',\\n 'RLM': 'Robust linear model',\\n 'NBin': 'Negative binomial model',\\n 'GLM': 'Generalized linear model'\\n }\\n\\n\\ndef summary_model(results):\\n '''Create a dict with information about the model\\n '''\\n\\n def time_now(*args, **kwds):\\n now = datetime.datetime.now()\\n return now.strftime('%Y-%m-%d %H:%M')\\n\\n info = OrderedDict()\\n info['Model:'] = lambda x: x.model.__class__.__name__\\n info['Model Family:'] = lambda x: x.family.__class.__name__\\n info['Link Function:'] = lambda x: x.family.link.__class__.__name__\\n info['Dependent Variable:'] = lambda x: x.model.endog_names\\n info['Date:'] = time_now\\n info['No. Observations:'] = lambda x: \\\"%#6d\\\" % x.nobs\\n info['Df Model:'] = lambda x: \\\"%#6d\\\" % x.df_model\\n info['Df Residuals:'] = lambda x: \\\"%#6d\\\" % x.df_resid\\n info['Converged:'] = lambda x: x.mle_retvals['converged']\\n info['No. Iterations:'] = lambda x: x.mle_retvals['iterations']\\n info['Method:'] = lambda x: x.method\\n info['Norm:'] = lambda x: x.fit_options['norm']\\n info['Scale Est.:'] = lambda x: x.fit_options['scale_est']\\n info['Cov. Type:'] = lambda x: x.fit_options['cov']\\n\\n rsquared_type = '' if results.k_constant else ' (uncentered)'\\n info['R-squared' + rsquared_type + ':'] = lambda x: \\\"%#8.3f\\\" % x.rsquared\\n info['Adj. R-squared' + rsquared_type + ':'] = lambda x: \\\"%#8.3f\\\" % x.rsquared_adj\\n info['Pseudo R-squared:'] = lambda x: \\\"%#8.3f\\\" % x.prsquared\\n info['AIC:'] = lambda x: \\\"%8.4f\\\" % x.aic\\n info['BIC:'] = lambda x: \\\"%8.4f\\\" % x.bic\\n info['Log-Likelihood:'] = lambda x: \\\"%#8.5g\\\" % x.llf\\n info['LL-Null:'] = lambda x: \\\"%#8.5g\\\" % x.llnull\\n info['LLR p-value:'] = lambda x: \\\"%#8.5g\\\" % x.llr_pvalue\\n info['Deviance:'] = lambda x: \\\"%#8.5g\\\" % x.deviance\\n info['Pearson chi2:'] = lambda x: \\\"%#6.3g\\\" % x.pearson_chi2\\n info['F-statistic:'] = lambda x: \\\"%#8.4g\\\" % x.fvalue\\n info['Prob (F-statistic):'] = lambda x: \\\"%#6.3g\\\" % x.f_pvalue\\n info['Scale:'] = lambda x: \\\"%#8.5g\\\" % x.scale\\n out = OrderedDict()\\n for key, func in iteritems(info):\\n try:\\n out[key] = func(results)\\n except (AttributeError, KeyError, NotImplementedError):\\n # NOTE: some models don't have loglike defined (RLM),\\n # so raise NotImplementedError\\n pass\\n return out\\n\\n\\ndef summary_params(results, yname=None, xname=None, alpha=.05, use_t=True,\\n skip_header=False, float_format=\\\"%.4f\\\"):\\n '''create a summary table of parameters from results instance\\n\\n Parameters\\n ----------\\n res : results instance\\n some required information is directly taken from the result\\n instance\\n yname : string or None\\n optional name for the endogenous variable, default is \\\"y\\\"\\n xname : list of strings or None\\n optional names for the exogenous variables, default is \\\"var_xx\\\"\\n alpha : float\\n significance level for the confidence intervals\\n use_t : bool\\n indicator whether the p-values are based on the Student-t\\n distribution (if True) or on the normal distribution (if False)\\n skip_headers : bool\\n If false (default), then the header row is added. If true, then no\\n header row is added.\\n float_format : string\\n float formatting options (e.g. \\\".3g\\\")\\n\\n Returns\\n -------\\n params_table : SimpleTable instance\\n '''\\n\\n if isinstance(results, tuple):\\n results, params, bse, tvalues, pvalues, conf_int = results\\n else:\\n params = results.params\\n bse = results.bse\\n tvalues = results.tvalues\\n pvalues = results.pvalues\\n conf_int = results.conf_int(alpha)\\n\\n data = np.array([params, bse, tvalues, pvalues]).T\\n data = np.hstack([data, conf_int])\\n data = pd.DataFrame(data)\\n\\n if use_t:\\n data.columns = ['Coef.', 'Std.Err.', 't', 'P>|t|',\\n '[' + str(alpha/2), str(1-alpha/2) + ']']\\n else:\\n data.columns = ['Coef.', 'Std.Err.', 'z', 'P>|z|',\\n '[' + str(alpha/2), str(1-alpha/2) + ']']\\n\\n if not xname:\\n try:\\n data.index = results.model.data.param_names\\n except AttributeError:\\n data.index = results.model.exog_names\\n else:\\n data.index = xname\\n\\n return data\\n\\n\\n# Vertical summary instance for multiple models\\ndef _col_params(result, float_format='%.4f', stars=True):\\n '''Stack coefficients and standard errors in single column\\n '''\\n\\n # Extract parameters\\n res = summary_params(result)\\n # Format float\\n for col in res.columns[:2]:\\n res[col] = res[col].apply(lambda x: float_format % x)\\n # Std.Errors in parentheses\\n res.iloc[:, 1] = '(' + res.iloc[:, 1] + ')'\\n # Significance stars\\n if stars:\\n idx = res.iloc[:, 3] < .1\\n res.loc[idx, res.columns[0]] = res.loc[idx, res.columns[0]] + '*'\\n idx = res.iloc[:, 3] < .05\\n res.loc[idx, res.columns[0]] = res.loc[idx, res.columns[0]] + '*'\\n idx = res.iloc[:, 3] < .01\\n res.loc[idx, res.columns[0]] = res.loc[idx, res.columns[0]] + '*'\\n # Stack Coefs and Std.Errors\\n res = res.iloc[:, :2]\\n res = res.stack()\\n res = pd.DataFrame(res)\\n res.columns = [str(result.model.endog_names)]\\n return res\\n\\n\\ndef _col_info(result, info_dict=None):\\n '''Stack model info in a column\\n '''\\n\\n if info_dict is None:\\n info_dict = {}\\n out = []\\n index = []\\n for i in info_dict:\\n if isinstance(info_dict[i], dict):\\n # this is a specific model info_dict, but not for this result...\\n continue\\n try:\\n out.append(info_dict[i](result))\\n except:\\n out.append('')\\n index.append(i)\\n out = pd.DataFrame({str(result.model.endog_names): out}, index=index)\\n return out\\n\\n\\ndef _make_unique(list_of_names):\\n if len(set(list_of_names)) == len(list_of_names):\\n return list_of_names\\n # pandas does not like it if multiple columns have the same names\\n from collections import defaultdict\\n name_counter = defaultdict(str)\\n header = []\\n for _name in list_of_names:\\n name_counter[_name] += \\\"I\\\"\\n header.append(_name+\\\" \\\" + name_counter[_name])\\n return header\\n\\n\\ndef summary_col(results, float_format='%.4f', model_names=(), stars=False,\\n info_dict=None, regressor_order=(), drop_omitted=False):\\n \\\"\\\"\\\"\\n Summarize multiple results instances side-by-side (coefs and SEs)\\n\\n Parameters\\n ----------\\n results : statsmodels results instance or list of result instances\\n float_format : string, optional\\n float format for coefficients and standard errors\\n Default : '%.4f'\\n model_names : list of strings, optional\\n Must have same length as the number of results. If the names are not\\n unique, a roman number will be appended to all model names\\n stars : bool\\n print significance stars\\n info_dict : dict\\n dict of functions to be applied to results instances to retrieve\\n model info. To use specific information for different models, add a\\n (nested) info_dict with model name as the key.\\n Example: `info_dict = {\\\"N\\\":..., \\\"R2\\\": ..., \\\"OLS\\\":{\\\"R2\\\":...}}` would\\n only show `R2` for OLS regression models, but additionally `N` for\\n all other results.\\n Default : None (use the info_dict specified in\\n result.default_model_infos, if this property exists)\\n regressor_order : list of strings, optional\\n list of names of the regressors in the desired order. All regressors\\n not specified will be appended to the end of the list.\\n drop_omitted : bool, optional\\n Includes regressors that are not specified in regressor_order. If False,\\n regressors not specified will be appended to end of the list. If True,\\n only regressors in regressors_list will be included.\\n \\\"\\\"\\\"\\n\\n if not isinstance(results, list):\\n results = [results]\\n\\n cols = [_col_params(x, stars=stars, float_format=float_format) for x in\\n results]\\n\\n # Unique column names (pandas has problems merging otherwise)\\n if model_names:\\n colnames = _make_unique(model_names)\\n else:\\n colnames = _make_unique([x.columns[0] for x in cols])\\n for i in range(len(cols)):\\n cols[i].columns = [colnames[i]]\\n\\n merg = lambda x, y: x.merge(y, how='outer', right_index=True,\\n left_index=True)\\n summ = reduce(merg, cols)\\n\\n if regressor_order:\\n varnames = summ.index.get_level_values(0).tolist()\\n ordered = [x for x in regressor_order if x in varnames]\\n unordered = [x for x in varnames if x not in regressor_order + ['']]\\n order = ordered + list(np.unique(unordered))\\n\\n f = lambda idx: sum([[x + 'coef', x + 'stde'] for x in idx], [])\\n summ.index = f(pd.unique(varnames))\\n summ = summ.reindex(f(order))\\n summ.index = [x[:-4] for x in summ.index]\\n if drop_omitted:\\n summ = summ.loc[regressor_order]\\n\\n idx = pd.Series(lrange(summ.shape[0])) % 2 == 1\\n summ.index = np.where(idx, '', summ.index.get_level_values(0))\\n\\n # add infos about the models.\\n if info_dict:\\n cols = [_col_info(x, info_dict.get(x.model.__class__.__name__,\\n info_dict)) for x in results]\\n else:\\n cols = [_col_info(x, getattr(x, \\\"default_model_infos\\\", None)) for x in\\n results]\\n # use unique column names, otherwise the merge will not succeed\\n for df, name in zip(cols, _make_unique([df.columns[0] for df in cols])):\\n df.columns = [name]\\n merg = lambda x, y: x.merge(y, how='outer', right_index=True,\\n left_index=True)\\n info = reduce(merg, cols)\\n dat = pd.DataFrame(np.vstack([summ, info])) # pd.concat better, but error\\n dat.columns = summ.columns\\n dat.index = pd.Index(summ.index.tolist() + info.index.tolist())\\n summ = dat\\n\\n summ = summ.fillna('')\\n\\n smry = Summary()\\n smry._merge_latex = True\\n smry.add_df(summ, header=True, align='l')\\n smry.add_text('Standard errors in parentheses.')\\n if stars:\\n smry.add_text('* p<.1, ** p<.05, ***p<.01')\\n\\n return smry\\n\\n\\ndef _formatter(element, float_format='%.4f'):\\n try:\\n out = float_format % element\\n except:\\n out = str(element)\\n return out.strip()\\n\\n\\ndef _df_to_simpletable(df, align='r', float_format=\\\"%.4f\\\", header=True,\\n index=True, table_dec_above='-', table_dec_below=None,\\n header_dec_below='-', pad_col=0, pad_index=0):\\n dat = df.copy()\\n dat = dat.applymap(lambda x: _formatter(x, float_format))\\n if header:\\n headers = [str(x) for x in dat.columns.tolist()]\\n else:\\n headers = None\\n if index:\\n stubs = [str(x) + int(pad_index) * ' ' for x in dat.index.tolist()]\\n else:\\n dat.iloc[:, 0] = [str(x) + int(pad_index) * ' ' for x in dat.iloc[:, 0]]\\n stubs = None\\n st = SimpleTable(np.array(dat), headers=headers, stubs=stubs,\\n ltx_fmt=fmt_latex, txt_fmt=fmt_txt)\\n st.output_formats['latex']['data_aligns'] = align\\n st.output_formats['txt']['data_aligns'] = align\\n st.output_formats['txt']['table_dec_above'] = table_dec_above\\n st.output_formats['txt']['table_dec_below'] = table_dec_below\\n st.output_formats['txt']['header_dec_below'] = header_dec_below\\n st.output_formats['txt']['colsep'] = ' ' * int(pad_col + 1)\\n return st\\n\\n\\ndef _simple_tables(tables, settings, pad_col=None, pad_index=None):\\n simple_tables = []\\n float_format = '%.4f'\\n if pad_col is None:\\n pad_col = [0] * len(tables)\\n if pad_index is None:\\n pad_index = [0] * len(tables)\\n for i, v in enumerate(tables):\\n index = settings[i]['index']\\n header = settings[i]['header']\\n align = settings[i]['align']\\n simple_tables.append(_df_to_simpletable(v, align=align,\\n float_format=float_format,\\n header=header, index=index,\\n pad_col=pad_col[i],\\n pad_index=pad_index[i]))\\n return simple_tables\\n\",\n \"path\": \"statsmodels/iolib/summary2.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"from statsmodels.compat.python import (lrange, iterkeys, iteritems, lzip,\n reduce, itervalues, zip, string_types,\n range)\n\nfrom collections import OrderedDict\nimport datetime\nimport re\nimport textwrap\n\nimport numpy as np\nimport pandas as pd\n\nfrom .table import SimpleTable\nfrom .tableformatting import fmt_latex, fmt_txt\n\n\nclass Summary(object):\n def __init__(self):\n self.tables = []\n self.settings = []\n self.extra_txt = []\n self.title = None\n self._merge_latex = False\n\n def __str__(self):\n return self.as_text()\n\n def __repr__(self):\n return str(type(self)) + '\\n\"\"\"\\n' + self.__str__() + '\\n\"\"\"'\n\n def _repr_html_(self):\n '''Display as HTML in IPython notebook.'''\n return self.as_html()\n\n def add_df(self, df, index=True, header=True, float_format='%.4f',\n align='r'):\n '''Add the contents of a DataFrame to summary table\n\n Parameters\n ----------\n df : DataFrame\n header: bool\n Reproduce the DataFrame column labels in summary table\n index: bool\n Reproduce the DataFrame row labels in summary table\n float_format: string\n Formatting to float data columns\n align : string\n Data alignment (l/c/r)\n '''\n\n settings = {'index': index, 'header': header,\n 'float_format': float_format, 'align': align}\n self.tables.append(df)\n self.settings.append(settings)\n\n def add_array(self, array, align='r', float_format=\"%.4f\"):\n '''Add the contents of a Numpy array to summary table\n\n Parameters\n ----------\n array : numpy array (2D)\n float_format: string\n Formatting to array if type is float\n align : string\n Data alignment (l/c/r)\n '''\n\n table = pd.DataFrame(array)\n self.add_df(table, index=False, header=False,\n float_format=float_format, align=align)\n\n def add_dict(self, d, ncols=2, align='l', float_format=\"%.4f\"):\n '''Add the contents of a Dict to summary table\n\n Parameters\n ----------\n d : dict\n Keys and values are automatically coerced to strings with str().\n Users are encouraged to format them before using add_dict.\n ncols: int\n Number of columns of the output table\n align : string\n Data alignment (l/c/r)\n '''\n\n keys = [_formatter(x, float_format) for x in iterkeys(d)]\n vals = [_formatter(x, float_format) for x in itervalues(d)]\n data = np.array(lzip(keys, vals))\n\n if data.shape[0] % ncols != 0:\n pad = ncols - (data.shape[0] % ncols)\n data = np.vstack([data, np.array(pad * [['', '']])])\n\n data = np.split(data, ncols)\n data = reduce(lambda x, y: np.hstack([x, y]), data)\n self.add_array(data, align=align)\n\n def add_text(self, string):\n '''Append a note to the bottom of the summary table. In ASCII tables,\n the note will be wrapped to table width. Notes are not indendented.\n '''\n self.extra_txt.append(string)\n\n def add_title(self, title=None, results=None):\n '''Insert a title on top of the summary table. If a string is provided\n in the title argument, that string is printed. If no title string is\n provided but a results instance is provided, statsmodels attempts\n to construct a useful title automatically.\n '''\n if isinstance(title, string_types):\n self.title = title\n else:\n try:\n model = results.model.__class__.__name__\n if model in _model_types:\n model = _model_types[model]\n self.title = 'Results: ' + model\n except:\n self.title = ''\n\n def add_base(self, results, alpha=0.05, float_format=\"%.4f\", title=None,\n xname=None, yname=None):\n '''Try to construct a basic summary instance.\n\n Parameters\n ----------\n results : Model results instance\n alpha : float\n significance level for the confidence intervals (optional)\n float_formatting: string\n Float formatting for summary of parameters (optional)\n title : string\n Title of the summary table (optional)\n xname : List of strings of length equal to the number of parameters\n Names of the independent variables (optional)\n yname : string\n Name of the dependent variable (optional)\n '''\n\n param = summary_params(results, alpha=alpha, use_t=results.use_t)\n info = summary_model(results)\n if xname is not None:\n param.index = xname\n if yname is not None:\n info['Dependent Variable:'] = yname\n self.add_dict(info, align='l')\n self.add_df(param, float_format=float_format)\n self.add_title(title=title, results=results)\n\n def as_text(self):\n '''Generate ASCII Summary Table\n '''\n\n tables = self.tables\n settings = self.settings\n title = self.title\n extra_txt = self.extra_txt\n\n pad_col, pad_index, widest = _measure_tables(tables, settings)\n\n rule_equal = widest * '='\n\n simple_tables = _simple_tables(tables, settings, pad_col, pad_index)\n tab = [x.as_text() for x in simple_tables]\n\n tab = '\\n'.join(tab)\n tab = tab.split('\\n')\n tab[0] = rule_equal\n tab.append(rule_equal)\n tab = '\\n'.join(tab)\n\n if title is not None:\n title = title\n if len(title) < widest:\n title = ' ' * int(widest/2 - len(title)/2) + title\n else:\n title = ''\n\n txt = [textwrap.wrap(x, widest) for x in extra_txt]\n txt = ['\\n'.join(x) for x in txt]\n txt = '\\n'.join(txt)\n\n out = '\\n'.join([title, tab, txt])\n\n return out\n\n def as_html(self):\n '''Generate HTML Summary Table\n '''\n\n tables = self.tables\n settings = self.settings\n #TODO: this isn't used anywhere\n title = self.title\n\n simple_tables = _simple_tables(tables, settings)\n tab = [x.as_html() for x in simple_tables]\n tab = '\\n'.join(tab)\n\n return tab\n\n def as_latex(self):\n '''Generate LaTeX Summary Table\n '''\n tables = self.tables\n settings = self.settings\n title = self.title\n\n if title is not None:\n title = '\\\\caption{' + title + '}'\n else:\n title = '\\\\caption{}'\n\n simple_tables = _simple_tables(tables, settings)\n tab = [x.as_latex_tabular() for x in simple_tables]\n tab = '\\n\\\\hline\\n'.join(tab)\n\n to_replace = ('\\\\\\\\hline\\\\n\\\\\\\\hline\\\\n\\\\\\\\'\n 'end{tabular}\\\\n\\\\\\\\begin{tabular}{.*}\\\\n')\n\n if self._merge_latex:\n # create single tabular object for summary_col\n tab = re.sub(to_replace,r'\\\\midrule\\n', tab)\n\n out = '\\\\begin{table}', title, tab, '\\\\end{table}'\n out = '\\n'.join(out)\n return out\n\n\ndef _measure_tables(tables, settings):\n '''Compare width of ascii tables in a list and calculate padding values.\n We add space to each col_sep to get us as close as possible to the\n width of the largest table. Then, we add a few spaces to the first\n column to pad the rest.\n '''\n\n simple_tables = _simple_tables(tables, settings)\n tab = [x.as_text() for x in simple_tables]\n\n length = [len(x.splitlines()[0]) for x in tab]\n len_max = max(length)\n pad_sep = []\n pad_index = []\n\n for i in range(len(tab)):\n nsep = max(tables[i].shape[1] - 1, 1)\n pad = int((len_max - length[i]) / nsep)\n pad_sep.append(pad)\n len_new = length[i] + nsep * pad\n pad_index.append(len_max - len_new)\n\n return pad_sep, pad_index, max(length)\n\n\n# Useful stuff\n_model_types = {'OLS': 'Ordinary least squares',\n 'GLS': 'Generalized least squares',\n 'GLSAR' : 'Generalized least squares with AR(p)',\n 'WLS': 'Weighted least squares',\n 'RLM': 'Robust linear model',\n 'NBin': 'Negative binomial model',\n 'GLM': 'Generalized linear model'\n }\n\n\ndef summary_model(results):\n '''Create a dict with information about the model\n '''\n\n def time_now(*args, **kwds):\n now = datetime.datetime.now()\n return now.strftime('%Y-%m-%d %H:%M')\n\n info = OrderedDict()\n info['Model:'] = lambda x: x.model.__class__.__name__\n info['Model Family:'] = lambda x: x.family.__class.__name__\n info['Link Function:'] = lambda x: x.family.link.__class__.__name__\n info['Dependent Variable:'] = lambda x: x.model.endog_names\n info['Date:'] = time_now\n info['No. Observations:'] = lambda x: \"%#6d\" % x.nobs\n info['Df Model:'] = lambda x: \"%#6d\" % x.df_model\n info['Df Residuals:'] = lambda x: \"%#6d\" % x.df_resid\n info['Converged:'] = lambda x: x.mle_retvals['converged']\n info['No. Iterations:'] = lambda x: x.mle_retvals['iterations']\n info['Method:'] = lambda x: x.method\n info['Norm:'] = lambda x: x.fit_options['norm']\n info['Scale Est.:'] = lambda x: x.fit_options['scale_est']\n info['Cov. Type:'] = lambda x: x.fit_options['cov']\n\n rsquared_type = '' if results.k_constant else ' (uncentered)'\n info['R-squared' + rsquared_type + ':'] = lambda x: \"%#8.3f\" % x.rsquared\n info['Adj. R-squared' + rsquared_type + ':'] = lambda x: \"%#8.3f\" % x.rsquared_adj\n info['Pseudo R-squared:'] = lambda x: \"%#8.3f\" % x.prsquared\n info['AIC:'] = lambda x: \"%8.4f\" % x.aic\n info['BIC:'] = lambda x: \"%8.4f\" % x.bic\n info['Log-Likelihood:'] = lambda x: \"%#8.5g\" % x.llf\n info['LL-Null:'] = lambda x: \"%#8.5g\" % x.llnull\n info['LLR p-value:'] = lambda x: \"%#8.5g\" % x.llr_pvalue\n info['Deviance:'] = lambda x: \"%#8.5g\" % x.deviance\n info['Pearson chi2:'] = lambda x: \"%#6.3g\" % x.pearson_chi2\n info['F-statistic:'] = lambda x: \"%#8.4g\" % x.fvalue\n info['Prob (F-statistic):'] = lambda x: \"%#6.3g\" % x.f_pvalue\n info['Scale:'] = lambda x: \"%#8.5g\" % x.scale\n out = OrderedDict()\n for key, func in iteritems(info):\n try:\n out[key] = func(results)\n except (AttributeError, KeyError, NotImplementedError):\n # NOTE: some models don't have loglike defined (RLM),\n # so raise NotImplementedError\n pass\n return out\n\n\ndef summary_params(results, yname=None, xname=None, alpha=.05, use_t=True,\n skip_header=False, float_format=\"%.4f\"):\n '''create a summary table of parameters from results instance\n\n Parameters\n ----------\n res : results instance\n some required information is directly taken from the result\n instance\n yname : string or None\n optional name for the endogenous variable, default is \"y\"\n xname : list of strings or None\n optional names for the exogenous variables, default is \"var_xx\"\n alpha : float\n significance level for the confidence intervals\n use_t : bool\n indicator whether the p-values are based on the Student-t\n distribution (if True) or on the normal distribution (if False)\n skip_headers : bool\n If false (default), then the header row is added. If true, then no\n header row is added.\n float_format : string\n float formatting options (e.g. \".3g\")\n\n Returns\n -------\n params_table : SimpleTable instance\n '''\n\n if isinstance(results, tuple):\n results, params, bse, tvalues, pvalues, conf_int = results\n else:\n params = results.params\n bse = results.bse\n tvalues = results.tvalues\n pvalues = results.pvalues\n conf_int = results.conf_int(alpha)\n\n data = np.array([params, bse, tvalues, pvalues]).T\n data = np.hstack([data, conf_int])\n data = pd.DataFrame(data)\n\n if use_t:\n data.columns = ['Coef.', 'Std.Err.', 't', 'P>|t|',\n '[' + str(alpha/2), str(1-alpha/2) + ']']\n else:\n data.columns = ['Coef.', 'Std.Err.', 'z', 'P>|z|',\n '[' + str(alpha/2), str(1-alpha/2) + ']']\n\n if not xname:\n try:\n data.index = results.model.data.param_names\n except AttributeError:\n data.index = results.model.exog_names\n else:\n data.index = xname\n\n return data\n\n\n# Vertical summary instance for multiple models\ndef _col_params(result, float_format='%.4f', stars=True):\n '''Stack coefficients and standard errors in single column\n '''\n\n # Extract parameters\n res = summary_params(result)\n # Format float\n for col in res.columns[:2]:\n res[col] = res[col].apply(lambda x: float_format % x)\n # Std.Errors in parentheses\n res.iloc[:, 1] = '(' + res.iloc[:, 1] + ')'\n # Significance stars\n if stars:\n idx = res.iloc[:, 3] < .1\n res.loc[idx, res.columns[0]] = res.loc[idx, res.columns[0]] + '*'\n idx = res.iloc[:, 3] < .05\n res.loc[idx, res.columns[0]] = res.loc[idx, res.columns[0]] + '*'\n idx = res.iloc[:, 3] < .01\n res.loc[idx, res.columns[0]] = res.loc[idx, res.columns[0]] + '*'\n # Stack Coefs and Std.Errors\n res = res.iloc[:, :2]\n res = res.stack()\n res = pd.DataFrame(res)\n res.columns = [str(result.model.endog_names)]\n return res\n\n\ndef _col_info(result, info_dict=None):\n '''Stack model info in a column\n '''\n\n if info_dict is None:\n info_dict = {}\n out = []\n index = []\n for i in info_dict:\n if isinstance(info_dict[i], dict):\n # this is a specific model info_dict, but not for this result...\n continue\n try:\n out.append(info_dict[i](result))\n except:\n out.append('')\n index.append(i)\n out = pd.DataFrame({str(result.model.endog_names): out}, index=index)\n return out\n\n\ndef _make_unique(list_of_names):\n if len(set(list_of_names)) == len(list_of_names):\n return list_of_names\n # pandas does not like it if multiple columns have the same names\n from collections import defaultdict\n name_counter = defaultdict(str)\n header = []\n for _name in list_of_names:\n name_counter[_name] += \"I\"\n header.append(_name+\" \" + name_counter[_name])\n return header\n\n\ndef summary_col(results, float_format='%.4f', model_names=(), stars=False,\n info_dict=None, regressor_order=(), drop_omitted=False):\n \"\"\"\n Summarize multiple results instances side-by-side (coefs and SEs)\n\n Parameters\n ----------\n results : statsmodels results instance or list of result instances\n float_format : string, optional\n float format for coefficients and standard errors\n Default : '%.4f'\n model_names : list of strings, optional\n Must have same length as the number of results. If the names are not\n unique, a roman number will be appended to all model names\n stars : bool\n print significance stars\n info_dict : dict\n dict of functions to be applied to results instances to retrieve\n model info. To use specific information for different models, add a\n (nested) info_dict with model name as the key.\n Example: `info_dict = {\"N\":..., \"R2\": ..., \"OLS\":{\"R2\":...}}` would\n only show `R2` for OLS regression models, but additionally `N` for\n all other results.\n Default : None (use the info_dict specified in\n result.default_model_infos, if this property exists)\n regressor_order : list of strings, optional\n list of names of the regressors in the desired order. All regressors\n not specified will be appended to the end of the list.\n drop_omitted : bool, optional\n Includes regressors that are not specified in regressor_order. If False,\n regressors not specified will be appended to end of the list. If True,\n only regressors in regressors_list will be included.\n \"\"\"\n\n if not isinstance(results, list):\n results = [results]\n\n cols = [_col_params(x, stars=stars, float_format=float_format) for x in\n results]\n\n # Unique column names (pandas has problems merging otherwise)\n if model_names:\n colnames = _make_unique(model_names)\n else:\n colnames = _make_unique([x.columns[0] for x in cols])\n for i in range(len(cols)):\n cols[i].columns = [colnames[i]]\n\n merg = lambda x, y: x.merge(y, how='outer', right_index=True,\n left_index=True)\n summ = reduce(merg, cols)\n\n if regressor_order:\n varnames = summ.index.get_level_values(0).tolist()\n ordered = [x for x in regressor_order if x in varnames]\n unordered = [x for x in varnames if x not in regressor_order + ['']]\n order = ordered + list(np.unique(unordered))\n\n f = lambda idx: sum([[x + 'coef', x + 'stde'] for x in idx], [])\n summ.index = f(pd.unique(varnames))\n summ = summ.reindex(f(order))\n summ.index = [x[:-4] for x in summ.index]\n if drop_omitted:\n summ = summ.loc[regressor_order]\n\n idx = pd.Series(lrange(summ.shape[0])) % 2 == 1\n summ.index = np.where(idx, '', summ.index.get_level_values(0))\n\n # add infos about the models.\n if info_dict:\n cols = [_col_info(x, info_dict.get(x.model.__class__.__name__,\n info_dict)) for x in results]\n else:\n cols = [_col_info(x, getattr(x, \"default_model_infos\", None)) for x in\n results]\n # use unique column names, otherwise the merge will not succeed\n for df, name in zip(cols, _make_unique([df.columns[0] for df in cols])):\n df.columns = [name]\n merg = lambda x, y: x.merge(y, how='outer', right_index=True,\n left_index=True)\n info = reduce(merg, cols)\n dat = pd.DataFrame(np.vstack([summ, info])) # pd.concat better, but error\n dat.columns = summ.columns\n dat.index = pd.Index(summ.index.tolist() + info.index.tolist())\n summ = dat\n\n summ = summ.fillna('')\n\n smry = Summary()\n smry._merge_latex = True\n smry.add_df(summ, header=True, align='l')\n smry.add_text('Standard errors in parentheses.')\n if stars:\n smry.add_text('* p<.1, ** p<.05, ***p<.01')\n\n return smry\n\n\ndef _formatter(element, float_format='%.4f'):\n try:\n out = float_format % element\n except:\n out = str(element)\n return out.strip()\n\n\ndef _df_to_simpletable(df, align='r', float_format=\"%.4f\", header=True,\n index=True, table_dec_above='-', table_dec_below=None,\n header_dec_below='-', pad_col=0, pad_index=0):\n dat = df.copy()\n dat = dat.applymap(lambda x: _formatter(x, float_format))\n if header:\n headers = [str(x) for x in dat.columns.tolist()]\n else:\n headers = None\n if index:\n stubs = [str(x) + int(pad_index) * ' ' for x in dat.index.tolist()]\n else:\n dat.iloc[:, 0] = [str(x) + int(pad_index) * ' ' for x in dat.iloc[:, 0]]\n stubs = None\n st = SimpleTable(np.array(dat), headers=headers, stubs=stubs,\n ltx_fmt=fmt_latex, txt_fmt=fmt_txt)\n st.output_formats['latex']['data_aligns'] = align\n st.output_formats['txt']['data_aligns'] = align\n st.output_formats['txt']['table_dec_above'] = table_dec_above\n st.output_formats['txt']['table_dec_below'] = table_dec_below\n st.output_formats['txt']['header_dec_below'] = header_dec_below\n st.output_formats['txt']['colsep'] = ' ' * int(pad_col + 1)\n return st\n\n\ndef _simple_tables(tables, settings, pad_col=None, pad_index=None):\n simple_tables = []\n float_format = '%.4f'\n if pad_col is None:\n pad_col = [0] * len(tables)\n if pad_index is None:\n pad_index = [0] * len(tables)\n for i, v in enumerate(tables):\n index = settings[i]['index']\n header = settings[i]['header']\n align = settings[i]['align']\n simple_tables.append(_df_to_simpletable(v, align=align,\n float_format=float_format,\n header=header, index=index,\n pad_col=pad_col[i],\n pad_index=pad_index[i]))\n return simple_tables\n","path":"statsmodels/iolib/summary2.py"}],"string":"[\n {\n \"content\": \"from statsmodels.compat.python import (lrange, iterkeys, iteritems, lzip,\\n reduce, itervalues, zip, string_types,\\n range)\\n\\nfrom collections import OrderedDict\\nimport datetime\\nimport re\\nimport textwrap\\n\\nimport numpy as np\\nimport pandas as pd\\n\\nfrom .table import SimpleTable\\nfrom .tableformatting import fmt_latex, fmt_txt\\n\\n\\nclass Summary(object):\\n def __init__(self):\\n self.tables = []\\n self.settings = []\\n self.extra_txt = []\\n self.title = None\\n self._merge_latex = False\\n\\n def __str__(self):\\n return self.as_text()\\n\\n def __repr__(self):\\n return str(type(self)) + '\\\\n\\\"\\\"\\\"\\\\n' + self.__str__() + '\\\\n\\\"\\\"\\\"'\\n\\n def _repr_html_(self):\\n '''Display as HTML in IPython notebook.'''\\n return self.as_html()\\n\\n def add_df(self, df, index=True, header=True, float_format='%.4f',\\n align='r'):\\n '''Add the contents of a DataFrame to summary table\\n\\n Parameters\\n ----------\\n df : DataFrame\\n header: bool\\n Reproduce the DataFrame column labels in summary table\\n index: bool\\n Reproduce the DataFrame row labels in summary table\\n float_format: string\\n Formatting to float data columns\\n align : string\\n Data alignment (l/c/r)\\n '''\\n\\n settings = {'index': index, 'header': header,\\n 'float_format': float_format, 'align': align}\\n self.tables.append(df)\\n self.settings.append(settings)\\n\\n def add_array(self, array, align='r', float_format=\\\"%.4f\\\"):\\n '''Add the contents of a Numpy array to summary table\\n\\n Parameters\\n ----------\\n array : numpy array (2D)\\n float_format: string\\n Formatting to array if type is float\\n align : string\\n Data alignment (l/c/r)\\n '''\\n\\n table = pd.DataFrame(array)\\n self.add_df(table, index=False, header=False,\\n float_format=float_format, align=align)\\n\\n def add_dict(self, d, ncols=2, align='l', float_format=\\\"%.4f\\\"):\\n '''Add the contents of a Dict to summary table\\n\\n Parameters\\n ----------\\n d : dict\\n Keys and values are automatically coerced to strings with str().\\n Users are encouraged to format them before using add_dict.\\n ncols: int\\n Number of columns of the output table\\n align : string\\n Data alignment (l/c/r)\\n '''\\n\\n keys = [_formatter(x, float_format) for x in iterkeys(d)]\\n vals = [_formatter(x, float_format) for x in itervalues(d)]\\n data = np.array(lzip(keys, vals))\\n\\n if data.shape[0] % ncols != 0:\\n pad = ncols - (data.shape[0] % ncols)\\n data = np.vstack([data, np.array(pad * [['', '']])])\\n\\n data = np.split(data, ncols)\\n data = reduce(lambda x, y: np.hstack([x, y]), data)\\n self.add_array(data, align=align)\\n\\n def add_text(self, string):\\n '''Append a note to the bottom of the summary table. In ASCII tables,\\n the note will be wrapped to table width. Notes are not indendented.\\n '''\\n self.extra_txt.append(string)\\n\\n def add_title(self, title=None, results=None):\\n '''Insert a title on top of the summary table. If a string is provided\\n in the title argument, that string is printed. If no title string is\\n provided but a results instance is provided, statsmodels attempts\\n to construct a useful title automatically.\\n '''\\n if isinstance(title, string_types):\\n self.title = title\\n else:\\n try:\\n model = results.model.__class__.__name__\\n if model in _model_types:\\n model = _model_types[model]\\n self.title = 'Results: ' + model\\n except:\\n self.title = ''\\n\\n def add_base(self, results, alpha=0.05, float_format=\\\"%.4f\\\", title=None,\\n xname=None, yname=None):\\n '''Try to construct a basic summary instance.\\n\\n Parameters\\n ----------\\n results : Model results instance\\n alpha : float\\n significance level for the confidence intervals (optional)\\n float_formatting: string\\n Float formatting for summary of parameters (optional)\\n title : string\\n Title of the summary table (optional)\\n xname : List of strings of length equal to the number of parameters\\n Names of the independent variables (optional)\\n yname : string\\n Name of the dependent variable (optional)\\n '''\\n\\n param = summary_params(results, alpha=alpha, use_t=results.use_t)\\n info = summary_model(results)\\n if xname is not None:\\n param.index = xname\\n if yname is not None:\\n info['Dependent Variable:'] = yname\\n self.add_dict(info, align='l')\\n self.add_df(param, float_format=float_format)\\n self.add_title(title=title, results=results)\\n\\n def as_text(self):\\n '''Generate ASCII Summary Table\\n '''\\n\\n tables = self.tables\\n settings = self.settings\\n title = self.title\\n extra_txt = self.extra_txt\\n\\n pad_col, pad_index, widest = _measure_tables(tables, settings)\\n\\n rule_equal = widest * '='\\n\\n simple_tables = _simple_tables(tables, settings, pad_col, pad_index)\\n tab = [x.as_text() for x in simple_tables]\\n\\n tab = '\\\\n'.join(tab)\\n tab = tab.split('\\\\n')\\n tab[0] = rule_equal\\n tab.append(rule_equal)\\n tab = '\\\\n'.join(tab)\\n\\n if title is not None:\\n title = title\\n if len(title) < widest:\\n title = ' ' * int(widest/2 - len(title)/2) + title\\n else:\\n title = ''\\n\\n txt = [textwrap.wrap(x, widest) for x in extra_txt]\\n txt = ['\\\\n'.join(x) for x in txt]\\n txt = '\\\\n'.join(txt)\\n\\n out = '\\\\n'.join([title, tab, txt])\\n\\n return out\\n\\n def as_html(self):\\n '''Generate HTML Summary Table\\n '''\\n\\n tables = self.tables\\n settings = self.settings\\n #TODO: this isn't used anywhere\\n title = self.title\\n\\n simple_tables = _simple_tables(tables, settings)\\n tab = [x.as_html() for x in simple_tables]\\n tab = '\\\\n'.join(tab)\\n\\n return tab\\n\\n def as_latex(self):\\n '''Generate LaTeX Summary Table\\n '''\\n tables = self.tables\\n settings = self.settings\\n title = self.title\\n\\n if title is not None:\\n title = '\\\\\\\\caption{' + title + '}'\\n else:\\n title = '\\\\\\\\caption{}'\\n\\n simple_tables = _simple_tables(tables, settings)\\n tab = [x.as_latex_tabular() for x in simple_tables]\\n tab = '\\\\n\\\\\\\\hline\\\\n'.join(tab)\\n\\n to_replace = ('\\\\\\\\\\\\\\\\hline\\\\\\\\n\\\\\\\\\\\\\\\\hline\\\\\\\\n\\\\\\\\\\\\\\\\'\\n 'end{tabular}\\\\\\\\n\\\\\\\\\\\\\\\\begin{tabular}{.*}\\\\\\\\n')\\n\\n if self._merge_latex:\\n # create single tabular object for summary_col\\n tab = re.sub(to_replace,r'\\\\\\\\midrule\\\\n', tab)\\n\\n out = '\\\\\\\\begin{table}', title, tab, '\\\\\\\\end{table}'\\n out = '\\\\n'.join(out)\\n return out\\n\\n\\ndef _measure_tables(tables, settings):\\n '''Compare width of ascii tables in a list and calculate padding values.\\n We add space to each col_sep to get us as close as possible to the\\n width of the largest table. Then, we add a few spaces to the first\\n column to pad the rest.\\n '''\\n\\n simple_tables = _simple_tables(tables, settings)\\n tab = [x.as_text() for x in simple_tables]\\n\\n length = [len(x.splitlines()[0]) for x in tab]\\n len_max = max(length)\\n pad_sep = []\\n pad_index = []\\n\\n for i in range(len(tab)):\\n nsep = max(tables[i].shape[1] - 1, 1)\\n pad = int((len_max - length[i]) / nsep)\\n pad_sep.append(pad)\\n len_new = length[i] + nsep * pad\\n pad_index.append(len_max - len_new)\\n\\n return pad_sep, pad_index, max(length)\\n\\n\\n# Useful stuff\\n_model_types = {'OLS': 'Ordinary least squares',\\n 'GLS': 'Generalized least squares',\\n 'GLSAR' : 'Generalized least squares with AR(p)',\\n 'WLS': 'Weighted least squares',\\n 'RLM': 'Robust linear model',\\n 'NBin': 'Negative binomial model',\\n 'GLM': 'Generalized linear model'\\n }\\n\\n\\ndef summary_model(results):\\n '''Create a dict with information about the model\\n '''\\n\\n def time_now(*args, **kwds):\\n now = datetime.datetime.now()\\n return now.strftime('%Y-%m-%d %H:%M')\\n\\n info = OrderedDict()\\n info['Model:'] = lambda x: x.model.__class__.__name__\\n info['Model Family:'] = lambda x: x.family.__class.__name__\\n info['Link Function:'] = lambda x: x.family.link.__class__.__name__\\n info['Dependent Variable:'] = lambda x: x.model.endog_names\\n info['Date:'] = time_now\\n info['No. Observations:'] = lambda x: \\\"%#6d\\\" % x.nobs\\n info['Df Model:'] = lambda x: \\\"%#6d\\\" % x.df_model\\n info['Df Residuals:'] = lambda x: \\\"%#6d\\\" % x.df_resid\\n info['Converged:'] = lambda x: x.mle_retvals['converged']\\n info['No. Iterations:'] = lambda x: x.mle_retvals['iterations']\\n info['Method:'] = lambda x: x.method\\n info['Norm:'] = lambda x: x.fit_options['norm']\\n info['Scale Est.:'] = lambda x: x.fit_options['scale_est']\\n info['Cov. Type:'] = lambda x: x.fit_options['cov']\\n\\n rsquared_type = '' if results.k_constant else ' (uncentered)'\\n info['R-squared' + rsquared_type + ':'] = lambda x: \\\"%#8.3f\\\" % x.rsquared\\n info['Adj. R-squared' + rsquared_type + ':'] = lambda x: \\\"%#8.3f\\\" % x.rsquared_adj\\n info['Pseudo R-squared:'] = lambda x: \\\"%#8.3f\\\" % x.prsquared\\n info['AIC:'] = lambda x: \\\"%8.4f\\\" % x.aic\\n info['BIC:'] = lambda x: \\\"%8.4f\\\" % x.bic\\n info['Log-Likelihood:'] = lambda x: \\\"%#8.5g\\\" % x.llf\\n info['LL-Null:'] = lambda x: \\\"%#8.5g\\\" % x.llnull\\n info['LLR p-value:'] = lambda x: \\\"%#8.5g\\\" % x.llr_pvalue\\n info['Deviance:'] = lambda x: \\\"%#8.5g\\\" % x.deviance\\n info['Pearson chi2:'] = lambda x: \\\"%#6.3g\\\" % x.pearson_chi2\\n info['F-statistic:'] = lambda x: \\\"%#8.4g\\\" % x.fvalue\\n info['Prob (F-statistic):'] = lambda x: \\\"%#6.3g\\\" % x.f_pvalue\\n info['Scale:'] = lambda x: \\\"%#8.5g\\\" % x.scale\\n out = OrderedDict()\\n for key, func in iteritems(info):\\n try:\\n out[key] = func(results)\\n except (AttributeError, KeyError, NotImplementedError):\\n # NOTE: some models don't have loglike defined (RLM),\\n # so raise NotImplementedError\\n pass\\n return out\\n\\n\\ndef summary_params(results, yname=None, xname=None, alpha=.05, use_t=True,\\n skip_header=False, float_format=\\\"%.4f\\\"):\\n '''create a summary table of parameters from results instance\\n\\n Parameters\\n ----------\\n res : results instance\\n some required information is directly taken from the result\\n instance\\n yname : string or None\\n optional name for the endogenous variable, default is \\\"y\\\"\\n xname : list of strings or None\\n optional names for the exogenous variables, default is \\\"var_xx\\\"\\n alpha : float\\n significance level for the confidence intervals\\n use_t : bool\\n indicator whether the p-values are based on the Student-t\\n distribution (if True) or on the normal distribution (if False)\\n skip_headers : bool\\n If false (default), then the header row is added. If true, then no\\n header row is added.\\n float_format : string\\n float formatting options (e.g. \\\".3g\\\")\\n\\n Returns\\n -------\\n params_table : SimpleTable instance\\n '''\\n\\n if isinstance(results, tuple):\\n results, params, bse, tvalues, pvalues, conf_int = results\\n else:\\n params = results.params\\n bse = results.bse\\n tvalues = results.tvalues\\n pvalues = results.pvalues\\n conf_int = results.conf_int(alpha)\\n\\n data = np.array([params, bse, tvalues, pvalues]).T\\n data = np.hstack([data, conf_int])\\n data = pd.DataFrame(data)\\n\\n if use_t:\\n data.columns = ['Coef.', 'Std.Err.', 't', 'P>|t|',\\n '[' + str(alpha/2), str(1-alpha/2) + ']']\\n else:\\n data.columns = ['Coef.', 'Std.Err.', 'z', 'P>|z|',\\n '[' + str(alpha/2), str(1-alpha/2) + ']']\\n\\n if not xname:\\n try:\\n data.index = results.model.data.param_names\\n except AttributeError:\\n data.index = results.model.exog_names\\n else:\\n data.index = xname\\n\\n return data\\n\\n\\n# Vertical summary instance for multiple models\\ndef _col_params(result, float_format='%.4f', stars=True):\\n '''Stack coefficients and standard errors in single column\\n '''\\n\\n # Extract parameters\\n res = summary_params(result)\\n # Format float\\n for col in res.columns[:2]:\\n res[col] = res[col].apply(lambda x: float_format % x)\\n # Std.Errors in parentheses\\n res.iloc[:, 1] = '(' + res.iloc[:, 1] + ')'\\n # Significance stars\\n if stars:\\n idx = res.iloc[:, 3] < .1\\n res.loc[idx, res.columns[0]] = res.loc[idx, res.columns[0]] + '*'\\n idx = res.iloc[:, 3] < .05\\n res.loc[idx, res.columns[0]] = res.loc[idx, res.columns[0]] + '*'\\n idx = res.iloc[:, 3] < .01\\n res.loc[idx, res.columns[0]] = res.loc[idx, res.columns[0]] + '*'\\n # Stack Coefs and Std.Errors\\n res = res.iloc[:, :2]\\n res = res.stack()\\n res = pd.DataFrame(res)\\n res.columns = [str(result.model.endog_names)]\\n return res\\n\\n\\ndef _col_info(result, info_dict=None):\\n '''Stack model info in a column\\n '''\\n\\n if info_dict is None:\\n info_dict = {}\\n out = []\\n index = []\\n for i in info_dict:\\n if isinstance(info_dict[i], dict):\\n # this is a specific model info_dict, but not for this result...\\n continue\\n try:\\n out.append(info_dict[i](result))\\n except:\\n out.append('')\\n index.append(i)\\n out = pd.DataFrame({str(result.model.endog_names): out}, index=index)\\n return out\\n\\n\\ndef _make_unique(list_of_names):\\n if len(set(list_of_names)) == len(list_of_names):\\n return list_of_names\\n # pandas does not like it if multiple columns have the same names\\n from collections import defaultdict\\n name_counter = defaultdict(str)\\n header = []\\n for _name in list_of_names:\\n name_counter[_name] += \\\"I\\\"\\n header.append(_name+\\\" \\\" + name_counter[_name])\\n return header\\n\\n\\ndef summary_col(results, float_format='%.4f', model_names=(), stars=False,\\n info_dict=None, regressor_order=(), drop_omitted=False):\\n \\\"\\\"\\\"\\n Summarize multiple results instances side-by-side (coefs and SEs)\\n\\n Parameters\\n ----------\\n results : statsmodels results instance or list of result instances\\n float_format : string, optional\\n float format for coefficients and standard errors\\n Default : '%.4f'\\n model_names : list of strings, optional\\n Must have same length as the number of results. If the names are not\\n unique, a roman number will be appended to all model names\\n stars : bool\\n print significance stars\\n info_dict : dict\\n dict of functions to be applied to results instances to retrieve\\n model info. To use specific information for different models, add a\\n (nested) info_dict with model name as the key.\\n Example: `info_dict = {\\\"N\\\":..., \\\"R2\\\": ..., \\\"OLS\\\":{\\\"R2\\\":...}}` would\\n only show `R2` for OLS regression models, but additionally `N` for\\n all other results.\\n Default : None (use the info_dict specified in\\n result.default_model_infos, if this property exists)\\n regressor_order : list of strings, optional\\n list of names of the regressors in the desired order. All regressors\\n not specified will be appended to the end of the list.\\n drop_omitted : bool, optional\\n Includes regressors that are not specified in regressor_order. If False,\\n regressors not specified will be appended to end of the list. If True,\\n only regressors in regressors_list will be included.\\n \\\"\\\"\\\"\\n\\n if not isinstance(results, list):\\n results = [results]\\n\\n cols = [_col_params(x, stars=stars, float_format=float_format) for x in\\n results]\\n\\n # Unique column names (pandas has problems merging otherwise)\\n if model_names:\\n colnames = _make_unique(model_names)\\n else:\\n colnames = _make_unique([x.columns[0] for x in cols])\\n for i in range(len(cols)):\\n cols[i].columns = [colnames[i]]\\n\\n merg = lambda x, y: x.merge(y, how='outer', right_index=True,\\n left_index=True)\\n summ = reduce(merg, cols)\\n\\n if regressor_order:\\n varnames = summ.index.get_level_values(0).tolist()\\n ordered = [x for x in regressor_order if x in varnames]\\n unordered = [x for x in varnames if x not in regressor_order + ['']]\\n order = ordered + list(np.unique(unordered))\\n\\n f = lambda idx: sum([[x + 'coef', x + 'stde'] for x in idx], [])\\n summ.index = f(pd.unique(varnames))\\n summ = summ.reindex(f(order))\\n summ.index = [x[:-4] for x in summ.index]\\n if drop_omitted:\\n summ = summ.loc[regressor_order]\\n\\n idx = pd.Series(lrange(summ.shape[0])) % 2 == 1\\n summ.index = np.where(idx, '', summ.index.get_level_values(0))\\n\\n # add infos about the models.\\n if info_dict:\\n cols = [_col_info(x, info_dict.get(x.model.__class__.__name__,\\n info_dict)) for x in results]\\n else:\\n cols = [_col_info(x, getattr(x, \\\"default_model_infos\\\", None)) for x in\\n results]\\n # use unique column names, otherwise the merge will not succeed\\n for df, name in zip(cols, _make_unique([df.columns[0] for df in cols])):\\n df.columns = [name]\\n merg = lambda x, y: x.merge(y, how='outer', right_index=True,\\n left_index=True)\\n info = reduce(merg, cols)\\n dat = pd.DataFrame(np.vstack([summ, info])) # pd.concat better, but error\\n dat.columns = summ.columns\\n dat.index = pd.Index(summ.index.tolist() + info.index.tolist())\\n summ = dat\\n\\n summ = summ.fillna('')\\n\\n smry = Summary()\\n smry._merge_latex = True\\n smry.add_df(summ, header=True, align='l')\\n smry.add_text('Standard errors in parentheses.')\\n if stars:\\n smry.add_text('* p<.1, ** p<.05, ***p<.01')\\n\\n return smry\\n\\n\\ndef _formatter(element, float_format='%.4f'):\\n try:\\n out = float_format % element\\n except:\\n out = str(element)\\n return out.strip()\\n\\n\\ndef _df_to_simpletable(df, align='r', float_format=\\\"%.4f\\\", header=True,\\n index=True, table_dec_above='-', table_dec_below=None,\\n header_dec_below='-', pad_col=0, pad_index=0):\\n dat = df.copy()\\n dat = dat.applymap(lambda x: _formatter(x, float_format))\\n if header:\\n headers = [str(x) for x in dat.columns.tolist()]\\n else:\\n headers = None\\n if index:\\n stubs = [str(x) + int(pad_index) * ' ' for x in dat.index.tolist()]\\n else:\\n dat.iloc[:, 0] = [str(x) + int(pad_index) * ' ' for x in dat.iloc[:, 0]]\\n stubs = None\\n st = SimpleTable(np.array(dat), headers=headers, stubs=stubs,\\n ltx_fmt=fmt_latex, txt_fmt=fmt_txt)\\n st.output_formats['latex']['data_aligns'] = align\\n st.output_formats['txt']['data_aligns'] = align\\n st.output_formats['txt']['table_dec_above'] = table_dec_above\\n st.output_formats['txt']['table_dec_below'] = table_dec_below\\n st.output_formats['txt']['header_dec_below'] = header_dec_below\\n st.output_formats['txt']['colsep'] = ' ' * int(pad_col + 1)\\n return st\\n\\n\\ndef _simple_tables(tables, settings, pad_col=None, pad_index=None):\\n simple_tables = []\\n float_format = '%.4f'\\n if pad_col is None:\\n pad_col = [0] * len(tables)\\n if pad_index is None:\\n pad_index = [0] * len(tables)\\n for i, v in enumerate(tables):\\n index = settings[i]['index']\\n header = settings[i]['header']\\n align = settings[i]['align']\\n simple_tables.append(_df_to_simpletable(v, align=align,\\n float_format=float_format,\\n header=header, index=index,\\n pad_col=pad_col[i],\\n pad_index=pad_index[i]))\\n return simple_tables\\n\",\n \"path\": \"statsmodels/iolib/summary2.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/statsmodels/base/tests/test_penalized.py b/statsmodels/base/tests/test_penalized.py\nindex ee3f724270e..f519bc69abf 100644\n--- a/statsmodels/base/tests/test_penalized.py\n+++ b/statsmodels/base/tests/test_penalized.py\n@@ -94,7 +94,10 @@ def test_summary(self):\n \n @pytest.mark.smoke\n def test_summary2(self):\n- self.res1.summary2()\n+ summ = self.res1.summary2()\n+ assert isinstance(summ.as_latex(), str)\n+ assert isinstance(summ.as_html(), str)\n+ assert isinstance(summ.as_text(), str)\n \n def test_numdiff(self):\n res1 = self.res1\ndiff --git a/statsmodels/iolib/summary2.py b/statsmodels/iolib/summary2.py\nindex 21f1f7822f9..4ee2bae52ab 100644\n--- a/statsmodels/iolib/summary2.py\n+++ b/statsmodels/iolib/summary2.py\n@@ -221,7 +221,7 @@ def as_latex(self):\n \n if self._merge_latex:\n # create single tabular object for summary_col\n- tab = re.sub(to_replace,r'\\\\midrule\\n\\\\midrule\\n', tab)\n+ tab = re.sub(to_replace,r'\\\\midrule\\n', tab)\n \n out = '\\\\begin{table}', title, tab, '\\\\end{table}'\n out = '\\n'.join(out)\ndiff --git a/statsmodels/iolib/tests/test_summary2.py b/statsmodels/iolib/tests/test_summary2.py\nindex 94c9300ef2b..5b4f8168b7e 100644\n--- a/statsmodels/iolib/tests/test_summary2.py\n+++ b/statsmodels/iolib/tests/test_summary2.py\n@@ -21,7 +21,6 @@ def test_summarycol(self):\n \\hline\n & y I & y II \\\\\n \\midrule\n-\\midrule\n const & 7.7500 & 12.4231 \\\\\n & (1.1058) & (3.1872) \\\\\n x1 & -0.7500 & -1.5769 \\\\\n"}}},{"rowIdx":4669,"cells":{"in_source_id":{"kind":"string","value":"nilearn__nilearn-2248"},"issue":{"kind":"string","value":"NiftiLabelsMasker.inverse_transform() appears to fail in current nilearn version\n---------------------------------------------------------------------------\r\nAttributeError Traceback (most recent call last)\r\n<ipython-input-79-642858f1debf> in <module>\r\n----> 1 masker.inverse_transform(labels_and_my.values)\r\n\r\n~/anaconda3/lib/python3.7/site-packages/nilearn/input_data/nifti_labels_masker.py in inverse_transform(self, signals)\r\n 296 logger.log(\"computing image from signals\", verbose=self.verbose)\r\n 297 return signal_extraction.signals_to_img_labels(\r\n--> 298 signals, self._resampled_labels_img_, self.mask_img_,\r\n 299 background_label=self.background_label)\r\n\r\nAttributeError: 'NiftiLabelsMasker' object has no attribute '_resampled_labels_img_'\n"},"before_files":{"kind":"list like","value":[{"content":"\"\"\"\nTransformer for computing ROI signals.\n\"\"\"\n\nimport numpy as np\n\nfrom nilearn._utils.compat import Memory\n\nfrom .. import _utils\nfrom .._utils import logger, CacheMixin, _compose_err_msg\nfrom .._utils.class_inspect import get_params\nfrom .._utils.niimg_conversions import _check_same_fov\nfrom .. import masking\nfrom .. import image\nfrom .base_masker import filter_and_extract, BaseMasker\n\n\nclass _ExtractionFunctor(object):\n\n func_name = 'nifti_labels_masker_extractor'\n\n def __init__(self, _resampled_labels_img_, background_label, strategy):\n self._resampled_labels_img_ = _resampled_labels_img_\n self.background_label = background_label\n self.strategy = strategy\n\n def __call__(self, imgs):\n from ..regions import signal_extraction\n\n return signal_extraction.img_to_signals_labels(\n imgs, self._resampled_labels_img_,\n background_label=self.background_label, strategy=self.strategy)\n\n\nclass NiftiLabelsMasker(BaseMasker, CacheMixin):\n \"\"\"Class for masking of Niimg-like objects.\n\n NiftiLabelsMasker is useful when data from non-overlapping volumes should\n be extracted (contrarily to NiftiMapsMasker). Use case: Summarize brain\n signals from clusters that were obtained by prior K-means or Ward\n clustering.\n\n Parameters\n ----------\n labels_img: Niimg-like object\n See http://nilearn.github.io/manipulating_images/input_output.html\n Region definitions, as one image of labels.\n\n background_label: number, optional\n Label used in labels_img to represent background.\n\n mask_img: Niimg-like object, optional\n See http://nilearn.github.io/manipulating_images/input_output.html\n Mask to apply to regions before extracting signals.\n\n smoothing_fwhm: float, optional\n If smoothing_fwhm is not None, it gives the full-width half maximum in\n millimeters of the spatial smoothing to apply to the signal.\n\n standardize: {'zscore', 'psc', True, False}, default is 'zscore'\n Strategy to standardize the signal.\n 'zscore': the signal is z-scored. Timeseries are shifted\n to zero mean and scaled to unit variance.\n 'psc': Timeseries are shifted to zero mean value and scaled\n to percent signal change (as compared to original mean signal).\n True : the signal is z-scored. Timeseries are shifted\n to zero mean and scaled to unit variance.\n False : Do not standardize the data.\n\n detrend: boolean, optional\n This parameter is passed to signal.clean. Please see the related\n documentation for details\n\n low_pass: None or float, optional\n This parameter is passed to signal.clean. Please see the related\n documentation for details\n\n high_pass: None or float, optional\n This parameter is passed to signal.clean. Please see the related\n documentation for details\n\n t_r: float, optional\n This parameter is passed to signal.clean. Please see the related\n documentation for details\n\n dtype: {dtype, \"auto\"}\n Data type toward which the data should be converted. If \"auto\", the\n data will be converted to int32 if dtype is discrete and float32 if it\n is continuous.\n\n resampling_target: {\"data\", \"labels\", None}, optional.\n Gives which image gives the final shape/size. For example, if\n `resampling_target` is \"data\", the atlas is resampled to the\n shape of the data if needed. If it is \"labels\" then mask_img\n and images provided to fit() are resampled to the shape and\n affine of maps_img. \"None\" means no resampling: if shapes and\n affines do not match, a ValueError is raised. Defaults to \"data\".\n\n memory: joblib.Memory or str, optional\n Used to cache the region extraction process.\n By default, no caching is done. If a string is given, it is the\n path to the caching directory.\n\n memory_level: int, optional\n Aggressiveness of memory caching. The higher the number, the higher\n the number of functions that will be cached. Zero means no caching.\n\n verbose: integer, optional\n Indicate the level of verbosity. By default, nothing is printed\n\n strategy: str\n The name of a valid function to reduce the region with.\n Must be one of: sum, mean, median, mininum, maximum, variance,\n standard_deviation\n\n See also\n --------\n nilearn.input_data.NiftiMasker\n \"\"\"\n # memory and memory_level are used by CacheMixin.\n\n def __init__(self, labels_img, background_label=0, mask_img=None,\n smoothing_fwhm=None, standardize=False, detrend=False,\n low_pass=None, high_pass=None, t_r=None, dtype=None,\n resampling_target=\"data\",\n memory=Memory(cachedir=None, verbose=0), memory_level=1,\n verbose=0, strategy=\"mean\"):\n self.labels_img = labels_img\n self.background_label = background_label\n self.mask_img = mask_img\n\n # Parameters for _smooth_array\n self.smoothing_fwhm = smoothing_fwhm\n\n # Parameters for clean()\n self.standardize = standardize\n self.detrend = detrend\n self.low_pass = low_pass\n self.high_pass = high_pass\n self.t_r = t_r\n self.dtype = dtype\n\n # Parameters for resampling\n self.resampling_target = resampling_target\n\n # Parameters for joblib\n self.memory = memory\n self.memory_level = memory_level\n self.verbose = verbose\n\n available_reduction_strategies = {'mean', 'median', 'sum',\n 'minimum', 'maximum',\n 'standard_deviation', 'variance'}\n\n if strategy not in available_reduction_strategies:\n raise ValueError(str.format(\n \"Invalid strategy '{}'. Valid strategies are {}.\",\n strategy,\n available_reduction_strategies\n ))\n\n self.strategy = strategy\n\n if resampling_target not in (\"labels\", \"data\", None):\n raise ValueError(\"invalid value for 'resampling_target' \"\n \"parameter: \" + str(resampling_target))\n\n def fit(self, X=None, y=None):\n \"\"\"Prepare signal extraction from regions.\n\n All parameters are unused, they are for scikit-learn compatibility.\n \"\"\"\n logger.log(\"loading data from %s\" %\n _utils._repr_niimgs(self.labels_img)[:200],\n verbose=self.verbose)\n self.labels_img_ = _utils.check_niimg_3d(self.labels_img)\n if self.mask_img is not None:\n logger.log(\"loading data from %s\" %\n _utils._repr_niimgs(self.mask_img)[:200],\n verbose=self.verbose)\n self.mask_img_ = _utils.check_niimg_3d(self.mask_img)\n else:\n self.mask_img_ = None\n\n # Check shapes and affines or resample.\n if self.mask_img_ is not None:\n if self.resampling_target == \"data\":\n # resampling will be done at transform time\n pass\n elif self.resampling_target is None:\n if self.mask_img_.shape != self.labels_img_.shape[:3]:\n raise ValueError(\n _compose_err_msg(\n \"Regions and mask do not have the same shape\",\n mask_img=self.mask_img,\n labels_img=self.labels_img))\n if not np.allclose(self.mask_img_.affine,\n self.labels_img_.affine):\n raise ValueError(_compose_err_msg(\n \"Regions and mask do not have the same affine.\",\n mask_img=self.mask_img, labels_img=self.labels_img))\n\n elif self.resampling_target == \"labels\":\n logger.log(\"resampling the mask\", verbose=self.verbose)\n self.mask_img_ = image.resample_img(\n self.mask_img_,\n target_affine=self.labels_img_.affine,\n target_shape=self.labels_img_.shape[:3],\n interpolation=\"nearest\",\n copy=True)\n else:\n raise ValueError(\"Invalid value for resampling_target: \" +\n str(self.resampling_target))\n\n mask_data, mask_affine = masking._load_mask_img(self.mask_img_)\n\n return self\n\n def fit_transform(self, imgs, confounds=None):\n \"\"\" Prepare and perform signal extraction from regions.\n \"\"\"\n return self.fit().transform(imgs, confounds=confounds)\n\n def _check_fitted(self):\n if not hasattr(self, \"labels_img_\"):\n raise ValueError('It seems that %s has not been fitted. '\n 'You must call fit() before calling transform().'\n % self.__class__.__name__)\n\n def transform_single_imgs(self, imgs, confounds=None):\n \"\"\"Extract signals from a single 4D niimg.\n\n Parameters\n ----------\n imgs: 3D/4D Niimg-like object\n See http://nilearn.github.io/manipulating_images/input_output.html\n Images to process. It must boil down to a 4D image with scans\n number as last dimension.\n\n confounds: CSV file or array-like, optional\n This parameter is passed to signal.clean. Please see the related\n documentation for details.\n shape: (number of scans, number of confounds)\n\n Returns\n -------\n region_signals: 2D numpy.ndarray\n Signal for each label.\n shape: (number of scans, number of labels)\n \"\"\"\n # We handle the resampling of labels separately because the affine of\n # the labels image should not impact the extraction of the signal.\n\n if not hasattr(self, '_resampled_labels_img_'):\n self._resampled_labels_img_ = self.labels_img_\n if self.resampling_target == \"data\":\n imgs_ = _utils.check_niimg_4d(imgs)\n if not _check_same_fov(imgs_, self._resampled_labels_img_):\n if self.verbose > 0:\n print(\"Resampling labels\")\n self._resampled_labels_img_ = self._cache(\n image.resample_img, func_memory_level=2)(\n self.labels_img_, interpolation=\"nearest\",\n target_shape=imgs_.shape[:3],\n target_affine=imgs_.affine)\n # Remove imgs_ from memory before loading the same image\n # in filter_and_extract.\n del imgs_\n\n target_shape = None\n target_affine = None\n if self.resampling_target == 'labels':\n target_shape = self._resampled_labels_img_.shape[:3]\n target_affine = self._resampled_labels_img_.affine\n\n params = get_params(NiftiLabelsMasker, self,\n ignore=['resampling_target'])\n params['target_shape'] = target_shape\n params['target_affine'] = target_affine\n\n region_signals, labels_ = self._cache(\n filter_and_extract,\n ignore=['verbose', 'memory', 'memory_level'])(\n # Images\n imgs, _ExtractionFunctor(self._resampled_labels_img_,\n self.background_label, self.strategy),\n # Pre-processing\n params,\n confounds=confounds,\n dtype=self.dtype,\n # Caching\n memory=self.memory,\n memory_level=self.memory_level,\n verbose=self.verbose)\n\n self.labels_ = labels_\n\n return region_signals\n\n def inverse_transform(self, signals):\n \"\"\"Compute voxel signals from region signals\n\n Any mask given at initialization is taken into account.\n\n Parameters\n ----------\n signals (2D numpy.ndarray)\n Signal for each region.\n shape: (number of scans, number of regions)\n\n Returns\n -------\n voxel_signals (Nifti1Image)\n Signal for each voxel\n shape: (number of scans, number of voxels)\n \"\"\"\n from ..regions import signal_extraction\n\n self._check_fitted()\n\n logger.log(\"computing image from signals\", verbose=self.verbose)\n return signal_extraction.signals_to_img_labels(\n signals, self._resampled_labels_img_, self.mask_img_,\n background_label=self.background_label)\n","path":"nilearn/input_data/nifti_labels_masker.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"\\nTransformer for computing ROI signals.\\n\\\"\\\"\\\"\\n\\nimport numpy as np\\n\\nfrom nilearn._utils.compat import Memory\\n\\nfrom .. import _utils\\nfrom .._utils import logger, CacheMixin, _compose_err_msg\\nfrom .._utils.class_inspect import get_params\\nfrom .._utils.niimg_conversions import _check_same_fov\\nfrom .. import masking\\nfrom .. import image\\nfrom .base_masker import filter_and_extract, BaseMasker\\n\\n\\nclass _ExtractionFunctor(object):\\n\\n func_name = 'nifti_labels_masker_extractor'\\n\\n def __init__(self, _resampled_labels_img_, background_label, strategy):\\n self._resampled_labels_img_ = _resampled_labels_img_\\n self.background_label = background_label\\n self.strategy = strategy\\n\\n def __call__(self, imgs):\\n from ..regions import signal_extraction\\n\\n return signal_extraction.img_to_signals_labels(\\n imgs, self._resampled_labels_img_,\\n background_label=self.background_label, strategy=self.strategy)\\n\\n\\nclass NiftiLabelsMasker(BaseMasker, CacheMixin):\\n \\\"\\\"\\\"Class for masking of Niimg-like objects.\\n\\n NiftiLabelsMasker is useful when data from non-overlapping volumes should\\n be extracted (contrarily to NiftiMapsMasker). Use case: Summarize brain\\n signals from clusters that were obtained by prior K-means or Ward\\n clustering.\\n\\n Parameters\\n ----------\\n labels_img: Niimg-like object\\n See http://nilearn.github.io/manipulating_images/input_output.html\\n Region definitions, as one image of labels.\\n\\n background_label: number, optional\\n Label used in labels_img to represent background.\\n\\n mask_img: Niimg-like object, optional\\n See http://nilearn.github.io/manipulating_images/input_output.html\\n Mask to apply to regions before extracting signals.\\n\\n smoothing_fwhm: float, optional\\n If smoothing_fwhm is not None, it gives the full-width half maximum in\\n millimeters of the spatial smoothing to apply to the signal.\\n\\n standardize: {'zscore', 'psc', True, False}, default is 'zscore'\\n Strategy to standardize the signal.\\n 'zscore': the signal is z-scored. Timeseries are shifted\\n to zero mean and scaled to unit variance.\\n 'psc': Timeseries are shifted to zero mean value and scaled\\n to percent signal change (as compared to original mean signal).\\n True : the signal is z-scored. Timeseries are shifted\\n to zero mean and scaled to unit variance.\\n False : Do not standardize the data.\\n\\n detrend: boolean, optional\\n This parameter is passed to signal.clean. Please see the related\\n documentation for details\\n\\n low_pass: None or float, optional\\n This parameter is passed to signal.clean. Please see the related\\n documentation for details\\n\\n high_pass: None or float, optional\\n This parameter is passed to signal.clean. Please see the related\\n documentation for details\\n\\n t_r: float, optional\\n This parameter is passed to signal.clean. Please see the related\\n documentation for details\\n\\n dtype: {dtype, \\\"auto\\\"}\\n Data type toward which the data should be converted. If \\\"auto\\\", the\\n data will be converted to int32 if dtype is discrete and float32 if it\\n is continuous.\\n\\n resampling_target: {\\\"data\\\", \\\"labels\\\", None}, optional.\\n Gives which image gives the final shape/size. For example, if\\n `resampling_target` is \\\"data\\\", the atlas is resampled to the\\n shape of the data if needed. If it is \\\"labels\\\" then mask_img\\n and images provided to fit() are resampled to the shape and\\n affine of maps_img. \\\"None\\\" means no resampling: if shapes and\\n affines do not match, a ValueError is raised. Defaults to \\\"data\\\".\\n\\n memory: joblib.Memory or str, optional\\n Used to cache the region extraction process.\\n By default, no caching is done. If a string is given, it is the\\n path to the caching directory.\\n\\n memory_level: int, optional\\n Aggressiveness of memory caching. The higher the number, the higher\\n the number of functions that will be cached. Zero means no caching.\\n\\n verbose: integer, optional\\n Indicate the level of verbosity. By default, nothing is printed\\n\\n strategy: str\\n The name of a valid function to reduce the region with.\\n Must be one of: sum, mean, median, mininum, maximum, variance,\\n standard_deviation\\n\\n See also\\n --------\\n nilearn.input_data.NiftiMasker\\n \\\"\\\"\\\"\\n # memory and memory_level are used by CacheMixin.\\n\\n def __init__(self, labels_img, background_label=0, mask_img=None,\\n smoothing_fwhm=None, standardize=False, detrend=False,\\n low_pass=None, high_pass=None, t_r=None, dtype=None,\\n resampling_target=\\\"data\\\",\\n memory=Memory(cachedir=None, verbose=0), memory_level=1,\\n verbose=0, strategy=\\\"mean\\\"):\\n self.labels_img = labels_img\\n self.background_label = background_label\\n self.mask_img = mask_img\\n\\n # Parameters for _smooth_array\\n self.smoothing_fwhm = smoothing_fwhm\\n\\n # Parameters for clean()\\n self.standardize = standardize\\n self.detrend = detrend\\n self.low_pass = low_pass\\n self.high_pass = high_pass\\n self.t_r = t_r\\n self.dtype = dtype\\n\\n # Parameters for resampling\\n self.resampling_target = resampling_target\\n\\n # Parameters for joblib\\n self.memory = memory\\n self.memory_level = memory_level\\n self.verbose = verbose\\n\\n available_reduction_strategies = {'mean', 'median', 'sum',\\n 'minimum', 'maximum',\\n 'standard_deviation', 'variance'}\\n\\n if strategy not in available_reduction_strategies:\\n raise ValueError(str.format(\\n \\\"Invalid strategy '{}'. Valid strategies are {}.\\\",\\n strategy,\\n available_reduction_strategies\\n ))\\n\\n self.strategy = strategy\\n\\n if resampling_target not in (\\\"labels\\\", \\\"data\\\", None):\\n raise ValueError(\\\"invalid value for 'resampling_target' \\\"\\n \\\"parameter: \\\" + str(resampling_target))\\n\\n def fit(self, X=None, y=None):\\n \\\"\\\"\\\"Prepare signal extraction from regions.\\n\\n All parameters are unused, they are for scikit-learn compatibility.\\n \\\"\\\"\\\"\\n logger.log(\\\"loading data from %s\\\" %\\n _utils._repr_niimgs(self.labels_img)[:200],\\n verbose=self.verbose)\\n self.labels_img_ = _utils.check_niimg_3d(self.labels_img)\\n if self.mask_img is not None:\\n logger.log(\\\"loading data from %s\\\" %\\n _utils._repr_niimgs(self.mask_img)[:200],\\n verbose=self.verbose)\\n self.mask_img_ = _utils.check_niimg_3d(self.mask_img)\\n else:\\n self.mask_img_ = None\\n\\n # Check shapes and affines or resample.\\n if self.mask_img_ is not None:\\n if self.resampling_target == \\\"data\\\":\\n # resampling will be done at transform time\\n pass\\n elif self.resampling_target is None:\\n if self.mask_img_.shape != self.labels_img_.shape[:3]:\\n raise ValueError(\\n _compose_err_msg(\\n \\\"Regions and mask do not have the same shape\\\",\\n mask_img=self.mask_img,\\n labels_img=self.labels_img))\\n if not np.allclose(self.mask_img_.affine,\\n self.labels_img_.affine):\\n raise ValueError(_compose_err_msg(\\n \\\"Regions and mask do not have the same affine.\\\",\\n mask_img=self.mask_img, labels_img=self.labels_img))\\n\\n elif self.resampling_target == \\\"labels\\\":\\n logger.log(\\\"resampling the mask\\\", verbose=self.verbose)\\n self.mask_img_ = image.resample_img(\\n self.mask_img_,\\n target_affine=self.labels_img_.affine,\\n target_shape=self.labels_img_.shape[:3],\\n interpolation=\\\"nearest\\\",\\n copy=True)\\n else:\\n raise ValueError(\\\"Invalid value for resampling_target: \\\" +\\n str(self.resampling_target))\\n\\n mask_data, mask_affine = masking._load_mask_img(self.mask_img_)\\n\\n return self\\n\\n def fit_transform(self, imgs, confounds=None):\\n \\\"\\\"\\\" Prepare and perform signal extraction from regions.\\n \\\"\\\"\\\"\\n return self.fit().transform(imgs, confounds=confounds)\\n\\n def _check_fitted(self):\\n if not hasattr(self, \\\"labels_img_\\\"):\\n raise ValueError('It seems that %s has not been fitted. '\\n 'You must call fit() before calling transform().'\\n % self.__class__.__name__)\\n\\n def transform_single_imgs(self, imgs, confounds=None):\\n \\\"\\\"\\\"Extract signals from a single 4D niimg.\\n\\n Parameters\\n ----------\\n imgs: 3D/4D Niimg-like object\\n See http://nilearn.github.io/manipulating_images/input_output.html\\n Images to process. It must boil down to a 4D image with scans\\n number as last dimension.\\n\\n confounds: CSV file or array-like, optional\\n This parameter is passed to signal.clean. Please see the related\\n documentation for details.\\n shape: (number of scans, number of confounds)\\n\\n Returns\\n -------\\n region_signals: 2D numpy.ndarray\\n Signal for each label.\\n shape: (number of scans, number of labels)\\n \\\"\\\"\\\"\\n # We handle the resampling of labels separately because the affine of\\n # the labels image should not impact the extraction of the signal.\\n\\n if not hasattr(self, '_resampled_labels_img_'):\\n self._resampled_labels_img_ = self.labels_img_\\n if self.resampling_target == \\\"data\\\":\\n imgs_ = _utils.check_niimg_4d(imgs)\\n if not _check_same_fov(imgs_, self._resampled_labels_img_):\\n if self.verbose > 0:\\n print(\\\"Resampling labels\\\")\\n self._resampled_labels_img_ = self._cache(\\n image.resample_img, func_memory_level=2)(\\n self.labels_img_, interpolation=\\\"nearest\\\",\\n target_shape=imgs_.shape[:3],\\n target_affine=imgs_.affine)\\n # Remove imgs_ from memory before loading the same image\\n # in filter_and_extract.\\n del imgs_\\n\\n target_shape = None\\n target_affine = None\\n if self.resampling_target == 'labels':\\n target_shape = self._resampled_labels_img_.shape[:3]\\n target_affine = self._resampled_labels_img_.affine\\n\\n params = get_params(NiftiLabelsMasker, self,\\n ignore=['resampling_target'])\\n params['target_shape'] = target_shape\\n params['target_affine'] = target_affine\\n\\n region_signals, labels_ = self._cache(\\n filter_and_extract,\\n ignore=['verbose', 'memory', 'memory_level'])(\\n # Images\\n imgs, _ExtractionFunctor(self._resampled_labels_img_,\\n self.background_label, self.strategy),\\n # Pre-processing\\n params,\\n confounds=confounds,\\n dtype=self.dtype,\\n # Caching\\n memory=self.memory,\\n memory_level=self.memory_level,\\n verbose=self.verbose)\\n\\n self.labels_ = labels_\\n\\n return region_signals\\n\\n def inverse_transform(self, signals):\\n \\\"\\\"\\\"Compute voxel signals from region signals\\n\\n Any mask given at initialization is taken into account.\\n\\n Parameters\\n ----------\\n signals (2D numpy.ndarray)\\n Signal for each region.\\n shape: (number of scans, number of regions)\\n\\n Returns\\n -------\\n voxel_signals (Nifti1Image)\\n Signal for each voxel\\n shape: (number of scans, number of voxels)\\n \\\"\\\"\\\"\\n from ..regions import signal_extraction\\n\\n self._check_fitted()\\n\\n logger.log(\\\"computing image from signals\\\", verbose=self.verbose)\\n return signal_extraction.signals_to_img_labels(\\n signals, self._resampled_labels_img_, self.mask_img_,\\n background_label=self.background_label)\\n\",\n \"path\": \"nilearn/input_data/nifti_labels_masker.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"\"\"\"\nTransformer for computing ROI signals.\n\"\"\"\n\nimport numpy as np\n\nfrom nilearn._utils.compat import Memory\n\nfrom .. import _utils\nfrom .._utils import logger, CacheMixin, _compose_err_msg\nfrom .._utils.class_inspect import get_params\nfrom .._utils.niimg_conversions import _check_same_fov\nfrom .. import masking\nfrom .. import image\nfrom .base_masker import filter_and_extract, BaseMasker\n\n\nclass _ExtractionFunctor(object):\n\n func_name = 'nifti_labels_masker_extractor'\n\n def __init__(self, _resampled_labels_img_, background_label, strategy):\n self._resampled_labels_img_ = _resampled_labels_img_\n self.background_label = background_label\n self.strategy = strategy\n\n def __call__(self, imgs):\n from ..regions import signal_extraction\n\n return signal_extraction.img_to_signals_labels(\n imgs, self._resampled_labels_img_,\n background_label=self.background_label, strategy=self.strategy)\n\n\nclass NiftiLabelsMasker(BaseMasker, CacheMixin):\n \"\"\"Class for masking of Niimg-like objects.\n\n NiftiLabelsMasker is useful when data from non-overlapping volumes should\n be extracted (contrarily to NiftiMapsMasker). Use case: Summarize brain\n signals from clusters that were obtained by prior K-means or Ward\n clustering.\n\n Parameters\n ----------\n labels_img: Niimg-like object\n See http://nilearn.github.io/manipulating_images/input_output.html\n Region definitions, as one image of labels.\n\n background_label: number, optional\n Label used in labels_img to represent background.\n\n mask_img: Niimg-like object, optional\n See http://nilearn.github.io/manipulating_images/input_output.html\n Mask to apply to regions before extracting signals.\n\n smoothing_fwhm: float, optional\n If smoothing_fwhm is not None, it gives the full-width half maximum in\n millimeters of the spatial smoothing to apply to the signal.\n\n standardize: {'zscore', 'psc', True, False}, default is 'zscore'\n Strategy to standardize the signal.\n 'zscore': the signal is z-scored. Timeseries are shifted\n to zero mean and scaled to unit variance.\n 'psc': Timeseries are shifted to zero mean value and scaled\n to percent signal change (as compared to original mean signal).\n True : the signal is z-scored. Timeseries are shifted\n to zero mean and scaled to unit variance.\n False : Do not standardize the data.\n\n detrend: boolean, optional\n This parameter is passed to signal.clean. Please see the related\n documentation for details\n\n low_pass: None or float, optional\n This parameter is passed to signal.clean. Please see the related\n documentation for details\n\n high_pass: None or float, optional\n This parameter is passed to signal.clean. Please see the related\n documentation for details\n\n t_r: float, optional\n This parameter is passed to signal.clean. Please see the related\n documentation for details\n\n dtype: {dtype, \"auto\"}\n Data type toward which the data should be converted. If \"auto\", the\n data will be converted to int32 if dtype is discrete and float32 if it\n is continuous.\n\n resampling_target: {\"data\", \"labels\", None}, optional.\n Gives which image gives the final shape/size. For example, if\n `resampling_target` is \"data\", the atlas is resampled to the\n shape of the data if needed. If it is \"labels\" then mask_img\n and images provided to fit() are resampled to the shape and\n affine of maps_img. \"None\" means no resampling: if shapes and\n affines do not match, a ValueError is raised. Defaults to \"data\".\n\n memory: joblib.Memory or str, optional\n Used to cache the region extraction process.\n By default, no caching is done. If a string is given, it is the\n path to the caching directory.\n\n memory_level: int, optional\n Aggressiveness of memory caching. The higher the number, the higher\n the number of functions that will be cached. Zero means no caching.\n\n verbose: integer, optional\n Indicate the level of verbosity. By default, nothing is printed\n\n strategy: str\n The name of a valid function to reduce the region with.\n Must be one of: sum, mean, median, mininum, maximum, variance,\n standard_deviation\n\n See also\n --------\n nilearn.input_data.NiftiMasker\n \"\"\"\n # memory and memory_level are used by CacheMixin.\n\n def __init__(self, labels_img, background_label=0, mask_img=None,\n smoothing_fwhm=None, standardize=False, detrend=False,\n low_pass=None, high_pass=None, t_r=None, dtype=None,\n resampling_target=\"data\",\n memory=Memory(cachedir=None, verbose=0), memory_level=1,\n verbose=0, strategy=\"mean\"):\n self.labels_img = labels_img\n self.background_label = background_label\n self.mask_img = mask_img\n\n # Parameters for _smooth_array\n self.smoothing_fwhm = smoothing_fwhm\n\n # Parameters for clean()\n self.standardize = standardize\n self.detrend = detrend\n self.low_pass = low_pass\n self.high_pass = high_pass\n self.t_r = t_r\n self.dtype = dtype\n\n # Parameters for resampling\n self.resampling_target = resampling_target\n\n # Parameters for joblib\n self.memory = memory\n self.memory_level = memory_level\n self.verbose = verbose\n\n available_reduction_strategies = {'mean', 'median', 'sum',\n 'minimum', 'maximum',\n 'standard_deviation', 'variance'}\n\n if strategy not in available_reduction_strategies:\n raise ValueError(str.format(\n \"Invalid strategy '{}'. Valid strategies are {}.\",\n strategy,\n available_reduction_strategies\n ))\n\n self.strategy = strategy\n\n if resampling_target not in (\"labels\", \"data\", None):\n raise ValueError(\"invalid value for 'resampling_target' \"\n \"parameter: \" + str(resampling_target))\n\n def fit(self, X=None, y=None):\n \"\"\"Prepare signal extraction from regions.\n\n All parameters are unused, they are for scikit-learn compatibility.\n \"\"\"\n logger.log(\"loading data from %s\" %\n _utils._repr_niimgs(self.labels_img)[:200],\n verbose=self.verbose)\n self.labels_img_ = _utils.check_niimg_3d(self.labels_img)\n if self.mask_img is not None:\n logger.log(\"loading data from %s\" %\n _utils._repr_niimgs(self.mask_img)[:200],\n verbose=self.verbose)\n self.mask_img_ = _utils.check_niimg_3d(self.mask_img)\n else:\n self.mask_img_ = None\n\n # Check shapes and affines or resample.\n if self.mask_img_ is not None:\n if self.resampling_target == \"data\":\n # resampling will be done at transform time\n pass\n elif self.resampling_target is None:\n if self.mask_img_.shape != self.labels_img_.shape[:3]:\n raise ValueError(\n _compose_err_msg(\n \"Regions and mask do not have the same shape\",\n mask_img=self.mask_img,\n labels_img=self.labels_img))\n if not np.allclose(self.mask_img_.affine,\n self.labels_img_.affine):\n raise ValueError(_compose_err_msg(\n \"Regions and mask do not have the same affine.\",\n mask_img=self.mask_img, labels_img=self.labels_img))\n\n elif self.resampling_target == \"labels\":\n logger.log(\"resampling the mask\", verbose=self.verbose)\n self.mask_img_ = image.resample_img(\n self.mask_img_,\n target_affine=self.labels_img_.affine,\n target_shape=self.labels_img_.shape[:3],\n interpolation=\"nearest\",\n copy=True)\n else:\n raise ValueError(\"Invalid value for resampling_target: \" +\n str(self.resampling_target))\n\n mask_data, mask_affine = masking._load_mask_img(self.mask_img_)\n\n if not hasattr(self, '_resampled_labels_img_'):\n # obviates need to run .transform() before .inverse_transform()\n self._resampled_labels_img_ = self.labels_img_\n\n return self\n\n def fit_transform(self, imgs, confounds=None):\n \"\"\" Prepare and perform signal extraction from regions.\n \"\"\"\n return self.fit().transform(imgs, confounds=confounds)\n\n def _check_fitted(self):\n if not hasattr(self, \"labels_img_\"):\n raise ValueError('It seems that %s has not been fitted. '\n 'You must call fit() before calling transform().'\n % self.__class__.__name__)\n\n def transform_single_imgs(self, imgs, confounds=None):\n \"\"\"Extract signals from a single 4D niimg.\n\n Parameters\n ----------\n imgs: 3D/4D Niimg-like object\n See http://nilearn.github.io/manipulating_images/input_output.html\n Images to process. It must boil down to a 4D image with scans\n number as last dimension.\n\n confounds: CSV file or array-like, optional\n This parameter is passed to signal.clean. Please see the related\n documentation for details.\n shape: (number of scans, number of confounds)\n\n Returns\n -------\n region_signals: 2D numpy.ndarray\n Signal for each label.\n shape: (number of scans, number of labels)\n \"\"\"\n # We handle the resampling of labels separately because the affine of\n # the labels image should not impact the extraction of the signal.\n\n if not hasattr(self, '_resampled_labels_img_'):\n self._resampled_labels_img_ = self.labels_img_\n if self.resampling_target == \"data\":\n imgs_ = _utils.check_niimg_4d(imgs)\n if not _check_same_fov(imgs_, self._resampled_labels_img_):\n if self.verbose > 0:\n print(\"Resampling labels\")\n self._resampled_labels_img_ = self._cache(\n image.resample_img, func_memory_level=2)(\n self.labels_img_, interpolation=\"nearest\",\n target_shape=imgs_.shape[:3],\n target_affine=imgs_.affine)\n # Remove imgs_ from memory before loading the same image\n # in filter_and_extract.\n del imgs_\n\n target_shape = None\n target_affine = None\n if self.resampling_target == 'labels':\n target_shape = self._resampled_labels_img_.shape[:3]\n target_affine = self._resampled_labels_img_.affine\n\n params = get_params(NiftiLabelsMasker, self,\n ignore=['resampling_target'])\n params['target_shape'] = target_shape\n params['target_affine'] = target_affine\n\n region_signals, labels_ = self._cache(\n filter_and_extract,\n ignore=['verbose', 'memory', 'memory_level'])(\n # Images\n imgs, _ExtractionFunctor(self._resampled_labels_img_,\n self.background_label, self.strategy),\n # Pre-processing\n params,\n confounds=confounds,\n dtype=self.dtype,\n # Caching\n memory=self.memory,\n memory_level=self.memory_level,\n verbose=self.verbose)\n\n self.labels_ = labels_\n\n return region_signals\n\n def inverse_transform(self, signals):\n \"\"\"Compute voxel signals from region signals\n\n Any mask given at initialization is taken into account.\n\n Parameters\n ----------\n signals (2D numpy.ndarray)\n Signal for each region.\n shape: (number of scans, number of regions)\n\n Returns\n -------\n voxel_signals (Nifti1Image)\n Signal for each voxel\n shape: (number of scans, number of voxels)\n \"\"\"\n from ..regions import signal_extraction\n\n self._check_fitted()\n\n logger.log(\"computing image from signals\", verbose=self.verbose)\n return signal_extraction.signals_to_img_labels(\n signals, self._resampled_labels_img_, self.mask_img_,\n background_label=self.background_label)\n","path":"nilearn/input_data/nifti_labels_masker.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"\\nTransformer for computing ROI signals.\\n\\\"\\\"\\\"\\n\\nimport numpy as np\\n\\nfrom nilearn._utils.compat import Memory\\n\\nfrom .. import _utils\\nfrom .._utils import logger, CacheMixin, _compose_err_msg\\nfrom .._utils.class_inspect import get_params\\nfrom .._utils.niimg_conversions import _check_same_fov\\nfrom .. import masking\\nfrom .. import image\\nfrom .base_masker import filter_and_extract, BaseMasker\\n\\n\\nclass _ExtractionFunctor(object):\\n\\n func_name = 'nifti_labels_masker_extractor'\\n\\n def __init__(self, _resampled_labels_img_, background_label, strategy):\\n self._resampled_labels_img_ = _resampled_labels_img_\\n self.background_label = background_label\\n self.strategy = strategy\\n\\n def __call__(self, imgs):\\n from ..regions import signal_extraction\\n\\n return signal_extraction.img_to_signals_labels(\\n imgs, self._resampled_labels_img_,\\n background_label=self.background_label, strategy=self.strategy)\\n\\n\\nclass NiftiLabelsMasker(BaseMasker, CacheMixin):\\n \\\"\\\"\\\"Class for masking of Niimg-like objects.\\n\\n NiftiLabelsMasker is useful when data from non-overlapping volumes should\\n be extracted (contrarily to NiftiMapsMasker). Use case: Summarize brain\\n signals from clusters that were obtained by prior K-means or Ward\\n clustering.\\n\\n Parameters\\n ----------\\n labels_img: Niimg-like object\\n See http://nilearn.github.io/manipulating_images/input_output.html\\n Region definitions, as one image of labels.\\n\\n background_label: number, optional\\n Label used in labels_img to represent background.\\n\\n mask_img: Niimg-like object, optional\\n See http://nilearn.github.io/manipulating_images/input_output.html\\n Mask to apply to regions before extracting signals.\\n\\n smoothing_fwhm: float, optional\\n If smoothing_fwhm is not None, it gives the full-width half maximum in\\n millimeters of the spatial smoothing to apply to the signal.\\n\\n standardize: {'zscore', 'psc', True, False}, default is 'zscore'\\n Strategy to standardize the signal.\\n 'zscore': the signal is z-scored. Timeseries are shifted\\n to zero mean and scaled to unit variance.\\n 'psc': Timeseries are shifted to zero mean value and scaled\\n to percent signal change (as compared to original mean signal).\\n True : the signal is z-scored. Timeseries are shifted\\n to zero mean and scaled to unit variance.\\n False : Do not standardize the data.\\n\\n detrend: boolean, optional\\n This parameter is passed to signal.clean. Please see the related\\n documentation for details\\n\\n low_pass: None or float, optional\\n This parameter is passed to signal.clean. Please see the related\\n documentation for details\\n\\n high_pass: None or float, optional\\n This parameter is passed to signal.clean. Please see the related\\n documentation for details\\n\\n t_r: float, optional\\n This parameter is passed to signal.clean. Please see the related\\n documentation for details\\n\\n dtype: {dtype, \\\"auto\\\"}\\n Data type toward which the data should be converted. If \\\"auto\\\", the\\n data will be converted to int32 if dtype is discrete and float32 if it\\n is continuous.\\n\\n resampling_target: {\\\"data\\\", \\\"labels\\\", None}, optional.\\n Gives which image gives the final shape/size. For example, if\\n `resampling_target` is \\\"data\\\", the atlas is resampled to the\\n shape of the data if needed. If it is \\\"labels\\\" then mask_img\\n and images provided to fit() are resampled to the shape and\\n affine of maps_img. \\\"None\\\" means no resampling: if shapes and\\n affines do not match, a ValueError is raised. Defaults to \\\"data\\\".\\n\\n memory: joblib.Memory or str, optional\\n Used to cache the region extraction process.\\n By default, no caching is done. If a string is given, it is the\\n path to the caching directory.\\n\\n memory_level: int, optional\\n Aggressiveness of memory caching. The higher the number, the higher\\n the number of functions that will be cached. Zero means no caching.\\n\\n verbose: integer, optional\\n Indicate the level of verbosity. By default, nothing is printed\\n\\n strategy: str\\n The name of a valid function to reduce the region with.\\n Must be one of: sum, mean, median, mininum, maximum, variance,\\n standard_deviation\\n\\n See also\\n --------\\n nilearn.input_data.NiftiMasker\\n \\\"\\\"\\\"\\n # memory and memory_level are used by CacheMixin.\\n\\n def __init__(self, labels_img, background_label=0, mask_img=None,\\n smoothing_fwhm=None, standardize=False, detrend=False,\\n low_pass=None, high_pass=None, t_r=None, dtype=None,\\n resampling_target=\\\"data\\\",\\n memory=Memory(cachedir=None, verbose=0), memory_level=1,\\n verbose=0, strategy=\\\"mean\\\"):\\n self.labels_img = labels_img\\n self.background_label = background_label\\n self.mask_img = mask_img\\n\\n # Parameters for _smooth_array\\n self.smoothing_fwhm = smoothing_fwhm\\n\\n # Parameters for clean()\\n self.standardize = standardize\\n self.detrend = detrend\\n self.low_pass = low_pass\\n self.high_pass = high_pass\\n self.t_r = t_r\\n self.dtype = dtype\\n\\n # Parameters for resampling\\n self.resampling_target = resampling_target\\n\\n # Parameters for joblib\\n self.memory = memory\\n self.memory_level = memory_level\\n self.verbose = verbose\\n\\n available_reduction_strategies = {'mean', 'median', 'sum',\\n 'minimum', 'maximum',\\n 'standard_deviation', 'variance'}\\n\\n if strategy not in available_reduction_strategies:\\n raise ValueError(str.format(\\n \\\"Invalid strategy '{}'. Valid strategies are {}.\\\",\\n strategy,\\n available_reduction_strategies\\n ))\\n\\n self.strategy = strategy\\n\\n if resampling_target not in (\\\"labels\\\", \\\"data\\\", None):\\n raise ValueError(\\\"invalid value for 'resampling_target' \\\"\\n \\\"parameter: \\\" + str(resampling_target))\\n\\n def fit(self, X=None, y=None):\\n \\\"\\\"\\\"Prepare signal extraction from regions.\\n\\n All parameters are unused, they are for scikit-learn compatibility.\\n \\\"\\\"\\\"\\n logger.log(\\\"loading data from %s\\\" %\\n _utils._repr_niimgs(self.labels_img)[:200],\\n verbose=self.verbose)\\n self.labels_img_ = _utils.check_niimg_3d(self.labels_img)\\n if self.mask_img is not None:\\n logger.log(\\\"loading data from %s\\\" %\\n _utils._repr_niimgs(self.mask_img)[:200],\\n verbose=self.verbose)\\n self.mask_img_ = _utils.check_niimg_3d(self.mask_img)\\n else:\\n self.mask_img_ = None\\n\\n # Check shapes and affines or resample.\\n if self.mask_img_ is not None:\\n if self.resampling_target == \\\"data\\\":\\n # resampling will be done at transform time\\n pass\\n elif self.resampling_target is None:\\n if self.mask_img_.shape != self.labels_img_.shape[:3]:\\n raise ValueError(\\n _compose_err_msg(\\n \\\"Regions and mask do not have the same shape\\\",\\n mask_img=self.mask_img,\\n labels_img=self.labels_img))\\n if not np.allclose(self.mask_img_.affine,\\n self.labels_img_.affine):\\n raise ValueError(_compose_err_msg(\\n \\\"Regions and mask do not have the same affine.\\\",\\n mask_img=self.mask_img, labels_img=self.labels_img))\\n\\n elif self.resampling_target == \\\"labels\\\":\\n logger.log(\\\"resampling the mask\\\", verbose=self.verbose)\\n self.mask_img_ = image.resample_img(\\n self.mask_img_,\\n target_affine=self.labels_img_.affine,\\n target_shape=self.labels_img_.shape[:3],\\n interpolation=\\\"nearest\\\",\\n copy=True)\\n else:\\n raise ValueError(\\\"Invalid value for resampling_target: \\\" +\\n str(self.resampling_target))\\n\\n mask_data, mask_affine = masking._load_mask_img(self.mask_img_)\\n\\n if not hasattr(self, '_resampled_labels_img_'):\\n # obviates need to run .transform() before .inverse_transform()\\n self._resampled_labels_img_ = self.labels_img_\\n\\n return self\\n\\n def fit_transform(self, imgs, confounds=None):\\n \\\"\\\"\\\" Prepare and perform signal extraction from regions.\\n \\\"\\\"\\\"\\n return self.fit().transform(imgs, confounds=confounds)\\n\\n def _check_fitted(self):\\n if not hasattr(self, \\\"labels_img_\\\"):\\n raise ValueError('It seems that %s has not been fitted. '\\n 'You must call fit() before calling transform().'\\n % self.__class__.__name__)\\n\\n def transform_single_imgs(self, imgs, confounds=None):\\n \\\"\\\"\\\"Extract signals from a single 4D niimg.\\n\\n Parameters\\n ----------\\n imgs: 3D/4D Niimg-like object\\n See http://nilearn.github.io/manipulating_images/input_output.html\\n Images to process. It must boil down to a 4D image with scans\\n number as last dimension.\\n\\n confounds: CSV file or array-like, optional\\n This parameter is passed to signal.clean. Please see the related\\n documentation for details.\\n shape: (number of scans, number of confounds)\\n\\n Returns\\n -------\\n region_signals: 2D numpy.ndarray\\n Signal for each label.\\n shape: (number of scans, number of labels)\\n \\\"\\\"\\\"\\n # We handle the resampling of labels separately because the affine of\\n # the labels image should not impact the extraction of the signal.\\n\\n if not hasattr(self, '_resampled_labels_img_'):\\n self._resampled_labels_img_ = self.labels_img_\\n if self.resampling_target == \\\"data\\\":\\n imgs_ = _utils.check_niimg_4d(imgs)\\n if not _check_same_fov(imgs_, self._resampled_labels_img_):\\n if self.verbose > 0:\\n print(\\\"Resampling labels\\\")\\n self._resampled_labels_img_ = self._cache(\\n image.resample_img, func_memory_level=2)(\\n self.labels_img_, interpolation=\\\"nearest\\\",\\n target_shape=imgs_.shape[:3],\\n target_affine=imgs_.affine)\\n # Remove imgs_ from memory before loading the same image\\n # in filter_and_extract.\\n del imgs_\\n\\n target_shape = None\\n target_affine = None\\n if self.resampling_target == 'labels':\\n target_shape = self._resampled_labels_img_.shape[:3]\\n target_affine = self._resampled_labels_img_.affine\\n\\n params = get_params(NiftiLabelsMasker, self,\\n ignore=['resampling_target'])\\n params['target_shape'] = target_shape\\n params['target_affine'] = target_affine\\n\\n region_signals, labels_ = self._cache(\\n filter_and_extract,\\n ignore=['verbose', 'memory', 'memory_level'])(\\n # Images\\n imgs, _ExtractionFunctor(self._resampled_labels_img_,\\n self.background_label, self.strategy),\\n # Pre-processing\\n params,\\n confounds=confounds,\\n dtype=self.dtype,\\n # Caching\\n memory=self.memory,\\n memory_level=self.memory_level,\\n verbose=self.verbose)\\n\\n self.labels_ = labels_\\n\\n return region_signals\\n\\n def inverse_transform(self, signals):\\n \\\"\\\"\\\"Compute voxel signals from region signals\\n\\n Any mask given at initialization is taken into account.\\n\\n Parameters\\n ----------\\n signals (2D numpy.ndarray)\\n Signal for each region.\\n shape: (number of scans, number of regions)\\n\\n Returns\\n -------\\n voxel_signals (Nifti1Image)\\n Signal for each voxel\\n shape: (number of scans, number of voxels)\\n \\\"\\\"\\\"\\n from ..regions import signal_extraction\\n\\n self._check_fitted()\\n\\n logger.log(\\\"computing image from signals\\\", verbose=self.verbose)\\n return signal_extraction.signals_to_img_labels(\\n signals, self._resampled_labels_img_, self.mask_img_,\\n background_label=self.background_label)\\n\",\n \"path\": \"nilearn/input_data/nifti_labels_masker.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/doc/whats_new.rst b/doc/whats_new.rst\nindex d0ecf7f749..ca9f0201a4 100644\n--- a/doc/whats_new.rst\n+++ b/doc/whats_new.rst\n@@ -25,6 +25,8 @@ Fixes\n - :func:`nilearn.image.new_img_like` no longer attempts to copy non-iterable headers. (PR #2212)\n - Nilearn no longer raises ImportError for nose when Matplotlib is not installed.\n - The arg `version='det'` in :func:`nilearn.datasets.fetch_atlas_pauli_2017` now works as expected.\n+- :func:`nilearn.input_data.NiftiLabelsMasker.inverse_transform` now works without the need to call\n+ transform first.\n \n Contributors\n ------------\ndiff --git a/nilearn/input_data/nifti_labels_masker.py b/nilearn/input_data/nifti_labels_masker.py\nindex a0261964c8..256f7dc211 100644\n--- a/nilearn/input_data/nifti_labels_masker.py\n+++ b/nilearn/input_data/nifti_labels_masker.py\n@@ -214,6 +214,10 @@ def fit(self, X=None, y=None):\n \n mask_data, mask_affine = masking._load_mask_img(self.mask_img_)\n \n+ if not hasattr(self, '_resampled_labels_img_'):\n+ # obviates need to run .transform() before .inverse_transform()\n+ self._resampled_labels_img_ = self.labels_img_\n+\n return self\n \n def fit_transform(self, imgs, confounds=None):\ndiff --git a/nilearn/input_data/tests/test_nifti_labels_masker.py b/nilearn/input_data/tests/test_nifti_labels_masker.py\nindex 0f095730ee..8bd969703c 100644\n--- a/nilearn/input_data/tests/test_nifti_labels_masker.py\n+++ b/nilearn/input_data/tests/test_nifti_labels_masker.py\n@@ -66,6 +66,11 @@ def test_nifti_labels_masker():\n signals11 = masker11.fit().transform(fmri11_img)\n assert_equal(signals11.shape, (length, n_regions))\n \n+ # No exception should be raised either\n+ masker11 = NiftiLabelsMasker(labels11_img, resampling_target=None)\n+ masker11.fit()\n+ masker11.inverse_transform(signals11)\n+\n masker11 = NiftiLabelsMasker(labels11_img, mask_img=mask11_img,\n resampling_target=None)\n signals11 = masker11.fit().transform(fmri11_img)\ndiff --git a/nilearn/input_data/tests/test_nifti_maps_masker.py b/nilearn/input_data/tests/test_nifti_maps_masker.py\nindex 2ca18e2a54..0cb0aca5f0 100644\n--- a/nilearn/input_data/tests/test_nifti_maps_masker.py\n+++ b/nilearn/input_data/tests/test_nifti_maps_masker.py\n@@ -105,6 +105,11 @@ def test_nifti_maps_masker():\n assert_equal(fmri11_img_r.shape, fmri11_img.shape)\n np.testing.assert_almost_equal(fmri11_img_r.affine, fmri11_img.affine)\n \n+ # Now try on a masker that has never seen the call to \"transform\"\n+ masker2 = NiftiMapsMasker(labels11_img, resampling_target=None)\n+ masker2.fit()\n+ masker2.inverse_transform(signals11)\n+\n # Test with data and atlas of different shape: the atlas should be\n # resampled to the data\n shape22 = (5, 5, 6)\n"}}},{"rowIdx":4670,"cells":{"in_source_id":{"kind":"string","value":"getsentry__sentry-3393"},"issue":{"kind":"string","value":"Source map lookups wrong when location is first position in state array\nFailing test here: https://github.com/getsentry/sentry/commit/289e4e664769173b3b9ef7eb34c3e2576a2a543f\n\nSource of bug in [sentry.lang.javascript.sourcemaps#L158](https://github.com/getsentry/sentry/blob/master/src/sentry/lang/javascript/sourcemaps.py#L158):\n\n``` python\ndef find_source(indexed_sourcemap, lineno, colno):\n # error says \"line no 1, column no 56\"\n assert lineno > 0, 'line numbers are 1-indexed'\n return indexed_sourcemap.states[bisect.bisect_left(indexed_sourcemap.keys, (lineno - 1, colno)) - 1]\n```\n\nFails because `bisect_left` will return the index to the left of a match if there is an exact match. In this test case, the match is the first state `(0, 0)`, after which we subtract `1` and access the array at location `-1` ... which is the last element in the array.\n\nMe debugging the test case in pdb:\n\n```\n>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n> sentry/src/sentry/lang/javascript/sourcemaps.py(157)find_source()\n-> assert lineno > 0, 'line numbers are 1-indexed'\n(Pdb) lineno\n1\n(Pdb) colno\n0\n(Pdb) bisect.bisect_left(indexed_sourcemap.keys, (lineno - 1, colno)) - 1\n-1\n(Pdb) indexed_sourcemap.keys\n[(0, 0), (0, 8), (0, 13), (0, 15), ..., (0, 168), (0, 174), (0, 191)]\n(Pdb) indexed_sourcemap.states[-1]\nSourceMap(dst_line=0, dst_col=191, src='foo/file2.js', src_line=9, src_col=25, name='e')\n```\n\n---\n\nIt appears that @mattrobenolt's python-sourcemap [implementation](https://github.com/mattrobenolt/python-sourcemap/blob/master/sourcemap/objects.py#L70) uses `bisect_right`, but I haven't investigated to see if the bug is present there.\n\n"},"before_files":{"kind":"list like","value":[{"content":"\"\"\"\nsentry.utils.sourcemaps\n~~~~~~~~~~~~~~~~~~~~~~~\n\nOriginally based on https://github.com/martine/python-sourcemap\n\n:copyright: (c) 2010-2014 by the Sentry Team, see AUTHORS for more details.\n:license: BSD, see LICENSE for more details.\n\"\"\"\nfrom __future__ import absolute_import\n\nimport bisect\n\nfrom collections import namedtuple\nfrom urlparse import urljoin\n\nfrom sentry.utils import json\n\n\nSourceMap = namedtuple('SourceMap', ['dst_line', 'dst_col', 'src', 'src_line', 'src_col', 'name'])\nSourceMapIndex = namedtuple('SourceMapIndex', ['states', 'keys', 'sources', 'content'])\n\n# Mapping of base64 letter -> integer value.\nB64 = dict(\n (c, i) for i, c in\n enumerate('ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/')\n)\n\n\ndef parse_vlq(segment):\n \"\"\"\n Parse a string of VLQ-encoded data.\n\n Returns:\n a list of integers.\n \"\"\"\n\n values = []\n\n cur, shift = 0, 0\n for c in segment:\n val = B64[c]\n # Each character is 6 bits:\n # 5 of value and the high bit is the continuation.\n val, cont = val & 0b11111, val >> 5\n cur += val << shift\n shift += 5\n\n if not cont:\n # The low bit of the unpacked value is the sign.\n cur, sign = cur >> 1, cur & 1\n if sign:\n cur = -cur\n values.append(cur)\n cur, shift = 0, 0\n\n if cur or shift:\n raise Exception('leftover cur/shift in vlq decode')\n\n return values\n\n\ndef parse_sourcemap(smap):\n \"\"\"\n Given a sourcemap json object, yield SourceMap objects as they are read from it.\n \"\"\"\n sources = smap['sources']\n sourceRoot = smap.get('sourceRoot')\n names = smap.get('names', [])\n mappings = smap['mappings']\n lines = mappings.split(';')\n\n if sourceRoot:\n # turn /foo/bar into /foo/bar/ so urljoin doesnt strip the last path\n if not sourceRoot.endswith('/'):\n sourceRoot = sourceRoot + '/'\n\n sources = [\n urljoin(sourceRoot, src)\n for src in sources\n ]\n\n dst_col, src_id, src_line, src_col, name_id = 0, 0, 0, 0, 0\n for dst_line, line in enumerate(lines):\n segments = line.split(',')\n dst_col = 0\n for segment in segments:\n if not segment:\n continue\n parse = parse_vlq(segment)\n dst_col += parse[0]\n\n src = None\n name = None\n if len(parse) > 1:\n src_id += parse[1]\n src = sources[src_id]\n src_line += parse[2]\n src_col += parse[3]\n\n if len(parse) > 4:\n name_id += parse[4]\n name = names[name_id]\n\n assert dst_line >= 0\n assert dst_col >= 0\n assert src_line >= 0\n assert src_col >= 0\n\n yield SourceMap(dst_line, dst_col, src, src_line, src_col, name)\n\n\ndef sourcemap_to_index(sourcemap):\n smap = json.loads(sourcemap)\n\n state_list = []\n key_list = []\n src_list = set()\n content = {}\n sourceRoot = smap.get('sourceRoot')\n\n # turn /foo/bar into /foo/bar/ so urljoin doesnt strip the last path\n if sourceRoot and not sourceRoot.endswith('/'):\n sourceRoot = sourceRoot + '/'\n\n if smap.get('sourcesContent'):\n for idx, source in enumerate(smap['sources']):\n # Ensure we handle null files that may be specified outside of\n # sourcesContent\n try:\n value = smap['sourcesContent'][idx]\n except IndexError:\n continue\n\n if value is None:\n continue\n\n # Apply the root to the source before shoving into the index\n # so we can look it up correctly later\n source = urljoin(sourceRoot, source)\n content[source] = value.split('\\n')\n\n for state in parse_sourcemap(smap):\n state_list.append(state)\n key_list.append((state.dst_line, state.dst_col))\n\n # Apparently it's possible to not have a src\n # specified in the vlq segments\n if state.src is not None:\n src_list.add(state.src)\n\n return SourceMapIndex(state_list, key_list, src_list, content)\n\n\ndef find_source(indexed_sourcemap, lineno, colno):\n # error says \"line no 1, column no 56\"\n assert lineno > 0, 'line numbers are 1-indexed'\n return indexed_sourcemap.states[bisect.bisect_left(indexed_sourcemap.keys, (lineno - 1, colno)) - 1]\n","path":"src/sentry/lang/javascript/sourcemaps.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"\\nsentry.utils.sourcemaps\\n~~~~~~~~~~~~~~~~~~~~~~~\\n\\nOriginally based on https://github.com/martine/python-sourcemap\\n\\n:copyright: (c) 2010-2014 by the Sentry Team, see AUTHORS for more details.\\n:license: BSD, see LICENSE for more details.\\n\\\"\\\"\\\"\\nfrom __future__ import absolute_import\\n\\nimport bisect\\n\\nfrom collections import namedtuple\\nfrom urlparse import urljoin\\n\\nfrom sentry.utils import json\\n\\n\\nSourceMap = namedtuple('SourceMap', ['dst_line', 'dst_col', 'src', 'src_line', 'src_col', 'name'])\\nSourceMapIndex = namedtuple('SourceMapIndex', ['states', 'keys', 'sources', 'content'])\\n\\n# Mapping of base64 letter -> integer value.\\nB64 = dict(\\n (c, i) for i, c in\\n enumerate('ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/')\\n)\\n\\n\\ndef parse_vlq(segment):\\n \\\"\\\"\\\"\\n Parse a string of VLQ-encoded data.\\n\\n Returns:\\n a list of integers.\\n \\\"\\\"\\\"\\n\\n values = []\\n\\n cur, shift = 0, 0\\n for c in segment:\\n val = B64[c]\\n # Each character is 6 bits:\\n # 5 of value and the high bit is the continuation.\\n val, cont = val & 0b11111, val >> 5\\n cur += val << shift\\n shift += 5\\n\\n if not cont:\\n # The low bit of the unpacked value is the sign.\\n cur, sign = cur >> 1, cur & 1\\n if sign:\\n cur = -cur\\n values.append(cur)\\n cur, shift = 0, 0\\n\\n if cur or shift:\\n raise Exception('leftover cur/shift in vlq decode')\\n\\n return values\\n\\n\\ndef parse_sourcemap(smap):\\n \\\"\\\"\\\"\\n Given a sourcemap json object, yield SourceMap objects as they are read from it.\\n \\\"\\\"\\\"\\n sources = smap['sources']\\n sourceRoot = smap.get('sourceRoot')\\n names = smap.get('names', [])\\n mappings = smap['mappings']\\n lines = mappings.split(';')\\n\\n if sourceRoot:\\n # turn /foo/bar into /foo/bar/ so urljoin doesnt strip the last path\\n if not sourceRoot.endswith('/'):\\n sourceRoot = sourceRoot + '/'\\n\\n sources = [\\n urljoin(sourceRoot, src)\\n for src in sources\\n ]\\n\\n dst_col, src_id, src_line, src_col, name_id = 0, 0, 0, 0, 0\\n for dst_line, line in enumerate(lines):\\n segments = line.split(',')\\n dst_col = 0\\n for segment in segments:\\n if not segment:\\n continue\\n parse = parse_vlq(segment)\\n dst_col += parse[0]\\n\\n src = None\\n name = None\\n if len(parse) > 1:\\n src_id += parse[1]\\n src = sources[src_id]\\n src_line += parse[2]\\n src_col += parse[3]\\n\\n if len(parse) > 4:\\n name_id += parse[4]\\n name = names[name_id]\\n\\n assert dst_line >= 0\\n assert dst_col >= 0\\n assert src_line >= 0\\n assert src_col >= 0\\n\\n yield SourceMap(dst_line, dst_col, src, src_line, src_col, name)\\n\\n\\ndef sourcemap_to_index(sourcemap):\\n smap = json.loads(sourcemap)\\n\\n state_list = []\\n key_list = []\\n src_list = set()\\n content = {}\\n sourceRoot = smap.get('sourceRoot')\\n\\n # turn /foo/bar into /foo/bar/ so urljoin doesnt strip the last path\\n if sourceRoot and not sourceRoot.endswith('/'):\\n sourceRoot = sourceRoot + '/'\\n\\n if smap.get('sourcesContent'):\\n for idx, source in enumerate(smap['sources']):\\n # Ensure we handle null files that may be specified outside of\\n # sourcesContent\\n try:\\n value = smap['sourcesContent'][idx]\\n except IndexError:\\n continue\\n\\n if value is None:\\n continue\\n\\n # Apply the root to the source before shoving into the index\\n # so we can look it up correctly later\\n source = urljoin(sourceRoot, source)\\n content[source] = value.split('\\\\n')\\n\\n for state in parse_sourcemap(smap):\\n state_list.append(state)\\n key_list.append((state.dst_line, state.dst_col))\\n\\n # Apparently it's possible to not have a src\\n # specified in the vlq segments\\n if state.src is not None:\\n src_list.add(state.src)\\n\\n return SourceMapIndex(state_list, key_list, src_list, content)\\n\\n\\ndef find_source(indexed_sourcemap, lineno, colno):\\n # error says \\\"line no 1, column no 56\\\"\\n assert lineno > 0, 'line numbers are 1-indexed'\\n return indexed_sourcemap.states[bisect.bisect_left(indexed_sourcemap.keys, (lineno - 1, colno)) - 1]\\n\",\n \"path\": \"src/sentry/lang/javascript/sourcemaps.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"\"\"\"\nsentry.utils.sourcemaps\n~~~~~~~~~~~~~~~~~~~~~~~\n\nOriginally based on https://github.com/martine/python-sourcemap\n\n:copyright: (c) 2010-2014 by the Sentry Team, see AUTHORS for more details.\n:license: BSD, see LICENSE for more details.\n\"\"\"\nfrom __future__ import absolute_import\n\nimport bisect\n\nfrom collections import namedtuple\nfrom urlparse import urljoin\n\nfrom sentry.utils import json\n\n\nSourceMap = namedtuple('SourceMap', ['dst_line', 'dst_col', 'src', 'src_line', 'src_col', 'name'])\nSourceMapIndex = namedtuple('SourceMapIndex', ['states', 'keys', 'sources', 'content'])\n\n# Mapping of base64 letter -> integer value.\nB64 = dict(\n (c, i) for i, c in\n enumerate('ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/')\n)\n\n\ndef parse_vlq(segment):\n \"\"\"\n Parse a string of VLQ-encoded data.\n\n Returns:\n a list of integers.\n \"\"\"\n\n values = []\n\n cur, shift = 0, 0\n for c in segment:\n val = B64[c]\n # Each character is 6 bits:\n # 5 of value and the high bit is the continuation.\n val, cont = val & 0b11111, val >> 5\n cur += val << shift\n shift += 5\n\n if not cont:\n # The low bit of the unpacked value is the sign.\n cur, sign = cur >> 1, cur & 1\n if sign:\n cur = -cur\n values.append(cur)\n cur, shift = 0, 0\n\n if cur or shift:\n raise Exception('leftover cur/shift in vlq decode')\n\n return values\n\n\ndef parse_sourcemap(smap):\n \"\"\"\n Given a sourcemap json object, yield SourceMap objects as they are read from it.\n \"\"\"\n sources = smap['sources']\n sourceRoot = smap.get('sourceRoot')\n names = smap.get('names', [])\n mappings = smap['mappings']\n lines = mappings.split(';')\n\n if sourceRoot:\n # turn /foo/bar into /foo/bar/ so urljoin doesnt strip the last path\n if not sourceRoot.endswith('/'):\n sourceRoot = sourceRoot + '/'\n\n sources = [\n urljoin(sourceRoot, src)\n for src in sources\n ]\n\n dst_col, src_id, src_line, src_col, name_id = 0, 0, 0, 0, 0\n for dst_line, line in enumerate(lines):\n segments = line.split(',')\n dst_col = 0\n for segment in segments:\n if not segment:\n continue\n parse = parse_vlq(segment)\n dst_col += parse[0]\n\n src = None\n name = None\n if len(parse) > 1:\n src_id += parse[1]\n src = sources[src_id]\n src_line += parse[2]\n src_col += parse[3]\n\n if len(parse) > 4:\n name_id += parse[4]\n name = names[name_id]\n\n assert dst_line >= 0\n assert dst_col >= 0\n assert src_line >= 0\n assert src_col >= 0\n\n yield SourceMap(dst_line, dst_col, src, src_line, src_col, name)\n\n\ndef sourcemap_to_index(sourcemap):\n smap = json.loads(sourcemap)\n\n state_list = []\n key_list = []\n src_list = set()\n content = {}\n sourceRoot = smap.get('sourceRoot')\n\n # turn /foo/bar into /foo/bar/ so urljoin doesnt strip the last path\n if sourceRoot and not sourceRoot.endswith('/'):\n sourceRoot = sourceRoot + '/'\n\n if smap.get('sourcesContent'):\n for idx, source in enumerate(smap['sources']):\n # Ensure we handle null files that may be specified outside of\n # sourcesContent\n try:\n value = smap['sourcesContent'][idx]\n except IndexError:\n continue\n\n if value is None:\n continue\n\n # Apply the root to the source before shoving into the index\n # so we can look it up correctly later\n source = urljoin(sourceRoot, source)\n content[source] = value.split('\\n')\n\n for state in parse_sourcemap(smap):\n state_list.append(state)\n key_list.append((state.dst_line, state.dst_col))\n\n # Apparently it's possible to not have a src\n # specified in the vlq segments\n if state.src is not None:\n src_list.add(state.src)\n\n return SourceMapIndex(state_list, key_list, src_list, content)\n\n\ndef find_source(indexed_sourcemap, lineno, colno):\n # error says \"line no 1, column no 56\"\n assert lineno > 0, 'line numbers are 1-indexed'\n\n return indexed_sourcemap.states[bisect.bisect_right(indexed_sourcemap.keys, (lineno - 1, colno)) - 1]\n","path":"src/sentry/lang/javascript/sourcemaps.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"\\nsentry.utils.sourcemaps\\n~~~~~~~~~~~~~~~~~~~~~~~\\n\\nOriginally based on https://github.com/martine/python-sourcemap\\n\\n:copyright: (c) 2010-2014 by the Sentry Team, see AUTHORS for more details.\\n:license: BSD, see LICENSE for more details.\\n\\\"\\\"\\\"\\nfrom __future__ import absolute_import\\n\\nimport bisect\\n\\nfrom collections import namedtuple\\nfrom urlparse import urljoin\\n\\nfrom sentry.utils import json\\n\\n\\nSourceMap = namedtuple('SourceMap', ['dst_line', 'dst_col', 'src', 'src_line', 'src_col', 'name'])\\nSourceMapIndex = namedtuple('SourceMapIndex', ['states', 'keys', 'sources', 'content'])\\n\\n# Mapping of base64 letter -> integer value.\\nB64 = dict(\\n (c, i) for i, c in\\n enumerate('ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/')\\n)\\n\\n\\ndef parse_vlq(segment):\\n \\\"\\\"\\\"\\n Parse a string of VLQ-encoded data.\\n\\n Returns:\\n a list of integers.\\n \\\"\\\"\\\"\\n\\n values = []\\n\\n cur, shift = 0, 0\\n for c in segment:\\n val = B64[c]\\n # Each character is 6 bits:\\n # 5 of value and the high bit is the continuation.\\n val, cont = val & 0b11111, val >> 5\\n cur += val << shift\\n shift += 5\\n\\n if not cont:\\n # The low bit of the unpacked value is the sign.\\n cur, sign = cur >> 1, cur & 1\\n if sign:\\n cur = -cur\\n values.append(cur)\\n cur, shift = 0, 0\\n\\n if cur or shift:\\n raise Exception('leftover cur/shift in vlq decode')\\n\\n return values\\n\\n\\ndef parse_sourcemap(smap):\\n \\\"\\\"\\\"\\n Given a sourcemap json object, yield SourceMap objects as they are read from it.\\n \\\"\\\"\\\"\\n sources = smap['sources']\\n sourceRoot = smap.get('sourceRoot')\\n names = smap.get('names', [])\\n mappings = smap['mappings']\\n lines = mappings.split(';')\\n\\n if sourceRoot:\\n # turn /foo/bar into /foo/bar/ so urljoin doesnt strip the last path\\n if not sourceRoot.endswith('/'):\\n sourceRoot = sourceRoot + '/'\\n\\n sources = [\\n urljoin(sourceRoot, src)\\n for src in sources\\n ]\\n\\n dst_col, src_id, src_line, src_col, name_id = 0, 0, 0, 0, 0\\n for dst_line, line in enumerate(lines):\\n segments = line.split(',')\\n dst_col = 0\\n for segment in segments:\\n if not segment:\\n continue\\n parse = parse_vlq(segment)\\n dst_col += parse[0]\\n\\n src = None\\n name = None\\n if len(parse) > 1:\\n src_id += parse[1]\\n src = sources[src_id]\\n src_line += parse[2]\\n src_col += parse[3]\\n\\n if len(parse) > 4:\\n name_id += parse[4]\\n name = names[name_id]\\n\\n assert dst_line >= 0\\n assert dst_col >= 0\\n assert src_line >= 0\\n assert src_col >= 0\\n\\n yield SourceMap(dst_line, dst_col, src, src_line, src_col, name)\\n\\n\\ndef sourcemap_to_index(sourcemap):\\n smap = json.loads(sourcemap)\\n\\n state_list = []\\n key_list = []\\n src_list = set()\\n content = {}\\n sourceRoot = smap.get('sourceRoot')\\n\\n # turn /foo/bar into /foo/bar/ so urljoin doesnt strip the last path\\n if sourceRoot and not sourceRoot.endswith('/'):\\n sourceRoot = sourceRoot + '/'\\n\\n if smap.get('sourcesContent'):\\n for idx, source in enumerate(smap['sources']):\\n # Ensure we handle null files that may be specified outside of\\n # sourcesContent\\n try:\\n value = smap['sourcesContent'][idx]\\n except IndexError:\\n continue\\n\\n if value is None:\\n continue\\n\\n # Apply the root to the source before shoving into the index\\n # so we can look it up correctly later\\n source = urljoin(sourceRoot, source)\\n content[source] = value.split('\\\\n')\\n\\n for state in parse_sourcemap(smap):\\n state_list.append(state)\\n key_list.append((state.dst_line, state.dst_col))\\n\\n # Apparently it's possible to not have a src\\n # specified in the vlq segments\\n if state.src is not None:\\n src_list.add(state.src)\\n\\n return SourceMapIndex(state_list, key_list, src_list, content)\\n\\n\\ndef find_source(indexed_sourcemap, lineno, colno):\\n # error says \\\"line no 1, column no 56\\\"\\n assert lineno > 0, 'line numbers are 1-indexed'\\n\\n return indexed_sourcemap.states[bisect.bisect_right(indexed_sourcemap.keys, (lineno - 1, colno)) - 1]\\n\",\n \"path\": \"src/sentry/lang/javascript/sourcemaps.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/src/sentry/lang/javascript/sourcemaps.py b/src/sentry/lang/javascript/sourcemaps.py\nindex 8496b706a9ad15..cb5920f22b80ef 100644\n--- a/src/sentry/lang/javascript/sourcemaps.py\n+++ b/src/sentry/lang/javascript/sourcemaps.py\n@@ -155,4 +155,5 @@ def sourcemap_to_index(sourcemap):\n def find_source(indexed_sourcemap, lineno, colno):\n # error says \"line no 1, column no 56\"\n assert lineno > 0, 'line numbers are 1-indexed'\n- return indexed_sourcemap.states[bisect.bisect_left(indexed_sourcemap.keys, (lineno - 1, colno)) - 1]\n+\n+ return indexed_sourcemap.states[bisect.bisect_right(indexed_sourcemap.keys, (lineno - 1, colno)) - 1]\ndiff --git a/tests/sentry/lang/javascript/test_sourcemaps.py b/tests/sentry/lang/javascript/test_sourcemaps.py\nindex 0994de57bc0b52..551fc4c56252cf 100644\n--- a/tests/sentry/lang/javascript/test_sourcemaps.py\n+++ b/tests/sentry/lang/javascript/test_sourcemaps.py\n@@ -34,9 +34,24 @@ def test_simple(self):\n indexed_sourcemap = sourcemap_to_index(sourcemap)\n \n result = find_source(indexed_sourcemap, 1, 56)\n-\n assert result == SourceMap(dst_line=0, dst_col=50, src='foo/file2.js', src_line=0, src_col=9, name='multiply')\n \n+ # Start of minified file (exact match first line/col tuple)\n+ result = find_source(indexed_sourcemap, 1, 0)\n+ assert result == SourceMap(dst_line=0, dst_col=0, src='foo/file1.js', src_line=0, src_col=0, name=None)\n+\n+ # Last character in mapping\n+ result = find_source(indexed_sourcemap, 1, 36)\n+ assert result == SourceMap(dst_line=0, dst_col=30, src='foo/file1.js', src_line=2, src_col=1, name=None)\n+\n+ # First character in mapping (exact match line/col tuple)\n+ result = find_source(indexed_sourcemap, 1, 37)\n+ assert result == SourceMap(dst_line=0, dst_col=37, src='foo/file1.js', src_line=2, src_col=8, name='a')\n+\n+ # End of minified file (character *beyond* last line/col tuple)\n+ result = find_source(indexed_sourcemap, 1, 192)\n+ assert result == SourceMap(dst_line=0, dst_col=191, src='foo/file2.js', src_line=9, src_col=25, name='e')\n+\n \n class ParseSourcemapTest(TestCase):\n def test_basic(self):\n"}}},{"rowIdx":4671,"cells":{"in_source_id":{"kind":"string","value":"googleapis__google-cloud-python-3517"},"issue":{"kind":"string","value":"Broken link\nHello,\r\n\r\nI found that the link at [https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/core/google/cloud/client.py#L33][1] is broken.\r\n\r\nhttps://google-cloud-python.readthedocs.io/en/latest/google-cloud-auth.html\r\n\r\n[1]: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/661816540f1387bcc6e08b0fd722f4abae585b37/core/google/cloud/client.py#L33\n"},"before_files":{"kind":"list like","value":[{"content":"# Copyright 2015 Google 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\"\"\"Base classes for client used to interact with Google Cloud APIs.\"\"\"\n\nimport io\nimport json\nfrom pickle import PicklingError\n\nimport google.auth.credentials\nfrom google.oauth2 import service_account\nimport google_auth_httplib2\nimport six\n\nfrom google.cloud._helpers import _determine_default_project\nfrom google.cloud.credentials import get_credentials\n\n\n_GOOGLE_AUTH_CREDENTIALS_HELP = (\n 'This library only supports credentials from google-auth-library-python. '\n 'See https://google-cloud-python.readthedocs.io/en/latest/'\n 'google-cloud-auth.html for help on authentication with this library.'\n)\n\n\nclass _ClientFactoryMixin(object):\n \"\"\"Mixin to allow factories that create credentials.\n\n .. note::\n\n This class is virtual.\n \"\"\"\n\n _SET_PROJECT = False\n\n @classmethod\n def from_service_account_json(cls, json_credentials_path, *args, **kwargs):\n \"\"\"Factory to retrieve JSON credentials while creating client.\n\n :type json_credentials_path: str\n :param json_credentials_path: The path to a private key file (this file\n was given to you when you created the\n service account). This file must contain\n a JSON object with a private key and\n other credentials information (downloaded\n from the Google APIs console).\n\n :type args: tuple\n :param args: Remaining positional arguments to pass to constructor.\n\n :type kwargs: dict\n :param kwargs: Remaining keyword arguments to pass to constructor.\n\n :rtype: :class:`_ClientFactoryMixin`\n :returns: The client created with the retrieved JSON credentials.\n :raises: :class:`TypeError` if there is a conflict with the kwargs\n and the credentials created by the factory.\n \"\"\"\n if 'credentials' in kwargs:\n raise TypeError('credentials must not be in keyword arguments')\n with io.open(json_credentials_path, 'r', encoding='utf-8') as json_fi:\n credentials_info = json.load(json_fi)\n credentials = service_account.Credentials.from_service_account_info(\n credentials_info)\n if cls._SET_PROJECT:\n if 'project' not in kwargs:\n kwargs['project'] = credentials_info.get('project_id')\n\n kwargs['credentials'] = credentials\n return cls(*args, **kwargs)\n\n\nclass Client(_ClientFactoryMixin):\n \"\"\"Client to bundle configuration needed for API requests.\n\n Stores ``credentials`` and an HTTP object so that subclasses\n can pass them along to a connection class.\n\n If no value is passed in for ``_http``, a :class:`httplib2.Http` object\n will be created and authorized with the ``credentials``. If not, the\n ``credentials`` and ``_http`` need not be related.\n\n Callers and subclasses may seek to use the private key from\n ``credentials`` to sign data.\n\n A custom (non-``httplib2``) HTTP object must have a ``request`` method\n which accepts the following arguments:\n\n * ``uri``\n * ``method``\n * ``body``\n * ``headers``\n\n In addition, ``redirections`` and ``connection_type`` may be used.\n\n A custom ``_http`` object will also need to be able to add a bearer token\n to API requests and handle token refresh on 401 errors.\n\n :type credentials: :class:`~google.auth.credentials.Credentials`\n :param credentials: (Optional) The OAuth2 Credentials to use for this\n client. If not passed (and if no ``_http`` object is\n passed), falls back to the default inferred from the\n environment.\n\n :type _http: :class:`~httplib2.Http`\n :param _http: (Optional) HTTP object to make requests. Can be any object\n that defines ``request()`` with the same interface as\n :meth:`~httplib2.Http.request`. If not passed, an\n ``_http`` object is created that is bound to the\n ``credentials`` for the current object.\n This parameter should be considered private, and could\n change in the future.\n \"\"\"\n\n SCOPE = None\n \"\"\"The scopes required for authenticating with a service.\n\n Needs to be set by subclasses.\n \"\"\"\n\n def __init__(self, credentials=None, _http=None):\n if (credentials is not None and\n not isinstance(\n credentials, google.auth.credentials.Credentials)):\n raise ValueError(_GOOGLE_AUTH_CREDENTIALS_HELP)\n if credentials is None and _http is None:\n credentials = get_credentials()\n self._credentials = google.auth.credentials.with_scopes_if_required(\n credentials, self.SCOPE)\n self._http_internal = _http\n\n def __getstate__(self):\n \"\"\"Explicitly state that clients are not pickleable.\"\"\"\n raise PicklingError('\\n'.join([\n 'Pickling client objects is explicitly not supported.',\n 'Clients have non-trivial state that is local and unpickleable.',\n ]))\n\n @property\n def _http(self):\n \"\"\"Getter for object used for HTTP transport.\n\n :rtype: :class:`~httplib2.Http`\n :returns: An HTTP object.\n \"\"\"\n if self._http_internal is None:\n self._http_internal = google_auth_httplib2.AuthorizedHttp(\n self._credentials)\n return self._http_internal\n\n\nclass _ClientProjectMixin(object):\n \"\"\"Mixin to allow setting the project on the client.\n\n :type project: str\n :param project: the project which the client acts on behalf of. If not\n passed falls back to the default inferred from the\n environment.\n\n :raises: :class:`EnvironmentError` if the project is neither passed in nor\n set in the environment. :class:`ValueError` if the project value\n is invalid.\n \"\"\"\n\n def __init__(self, project=None):\n project = self._determine_default(project)\n if project is None:\n raise EnvironmentError('Project was not passed and could not be '\n 'determined from the environment.')\n if isinstance(project, six.binary_type):\n project = project.decode('utf-8')\n if not isinstance(project, six.string_types):\n raise ValueError('Project must be a string.')\n self.project = project\n\n @staticmethod\n def _determine_default(project):\n \"\"\"Helper: use default project detection.\"\"\"\n return _determine_default_project(project)\n\n\nclass ClientWithProject(Client, _ClientProjectMixin):\n \"\"\"Client that also stores a project.\n\n :type project: str\n :param project: the project which the client acts on behalf of. If not\n passed falls back to the default inferred from the\n environment.\n\n :type credentials: :class:`~google.auth.credentials.Credentials`\n :param credentials: (Optional) The OAuth2 Credentials to use for this\n client. If not passed (and if no ``_http`` object is\n passed), falls back to the default inferred from the\n environment.\n\n :type _http: :class:`~httplib2.Http`\n :param _http: (Optional) HTTP object to make requests. Can be any object\n that defines ``request()`` with the same interface as\n :meth:`~httplib2.Http.request`. If not passed, an\n ``_http`` object is created that is bound to the\n ``credentials`` for the current object.\n This parameter should be considered private, and could\n change in the future.\n\n :raises: :class:`ValueError` if the project is neither passed in nor\n set in the environment.\n \"\"\"\n\n _SET_PROJECT = True # Used by from_service_account_json()\n\n def __init__(self, project=None, credentials=None, _http=None):\n _ClientProjectMixin.__init__(self, project=project)\n Client.__init__(self, credentials=credentials, _http=_http)\n","path":"core/google/cloud/client.py"}],"string":"[\n {\n \"content\": \"# Copyright 2015 Google 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\\\"\\\"\\\"Base classes for client used to interact with Google Cloud APIs.\\\"\\\"\\\"\\n\\nimport io\\nimport json\\nfrom pickle import PicklingError\\n\\nimport google.auth.credentials\\nfrom google.oauth2 import service_account\\nimport google_auth_httplib2\\nimport six\\n\\nfrom google.cloud._helpers import _determine_default_project\\nfrom google.cloud.credentials import get_credentials\\n\\n\\n_GOOGLE_AUTH_CREDENTIALS_HELP = (\\n 'This library only supports credentials from google-auth-library-python. '\\n 'See https://google-cloud-python.readthedocs.io/en/latest/'\\n 'google-cloud-auth.html for help on authentication with this library.'\\n)\\n\\n\\nclass _ClientFactoryMixin(object):\\n \\\"\\\"\\\"Mixin to allow factories that create credentials.\\n\\n .. note::\\n\\n This class is virtual.\\n \\\"\\\"\\\"\\n\\n _SET_PROJECT = False\\n\\n @classmethod\\n def from_service_account_json(cls, json_credentials_path, *args, **kwargs):\\n \\\"\\\"\\\"Factory to retrieve JSON credentials while creating client.\\n\\n :type json_credentials_path: str\\n :param json_credentials_path: The path to a private key file (this file\\n was given to you when you created the\\n service account). This file must contain\\n a JSON object with a private key and\\n other credentials information (downloaded\\n from the Google APIs console).\\n\\n :type args: tuple\\n :param args: Remaining positional arguments to pass to constructor.\\n\\n :type kwargs: dict\\n :param kwargs: Remaining keyword arguments to pass to constructor.\\n\\n :rtype: :class:`_ClientFactoryMixin`\\n :returns: The client created with the retrieved JSON credentials.\\n :raises: :class:`TypeError` if there is a conflict with the kwargs\\n and the credentials created by the factory.\\n \\\"\\\"\\\"\\n if 'credentials' in kwargs:\\n raise TypeError('credentials must not be in keyword arguments')\\n with io.open(json_credentials_path, 'r', encoding='utf-8') as json_fi:\\n credentials_info = json.load(json_fi)\\n credentials = service_account.Credentials.from_service_account_info(\\n credentials_info)\\n if cls._SET_PROJECT:\\n if 'project' not in kwargs:\\n kwargs['project'] = credentials_info.get('project_id')\\n\\n kwargs['credentials'] = credentials\\n return cls(*args, **kwargs)\\n\\n\\nclass Client(_ClientFactoryMixin):\\n \\\"\\\"\\\"Client to bundle configuration needed for API requests.\\n\\n Stores ``credentials`` and an HTTP object so that subclasses\\n can pass them along to a connection class.\\n\\n If no value is passed in for ``_http``, a :class:`httplib2.Http` object\\n will be created and authorized with the ``credentials``. If not, the\\n ``credentials`` and ``_http`` need not be related.\\n\\n Callers and subclasses may seek to use the private key from\\n ``credentials`` to sign data.\\n\\n A custom (non-``httplib2``) HTTP object must have a ``request`` method\\n which accepts the following arguments:\\n\\n * ``uri``\\n * ``method``\\n * ``body``\\n * ``headers``\\n\\n In addition, ``redirections`` and ``connection_type`` may be used.\\n\\n A custom ``_http`` object will also need to be able to add a bearer token\\n to API requests and handle token refresh on 401 errors.\\n\\n :type credentials: :class:`~google.auth.credentials.Credentials`\\n :param credentials: (Optional) The OAuth2 Credentials to use for this\\n client. If not passed (and if no ``_http`` object is\\n passed), falls back to the default inferred from the\\n environment.\\n\\n :type _http: :class:`~httplib2.Http`\\n :param _http: (Optional) HTTP object to make requests. Can be any object\\n that defines ``request()`` with the same interface as\\n :meth:`~httplib2.Http.request`. If not passed, an\\n ``_http`` object is created that is bound to the\\n ``credentials`` for the current object.\\n This parameter should be considered private, and could\\n change in the future.\\n \\\"\\\"\\\"\\n\\n SCOPE = None\\n \\\"\\\"\\\"The scopes required for authenticating with a service.\\n\\n Needs to be set by subclasses.\\n \\\"\\\"\\\"\\n\\n def __init__(self, credentials=None, _http=None):\\n if (credentials is not None and\\n not isinstance(\\n credentials, google.auth.credentials.Credentials)):\\n raise ValueError(_GOOGLE_AUTH_CREDENTIALS_HELP)\\n if credentials is None and _http is None:\\n credentials = get_credentials()\\n self._credentials = google.auth.credentials.with_scopes_if_required(\\n credentials, self.SCOPE)\\n self._http_internal = _http\\n\\n def __getstate__(self):\\n \\\"\\\"\\\"Explicitly state that clients are not pickleable.\\\"\\\"\\\"\\n raise PicklingError('\\\\n'.join([\\n 'Pickling client objects is explicitly not supported.',\\n 'Clients have non-trivial state that is local and unpickleable.',\\n ]))\\n\\n @property\\n def _http(self):\\n \\\"\\\"\\\"Getter for object used for HTTP transport.\\n\\n :rtype: :class:`~httplib2.Http`\\n :returns: An HTTP object.\\n \\\"\\\"\\\"\\n if self._http_internal is None:\\n self._http_internal = google_auth_httplib2.AuthorizedHttp(\\n self._credentials)\\n return self._http_internal\\n\\n\\nclass _ClientProjectMixin(object):\\n \\\"\\\"\\\"Mixin to allow setting the project on the client.\\n\\n :type project: str\\n :param project: the project which the client acts on behalf of. If not\\n passed falls back to the default inferred from the\\n environment.\\n\\n :raises: :class:`EnvironmentError` if the project is neither passed in nor\\n set in the environment. :class:`ValueError` if the project value\\n is invalid.\\n \\\"\\\"\\\"\\n\\n def __init__(self, project=None):\\n project = self._determine_default(project)\\n if project is None:\\n raise EnvironmentError('Project was not passed and could not be '\\n 'determined from the environment.')\\n if isinstance(project, six.binary_type):\\n project = project.decode('utf-8')\\n if not isinstance(project, six.string_types):\\n raise ValueError('Project must be a string.')\\n self.project = project\\n\\n @staticmethod\\n def _determine_default(project):\\n \\\"\\\"\\\"Helper: use default project detection.\\\"\\\"\\\"\\n return _determine_default_project(project)\\n\\n\\nclass ClientWithProject(Client, _ClientProjectMixin):\\n \\\"\\\"\\\"Client that also stores a project.\\n\\n :type project: str\\n :param project: the project which the client acts on behalf of. If not\\n passed falls back to the default inferred from the\\n environment.\\n\\n :type credentials: :class:`~google.auth.credentials.Credentials`\\n :param credentials: (Optional) The OAuth2 Credentials to use for this\\n client. If not passed (and if no ``_http`` object is\\n passed), falls back to the default inferred from the\\n environment.\\n\\n :type _http: :class:`~httplib2.Http`\\n :param _http: (Optional) HTTP object to make requests. Can be any object\\n that defines ``request()`` with the same interface as\\n :meth:`~httplib2.Http.request`. If not passed, an\\n ``_http`` object is created that is bound to the\\n ``credentials`` for the current object.\\n This parameter should be considered private, and could\\n change in the future.\\n\\n :raises: :class:`ValueError` if the project is neither passed in nor\\n set in the environment.\\n \\\"\\\"\\\"\\n\\n _SET_PROJECT = True # Used by from_service_account_json()\\n\\n def __init__(self, project=None, credentials=None, _http=None):\\n _ClientProjectMixin.__init__(self, project=project)\\n Client.__init__(self, credentials=credentials, _http=_http)\\n\",\n \"path\": \"core/google/cloud/client.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# Copyright 2015 Google 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\"\"\"Base classes for client used to interact with Google Cloud APIs.\"\"\"\n\nimport io\nimport json\nfrom pickle import PicklingError\n\nimport google.auth.credentials\nfrom google.oauth2 import service_account\nimport google_auth_httplib2\nimport six\n\nfrom google.cloud._helpers import _determine_default_project\nfrom google.cloud.credentials import get_credentials\n\n\n_GOOGLE_AUTH_CREDENTIALS_HELP = (\n 'This library only supports credentials from google-auth-library-python. '\n 'See https://google-cloud-python.readthedocs.io/en/latest/core/auth.html '\n 'for help on authentication with this library.'\n)\n\n\nclass _ClientFactoryMixin(object):\n \"\"\"Mixin to allow factories that create credentials.\n\n .. note::\n\n This class is virtual.\n \"\"\"\n\n _SET_PROJECT = False\n\n @classmethod\n def from_service_account_json(cls, json_credentials_path, *args, **kwargs):\n \"\"\"Factory to retrieve JSON credentials while creating client.\n\n :type json_credentials_path: str\n :param json_credentials_path: The path to a private key file (this file\n was given to you when you created the\n service account). This file must contain\n a JSON object with a private key and\n other credentials information (downloaded\n from the Google APIs console).\n\n :type args: tuple\n :param args: Remaining positional arguments to pass to constructor.\n\n :type kwargs: dict\n :param kwargs: Remaining keyword arguments to pass to constructor.\n\n :rtype: :class:`_ClientFactoryMixin`\n :returns: The client created with the retrieved JSON credentials.\n :raises: :class:`TypeError` if there is a conflict with the kwargs\n and the credentials created by the factory.\n \"\"\"\n if 'credentials' in kwargs:\n raise TypeError('credentials must not be in keyword arguments')\n with io.open(json_credentials_path, 'r', encoding='utf-8') as json_fi:\n credentials_info = json.load(json_fi)\n credentials = service_account.Credentials.from_service_account_info(\n credentials_info)\n if cls._SET_PROJECT:\n if 'project' not in kwargs:\n kwargs['project'] = credentials_info.get('project_id')\n\n kwargs['credentials'] = credentials\n return cls(*args, **kwargs)\n\n\nclass Client(_ClientFactoryMixin):\n \"\"\"Client to bundle configuration needed for API requests.\n\n Stores ``credentials`` and an HTTP object so that subclasses\n can pass them along to a connection class.\n\n If no value is passed in for ``_http``, a :class:`httplib2.Http` object\n will be created and authorized with the ``credentials``. If not, the\n ``credentials`` and ``_http`` need not be related.\n\n Callers and subclasses may seek to use the private key from\n ``credentials`` to sign data.\n\n A custom (non-``httplib2``) HTTP object must have a ``request`` method\n which accepts the following arguments:\n\n * ``uri``\n * ``method``\n * ``body``\n * ``headers``\n\n In addition, ``redirections`` and ``connection_type`` may be used.\n\n A custom ``_http`` object will also need to be able to add a bearer token\n to API requests and handle token refresh on 401 errors.\n\n :type credentials: :class:`~google.auth.credentials.Credentials`\n :param credentials: (Optional) The OAuth2 Credentials to use for this\n client. If not passed (and if no ``_http`` object is\n passed), falls back to the default inferred from the\n environment.\n\n :type _http: :class:`~httplib2.Http`\n :param _http: (Optional) HTTP object to make requests. Can be any object\n that defines ``request()`` with the same interface as\n :meth:`~httplib2.Http.request`. If not passed, an\n ``_http`` object is created that is bound to the\n ``credentials`` for the current object.\n This parameter should be considered private, and could\n change in the future.\n \"\"\"\n\n SCOPE = None\n \"\"\"The scopes required for authenticating with a service.\n\n Needs to be set by subclasses.\n \"\"\"\n\n def __init__(self, credentials=None, _http=None):\n if (credentials is not None and\n not isinstance(\n credentials, google.auth.credentials.Credentials)):\n raise ValueError(_GOOGLE_AUTH_CREDENTIALS_HELP)\n if credentials is None and _http is None:\n credentials = get_credentials()\n self._credentials = google.auth.credentials.with_scopes_if_required(\n credentials, self.SCOPE)\n self._http_internal = _http\n\n def __getstate__(self):\n \"\"\"Explicitly state that clients are not pickleable.\"\"\"\n raise PicklingError('\\n'.join([\n 'Pickling client objects is explicitly not supported.',\n 'Clients have non-trivial state that is local and unpickleable.',\n ]))\n\n @property\n def _http(self):\n \"\"\"Getter for object used for HTTP transport.\n\n :rtype: :class:`~httplib2.Http`\n :returns: An HTTP object.\n \"\"\"\n if self._http_internal is None:\n self._http_internal = google_auth_httplib2.AuthorizedHttp(\n self._credentials)\n return self._http_internal\n\n\nclass _ClientProjectMixin(object):\n \"\"\"Mixin to allow setting the project on the client.\n\n :type project: str\n :param project: the project which the client acts on behalf of. If not\n passed falls back to the default inferred from the\n environment.\n\n :raises: :class:`EnvironmentError` if the project is neither passed in nor\n set in the environment. :class:`ValueError` if the project value\n is invalid.\n \"\"\"\n\n def __init__(self, project=None):\n project = self._determine_default(project)\n if project is None:\n raise EnvironmentError('Project was not passed and could not be '\n 'determined from the environment.')\n if isinstance(project, six.binary_type):\n project = project.decode('utf-8')\n if not isinstance(project, six.string_types):\n raise ValueError('Project must be a string.')\n self.project = project\n\n @staticmethod\n def _determine_default(project):\n \"\"\"Helper: use default project detection.\"\"\"\n return _determine_default_project(project)\n\n\nclass ClientWithProject(Client, _ClientProjectMixin):\n \"\"\"Client that also stores a project.\n\n :type project: str\n :param project: the project which the client acts on behalf of. If not\n passed falls back to the default inferred from the\n environment.\n\n :type credentials: :class:`~google.auth.credentials.Credentials`\n :param credentials: (Optional) The OAuth2 Credentials to use for this\n client. If not passed (and if no ``_http`` object is\n passed), falls back to the default inferred from the\n environment.\n\n :type _http: :class:`~httplib2.Http`\n :param _http: (Optional) HTTP object to make requests. Can be any object\n that defines ``request()`` with the same interface as\n :meth:`~httplib2.Http.request`. If not passed, an\n ``_http`` object is created that is bound to the\n ``credentials`` for the current object.\n This parameter should be considered private, and could\n change in the future.\n\n :raises: :class:`ValueError` if the project is neither passed in nor\n set in the environment.\n \"\"\"\n\n _SET_PROJECT = True # Used by from_service_account_json()\n\n def __init__(self, project=None, credentials=None, _http=None):\n _ClientProjectMixin.__init__(self, project=project)\n Client.__init__(self, credentials=credentials, _http=_http)\n","path":"core/google/cloud/client.py"}],"string":"[\n {\n \"content\": \"# Copyright 2015 Google 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\\\"\\\"\\\"Base classes for client used to interact with Google Cloud APIs.\\\"\\\"\\\"\\n\\nimport io\\nimport json\\nfrom pickle import PicklingError\\n\\nimport google.auth.credentials\\nfrom google.oauth2 import service_account\\nimport google_auth_httplib2\\nimport six\\n\\nfrom google.cloud._helpers import _determine_default_project\\nfrom google.cloud.credentials import get_credentials\\n\\n\\n_GOOGLE_AUTH_CREDENTIALS_HELP = (\\n 'This library only supports credentials from google-auth-library-python. '\\n 'See https://google-cloud-python.readthedocs.io/en/latest/core/auth.html '\\n 'for help on authentication with this library.'\\n)\\n\\n\\nclass _ClientFactoryMixin(object):\\n \\\"\\\"\\\"Mixin to allow factories that create credentials.\\n\\n .. note::\\n\\n This class is virtual.\\n \\\"\\\"\\\"\\n\\n _SET_PROJECT = False\\n\\n @classmethod\\n def from_service_account_json(cls, json_credentials_path, *args, **kwargs):\\n \\\"\\\"\\\"Factory to retrieve JSON credentials while creating client.\\n\\n :type json_credentials_path: str\\n :param json_credentials_path: The path to a private key file (this file\\n was given to you when you created the\\n service account). This file must contain\\n a JSON object with a private key and\\n other credentials information (downloaded\\n from the Google APIs console).\\n\\n :type args: tuple\\n :param args: Remaining positional arguments to pass to constructor.\\n\\n :type kwargs: dict\\n :param kwargs: Remaining keyword arguments to pass to constructor.\\n\\n :rtype: :class:`_ClientFactoryMixin`\\n :returns: The client created with the retrieved JSON credentials.\\n :raises: :class:`TypeError` if there is a conflict with the kwargs\\n and the credentials created by the factory.\\n \\\"\\\"\\\"\\n if 'credentials' in kwargs:\\n raise TypeError('credentials must not be in keyword arguments')\\n with io.open(json_credentials_path, 'r', encoding='utf-8') as json_fi:\\n credentials_info = json.load(json_fi)\\n credentials = service_account.Credentials.from_service_account_info(\\n credentials_info)\\n if cls._SET_PROJECT:\\n if 'project' not in kwargs:\\n kwargs['project'] = credentials_info.get('project_id')\\n\\n kwargs['credentials'] = credentials\\n return cls(*args, **kwargs)\\n\\n\\nclass Client(_ClientFactoryMixin):\\n \\\"\\\"\\\"Client to bundle configuration needed for API requests.\\n\\n Stores ``credentials`` and an HTTP object so that subclasses\\n can pass them along to a connection class.\\n\\n If no value is passed in for ``_http``, a :class:`httplib2.Http` object\\n will be created and authorized with the ``credentials``. If not, the\\n ``credentials`` and ``_http`` need not be related.\\n\\n Callers and subclasses may seek to use the private key from\\n ``credentials`` to sign data.\\n\\n A custom (non-``httplib2``) HTTP object must have a ``request`` method\\n which accepts the following arguments:\\n\\n * ``uri``\\n * ``method``\\n * ``body``\\n * ``headers``\\n\\n In addition, ``redirections`` and ``connection_type`` may be used.\\n\\n A custom ``_http`` object will also need to be able to add a bearer token\\n to API requests and handle token refresh on 401 errors.\\n\\n :type credentials: :class:`~google.auth.credentials.Credentials`\\n :param credentials: (Optional) The OAuth2 Credentials to use for this\\n client. If not passed (and if no ``_http`` object is\\n passed), falls back to the default inferred from the\\n environment.\\n\\n :type _http: :class:`~httplib2.Http`\\n :param _http: (Optional) HTTP object to make requests. Can be any object\\n that defines ``request()`` with the same interface as\\n :meth:`~httplib2.Http.request`. If not passed, an\\n ``_http`` object is created that is bound to the\\n ``credentials`` for the current object.\\n This parameter should be considered private, and could\\n change in the future.\\n \\\"\\\"\\\"\\n\\n SCOPE = None\\n \\\"\\\"\\\"The scopes required for authenticating with a service.\\n\\n Needs to be set by subclasses.\\n \\\"\\\"\\\"\\n\\n def __init__(self, credentials=None, _http=None):\\n if (credentials is not None and\\n not isinstance(\\n credentials, google.auth.credentials.Credentials)):\\n raise ValueError(_GOOGLE_AUTH_CREDENTIALS_HELP)\\n if credentials is None and _http is None:\\n credentials = get_credentials()\\n self._credentials = google.auth.credentials.with_scopes_if_required(\\n credentials, self.SCOPE)\\n self._http_internal = _http\\n\\n def __getstate__(self):\\n \\\"\\\"\\\"Explicitly state that clients are not pickleable.\\\"\\\"\\\"\\n raise PicklingError('\\\\n'.join([\\n 'Pickling client objects is explicitly not supported.',\\n 'Clients have non-trivial state that is local and unpickleable.',\\n ]))\\n\\n @property\\n def _http(self):\\n \\\"\\\"\\\"Getter for object used for HTTP transport.\\n\\n :rtype: :class:`~httplib2.Http`\\n :returns: An HTTP object.\\n \\\"\\\"\\\"\\n if self._http_internal is None:\\n self._http_internal = google_auth_httplib2.AuthorizedHttp(\\n self._credentials)\\n return self._http_internal\\n\\n\\nclass _ClientProjectMixin(object):\\n \\\"\\\"\\\"Mixin to allow setting the project on the client.\\n\\n :type project: str\\n :param project: the project which the client acts on behalf of. If not\\n passed falls back to the default inferred from the\\n environment.\\n\\n :raises: :class:`EnvironmentError` if the project is neither passed in nor\\n set in the environment. :class:`ValueError` if the project value\\n is invalid.\\n \\\"\\\"\\\"\\n\\n def __init__(self, project=None):\\n project = self._determine_default(project)\\n if project is None:\\n raise EnvironmentError('Project was not passed and could not be '\\n 'determined from the environment.')\\n if isinstance(project, six.binary_type):\\n project = project.decode('utf-8')\\n if not isinstance(project, six.string_types):\\n raise ValueError('Project must be a string.')\\n self.project = project\\n\\n @staticmethod\\n def _determine_default(project):\\n \\\"\\\"\\\"Helper: use default project detection.\\\"\\\"\\\"\\n return _determine_default_project(project)\\n\\n\\nclass ClientWithProject(Client, _ClientProjectMixin):\\n \\\"\\\"\\\"Client that also stores a project.\\n\\n :type project: str\\n :param project: the project which the client acts on behalf of. If not\\n passed falls back to the default inferred from the\\n environment.\\n\\n :type credentials: :class:`~google.auth.credentials.Credentials`\\n :param credentials: (Optional) The OAuth2 Credentials to use for this\\n client. If not passed (and if no ``_http`` object is\\n passed), falls back to the default inferred from the\\n environment.\\n\\n :type _http: :class:`~httplib2.Http`\\n :param _http: (Optional) HTTP object to make requests. Can be any object\\n that defines ``request()`` with the same interface as\\n :meth:`~httplib2.Http.request`. If not passed, an\\n ``_http`` object is created that is bound to the\\n ``credentials`` for the current object.\\n This parameter should be considered private, and could\\n change in the future.\\n\\n :raises: :class:`ValueError` if the project is neither passed in nor\\n set in the environment.\\n \\\"\\\"\\\"\\n\\n _SET_PROJECT = True # Used by from_service_account_json()\\n\\n def __init__(self, project=None, credentials=None, _http=None):\\n _ClientProjectMixin.__init__(self, project=project)\\n Client.__init__(self, credentials=credentials, _http=_http)\\n\",\n \"path\": \"core/google/cloud/client.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/core/google/cloud/client.py b/core/google/cloud/client.py\nindex e7e43faf1e45..9bdbf507d201 100644\n--- a/core/google/cloud/client.py\n+++ b/core/google/cloud/client.py\n@@ -29,8 +29,8 @@\n \n _GOOGLE_AUTH_CREDENTIALS_HELP = (\n 'This library only supports credentials from google-auth-library-python. '\n- 'See https://google-cloud-python.readthedocs.io/en/latest/'\n- 'google-cloud-auth.html for help on authentication with this library.'\n+ 'See https://google-cloud-python.readthedocs.io/en/latest/core/auth.html '\n+ 'for help on authentication with this library.'\n )\n \n \n"}}},{"rowIdx":4672,"cells":{"in_source_id":{"kind":"string","value":"translate__pootle-4350"},"issue":{"kind":"string","value":"Editor templates broken in non-debug mode\nSince switching to Django 1.8 in master, the [scripts section of the editor templates](https://github.com/translate/pootle/blob/master/pootle/templates/editor/_scripts.html) doesn't render when `DEBUG = False`.\n\nI might be doing something wrong, but I tried removing any template customizations we have, also clearing out caches, trying different browsers, always with the same result. I can reproduce this locally and in our staging server.\n\n"},"before_files":{"kind":"list like","value":[{"content":"#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n#\n# Copyright (C) Pootle contributors.\n#\n# This file is a part of the Pootle project. It is distributed under the GPL3\n# or later license. See the LICENSE file for a copy of the license and the\n# AUTHORS file for copyright and authorship information.\n\nimport re\n\nfrom diff_match_patch import diff_match_patch\nfrom translate.misc.multistring import multistring\nfrom translate.storage.placeables import general\n\nfrom django import template\nfrom django.core.exceptions import ObjectDoesNotExist\nfrom django.template.defaultfilters import stringfilter\nfrom django.template.loader import get_template\nfrom django.utils.safestring import mark_safe\nfrom django.utils.translation import ugettext as _\n\nfrom pootle_store.fields import list_empty\n\n\nregister = template.Library()\n\n\nIMAGE_URL_RE = re.compile(\"(https?://[^\\s]+\\.(png|jpe?g|gif))\", re.IGNORECASE)\n\n\n@register.filter\ndef image_urls(text):\n \"\"\"Return a list of image URLs extracted from `text`.\"\"\"\n return map(lambda x: x[0], IMAGE_URL_RE.findall(text))\n\n\nESCAPE_RE = re.compile('<[^<]*?>|\\\\\\\\|\\r\\n|[\\r\\n\\t&<>]')\n\n\ndef fancy_escape(text):\n \"\"\"Replace special chars with entities, and highlight XML tags and\n whitespaces.\n \"\"\"\n def replace(match):\n escape_highlight = ('<span class=\"highlight-escape '\n 'js-editor-copytext\">%s</span>')\n submap = {\n '\\r\\n': (escape_highlight % '\\\\r\\\\n') + '<br/>\\n',\n '\\r': (escape_highlight % '\\\\r') + '<br/>\\n',\n '\\n': (escape_highlight % '\\\\n') + '<br/>\\n',\n '\\t': (escape_highlight % '\\\\t'),\n '&': '&',\n '<': '<',\n '>': '>',\n '\\\\': (escape_highlight % '\\\\\\\\'),\n }\n try:\n return submap[match.group()]\n except KeyError:\n html_highlight = ('<span class=\"highlight-html '\n 'js-editor-copytext\"><%s></span>')\n return html_highlight % fancy_escape(match.group()[1:-1])\n\n return ESCAPE_RE.sub(replace, text)\n\n\nWHITESPACE_RE = re.compile('^ +| +$|[\\r\\n\\t] +| {2,}')\n\n\ndef fancy_spaces(text):\n \"\"\"Highlight spaces to make them easily visible.\"\"\"\n def replace(match):\n fancy_space = '<span class=\"translation-space\"> </span>'\n if match.group().startswith(' '):\n return fancy_space * len(match.group())\n return match.group()[0] + fancy_space * (len(match.group()) - 1)\n return WHITESPACE_RE.sub(replace, text)\n\n\nPUNCTUATION_RE = general.PunctuationPlaceable().regex\n\n\ndef fancy_punctuation_chars(text):\n \"\"\"Wrap punctuation chars found in the ``text`` around tags.\"\"\"\n def replace(match):\n fancy_special_char = ('<span class=\"highlight-punctuation '\n 'js-editor-copytext\">%s</span>')\n return fancy_special_char % match.group()\n\n return PUNCTUATION_RE.sub(replace, text)\n\n\n@register.filter\n@stringfilter\ndef fancy_highlight(text):\n return mark_safe(fancy_punctuation_chars(fancy_spaces(fancy_escape(text))))\n\n\ndef call_highlight(old, new):\n \"\"\"Calls diff highlighting code only if the target is set.\n Otherwise, highlight as a normal unit.\n \"\"\"\n if isinstance(old, multistring):\n old_value = old.strings\n else:\n old_value = old\n\n if list_empty(old_value):\n return fancy_highlight(new)\n\n return highlight_diffs(old, new)\n\n\ndifferencer = diff_match_patch()\n\n\ndef highlight_diffs(old, new):\n \"\"\"Highlight the differences between old and new.\"\"\"\n\n textdiff = u\"\" # to store the final result\n removed = u\"\" # the removed text that we might still want to add\n diff = differencer.diff_main(old, new)\n differencer.diff_cleanupSemantic(diff)\n for op, text in diff:\n if op == 0: # equality\n if removed:\n textdiff += '<span class=\"diff-delete\">%s</span>' % \\\n fancy_escape(removed)\n removed = u\"\"\n textdiff += fancy_escape(text)\n elif op == 1: # insertion\n if removed:\n # this is part of a substitution, not a plain insertion. We\n # will format this differently.\n textdiff += '<span class=\"diff-replace\">%s</span>' % \\\n fancy_escape(text)\n removed = u\"\"\n else:\n textdiff += '<span class=\"diff-insert\">%s</span>' % \\\n fancy_escape(text)\n elif op == -1: # deletion\n removed = text\n if removed:\n textdiff += '<span class=\"diff-delete\">%s</span>' % \\\n fancy_escape(removed)\n return mark_safe(textdiff)\n\n\n@register.filter('pluralize_source')\ndef pluralize_source(unit):\n if not unit.hasplural():\n return [(0, unit.source, None)]\n\n count = len(unit.source.strings)\n if count == 1:\n return [(0, unit.source.strings[0], \"%s+%s\" % (_('Singular'),\n _('Plural')))]\n\n if count == 2:\n return [(0, unit.source.strings[0], _('Singular')),\n (1, unit.source.strings[1], _('Plural'))]\n\n forms = []\n for i, source in enumerate(unit.source.strings):\n forms.append((i, source, _('Plural Form %d', i)))\n return forms\n\n\n@register.filter('pluralize_target')\ndef pluralize_target(unit, nplurals=None):\n if not unit.hasplural():\n return [(0, unit.target, None)]\n\n if nplurals is None:\n try:\n nplurals = unit.store.translation_project.language.nplurals\n except ObjectDoesNotExist:\n pass\n forms = []\n if nplurals is None:\n for i, target in enumerate(unit.target.strings):\n forms.append((i, target, _('Plural Form %d', i)))\n else:\n for i in range(nplurals):\n try:\n target = unit.target.strings[i]\n except IndexError:\n target = ''\n forms.append((i, target, _('Plural Form %d', i)))\n\n return forms\n\n\n@register.filter('pluralize_diff_sugg')\ndef pluralize_diff_sugg(sugg):\n unit = sugg.unit\n if not unit.hasplural():\n return [\n (0, sugg.target, call_highlight(unit.target, sugg.target), None)\n ]\n\n forms = []\n for i, target in enumerate(sugg.target.strings):\n if i < len(unit.target.strings):\n sugg_text = unit.target.strings[i]\n else:\n sugg_text = ''\n\n forms.append((\n i, target, call_highlight(sugg_text, target),\n _('Plural Form %d', i)\n ))\n\n return forms\n\n\n@register.tag(name=\"include_raw\")\ndef do_include_raw(parser, token):\n \"\"\"\n Performs a template include without parsing the context, just dumps\n the template in.\n Source: http://djangosnippets.org/snippets/1684/\n \"\"\"\n bits = token.split_contents()\n if len(bits) != 2:\n raise template.TemplateSyntaxError(\n \"%r tag takes one argument: the name of the template \"\n \"to be included\" % bits[0]\n )\n\n template_name = bits[1]\n if (template_name[0] in ('\"', \"'\") and\n template_name[-1] == template_name[0]):\n template_name = template_name[1:-1]\n\n source, path = get_template(\n template_name).origin.loader(template_name)\n\n return template.base.TextNode(source)\n","path":"pootle/apps/pootle_store/templatetags/store_tags.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/env python\\n# -*- coding: utf-8 -*-\\n#\\n# Copyright (C) Pootle contributors.\\n#\\n# This file is a part of the Pootle project. It is distributed under the GPL3\\n# or later license. See the LICENSE file for a copy of the license and the\\n# AUTHORS file for copyright and authorship information.\\n\\nimport re\\n\\nfrom diff_match_patch import diff_match_patch\\nfrom translate.misc.multistring import multistring\\nfrom translate.storage.placeables import general\\n\\nfrom django import template\\nfrom django.core.exceptions import ObjectDoesNotExist\\nfrom django.template.defaultfilters import stringfilter\\nfrom django.template.loader import get_template\\nfrom django.utils.safestring import mark_safe\\nfrom django.utils.translation import ugettext as _\\n\\nfrom pootle_store.fields import list_empty\\n\\n\\nregister = template.Library()\\n\\n\\nIMAGE_URL_RE = re.compile(\\\"(https?://[^\\\\s]+\\\\.(png|jpe?g|gif))\\\", re.IGNORECASE)\\n\\n\\n@register.filter\\ndef image_urls(text):\\n \\\"\\\"\\\"Return a list of image URLs extracted from `text`.\\\"\\\"\\\"\\n return map(lambda x: x[0], IMAGE_URL_RE.findall(text))\\n\\n\\nESCAPE_RE = re.compile('<[^<]*?>|\\\\\\\\\\\\\\\\|\\\\r\\\\n|[\\\\r\\\\n\\\\t&<>]')\\n\\n\\ndef fancy_escape(text):\\n \\\"\\\"\\\"Replace special chars with entities, and highlight XML tags and\\n whitespaces.\\n \\\"\\\"\\\"\\n def replace(match):\\n escape_highlight = ('<span class=\\\"highlight-escape '\\n 'js-editor-copytext\\\">%s</span>')\\n submap = {\\n '\\\\r\\\\n': (escape_highlight % '\\\\\\\\r\\\\\\\\n') + '<br/>\\\\n',\\n '\\\\r': (escape_highlight % '\\\\\\\\r') + '<br/>\\\\n',\\n '\\\\n': (escape_highlight % '\\\\\\\\n') + '<br/>\\\\n',\\n '\\\\t': (escape_highlight % '\\\\\\\\t'),\\n '&': '&',\\n '<': '<',\\n '>': '>',\\n '\\\\\\\\': (escape_highlight % '\\\\\\\\\\\\\\\\'),\\n }\\n try:\\n return submap[match.group()]\\n except KeyError:\\n html_highlight = ('<span class=\\\"highlight-html '\\n 'js-editor-copytext\\\"><%s></span>')\\n return html_highlight % fancy_escape(match.group()[1:-1])\\n\\n return ESCAPE_RE.sub(replace, text)\\n\\n\\nWHITESPACE_RE = re.compile('^ +| +$|[\\\\r\\\\n\\\\t] +| {2,}')\\n\\n\\ndef fancy_spaces(text):\\n \\\"\\\"\\\"Highlight spaces to make them easily visible.\\\"\\\"\\\"\\n def replace(match):\\n fancy_space = '<span class=\\\"translation-space\\\"> </span>'\\n if match.group().startswith(' '):\\n return fancy_space * len(match.group())\\n return match.group()[0] + fancy_space * (len(match.group()) - 1)\\n return WHITESPACE_RE.sub(replace, text)\\n\\n\\nPUNCTUATION_RE = general.PunctuationPlaceable().regex\\n\\n\\ndef fancy_punctuation_chars(text):\\n \\\"\\\"\\\"Wrap punctuation chars found in the ``text`` around tags.\\\"\\\"\\\"\\n def replace(match):\\n fancy_special_char = ('<span class=\\\"highlight-punctuation '\\n 'js-editor-copytext\\\">%s</span>')\\n return fancy_special_char % match.group()\\n\\n return PUNCTUATION_RE.sub(replace, text)\\n\\n\\n@register.filter\\n@stringfilter\\ndef fancy_highlight(text):\\n return mark_safe(fancy_punctuation_chars(fancy_spaces(fancy_escape(text))))\\n\\n\\ndef call_highlight(old, new):\\n \\\"\\\"\\\"Calls diff highlighting code only if the target is set.\\n Otherwise, highlight as a normal unit.\\n \\\"\\\"\\\"\\n if isinstance(old, multistring):\\n old_value = old.strings\\n else:\\n old_value = old\\n\\n if list_empty(old_value):\\n return fancy_highlight(new)\\n\\n return highlight_diffs(old, new)\\n\\n\\ndifferencer = diff_match_patch()\\n\\n\\ndef highlight_diffs(old, new):\\n \\\"\\\"\\\"Highlight the differences between old and new.\\\"\\\"\\\"\\n\\n textdiff = u\\\"\\\" # to store the final result\\n removed = u\\\"\\\" # the removed text that we might still want to add\\n diff = differencer.diff_main(old, new)\\n differencer.diff_cleanupSemantic(diff)\\n for op, text in diff:\\n if op == 0: # equality\\n if removed:\\n textdiff += '<span class=\\\"diff-delete\\\">%s</span>' % \\\\\\n fancy_escape(removed)\\n removed = u\\\"\\\"\\n textdiff += fancy_escape(text)\\n elif op == 1: # insertion\\n if removed:\\n # this is part of a substitution, not a plain insertion. We\\n # will format this differently.\\n textdiff += '<span class=\\\"diff-replace\\\">%s</span>' % \\\\\\n fancy_escape(text)\\n removed = u\\\"\\\"\\n else:\\n textdiff += '<span class=\\\"diff-insert\\\">%s</span>' % \\\\\\n fancy_escape(text)\\n elif op == -1: # deletion\\n removed = text\\n if removed:\\n textdiff += '<span class=\\\"diff-delete\\\">%s</span>' % \\\\\\n fancy_escape(removed)\\n return mark_safe(textdiff)\\n\\n\\n@register.filter('pluralize_source')\\ndef pluralize_source(unit):\\n if not unit.hasplural():\\n return [(0, unit.source, None)]\\n\\n count = len(unit.source.strings)\\n if count == 1:\\n return [(0, unit.source.strings[0], \\\"%s+%s\\\" % (_('Singular'),\\n _('Plural')))]\\n\\n if count == 2:\\n return [(0, unit.source.strings[0], _('Singular')),\\n (1, unit.source.strings[1], _('Plural'))]\\n\\n forms = []\\n for i, source in enumerate(unit.source.strings):\\n forms.append((i, source, _('Plural Form %d', i)))\\n return forms\\n\\n\\n@register.filter('pluralize_target')\\ndef pluralize_target(unit, nplurals=None):\\n if not unit.hasplural():\\n return [(0, unit.target, None)]\\n\\n if nplurals is None:\\n try:\\n nplurals = unit.store.translation_project.language.nplurals\\n except ObjectDoesNotExist:\\n pass\\n forms = []\\n if nplurals is None:\\n for i, target in enumerate(unit.target.strings):\\n forms.append((i, target, _('Plural Form %d', i)))\\n else:\\n for i in range(nplurals):\\n try:\\n target = unit.target.strings[i]\\n except IndexError:\\n target = ''\\n forms.append((i, target, _('Plural Form %d', i)))\\n\\n return forms\\n\\n\\n@register.filter('pluralize_diff_sugg')\\ndef pluralize_diff_sugg(sugg):\\n unit = sugg.unit\\n if not unit.hasplural():\\n return [\\n (0, sugg.target, call_highlight(unit.target, sugg.target), None)\\n ]\\n\\n forms = []\\n for i, target in enumerate(sugg.target.strings):\\n if i < len(unit.target.strings):\\n sugg_text = unit.target.strings[i]\\n else:\\n sugg_text = ''\\n\\n forms.append((\\n i, target, call_highlight(sugg_text, target),\\n _('Plural Form %d', i)\\n ))\\n\\n return forms\\n\\n\\n@register.tag(name=\\\"include_raw\\\")\\ndef do_include_raw(parser, token):\\n \\\"\\\"\\\"\\n Performs a template include without parsing the context, just dumps\\n the template in.\\n Source: http://djangosnippets.org/snippets/1684/\\n \\\"\\\"\\\"\\n bits = token.split_contents()\\n if len(bits) != 2:\\n raise template.TemplateSyntaxError(\\n \\\"%r tag takes one argument: the name of the template \\\"\\n \\\"to be included\\\" % bits[0]\\n )\\n\\n template_name = bits[1]\\n if (template_name[0] in ('\\\"', \\\"'\\\") and\\n template_name[-1] == template_name[0]):\\n template_name = template_name[1:-1]\\n\\n source, path = get_template(\\n template_name).origin.loader(template_name)\\n\\n return template.base.TextNode(source)\\n\",\n \"path\": \"pootle/apps/pootle_store/templatetags/store_tags.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n#\n# Copyright (C) Pootle contributors.\n#\n# This file is a part of the Pootle project. It is distributed under the GPL3\n# or later license. See the LICENSE file for a copy of the license and the\n# AUTHORS file for copyright and authorship information.\n\nimport re\n\nfrom diff_match_patch import diff_match_patch\nfrom translate.misc.multistring import multistring\nfrom translate.storage.placeables import general\n\nfrom django import template\nfrom django.core.exceptions import ObjectDoesNotExist\nfrom django.template.defaultfilters import stringfilter\nfrom django.template.loader import get_template\nfrom django.utils.safestring import mark_safe\nfrom django.utils.translation import ugettext as _\n\nfrom pootle_store.fields import list_empty\n\n\nregister = template.Library()\n\n\nIMAGE_URL_RE = re.compile(\"(https?://[^\\s]+\\.(png|jpe?g|gif))\", re.IGNORECASE)\n\n\n@register.filter\ndef image_urls(text):\n \"\"\"Return a list of image URLs extracted from `text`.\"\"\"\n return map(lambda x: x[0], IMAGE_URL_RE.findall(text))\n\n\nESCAPE_RE = re.compile('<[^<]*?>|\\\\\\\\|\\r\\n|[\\r\\n\\t&<>]')\n\n\ndef fancy_escape(text):\n \"\"\"Replace special chars with entities, and highlight XML tags and\n whitespaces.\n \"\"\"\n def replace(match):\n escape_highlight = ('<span class=\"highlight-escape '\n 'js-editor-copytext\">%s</span>')\n submap = {\n '\\r\\n': (escape_highlight % '\\\\r\\\\n') + '<br/>\\n',\n '\\r': (escape_highlight % '\\\\r') + '<br/>\\n',\n '\\n': (escape_highlight % '\\\\n') + '<br/>\\n',\n '\\t': (escape_highlight % '\\\\t'),\n '&': '&',\n '<': '<',\n '>': '>',\n '\\\\': (escape_highlight % '\\\\\\\\'),\n }\n try:\n return submap[match.group()]\n except KeyError:\n html_highlight = ('<span class=\"highlight-html '\n 'js-editor-copytext\"><%s></span>')\n return html_highlight % fancy_escape(match.group()[1:-1])\n\n return ESCAPE_RE.sub(replace, text)\n\n\nWHITESPACE_RE = re.compile('^ +| +$|[\\r\\n\\t] +| {2,}')\n\n\ndef fancy_spaces(text):\n \"\"\"Highlight spaces to make them easily visible.\"\"\"\n def replace(match):\n fancy_space = '<span class=\"translation-space\"> </span>'\n if match.group().startswith(' '):\n return fancy_space * len(match.group())\n return match.group()[0] + fancy_space * (len(match.group()) - 1)\n return WHITESPACE_RE.sub(replace, text)\n\n\nPUNCTUATION_RE = general.PunctuationPlaceable().regex\n\n\ndef fancy_punctuation_chars(text):\n \"\"\"Wrap punctuation chars found in the ``text`` around tags.\"\"\"\n def replace(match):\n fancy_special_char = ('<span class=\"highlight-punctuation '\n 'js-editor-copytext\">%s</span>')\n return fancy_special_char % match.group()\n\n return PUNCTUATION_RE.sub(replace, text)\n\n\n@register.filter\n@stringfilter\ndef fancy_highlight(text):\n return mark_safe(fancy_punctuation_chars(fancy_spaces(fancy_escape(text))))\n\n\ndef call_highlight(old, new):\n \"\"\"Calls diff highlighting code only if the target is set.\n Otherwise, highlight as a normal unit.\n \"\"\"\n if isinstance(old, multistring):\n old_value = old.strings\n else:\n old_value = old\n\n if list_empty(old_value):\n return fancy_highlight(new)\n\n return highlight_diffs(old, new)\n\n\ndifferencer = diff_match_patch()\n\n\ndef highlight_diffs(old, new):\n \"\"\"Highlight the differences between old and new.\"\"\"\n\n textdiff = u\"\" # to store the final result\n removed = u\"\" # the removed text that we might still want to add\n diff = differencer.diff_main(old, new)\n differencer.diff_cleanupSemantic(diff)\n for op, text in diff:\n if op == 0: # equality\n if removed:\n textdiff += '<span class=\"diff-delete\">%s</span>' % \\\n fancy_escape(removed)\n removed = u\"\"\n textdiff += fancy_escape(text)\n elif op == 1: # insertion\n if removed:\n # this is part of a substitution, not a plain insertion. We\n # will format this differently.\n textdiff += '<span class=\"diff-replace\">%s</span>' % \\\n fancy_escape(text)\n removed = u\"\"\n else:\n textdiff += '<span class=\"diff-insert\">%s</span>' % \\\n fancy_escape(text)\n elif op == -1: # deletion\n removed = text\n if removed:\n textdiff += '<span class=\"diff-delete\">%s</span>' % \\\n fancy_escape(removed)\n return mark_safe(textdiff)\n\n\n@register.filter('pluralize_source')\ndef pluralize_source(unit):\n if not unit.hasplural():\n return [(0, unit.source, None)]\n\n count = len(unit.source.strings)\n if count == 1:\n return [(0, unit.source.strings[0], \"%s+%s\" % (_('Singular'),\n _('Plural')))]\n\n if count == 2:\n return [(0, unit.source.strings[0], _('Singular')),\n (1, unit.source.strings[1], _('Plural'))]\n\n forms = []\n for i, source in enumerate(unit.source.strings):\n forms.append((i, source, _('Plural Form %d', i)))\n return forms\n\n\n@register.filter('pluralize_target')\ndef pluralize_target(unit, nplurals=None):\n if not unit.hasplural():\n return [(0, unit.target, None)]\n\n if nplurals is None:\n try:\n nplurals = unit.store.translation_project.language.nplurals\n except ObjectDoesNotExist:\n pass\n forms = []\n if nplurals is None:\n for i, target in enumerate(unit.target.strings):\n forms.append((i, target, _('Plural Form %d', i)))\n else:\n for i in range(nplurals):\n try:\n target = unit.target.strings[i]\n except IndexError:\n target = ''\n forms.append((i, target, _('Plural Form %d', i)))\n\n return forms\n\n\n@register.filter('pluralize_diff_sugg')\ndef pluralize_diff_sugg(sugg):\n unit = sugg.unit\n if not unit.hasplural():\n return [\n (0, sugg.target, call_highlight(unit.target, sugg.target), None)\n ]\n\n forms = []\n for i, target in enumerate(sugg.target.strings):\n if i < len(unit.target.strings):\n sugg_text = unit.target.strings[i]\n else:\n sugg_text = ''\n\n forms.append((\n i, target, call_highlight(sugg_text, target),\n _('Plural Form %d', i)\n ))\n\n return forms\n\n\n@register.tag(name=\"include_raw\")\ndef do_include_raw(parser, token):\n \"\"\"\n Performs a template include without parsing the context, just dumps\n the template in.\n Source: http://djangosnippets.org/snippets/1684/\n \"\"\"\n bits = token.split_contents()\n if len(bits) != 2:\n raise template.TemplateSyntaxError(\n \"%r tag takes one argument: the name of the template \"\n \"to be included\" % bits[0]\n )\n\n template_name = bits[1]\n if (template_name[0] in ('\"', \"'\") and\n template_name[-1] == template_name[0]):\n template_name = template_name[1:-1]\n\n return template.base.TextNode(\n u\"\\n\".join(\n [x.s\n for x\n in get_template(template_name).template.nodelist]))\n","path":"pootle/apps/pootle_store/templatetags/store_tags.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/env python\\n# -*- coding: utf-8 -*-\\n#\\n# Copyright (C) Pootle contributors.\\n#\\n# This file is a part of the Pootle project. It is distributed under the GPL3\\n# or later license. See the LICENSE file for a copy of the license and the\\n# AUTHORS file for copyright and authorship information.\\n\\nimport re\\n\\nfrom diff_match_patch import diff_match_patch\\nfrom translate.misc.multistring import multistring\\nfrom translate.storage.placeables import general\\n\\nfrom django import template\\nfrom django.core.exceptions import ObjectDoesNotExist\\nfrom django.template.defaultfilters import stringfilter\\nfrom django.template.loader import get_template\\nfrom django.utils.safestring import mark_safe\\nfrom django.utils.translation import ugettext as _\\n\\nfrom pootle_store.fields import list_empty\\n\\n\\nregister = template.Library()\\n\\n\\nIMAGE_URL_RE = re.compile(\\\"(https?://[^\\\\s]+\\\\.(png|jpe?g|gif))\\\", re.IGNORECASE)\\n\\n\\n@register.filter\\ndef image_urls(text):\\n \\\"\\\"\\\"Return a list of image URLs extracted from `text`.\\\"\\\"\\\"\\n return map(lambda x: x[0], IMAGE_URL_RE.findall(text))\\n\\n\\nESCAPE_RE = re.compile('<[^<]*?>|\\\\\\\\\\\\\\\\|\\\\r\\\\n|[\\\\r\\\\n\\\\t&<>]')\\n\\n\\ndef fancy_escape(text):\\n \\\"\\\"\\\"Replace special chars with entities, and highlight XML tags and\\n whitespaces.\\n \\\"\\\"\\\"\\n def replace(match):\\n escape_highlight = ('<span class=\\\"highlight-escape '\\n 'js-editor-copytext\\\">%s</span>')\\n submap = {\\n '\\\\r\\\\n': (escape_highlight % '\\\\\\\\r\\\\\\\\n') + '<br/>\\\\n',\\n '\\\\r': (escape_highlight % '\\\\\\\\r') + '<br/>\\\\n',\\n '\\\\n': (escape_highlight % '\\\\\\\\n') + '<br/>\\\\n',\\n '\\\\t': (escape_highlight % '\\\\\\\\t'),\\n '&': '&',\\n '<': '<',\\n '>': '>',\\n '\\\\\\\\': (escape_highlight % '\\\\\\\\\\\\\\\\'),\\n }\\n try:\\n return submap[match.group()]\\n except KeyError:\\n html_highlight = ('<span class=\\\"highlight-html '\\n 'js-editor-copytext\\\"><%s></span>')\\n return html_highlight % fancy_escape(match.group()[1:-1])\\n\\n return ESCAPE_RE.sub(replace, text)\\n\\n\\nWHITESPACE_RE = re.compile('^ +| +$|[\\\\r\\\\n\\\\t] +| {2,}')\\n\\n\\ndef fancy_spaces(text):\\n \\\"\\\"\\\"Highlight spaces to make them easily visible.\\\"\\\"\\\"\\n def replace(match):\\n fancy_space = '<span class=\\\"translation-space\\\"> </span>'\\n if match.group().startswith(' '):\\n return fancy_space * len(match.group())\\n return match.group()[0] + fancy_space * (len(match.group()) - 1)\\n return WHITESPACE_RE.sub(replace, text)\\n\\n\\nPUNCTUATION_RE = general.PunctuationPlaceable().regex\\n\\n\\ndef fancy_punctuation_chars(text):\\n \\\"\\\"\\\"Wrap punctuation chars found in the ``text`` around tags.\\\"\\\"\\\"\\n def replace(match):\\n fancy_special_char = ('<span class=\\\"highlight-punctuation '\\n 'js-editor-copytext\\\">%s</span>')\\n return fancy_special_char % match.group()\\n\\n return PUNCTUATION_RE.sub(replace, text)\\n\\n\\n@register.filter\\n@stringfilter\\ndef fancy_highlight(text):\\n return mark_safe(fancy_punctuation_chars(fancy_spaces(fancy_escape(text))))\\n\\n\\ndef call_highlight(old, new):\\n \\\"\\\"\\\"Calls diff highlighting code only if the target is set.\\n Otherwise, highlight as a normal unit.\\n \\\"\\\"\\\"\\n if isinstance(old, multistring):\\n old_value = old.strings\\n else:\\n old_value = old\\n\\n if list_empty(old_value):\\n return fancy_highlight(new)\\n\\n return highlight_diffs(old, new)\\n\\n\\ndifferencer = diff_match_patch()\\n\\n\\ndef highlight_diffs(old, new):\\n \\\"\\\"\\\"Highlight the differences between old and new.\\\"\\\"\\\"\\n\\n textdiff = u\\\"\\\" # to store the final result\\n removed = u\\\"\\\" # the removed text that we might still want to add\\n diff = differencer.diff_main(old, new)\\n differencer.diff_cleanupSemantic(diff)\\n for op, text in diff:\\n if op == 0: # equality\\n if removed:\\n textdiff += '<span class=\\\"diff-delete\\\">%s</span>' % \\\\\\n fancy_escape(removed)\\n removed = u\\\"\\\"\\n textdiff += fancy_escape(text)\\n elif op == 1: # insertion\\n if removed:\\n # this is part of a substitution, not a plain insertion. We\\n # will format this differently.\\n textdiff += '<span class=\\\"diff-replace\\\">%s</span>' % \\\\\\n fancy_escape(text)\\n removed = u\\\"\\\"\\n else:\\n textdiff += '<span class=\\\"diff-insert\\\">%s</span>' % \\\\\\n fancy_escape(text)\\n elif op == -1: # deletion\\n removed = text\\n if removed:\\n textdiff += '<span class=\\\"diff-delete\\\">%s</span>' % \\\\\\n fancy_escape(removed)\\n return mark_safe(textdiff)\\n\\n\\n@register.filter('pluralize_source')\\ndef pluralize_source(unit):\\n if not unit.hasplural():\\n return [(0, unit.source, None)]\\n\\n count = len(unit.source.strings)\\n if count == 1:\\n return [(0, unit.source.strings[0], \\\"%s+%s\\\" % (_('Singular'),\\n _('Plural')))]\\n\\n if count == 2:\\n return [(0, unit.source.strings[0], _('Singular')),\\n (1, unit.source.strings[1], _('Plural'))]\\n\\n forms = []\\n for i, source in enumerate(unit.source.strings):\\n forms.append((i, source, _('Plural Form %d', i)))\\n return forms\\n\\n\\n@register.filter('pluralize_target')\\ndef pluralize_target(unit, nplurals=None):\\n if not unit.hasplural():\\n return [(0, unit.target, None)]\\n\\n if nplurals is None:\\n try:\\n nplurals = unit.store.translation_project.language.nplurals\\n except ObjectDoesNotExist:\\n pass\\n forms = []\\n if nplurals is None:\\n for i, target in enumerate(unit.target.strings):\\n forms.append((i, target, _('Plural Form %d', i)))\\n else:\\n for i in range(nplurals):\\n try:\\n target = unit.target.strings[i]\\n except IndexError:\\n target = ''\\n forms.append((i, target, _('Plural Form %d', i)))\\n\\n return forms\\n\\n\\n@register.filter('pluralize_diff_sugg')\\ndef pluralize_diff_sugg(sugg):\\n unit = sugg.unit\\n if not unit.hasplural():\\n return [\\n (0, sugg.target, call_highlight(unit.target, sugg.target), None)\\n ]\\n\\n forms = []\\n for i, target in enumerate(sugg.target.strings):\\n if i < len(unit.target.strings):\\n sugg_text = unit.target.strings[i]\\n else:\\n sugg_text = ''\\n\\n forms.append((\\n i, target, call_highlight(sugg_text, target),\\n _('Plural Form %d', i)\\n ))\\n\\n return forms\\n\\n\\n@register.tag(name=\\\"include_raw\\\")\\ndef do_include_raw(parser, token):\\n \\\"\\\"\\\"\\n Performs a template include without parsing the context, just dumps\\n the template in.\\n Source: http://djangosnippets.org/snippets/1684/\\n \\\"\\\"\\\"\\n bits = token.split_contents()\\n if len(bits) != 2:\\n raise template.TemplateSyntaxError(\\n \\\"%r tag takes one argument: the name of the template \\\"\\n \\\"to be included\\\" % bits[0]\\n )\\n\\n template_name = bits[1]\\n if (template_name[0] in ('\\\"', \\\"'\\\") and\\n template_name[-1] == template_name[0]):\\n template_name = template_name[1:-1]\\n\\n return template.base.TextNode(\\n u\\\"\\\\n\\\".join(\\n [x.s\\n for x\\n in get_template(template_name).template.nodelist]))\\n\",\n \"path\": \"pootle/apps/pootle_store/templatetags/store_tags.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/pootle/apps/pootle_store/templatetags/store_tags.py b/pootle/apps/pootle_store/templatetags/store_tags.py\nindex a37b6e0687b..9996befb050 100644\n--- a/pootle/apps/pootle_store/templatetags/store_tags.py\n+++ b/pootle/apps/pootle_store/templatetags/store_tags.py\n@@ -234,7 +234,8 @@ def do_include_raw(parser, token):\n template_name[-1] == template_name[0]):\n template_name = template_name[1:-1]\n \n- source, path = get_template(\n- template_name).origin.loader(template_name)\n-\n- return template.base.TextNode(source)\n+ return template.base.TextNode(\n+ u\"\\n\".join(\n+ [x.s\n+ for x\n+ in get_template(template_name).template.nodelist]))\n"}}},{"rowIdx":4673,"cells":{"in_source_id":{"kind":"string","value":"facebookresearch__fairscale-221"},"issue":{"kind":"string","value":"Fail on install - CUDA 11.1.0\n## 🐛 Bug\r\n\r\nHi,\r\npip install on below environment throws an error. I'm happy to provide more info if it would be useful. Thanks!\r\n\r\nfatal error: multi_tensor_apply.cuh: No such file or directory\r\n\r\n## Environment (NVIDIA-Python Docker: 20.10)\r\nPython: 3.6\r\nPyTorch: 1.7.0\r\nCUDA: 11.1.0\r\ncuDNN: 8.0.4\r\n\r\n## Error\r\n```\r\nError:\r\nb' ERROR: Command errored out with exit status 1:\r\n command: /usr/bin/python3 /usr/local/lib/python3.6/dist-packages/pip/_vendor/pep517/_in_process.py build_wheel /tmp/tmpl6xin7ge\r\n cwd: /tmp/pip-install-0_xiegmi/fairscale\r\n Complete output (158 lines):\r\n running bdist_wheel\r\n running build\r\n running build_py\r\n creating build\r\n creating build/lib.linux-x86_64-3.6\r\n creating build/lib.linux-x86_64-3.6/fairscale\r\n copying fairscale/__init__.py -> build/lib.linux-x86_64-3.6/fairscale\r\n creating build/lib.linux-x86_64-3.6/fairscale/optim\r\n copying fairscale/optim/grad_scaler.py -> build/lib.linux-x86_64-3.6/fairscale/optim\r\n copying fairscale/optim/oss.py -> build/lib.linux-x86_64-3.6/fairscale/optim\r\n copying fairscale/optim/__init__.py -> build/lib.linux-x86_64-3.6/fairscale/optim\r\n copying fairscale/optim/utils.py -> build/lib.linux-x86_64-3.6/fairscale/optim\r\n copying fairscale/optim/adam.py -> build/lib.linux-x86_64-3.6/fairscale/optim\r\n creating build/lib.linux-x86_64-3.6/fairscale/nn\r\n copying fairscale/nn/__init__.py -> build/lib.linux-x86_64-3.6/fairscale/nn\r\n creating build/lib.linux-x86_64-3.6/fairscale/nn/pipe\r\n copying fairscale/nn/pipe/dependency.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe\r\n copying fairscale/nn/pipe/pipe.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe\r\n copying fairscale/nn/pipe/stream.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe\r\n copying fairscale/nn/pipe/batchnorm.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe\r\n copying fairscale/nn/pipe/__init__.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe\r\n copying fairscale/nn/pipe/pipeline.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe\r\n copying fairscale/nn/pipe/checkpoint.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe\r\n copying fairscale/nn/pipe/copy.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe\r\n copying fairscale/nn/pipe/phony.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe\r\n copying fairscale/nn/pipe/worker.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe\r\n copying fairscale/nn/pipe/microbatch.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe\r\n creating build/lib.linux-x86_64-3.6/fairscale/nn/model_parallel\r\n copying fairscale/nn/model_parallel/random.py -> build/lib.linux-x86_64-3.6/fairscale/nn/model_parallel\r\n copying fairscale/nn/model_parallel/initialize.py -> build/lib.linux-x86_64-3.6/fairscale/nn/model_parallel\r\n copying fairscale/nn/model_parallel/layers.py -> build/lib.linux-x86_64-3.6/fairscale/nn/model_parallel\r\n copying fairscale/nn/model_parallel/cross_entropy.py -> build/lib.linux-x86_64-3.6/fairscale/nn/model_parallel\r\n copying fairscale/nn/model_parallel/mappings.py -> build/lib.linux-x86_64-3.6/fairscale/nn/model_parallel\r\n copying fairscale/nn/model_parallel/__init__.py -> build/lib.linux-x86_64-3.6/fairscale/nn/model_parallel\r\n copying fairscale/nn/model_parallel/utils.py -> build/lib.linux-x86_64-3.6/fairscale/nn/model_parallel\r\n creating build/lib.linux-x86_64-3.6/fairscale/nn/data_parallel\r\n copying fairscale/nn/data_parallel/sharded_ddp.py -> build/lib.linux-x86_64-3.6/fairscale/nn/data_parallel\r\n copying fairscale/nn/data_parallel/__init__.py -> build/lib.linux-x86_64-3.6/fairscale/nn/data_parallel\r\n creating build/lib.linux-x86_64-3.6/fairscale/nn/moe\r\n copying fairscale/nn/moe/top2gate.py -> build/lib.linux-x86_64-3.6/fairscale/nn/moe\r\n copying fairscale/nn/moe/moelayer.py -> build/lib.linux-x86_64-3.6/fairscale/nn/moe\r\n copying fairscale/nn/moe/__init__.py -> build/lib.linux-x86_64-3.6/fairscale/nn/moe\r\n creating build/lib.linux-x86_64-3.6/fairscale/nn/pipe/balance\r\n copying fairscale/nn/pipe/balance/profile.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe/balance\r\n copying fairscale/nn/pipe/balance/__init__.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe/balance\r\n copying fairscale/nn/pipe/balance/blockpartition.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe/balance\r\n creating build/lib.linux-x86_64-3.6/fairscale/nn/pipe/skip\r\n copying fairscale/nn/pipe/skip/skippable.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe/skip\r\n copying fairscale/nn/pipe/skip/__init__.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe/skip\r\n copying fairscale/nn/pipe/skip/tracker.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe/skip\r\n copying fairscale/nn/pipe/skip/layout.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe/skip\r\n copying fairscale/nn/pipe/skip/portal.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe/skip\r\n copying fairscale/nn/pipe/skip/namespace.py -> build/lib.linux-x86_64-3.6/fairscale/nn/pipe/skip\r\n running egg_info\r\n writing fairscale.egg-info/PKG-INFO\r\n writing dependency_links to fairscale.egg-info/dependency_links.txt\r\n writing requirements to fairscale.egg-info/requires.txt\r\n writing top-level names to fairscale.egg-info/top_level.txt\r\n reading manifest file \\'fairscale.egg-info/SOURCES.txt\\'\r\n reading manifest template \\'MANIFEST.in\\'\r\n writing manifest file \\'fairscale.egg-info/SOURCES.txt\\'\r\n creating build/lib.linux-x86_64-3.6/fairscale/clib\r\n creating build/lib.linux-x86_64-3.6/fairscale/clib/fused_adam_cuda\r\n copying fairscale/clib/fused_adam_cuda/fused_adam_cuda.cpp -> build/lib.linux-x86_64-3.6/fairscale/clib/fused_adam_cuda\r\n copying fairscale/clib/fused_adam_cuda/fused_adam_cuda_kernel.cu -> build/lib.linux-x86_64-3.6/fairscale/clib/fused_adam_cuda\r\n running build_ext\r\n building \\'fairscale.fused_adam_cuda\\' extension\r\n creating /tmp/pip-install-0_xiegmi/fairscale/build/temp.linux-x86_64-3.6\r\n creating /tmp/pip-install-0_xiegmi/fairscale/build/temp.linux-x86_64-3.6/fairscale\r\n creating /tmp/pip-install-0_xiegmi/fairscale/build/temp.linux-x86_64-3.6/fairscale/clib\r\n creating /tmp/pip-install-0_xiegmi/fairscale/build/temp.linux-x86_64-3.6/fairscale/clib/fused_adam_cuda\r\n Emitting ninja build file /tmp/pip-install-0_xiegmi/fairscale/build/temp.linux-x86_64-3.6/build.ninja...\r\n Compiling objects...\r\n Allowing ninja to set a default number of workers... (overridable by setting the environment variable MAX_JOBS=N)\r\n [1/2] /usr/local/cuda/bin/nvcc -I/usr/local/lib/python3.6/dist-packages/torch/include -I/usr/local/lib/python3.6/dist-packages/torch/include/torch/csrc/api/include -I/usr/local/lib/python3.6/dist-packages/torch/include/TH -I/usr/local/lib/python3.6/dist-packages/torch/include/THC -I/usr/local/cuda/include -I/usr/include/python3.6m -c -c /tmp/pip-install-0_xiegmi/fairscale/fairscale/clib/fused_adam_cuda/fused_adam_cuda_kernel.cu -o /tmp/pip-install-0_xiegmi/fairscale/build/temp.linux-x86_64-3.6/fairscale/clib/fused_adam_cuda/fused_adam_cuda_kernel.o -D__CUDA_NO_HALF_OPERATORS__ -D__CUDA_NO_HALF_CONVERSIONS__ -D__CUDA_NO_HALF2_OPERATORS__ --expt-relaxed-constexpr --compiler-options \\'\\'\"\\'\"\\'-fPIC\\'\"\\'\"\\'\\' -O3 --use_fast_math -DTORCH_API_INCLUDE_EXTENSION_H -DTORCH_EXTENSION_NAME=fused_adam_cuda -D_GLIBCXX_USE_CXX11_ABI=0 -gencode=arch=compute_61,code=sm_61 -gencode=arch=compute_70,code=sm_70 -gencode=arch=compute_75,code=sm_75 -gencode=arch=compute_60,code=sm_60 -gencode=arch=compute_86,code=compute_86 -gencode=arch=compute_80,code=sm_80 -gencode=arch=compute_52,code=sm_52 -gencode=arch=compute_86,code=sm_86 -std=c++14\r\n FAILED: /tmp/pip-install-0_xiegmi/fairscale/build/temp.linux-x86_64-3.6/fairscale/clib/fused_adam_cuda/fused_adam_cuda_kernel.o\r\n /usr/local/cuda/bin/nvcc -I/usr/local/lib/python3.6/dist-packages/torch/include -I/usr/local/lib/python3.6/dist-packages/torch/include/torch/csrc/api/include -I/usr/local/lib/python3.6/dist-packages/torch/include/TH -I/usr/local/lib/python3.6/dist-packages/torch/include/THC -I/usr/local/cuda/include -I/usr/include/python3.6m -c -c /tmp/pip-install-0_xiegmi/fairscale/fairscale/clib/fused_adam_cuda/fused_adam_cuda_kernel.cu -o /tmp/pip-install-0_xiegmi/fairscale/build/temp.linux-x86_64-3.6/fairscale/clib/fused_adam_cuda/fused_adam_cuda_kernel.o -D__CUDA_NO_HALF_OPERATORS__ -D__CUDA_NO_HALF_CONVERSIONS__ -D__CUDA_NO_HALF2_OPERATORS__ --expt-relaxed-constexpr --compiler-options \\'\\'\"\\'\"\\'-fPIC\\'\"\\'\"\\'\\' -O3 --use_fast_math -DTORCH_API_INCLUDE_EXTENSION_H -DTORCH_EXTENSION_NAME=fused_adam_cuda -D_GLIBCXX_USE_CXX11_ABI=0 -gencode=arch=compute_61,code=sm_61 -gencode=arch=compute_70,code=sm_70 -gencode=arch=compute_75,code=sm_75 -gencode=arch=compute_60,code=sm_60 -gencode=arch=compute_86,code=compute_86 -gencode=arch=compute_80,code=sm_80 -gencode=arch=compute_52,code=sm_52 -gencode=arch=compute_86,code=sm_86 -std=c++14\r\n /tmp/pip-install-0_xiegmi/fairscale/fairscale/clib/fused_adam_cuda/fused_adam_cuda_kernel.cu:12:10: fatal error: multi_tensor_apply.cuh: No such file or directory\r\n #include \"multi_tensor_apply.cuh\"\r\n ^~~~~~~~~~~~~~~~~~~~~~~~\r\n compilation terminated.\r\n [2/2] c++ -MMD -MF /tmp/pip-install-0_xiegmi/fairscale/build/temp.linux-x86_64-3.6/fairscale/clib/fused_adam_cuda/fused_adam_cuda.o.d -pthread -DNDEBUG -g -fwrapv -O2 -Wall -g -fstack-protector-strong -Wformat -Werror=format-security -Wdate-time -D_FORTIFY_SOURCE=2 -fPIC -I/usr/local/lib/python3.6/dist-packages/torch/include -I/usr/local/lib/python3.6/dist-packages/torch/include/torch/csrc/api/include -I/usr/local/lib/python3.6/dist-packages/torch/include/TH -I/usr/local/lib/python3.6/dist-packages/torch/include/THC -I/usr/local/cuda/include -I/usr/include/python3.6m -c -c /tmp/pip-install-0_xiegmi/fairscale/fairscale/clib/fused_adam_cuda/fused_adam_cuda.cpp -o /tmp/pip-install-0_xiegmi/fairscale/build/temp.linux-x86_64-3.6/fairscale/clib/fused_adam_cuda/fused_adam_cuda.o -O3 -DTORCH_API_INCLUDE_EXTENSION_H -DTORCH_EXTENSION_NAME=fused_adam_cuda -D_GLIBCXX_USE_CXX11_ABI=0 -std=c++14\r\n In file included from /usr/local/lib/python3.6/dist-packages/torch/include/ATen/Parallel.h:149:0,\r\n from /usr/local/lib/python3.6/dist-packages/torch/include/torch/csrc/api/include/torch/utils.h:3,\r\n from /usr/local/lib/python3.6/dist-packages/torch/include/torch/csrc/api/include/torch/nn/cloneable.h:5,\r\n from /usr/local/lib/python3.6/dist-packages/torch/include/torch/csrc/api/include/torch/nn.h:3,\r\n from /usr/local/lib/python3.6/dist-packages/torch/include/torch/csrc/api/include/torch/all.h:12,\r\n from /usr/local/lib/python3.6/dist-packages/torch/include/torch/extension.h:4,\r\n from /tmp/pip-install-0_xiegmi/fairscale/fairscale/clib/fused_adam_cuda/fused_adam_cuda.cpp:1:\r\n /usr/local/lib/python3.6/dist-packages/torch/include/ATen/ParallelOpenMP.h:84:0: warning: ignoring #pragma omp parallel [-Wunknown-pragmas]\r\n #pragma omp parallel for if ((end - begin) >= grain_size)\r\n \r\n ninja: build stopped: subcommand failed.\r\n Traceback (most recent call last):\r\n File \"/usr/local/lib/python3.6/dist-packages/torch/utils/cpp_extension.py\", line 1522, in _run_ninja_build\r\n env=env)\r\n File \"/usr/lib/python3.6/subprocess.py\", line 438, in run\r\n output=stdout, stderr=stderr)\r\n subprocess.CalledProcessError: Command \\'[\\'ninja\\', \\'-v\\']\\' returned non-zero exit status 1.\r\n```\n"},"before_files":{"kind":"list like","value":[{"content":"# Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.\n#\n# This source code is licensed under the BSD license found in the\n# LICENSE file in the root directory of this source tree.\n\n__version__ = \"0.1.0\"\n\n################################################################################\n# Import most common subpackages\n################################################################################\n\nfrom . import nn\n","path":"fairscale/__init__.py"}],"string":"[\n {\n \"content\": \"# Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.\\n#\\n# This source code is licensed under the BSD license found in the\\n# LICENSE file in the root directory of this source tree.\\n\\n__version__ = \\\"0.1.0\\\"\\n\\n################################################################################\\n# Import most common subpackages\\n################################################################################\\n\\nfrom . import nn\\n\",\n \"path\": \"fairscale/__init__.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.\n#\n# This source code is licensed under the BSD license found in the\n# LICENSE file in the root directory of this source tree.\n\n__version__ = \"0.1.1\"\n\n################################################################################\n# Import most common subpackages\n################################################################################\n\nfrom . import nn\n","path":"fairscale/__init__.py"}],"string":"[\n {\n \"content\": \"# Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.\\n#\\n# This source code is licensed under the BSD license found in the\\n# LICENSE file in the root directory of this source tree.\\n\\n__version__ = \\\"0.1.1\\\"\\n\\n################################################################################\\n# Import most common subpackages\\n################################################################################\\n\\nfrom . import nn\\n\",\n \"path\": \"fairscale/__init__.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/CHANGELOG.md b/CHANGELOG.md\nindex 9cedc177a..e518464c7 100644\n--- a/CHANGELOG.md\n+++ b/CHANGELOG.md\n@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\n and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n \n \n+## [0.1.1] - 2020-12-01\n+### Fixed\n+- make sure pip package includes header files (#221)\n+\n ## [0.1.0] - 2020-12-01\n ### Added\n - ShardedDataParallel with autoreduce (#157)\ndiff --git a/MANIFEST.in b/MANIFEST.in\nindex 096dd5031..c81303e35 100644\n--- a/MANIFEST.in\n+++ b/MANIFEST.in\n@@ -1,2 +1,3 @@\n include LICENSE\n include requirements.txt\n+recursive-include fairscale *.h *.cuh\ndiff --git a/fairscale/__init__.py b/fairscale/__init__.py\nindex 8d620e218..ced9ea621 100644\n--- a/fairscale/__init__.py\n+++ b/fairscale/__init__.py\n@@ -3,7 +3,7 @@\n # This source code is licensed under the BSD license found in the\n # LICENSE file in the root directory of this source tree.\n \n-__version__ = \"0.1.0\"\n+__version__ = \"0.1.1\"\n \n ################################################################################\n # Import most common subpackages\n"}}},{"rowIdx":4674,"cells":{"in_source_id":{"kind":"string","value":"cocotb__cocotb-2677"},"issue":{"kind":"string","value":"Make `cocotb.scheduler.create_task` a public API\nBy creating a top-level alias `cocotb.create_task`. This function will turn a coroutine into a Task, but will not schedule it. Later the user can schedule that Task using `cocotb.start_soon` or `cocotb.start`.\n"},"before_files":{"kind":"list like","value":[{"content":"# Copyright (c) 2013 Potential Ventures Ltd\n# Copyright (c) 2013 SolarFlare Communications Inc\n# All rights reserved.\n\n# Redistribution and use in source and binary forms, with or without\n# modification, are permitted provided that the following conditions are met:\n# * Redistributions of source code must retain the above copyright\n# notice, this list of conditions and the following disclaimer.\n# * Redistributions in binary form must reproduce the above copyright\n# notice, this list of conditions and the following disclaimer in the\n# documentation and/or other materials provided with the distribution.\n# * Neither the name of Potential Ventures Ltd,\n# SolarFlare Communications Inc nor the\n# names of its contributors may be used to endorse or promote products\n# derived from this software without specific prior written permission.\n\n# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\n# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\n# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY\n# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\n# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\n# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\n# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n\"\"\"\nCocotb is a coroutine, cosimulation framework for writing testbenches in Python.\n\nSee https://docs.cocotb.org for full documentation\n\"\"\"\nimport os\nimport sys\nimport logging\nimport threading\nimport random\nimport time\nimport warnings\nfrom typing import Dict, List, Optional, Union\nfrom collections.abc import Coroutine\n\nimport cocotb.handle\nimport cocotb.log\nfrom cocotb.scheduler import Scheduler\nfrom cocotb.regression import RegressionManager\nfrom cocotb.decorators import RunningTask\n\n# Things we want in the cocotb namespace\nfrom cocotb.decorators import test, coroutine, function, external # noqa: F401\n\nfrom ._version import __version__\n\n\ndef _setup_logging():\n global log\n\n def _reopen_stream_with_buffering(stream_name):\n try:\n if not getattr(sys, stream_name).isatty():\n setattr(sys, stream_name, os.fdopen(getattr(sys, stream_name).fileno(), 'w', 1))\n return True\n return False\n except Exception as e:\n return e\n\n # If stdout/stderr are not TTYs, Python may not have opened them with line\n # buffering. In that case, try to reopen them with line buffering\n # explicitly enabled. This ensures that prints such as stack traces always\n # appear. Continue silently if this fails.\n _stdout_buffer_result = _reopen_stream_with_buffering('stdout')\n _stderr_buffer_result = _reopen_stream_with_buffering('stderr')\n\n # Don't set the logging up until we've attempted to fix the standard IO,\n # otherwise it will end up connected to the unfixed IO.\n cocotb.log.default_config()\n log = logging.getLogger(__name__)\n\n # we can't log these things until the logging is set up!\n if _stderr_buffer_result is True:\n log.debug(\"Reopened stderr with line buffering\")\n if _stdout_buffer_result is True:\n log.debug(\"Reopened stdout with line buffering\")\n if isinstance(_stdout_buffer_result, Exception) or isinstance(_stderr_buffer_result, Exception):\n if isinstance(_stdout_buffer_result, Exception):\n log.warning(\"Failed to ensure that stdout is line buffered\", exc_info=_stdout_buffer_result)\n if isinstance(_stderr_buffer_result, Exception):\n log.warning(\"Failed to ensure that stderr is line buffered\", exc_info=_stderr_buffer_result)\n log.warning(\"Some stack traces may not appear because of this.\")\n\n del _stderr_buffer_result, _stdout_buffer_result\n\n\n# Singleton scheduler instance\n# NB this cheekily ensures a singleton since we're replacing the reference\n# so that cocotb.scheduler gives you the singleton instance and not the\n# scheduler package\n\nscheduler: Optional[Scheduler] = None\n\"\"\"The global scheduler instance.\n\nThis is guaranteed to hold a value at test time.\n\"\"\"\n\nregression_manager: Optional[RegressionManager] = None\n\"\"\"The global regression manager instance.\n\nThis is guaranteed to hold a value at test time.\n\"\"\"\n\nargv: Optional[List[str]] = None\n\"\"\"The argument list as seen by the simulator.\n\nThis is guaranteed to hold a value at test time.\n\"\"\"\n\nargc: Optional[int] = None\n\"\"\"The length of :data:`cocotb.argv`.\n\nThis is guaranteed to hold a value at test time.\n\"\"\"\n\nplusargs: Optional[Dict[str, Union[bool, str]]] = None\n\"\"\"A dictionary of \"plusargs\" handed to the simulation.\n\nSee :make:var:`PLUSARGS` for details.\nThis is guaranteed to hold a value at test time.\n\"\"\"\n\nLANGUAGE: Optional[str] = os.getenv(\"TOPLEVEL_LANG\")\n\"\"\"The value of :make:var:`TOPLEVEL_LANG`.\n\nThis is guaranteed to hold a value at test time.\n\"\"\"\n\nSIM_NAME: Optional[str] = None\n\"\"\"The running simulator product information.\n\n``None`` if :mod:`cocotb` was not loaded from a simulator.\n\"\"\"\n\nSIM_VERSION: Optional[str] = None\n\"\"\"The version of the running simulator.\n\n``None`` if :mod:`cocotb` was not loaded from a simulator.\"\"\"\n\nRANDOM_SEED: Optional[int] = None\n\"\"\"\nThe value passed to the Python default random number generator.\n\nSee :envvar:`RANDOM_SEED` for details on how the value is computed.\nThis is guaranteed to hold a value at test time.\n\"\"\"\n\n_library_coverage = None\n\"\"\" used for cocotb library coverage \"\"\"\n\ntop: Optional[cocotb.handle.SimHandleBase] = None\nr\"\"\"\nA handle to the :envvar:`TOPLEVEL` entity/module.\n\nThis is equivalent to the :term:`DUT` parameter given to cocotb tests, so it can be used wherever that variable can be used.\nIt is particularly useful for extracting information about the :term:`DUT` in module-level class and function definitions;\nand in parameters to :class:`.TestFactory`\\ s.\n``None`` if :mod:`cocotb` was not loaded from a simulator.\n\"\"\"\n\n\ndef fork(coro: Union[RunningTask, Coroutine]) -> RunningTask:\n \"\"\" Schedule a coroutine to be run concurrently. See :ref:`coroutines` for details on its use. \"\"\"\n return scheduler.add(coro)\n\n\ndef start_soon(coro: Union[RunningTask, Coroutine]) -> RunningTask:\n \"\"\"\n Schedule a coroutine to be run concurrently.\n\n Note that this is not an async function,\n and the new task will not execute until the calling task yields control.\n\n .. versionadded:: 1.6.0\n \"\"\"\n return scheduler.start_soon(coro)\n\n\nasync def start(coro: Union[RunningTask, Coroutine]) -> RunningTask:\n \"\"\"\n Schedule a coroutine to be run concurrently, then yield control to allow pending tasks to execute.\n\n The calling task will resume execution before control is returned to the simulator.\n\n .. versionadded:: 1.6.0\n \"\"\"\n task = scheduler.start_soon(coro)\n await cocotb.triggers.NullTrigger()\n return task\n\n\n# FIXME is this really required?\n_rlock = threading.RLock()\n\n\ndef mem_debug(port):\n import cocotb.memdebug\n cocotb.memdebug.start(port)\n\n\ndef _initialise_testbench(argv_): # pragma: no cover\n \"\"\"Initialize testbench.\n\n This function is called after the simulator has elaborated all\n entities and is ready to run the test.\n\n The test must be defined by the environment variables\n :envvar:`MODULE` and :envvar:`TESTCASE`.\n \"\"\"\n with _rlock:\n\n if \"COCOTB_LIBRARY_COVERAGE\" in os.environ:\n import coverage\n\n global _library_coverage\n _library_coverage = coverage.coverage(\n data_file=\".coverage.cocotb\",\n branch=True,\n include=[\"{}/*\".format(os.path.dirname(__file__))])\n _library_coverage.start()\n\n return _initialise_testbench_(argv_)\n\n\ndef _initialise_testbench_(argv_):\n # The body of this function is split in two because no coverage is collected on\n # the function that starts the coverage. By splitting it in two we get coverage\n # on most of the function.\n\n global argc, argv\n argv = argv_\n argc = len(argv)\n\n root_name = os.getenv(\"TOPLEVEL\")\n if root_name is not None:\n root_name = root_name.strip()\n if root_name == \"\":\n root_name = None\n elif '.' in root_name:\n # Skip any library component of the toplevel\n root_name = root_name.split(\".\", 1)[1]\n\n # sys.path normally includes \"\" (the current directory), but does not appear to when python is embedded.\n # Add it back because users expect to be able to import files in their test directory.\n # TODO: move this to gpi_embed.cpp\n sys.path.insert(0, \"\")\n\n _setup_logging()\n\n # From https://www.python.org/dev/peps/pep-0565/#recommended-filter-settings-for-test-runners\n # If the user doesn't want to see these, they can always change the global\n # warning settings in their test module.\n if not sys.warnoptions:\n warnings.simplefilter(\"default\")\n\n from cocotb import simulator\n\n global SIM_NAME, SIM_VERSION\n SIM_NAME = simulator.get_simulator_product().strip()\n SIM_VERSION = simulator.get_simulator_version().strip()\n\n cocotb.log.info(f\"Running on {SIM_NAME} version {SIM_VERSION}\")\n\n memcheck_port = os.getenv('MEMCHECK')\n if memcheck_port is not None:\n mem_debug(int(memcheck_port))\n\n log.info(\"Running tests with cocotb v%s from %s\" %\n (__version__, os.path.dirname(__file__)))\n\n # Create the base handle type\n\n process_plusargs()\n\n global scheduler\n scheduler = Scheduler()\n\n # Seed the Python random number generator to make this repeatable\n global RANDOM_SEED\n RANDOM_SEED = os.getenv('RANDOM_SEED')\n\n if RANDOM_SEED is None:\n if 'ntb_random_seed' in plusargs:\n RANDOM_SEED = eval(plusargs['ntb_random_seed'])\n elif 'seed' in plusargs:\n RANDOM_SEED = eval(plusargs['seed'])\n else:\n RANDOM_SEED = int(time.time())\n log.info(\"Seeding Python random module with %d\" % (RANDOM_SEED))\n else:\n RANDOM_SEED = int(RANDOM_SEED)\n log.info(\"Seeding Python random module with supplied seed %d\" % (RANDOM_SEED))\n random.seed(RANDOM_SEED)\n\n # Setup DUT object\n from cocotb import simulator\n\n handle = simulator.get_root_handle(root_name)\n if not handle:\n raise RuntimeError(f\"Can not find root handle ({root_name})\")\n\n global top\n top = cocotb.handle.SimHandle(handle)\n\n try:\n import pytest\n except ImportError:\n log.warning(\"Pytest not found, assertion rewriting will not occur\")\n else:\n try:\n # Install the assertion rewriting hook, which must be done before we\n # import the test modules.\n from _pytest.config import Config\n from _pytest.assertion import install_importhook\n pytest_conf = Config.fromdictargs({}, ['--capture=no'])\n install_importhook(pytest_conf)\n except Exception:\n log.exception(\n \"Configuring the assertion rewrite hook using pytest {} failed. \"\n \"Please file a bug report!\".format(pytest.__version__))\n\n # start Regression Manager\n global regression_manager\n regression_manager = RegressionManager.from_discovery(top)\n regression_manager.execute()\n\n return True\n\n\ndef _sim_event(level, message):\n \"\"\"Function that can be called externally to signal an event.\"\"\"\n # SIM_INFO = 0\n SIM_TEST_FAIL = 1\n SIM_FAIL = 2\n from cocotb.result import TestFailure, SimFailure\n\n if level is SIM_TEST_FAIL:\n scheduler.log.error(\"Failing test at simulator request\")\n scheduler._finish_test(TestFailure(f\"Failure from external source: {message}\"))\n elif level is SIM_FAIL:\n # We simply return here as the simulator will exit\n # so no cleanup is needed\n msg = f\"Failing test at simulator request before test run completion: {message}\"\n scheduler.log.error(msg)\n scheduler._finish_scheduler(SimFailure(msg))\n else:\n scheduler.log.error(\"Unsupported sim event\")\n\n return True\n\n\ndef process_plusargs():\n\n global plusargs\n\n plusargs = {}\n\n for option in cocotb.argv:\n if option.startswith('+'):\n if option.find('=') != -1:\n (name, value) = option[1:].split('=', 1)\n plusargs[name] = value\n else:\n plusargs[option[1:]] = True\n","path":"cocotb/__init__.py"}],"string":"[\n {\n \"content\": \"# Copyright (c) 2013 Potential Ventures Ltd\\n# Copyright (c) 2013 SolarFlare Communications Inc\\n# All rights reserved.\\n\\n# Redistribution and use in source and binary forms, with or without\\n# modification, are permitted provided that the following conditions are met:\\n# * Redistributions of source code must retain the above copyright\\n# notice, this list of conditions and the following disclaimer.\\n# * Redistributions in binary form must reproduce the above copyright\\n# notice, this list of conditions and the following disclaimer in the\\n# documentation and/or other materials provided with the distribution.\\n# * Neither the name of Potential Ventures Ltd,\\n# SolarFlare Communications Inc nor the\\n# names of its contributors may be used to endorse or promote products\\n# derived from this software without specific prior written permission.\\n\\n# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \\\"AS IS\\\" AND\\n# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\\n# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\\n# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY\\n# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\\n# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\\n# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\\n# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\\n# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\n# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n\\\"\\\"\\\"\\nCocotb is a coroutine, cosimulation framework for writing testbenches in Python.\\n\\nSee https://docs.cocotb.org for full documentation\\n\\\"\\\"\\\"\\nimport os\\nimport sys\\nimport logging\\nimport threading\\nimport random\\nimport time\\nimport warnings\\nfrom typing import Dict, List, Optional, Union\\nfrom collections.abc import Coroutine\\n\\nimport cocotb.handle\\nimport cocotb.log\\nfrom cocotb.scheduler import Scheduler\\nfrom cocotb.regression import RegressionManager\\nfrom cocotb.decorators import RunningTask\\n\\n# Things we want in the cocotb namespace\\nfrom cocotb.decorators import test, coroutine, function, external # noqa: F401\\n\\nfrom ._version import __version__\\n\\n\\ndef _setup_logging():\\n global log\\n\\n def _reopen_stream_with_buffering(stream_name):\\n try:\\n if not getattr(sys, stream_name).isatty():\\n setattr(sys, stream_name, os.fdopen(getattr(sys, stream_name).fileno(), 'w', 1))\\n return True\\n return False\\n except Exception as e:\\n return e\\n\\n # If stdout/stderr are not TTYs, Python may not have opened them with line\\n # buffering. In that case, try to reopen them with line buffering\\n # explicitly enabled. This ensures that prints such as stack traces always\\n # appear. Continue silently if this fails.\\n _stdout_buffer_result = _reopen_stream_with_buffering('stdout')\\n _stderr_buffer_result = _reopen_stream_with_buffering('stderr')\\n\\n # Don't set the logging up until we've attempted to fix the standard IO,\\n # otherwise it will end up connected to the unfixed IO.\\n cocotb.log.default_config()\\n log = logging.getLogger(__name__)\\n\\n # we can't log these things until the logging is set up!\\n if _stderr_buffer_result is True:\\n log.debug(\\\"Reopened stderr with line buffering\\\")\\n if _stdout_buffer_result is True:\\n log.debug(\\\"Reopened stdout with line buffering\\\")\\n if isinstance(_stdout_buffer_result, Exception) or isinstance(_stderr_buffer_result, Exception):\\n if isinstance(_stdout_buffer_result, Exception):\\n log.warning(\\\"Failed to ensure that stdout is line buffered\\\", exc_info=_stdout_buffer_result)\\n if isinstance(_stderr_buffer_result, Exception):\\n log.warning(\\\"Failed to ensure that stderr is line buffered\\\", exc_info=_stderr_buffer_result)\\n log.warning(\\\"Some stack traces may not appear because of this.\\\")\\n\\n del _stderr_buffer_result, _stdout_buffer_result\\n\\n\\n# Singleton scheduler instance\\n# NB this cheekily ensures a singleton since we're replacing the reference\\n# so that cocotb.scheduler gives you the singleton instance and not the\\n# scheduler package\\n\\nscheduler: Optional[Scheduler] = None\\n\\\"\\\"\\\"The global scheduler instance.\\n\\nThis is guaranteed to hold a value at test time.\\n\\\"\\\"\\\"\\n\\nregression_manager: Optional[RegressionManager] = None\\n\\\"\\\"\\\"The global regression manager instance.\\n\\nThis is guaranteed to hold a value at test time.\\n\\\"\\\"\\\"\\n\\nargv: Optional[List[str]] = None\\n\\\"\\\"\\\"The argument list as seen by the simulator.\\n\\nThis is guaranteed to hold a value at test time.\\n\\\"\\\"\\\"\\n\\nargc: Optional[int] = None\\n\\\"\\\"\\\"The length of :data:`cocotb.argv`.\\n\\nThis is guaranteed to hold a value at test time.\\n\\\"\\\"\\\"\\n\\nplusargs: Optional[Dict[str, Union[bool, str]]] = None\\n\\\"\\\"\\\"A dictionary of \\\"plusargs\\\" handed to the simulation.\\n\\nSee :make:var:`PLUSARGS` for details.\\nThis is guaranteed to hold a value at test time.\\n\\\"\\\"\\\"\\n\\nLANGUAGE: Optional[str] = os.getenv(\\\"TOPLEVEL_LANG\\\")\\n\\\"\\\"\\\"The value of :make:var:`TOPLEVEL_LANG`.\\n\\nThis is guaranteed to hold a value at test time.\\n\\\"\\\"\\\"\\n\\nSIM_NAME: Optional[str] = None\\n\\\"\\\"\\\"The running simulator product information.\\n\\n``None`` if :mod:`cocotb` was not loaded from a simulator.\\n\\\"\\\"\\\"\\n\\nSIM_VERSION: Optional[str] = None\\n\\\"\\\"\\\"The version of the running simulator.\\n\\n``None`` if :mod:`cocotb` was not loaded from a simulator.\\\"\\\"\\\"\\n\\nRANDOM_SEED: Optional[int] = None\\n\\\"\\\"\\\"\\nThe value passed to the Python default random number generator.\\n\\nSee :envvar:`RANDOM_SEED` for details on how the value is computed.\\nThis is guaranteed to hold a value at test time.\\n\\\"\\\"\\\"\\n\\n_library_coverage = None\\n\\\"\\\"\\\" used for cocotb library coverage \\\"\\\"\\\"\\n\\ntop: Optional[cocotb.handle.SimHandleBase] = None\\nr\\\"\\\"\\\"\\nA handle to the :envvar:`TOPLEVEL` entity/module.\\n\\nThis is equivalent to the :term:`DUT` parameter given to cocotb tests, so it can be used wherever that variable can be used.\\nIt is particularly useful for extracting information about the :term:`DUT` in module-level class and function definitions;\\nand in parameters to :class:`.TestFactory`\\\\ s.\\n``None`` if :mod:`cocotb` was not loaded from a simulator.\\n\\\"\\\"\\\"\\n\\n\\ndef fork(coro: Union[RunningTask, Coroutine]) -> RunningTask:\\n \\\"\\\"\\\" Schedule a coroutine to be run concurrently. See :ref:`coroutines` for details on its use. \\\"\\\"\\\"\\n return scheduler.add(coro)\\n\\n\\ndef start_soon(coro: Union[RunningTask, Coroutine]) -> RunningTask:\\n \\\"\\\"\\\"\\n Schedule a coroutine to be run concurrently.\\n\\n Note that this is not an async function,\\n and the new task will not execute until the calling task yields control.\\n\\n .. versionadded:: 1.6.0\\n \\\"\\\"\\\"\\n return scheduler.start_soon(coro)\\n\\n\\nasync def start(coro: Union[RunningTask, Coroutine]) -> RunningTask:\\n \\\"\\\"\\\"\\n Schedule a coroutine to be run concurrently, then yield control to allow pending tasks to execute.\\n\\n The calling task will resume execution before control is returned to the simulator.\\n\\n .. versionadded:: 1.6.0\\n \\\"\\\"\\\"\\n task = scheduler.start_soon(coro)\\n await cocotb.triggers.NullTrigger()\\n return task\\n\\n\\n# FIXME is this really required?\\n_rlock = threading.RLock()\\n\\n\\ndef mem_debug(port):\\n import cocotb.memdebug\\n cocotb.memdebug.start(port)\\n\\n\\ndef _initialise_testbench(argv_): # pragma: no cover\\n \\\"\\\"\\\"Initialize testbench.\\n\\n This function is called after the simulator has elaborated all\\n entities and is ready to run the test.\\n\\n The test must be defined by the environment variables\\n :envvar:`MODULE` and :envvar:`TESTCASE`.\\n \\\"\\\"\\\"\\n with _rlock:\\n\\n if \\\"COCOTB_LIBRARY_COVERAGE\\\" in os.environ:\\n import coverage\\n\\n global _library_coverage\\n _library_coverage = coverage.coverage(\\n data_file=\\\".coverage.cocotb\\\",\\n branch=True,\\n include=[\\\"{}/*\\\".format(os.path.dirname(__file__))])\\n _library_coverage.start()\\n\\n return _initialise_testbench_(argv_)\\n\\n\\ndef _initialise_testbench_(argv_):\\n # The body of this function is split in two because no coverage is collected on\\n # the function that starts the coverage. By splitting it in two we get coverage\\n # on most of the function.\\n\\n global argc, argv\\n argv = argv_\\n argc = len(argv)\\n\\n root_name = os.getenv(\\\"TOPLEVEL\\\")\\n if root_name is not None:\\n root_name = root_name.strip()\\n if root_name == \\\"\\\":\\n root_name = None\\n elif '.' in root_name:\\n # Skip any library component of the toplevel\\n root_name = root_name.split(\\\".\\\", 1)[1]\\n\\n # sys.path normally includes \\\"\\\" (the current directory), but does not appear to when python is embedded.\\n # Add it back because users expect to be able to import files in their test directory.\\n # TODO: move this to gpi_embed.cpp\\n sys.path.insert(0, \\\"\\\")\\n\\n _setup_logging()\\n\\n # From https://www.python.org/dev/peps/pep-0565/#recommended-filter-settings-for-test-runners\\n # If the user doesn't want to see these, they can always change the global\\n # warning settings in their test module.\\n if not sys.warnoptions:\\n warnings.simplefilter(\\\"default\\\")\\n\\n from cocotb import simulator\\n\\n global SIM_NAME, SIM_VERSION\\n SIM_NAME = simulator.get_simulator_product().strip()\\n SIM_VERSION = simulator.get_simulator_version().strip()\\n\\n cocotb.log.info(f\\\"Running on {SIM_NAME} version {SIM_VERSION}\\\")\\n\\n memcheck_port = os.getenv('MEMCHECK')\\n if memcheck_port is not None:\\n mem_debug(int(memcheck_port))\\n\\n log.info(\\\"Running tests with cocotb v%s from %s\\\" %\\n (__version__, os.path.dirname(__file__)))\\n\\n # Create the base handle type\\n\\n process_plusargs()\\n\\n global scheduler\\n scheduler = Scheduler()\\n\\n # Seed the Python random number generator to make this repeatable\\n global RANDOM_SEED\\n RANDOM_SEED = os.getenv('RANDOM_SEED')\\n\\n if RANDOM_SEED is None:\\n if 'ntb_random_seed' in plusargs:\\n RANDOM_SEED = eval(plusargs['ntb_random_seed'])\\n elif 'seed' in plusargs:\\n RANDOM_SEED = eval(plusargs['seed'])\\n else:\\n RANDOM_SEED = int(time.time())\\n log.info(\\\"Seeding Python random module with %d\\\" % (RANDOM_SEED))\\n else:\\n RANDOM_SEED = int(RANDOM_SEED)\\n log.info(\\\"Seeding Python random module with supplied seed %d\\\" % (RANDOM_SEED))\\n random.seed(RANDOM_SEED)\\n\\n # Setup DUT object\\n from cocotb import simulator\\n\\n handle = simulator.get_root_handle(root_name)\\n if not handle:\\n raise RuntimeError(f\\\"Can not find root handle ({root_name})\\\")\\n\\n global top\\n top = cocotb.handle.SimHandle(handle)\\n\\n try:\\n import pytest\\n except ImportError:\\n log.warning(\\\"Pytest not found, assertion rewriting will not occur\\\")\\n else:\\n try:\\n # Install the assertion rewriting hook, which must be done before we\\n # import the test modules.\\n from _pytest.config import Config\\n from _pytest.assertion import install_importhook\\n pytest_conf = Config.fromdictargs({}, ['--capture=no'])\\n install_importhook(pytest_conf)\\n except Exception:\\n log.exception(\\n \\\"Configuring the assertion rewrite hook using pytest {} failed. \\\"\\n \\\"Please file a bug report!\\\".format(pytest.__version__))\\n\\n # start Regression Manager\\n global regression_manager\\n regression_manager = RegressionManager.from_discovery(top)\\n regression_manager.execute()\\n\\n return True\\n\\n\\ndef _sim_event(level, message):\\n \\\"\\\"\\\"Function that can be called externally to signal an event.\\\"\\\"\\\"\\n # SIM_INFO = 0\\n SIM_TEST_FAIL = 1\\n SIM_FAIL = 2\\n from cocotb.result import TestFailure, SimFailure\\n\\n if level is SIM_TEST_FAIL:\\n scheduler.log.error(\\\"Failing test at simulator request\\\")\\n scheduler._finish_test(TestFailure(f\\\"Failure from external source: {message}\\\"))\\n elif level is SIM_FAIL:\\n # We simply return here as the simulator will exit\\n # so no cleanup is needed\\n msg = f\\\"Failing test at simulator request before test run completion: {message}\\\"\\n scheduler.log.error(msg)\\n scheduler._finish_scheduler(SimFailure(msg))\\n else:\\n scheduler.log.error(\\\"Unsupported sim event\\\")\\n\\n return True\\n\\n\\ndef process_plusargs():\\n\\n global plusargs\\n\\n plusargs = {}\\n\\n for option in cocotb.argv:\\n if option.startswith('+'):\\n if option.find('=') != -1:\\n (name, value) = option[1:].split('=', 1)\\n plusargs[name] = value\\n else:\\n plusargs[option[1:]] = True\\n\",\n \"path\": \"cocotb/__init__.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# Copyright (c) 2013 Potential Ventures Ltd\n# Copyright (c) 2013 SolarFlare Communications Inc\n# All rights reserved.\n\n# Redistribution and use in source and binary forms, with or without\n# modification, are permitted provided that the following conditions are met:\n# * Redistributions of source code must retain the above copyright\n# notice, this list of conditions and the following disclaimer.\n# * Redistributions in binary form must reproduce the above copyright\n# notice, this list of conditions and the following disclaimer in the\n# documentation and/or other materials provided with the distribution.\n# * Neither the name of Potential Ventures Ltd,\n# SolarFlare Communications Inc nor the\n# names of its contributors may be used to endorse or promote products\n# derived from this software without specific prior written permission.\n\n# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\n# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\n# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY\n# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\n# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\n# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\n# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n\"\"\"\nCocotb is a coroutine, cosimulation framework for writing testbenches in Python.\n\nSee https://docs.cocotb.org for full documentation\n\"\"\"\nimport os\nimport sys\nimport logging\nimport threading\nimport random\nimport time\nimport warnings\nfrom typing import Dict, List, Optional, Union\nfrom collections.abc import Coroutine\n\nimport cocotb.handle\nimport cocotb.log\nfrom cocotb.scheduler import Scheduler\nfrom cocotb.regression import RegressionManager\nfrom cocotb.decorators import RunningTask\n\n# Things we want in the cocotb namespace\nfrom cocotb.decorators import test, coroutine, function, external # noqa: F401\n\nfrom ._version import __version__\n\n\ndef _setup_logging():\n global log\n\n def _reopen_stream_with_buffering(stream_name):\n try:\n if not getattr(sys, stream_name).isatty():\n setattr(sys, stream_name, os.fdopen(getattr(sys, stream_name).fileno(), 'w', 1))\n return True\n return False\n except Exception as e:\n return e\n\n # If stdout/stderr are not TTYs, Python may not have opened them with line\n # buffering. In that case, try to reopen them with line buffering\n # explicitly enabled. This ensures that prints such as stack traces always\n # appear. Continue silently if this fails.\n _stdout_buffer_result = _reopen_stream_with_buffering('stdout')\n _stderr_buffer_result = _reopen_stream_with_buffering('stderr')\n\n # Don't set the logging up until we've attempted to fix the standard IO,\n # otherwise it will end up connected to the unfixed IO.\n cocotb.log.default_config()\n log = logging.getLogger(__name__)\n\n # we can't log these things until the logging is set up!\n if _stderr_buffer_result is True:\n log.debug(\"Reopened stderr with line buffering\")\n if _stdout_buffer_result is True:\n log.debug(\"Reopened stdout with line buffering\")\n if isinstance(_stdout_buffer_result, Exception) or isinstance(_stderr_buffer_result, Exception):\n if isinstance(_stdout_buffer_result, Exception):\n log.warning(\"Failed to ensure that stdout is line buffered\", exc_info=_stdout_buffer_result)\n if isinstance(_stderr_buffer_result, Exception):\n log.warning(\"Failed to ensure that stderr is line buffered\", exc_info=_stderr_buffer_result)\n log.warning(\"Some stack traces may not appear because of this.\")\n\n del _stderr_buffer_result, _stdout_buffer_result\n\n\n# Singleton scheduler instance\n# NB this cheekily ensures a singleton since we're replacing the reference\n# so that cocotb.scheduler gives you the singleton instance and not the\n# scheduler package\n\nscheduler: Optional[Scheduler] = None\n\"\"\"The global scheduler instance.\n\nThis is guaranteed to hold a value at test time.\n\"\"\"\n\nregression_manager: Optional[RegressionManager] = None\n\"\"\"The global regression manager instance.\n\nThis is guaranteed to hold a value at test time.\n\"\"\"\n\nargv: Optional[List[str]] = None\n\"\"\"The argument list as seen by the simulator.\n\nThis is guaranteed to hold a value at test time.\n\"\"\"\n\nargc: Optional[int] = None\n\"\"\"The length of :data:`cocotb.argv`.\n\nThis is guaranteed to hold a value at test time.\n\"\"\"\n\nplusargs: Optional[Dict[str, Union[bool, str]]] = None\n\"\"\"A dictionary of \"plusargs\" handed to the simulation.\n\nSee :make:var:`PLUSARGS` for details.\nThis is guaranteed to hold a value at test time.\n\"\"\"\n\nLANGUAGE: Optional[str] = os.getenv(\"TOPLEVEL_LANG\")\n\"\"\"The value of :make:var:`TOPLEVEL_LANG`.\n\nThis is guaranteed to hold a value at test time.\n\"\"\"\n\nSIM_NAME: Optional[str] = None\n\"\"\"The running simulator product information.\n\n``None`` if :mod:`cocotb` was not loaded from a simulator.\n\"\"\"\n\nSIM_VERSION: Optional[str] = None\n\"\"\"The version of the running simulator.\n\n``None`` if :mod:`cocotb` was not loaded from a simulator.\"\"\"\n\nRANDOM_SEED: Optional[int] = None\n\"\"\"\nThe value passed to the Python default random number generator.\n\nSee :envvar:`RANDOM_SEED` for details on how the value is computed.\nThis is guaranteed to hold a value at test time.\n\"\"\"\n\n_library_coverage = None\n\"\"\" used for cocotb library coverage \"\"\"\n\ntop: Optional[cocotb.handle.SimHandleBase] = None\nr\"\"\"\nA handle to the :envvar:`TOPLEVEL` entity/module.\n\nThis is equivalent to the :term:`DUT` parameter given to cocotb tests, so it can be used wherever that variable can be used.\nIt is particularly useful for extracting information about the :term:`DUT` in module-level class and function definitions;\nand in parameters to :class:`.TestFactory`\\ s.\n``None`` if :mod:`cocotb` was not loaded from a simulator.\n\"\"\"\n\n\ndef fork(coro: Union[RunningTask, Coroutine]) -> RunningTask:\n \"\"\" Schedule a coroutine to be run concurrently. See :ref:`coroutines` for details on its use. \"\"\"\n return scheduler.add(coro)\n\n\ndef start_soon(coro: Union[RunningTask, Coroutine]) -> RunningTask:\n \"\"\"\n Schedule a coroutine to be run concurrently.\n\n Note that this is not an async function,\n and the new task will not execute until the calling task yields control.\n\n .. versionadded:: 1.6.0\n \"\"\"\n return scheduler.start_soon(coro)\n\n\nasync def start(coro: Union[RunningTask, Coroutine]) -> RunningTask:\n \"\"\"\n Schedule a coroutine to be run concurrently, then yield control to allow pending tasks to execute.\n\n The calling task will resume execution before control is returned to the simulator.\n\n .. versionadded:: 1.6.0\n \"\"\"\n task = scheduler.start_soon(coro)\n await cocotb.triggers.NullTrigger()\n return task\n\n\ndef create_task(coro: Union[RunningTask, Coroutine]) -> RunningTask:\n \"\"\"\n Constructs a coroutine into a Task without scheduling the Task.\n\n The Task can later be scheduled with :func:`cocotb.fork`, :func:`cocotb.start`, or\n :func:`cocotb.start_soon`.\n\n .. versionadded:: 1.6.0\n \"\"\"\n return cocotb.scheduler.create_task(coro)\n\n\n# FIXME is this really required?\n_rlock = threading.RLock()\n\n\ndef mem_debug(port):\n import cocotb.memdebug\n cocotb.memdebug.start(port)\n\n\ndef _initialise_testbench(argv_): # pragma: no cover\n \"\"\"Initialize testbench.\n\n This function is called after the simulator has elaborated all\n entities and is ready to run the test.\n\n The test must be defined by the environment variables\n :envvar:`MODULE` and :envvar:`TESTCASE`.\n \"\"\"\n with _rlock:\n\n if \"COCOTB_LIBRARY_COVERAGE\" in os.environ:\n import coverage\n\n global _library_coverage\n _library_coverage = coverage.coverage(\n data_file=\".coverage.cocotb\",\n branch=True,\n include=[\"{}/*\".format(os.path.dirname(__file__))])\n _library_coverage.start()\n\n return _initialise_testbench_(argv_)\n\n\ndef _initialise_testbench_(argv_):\n # The body of this function is split in two because no coverage is collected on\n # the function that starts the coverage. By splitting it in two we get coverage\n # on most of the function.\n\n global argc, argv\n argv = argv_\n argc = len(argv)\n\n root_name = os.getenv(\"TOPLEVEL\")\n if root_name is not None:\n root_name = root_name.strip()\n if root_name == \"\":\n root_name = None\n elif '.' in root_name:\n # Skip any library component of the toplevel\n root_name = root_name.split(\".\", 1)[1]\n\n # sys.path normally includes \"\" (the current directory), but does not appear to when python is embedded.\n # Add it back because users expect to be able to import files in their test directory.\n # TODO: move this to gpi_embed.cpp\n sys.path.insert(0, \"\")\n\n _setup_logging()\n\n # From https://www.python.org/dev/peps/pep-0565/#recommended-filter-settings-for-test-runners\n # If the user doesn't want to see these, they can always change the global\n # warning settings in their test module.\n if not sys.warnoptions:\n warnings.simplefilter(\"default\")\n\n from cocotb import simulator\n\n global SIM_NAME, SIM_VERSION\n SIM_NAME = simulator.get_simulator_product().strip()\n SIM_VERSION = simulator.get_simulator_version().strip()\n\n cocotb.log.info(f\"Running on {SIM_NAME} version {SIM_VERSION}\")\n\n memcheck_port = os.getenv('MEMCHECK')\n if memcheck_port is not None:\n mem_debug(int(memcheck_port))\n\n log.info(\"Running tests with cocotb v%s from %s\" %\n (__version__, os.path.dirname(__file__)))\n\n # Create the base handle type\n\n process_plusargs()\n\n global scheduler\n scheduler = Scheduler()\n\n # Seed the Python random number generator to make this repeatable\n global RANDOM_SEED\n RANDOM_SEED = os.getenv('RANDOM_SEED')\n\n if RANDOM_SEED is None:\n if 'ntb_random_seed' in plusargs:\n RANDOM_SEED = eval(plusargs['ntb_random_seed'])\n elif 'seed' in plusargs:\n RANDOM_SEED = eval(plusargs['seed'])\n else:\n RANDOM_SEED = int(time.time())\n log.info(\"Seeding Python random module with %d\" % (RANDOM_SEED))\n else:\n RANDOM_SEED = int(RANDOM_SEED)\n log.info(\"Seeding Python random module with supplied seed %d\" % (RANDOM_SEED))\n random.seed(RANDOM_SEED)\n\n # Setup DUT object\n from cocotb import simulator\n\n handle = simulator.get_root_handle(root_name)\n if not handle:\n raise RuntimeError(f\"Can not find root handle ({root_name})\")\n\n global top\n top = cocotb.handle.SimHandle(handle)\n\n try:\n import pytest\n except ImportError:\n log.warning(\"Pytest not found, assertion rewriting will not occur\")\n else:\n try:\n # Install the assertion rewriting hook, which must be done before we\n # import the test modules.\n from _pytest.config import Config\n from _pytest.assertion import install_importhook\n pytest_conf = Config.fromdictargs({}, ['--capture=no'])\n install_importhook(pytest_conf)\n except Exception:\n log.exception(\n \"Configuring the assertion rewrite hook using pytest {} failed. \"\n \"Please file a bug report!\".format(pytest.__version__))\n\n # start Regression Manager\n global regression_manager\n regression_manager = RegressionManager.from_discovery(top)\n regression_manager.execute()\n\n return True\n\n\ndef _sim_event(level, message):\n \"\"\"Function that can be called externally to signal an event.\"\"\"\n # SIM_INFO = 0\n SIM_TEST_FAIL = 1\n SIM_FAIL = 2\n from cocotb.result import TestFailure, SimFailure\n\n if level is SIM_TEST_FAIL:\n scheduler.log.error(\"Failing test at simulator request\")\n scheduler._finish_test(TestFailure(f\"Failure from external source: {message}\"))\n elif level is SIM_FAIL:\n # We simply return here as the simulator will exit\n # so no cleanup is needed\n msg = f\"Failing test at simulator request before test run completion: {message}\"\n scheduler.log.error(msg)\n scheduler._finish_scheduler(SimFailure(msg))\n else:\n scheduler.log.error(\"Unsupported sim event\")\n\n return True\n\n\ndef process_plusargs():\n\n global plusargs\n\n plusargs = {}\n\n for option in cocotb.argv:\n if option.startswith('+'):\n if option.find('=') != -1:\n (name, value) = option[1:].split('=', 1)\n plusargs[name] = value\n else:\n plusargs[option[1:]] = True\n","path":"cocotb/__init__.py"}],"string":"[\n {\n \"content\": \"# Copyright (c) 2013 Potential Ventures Ltd\\n# Copyright (c) 2013 SolarFlare Communications Inc\\n# All rights reserved.\\n\\n# Redistribution and use in source and binary forms, with or without\\n# modification, are permitted provided that the following conditions are met:\\n# * Redistributions of source code must retain the above copyright\\n# notice, this list of conditions and the following disclaimer.\\n# * Redistributions in binary form must reproduce the above copyright\\n# notice, this list of conditions and the following disclaimer in the\\n# documentation and/or other materials provided with the distribution.\\n# * Neither the name of Potential Ventures Ltd,\\n# SolarFlare Communications Inc nor the\\n# names of its contributors may be used to endorse or promote products\\n# derived from this software without specific prior written permission.\\n\\n# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \\\"AS IS\\\" AND\\n# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\\n# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\\n# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY\\n# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\\n# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\\n# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\\n# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\\n# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\n# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n\\\"\\\"\\\"\\nCocotb is a coroutine, cosimulation framework for writing testbenches in Python.\\n\\nSee https://docs.cocotb.org for full documentation\\n\\\"\\\"\\\"\\nimport os\\nimport sys\\nimport logging\\nimport threading\\nimport random\\nimport time\\nimport warnings\\nfrom typing import Dict, List, Optional, Union\\nfrom collections.abc import Coroutine\\n\\nimport cocotb.handle\\nimport cocotb.log\\nfrom cocotb.scheduler import Scheduler\\nfrom cocotb.regression import RegressionManager\\nfrom cocotb.decorators import RunningTask\\n\\n# Things we want in the cocotb namespace\\nfrom cocotb.decorators import test, coroutine, function, external # noqa: F401\\n\\nfrom ._version import __version__\\n\\n\\ndef _setup_logging():\\n global log\\n\\n def _reopen_stream_with_buffering(stream_name):\\n try:\\n if not getattr(sys, stream_name).isatty():\\n setattr(sys, stream_name, os.fdopen(getattr(sys, stream_name).fileno(), 'w', 1))\\n return True\\n return False\\n except Exception as e:\\n return e\\n\\n # If stdout/stderr are not TTYs, Python may not have opened them with line\\n # buffering. In that case, try to reopen them with line buffering\\n # explicitly enabled. This ensures that prints such as stack traces always\\n # appear. Continue silently if this fails.\\n _stdout_buffer_result = _reopen_stream_with_buffering('stdout')\\n _stderr_buffer_result = _reopen_stream_with_buffering('stderr')\\n\\n # Don't set the logging up until we've attempted to fix the standard IO,\\n # otherwise it will end up connected to the unfixed IO.\\n cocotb.log.default_config()\\n log = logging.getLogger(__name__)\\n\\n # we can't log these things until the logging is set up!\\n if _stderr_buffer_result is True:\\n log.debug(\\\"Reopened stderr with line buffering\\\")\\n if _stdout_buffer_result is True:\\n log.debug(\\\"Reopened stdout with line buffering\\\")\\n if isinstance(_stdout_buffer_result, Exception) or isinstance(_stderr_buffer_result, Exception):\\n if isinstance(_stdout_buffer_result, Exception):\\n log.warning(\\\"Failed to ensure that stdout is line buffered\\\", exc_info=_stdout_buffer_result)\\n if isinstance(_stderr_buffer_result, Exception):\\n log.warning(\\\"Failed to ensure that stderr is line buffered\\\", exc_info=_stderr_buffer_result)\\n log.warning(\\\"Some stack traces may not appear because of this.\\\")\\n\\n del _stderr_buffer_result, _stdout_buffer_result\\n\\n\\n# Singleton scheduler instance\\n# NB this cheekily ensures a singleton since we're replacing the reference\\n# so that cocotb.scheduler gives you the singleton instance and not the\\n# scheduler package\\n\\nscheduler: Optional[Scheduler] = None\\n\\\"\\\"\\\"The global scheduler instance.\\n\\nThis is guaranteed to hold a value at test time.\\n\\\"\\\"\\\"\\n\\nregression_manager: Optional[RegressionManager] = None\\n\\\"\\\"\\\"The global regression manager instance.\\n\\nThis is guaranteed to hold a value at test time.\\n\\\"\\\"\\\"\\n\\nargv: Optional[List[str]] = None\\n\\\"\\\"\\\"The argument list as seen by the simulator.\\n\\nThis is guaranteed to hold a value at test time.\\n\\\"\\\"\\\"\\n\\nargc: Optional[int] = None\\n\\\"\\\"\\\"The length of :data:`cocotb.argv`.\\n\\nThis is guaranteed to hold a value at test time.\\n\\\"\\\"\\\"\\n\\nplusargs: Optional[Dict[str, Union[bool, str]]] = None\\n\\\"\\\"\\\"A dictionary of \\\"plusargs\\\" handed to the simulation.\\n\\nSee :make:var:`PLUSARGS` for details.\\nThis is guaranteed to hold a value at test time.\\n\\\"\\\"\\\"\\n\\nLANGUAGE: Optional[str] = os.getenv(\\\"TOPLEVEL_LANG\\\")\\n\\\"\\\"\\\"The value of :make:var:`TOPLEVEL_LANG`.\\n\\nThis is guaranteed to hold a value at test time.\\n\\\"\\\"\\\"\\n\\nSIM_NAME: Optional[str] = None\\n\\\"\\\"\\\"The running simulator product information.\\n\\n``None`` if :mod:`cocotb` was not loaded from a simulator.\\n\\\"\\\"\\\"\\n\\nSIM_VERSION: Optional[str] = None\\n\\\"\\\"\\\"The version of the running simulator.\\n\\n``None`` if :mod:`cocotb` was not loaded from a simulator.\\\"\\\"\\\"\\n\\nRANDOM_SEED: Optional[int] = None\\n\\\"\\\"\\\"\\nThe value passed to the Python default random number generator.\\n\\nSee :envvar:`RANDOM_SEED` for details on how the value is computed.\\nThis is guaranteed to hold a value at test time.\\n\\\"\\\"\\\"\\n\\n_library_coverage = None\\n\\\"\\\"\\\" used for cocotb library coverage \\\"\\\"\\\"\\n\\ntop: Optional[cocotb.handle.SimHandleBase] = None\\nr\\\"\\\"\\\"\\nA handle to the :envvar:`TOPLEVEL` entity/module.\\n\\nThis is equivalent to the :term:`DUT` parameter given to cocotb tests, so it can be used wherever that variable can be used.\\nIt is particularly useful for extracting information about the :term:`DUT` in module-level class and function definitions;\\nand in parameters to :class:`.TestFactory`\\\\ s.\\n``None`` if :mod:`cocotb` was not loaded from a simulator.\\n\\\"\\\"\\\"\\n\\n\\ndef fork(coro: Union[RunningTask, Coroutine]) -> RunningTask:\\n \\\"\\\"\\\" Schedule a coroutine to be run concurrently. See :ref:`coroutines` for details on its use. \\\"\\\"\\\"\\n return scheduler.add(coro)\\n\\n\\ndef start_soon(coro: Union[RunningTask, Coroutine]) -> RunningTask:\\n \\\"\\\"\\\"\\n Schedule a coroutine to be run concurrently.\\n\\n Note that this is not an async function,\\n and the new task will not execute until the calling task yields control.\\n\\n .. versionadded:: 1.6.0\\n \\\"\\\"\\\"\\n return scheduler.start_soon(coro)\\n\\n\\nasync def start(coro: Union[RunningTask, Coroutine]) -> RunningTask:\\n \\\"\\\"\\\"\\n Schedule a coroutine to be run concurrently, then yield control to allow pending tasks to execute.\\n\\n The calling task will resume execution before control is returned to the simulator.\\n\\n .. versionadded:: 1.6.0\\n \\\"\\\"\\\"\\n task = scheduler.start_soon(coro)\\n await cocotb.triggers.NullTrigger()\\n return task\\n\\n\\ndef create_task(coro: Union[RunningTask, Coroutine]) -> RunningTask:\\n \\\"\\\"\\\"\\n Constructs a coroutine into a Task without scheduling the Task.\\n\\n The Task can later be scheduled with :func:`cocotb.fork`, :func:`cocotb.start`, or\\n :func:`cocotb.start_soon`.\\n\\n .. versionadded:: 1.6.0\\n \\\"\\\"\\\"\\n return cocotb.scheduler.create_task(coro)\\n\\n\\n# FIXME is this really required?\\n_rlock = threading.RLock()\\n\\n\\ndef mem_debug(port):\\n import cocotb.memdebug\\n cocotb.memdebug.start(port)\\n\\n\\ndef _initialise_testbench(argv_): # pragma: no cover\\n \\\"\\\"\\\"Initialize testbench.\\n\\n This function is called after the simulator has elaborated all\\n entities and is ready to run the test.\\n\\n The test must be defined by the environment variables\\n :envvar:`MODULE` and :envvar:`TESTCASE`.\\n \\\"\\\"\\\"\\n with _rlock:\\n\\n if \\\"COCOTB_LIBRARY_COVERAGE\\\" in os.environ:\\n import coverage\\n\\n global _library_coverage\\n _library_coverage = coverage.coverage(\\n data_file=\\\".coverage.cocotb\\\",\\n branch=True,\\n include=[\\\"{}/*\\\".format(os.path.dirname(__file__))])\\n _library_coverage.start()\\n\\n return _initialise_testbench_(argv_)\\n\\n\\ndef _initialise_testbench_(argv_):\\n # The body of this function is split in two because no coverage is collected on\\n # the function that starts the coverage. By splitting it in two we get coverage\\n # on most of the function.\\n\\n global argc, argv\\n argv = argv_\\n argc = len(argv)\\n\\n root_name = os.getenv(\\\"TOPLEVEL\\\")\\n if root_name is not None:\\n root_name = root_name.strip()\\n if root_name == \\\"\\\":\\n root_name = None\\n elif '.' in root_name:\\n # Skip any library component of the toplevel\\n root_name = root_name.split(\\\".\\\", 1)[1]\\n\\n # sys.path normally includes \\\"\\\" (the current directory), but does not appear to when python is embedded.\\n # Add it back because users expect to be able to import files in their test directory.\\n # TODO: move this to gpi_embed.cpp\\n sys.path.insert(0, \\\"\\\")\\n\\n _setup_logging()\\n\\n # From https://www.python.org/dev/peps/pep-0565/#recommended-filter-settings-for-test-runners\\n # If the user doesn't want to see these, they can always change the global\\n # warning settings in their test module.\\n if not sys.warnoptions:\\n warnings.simplefilter(\\\"default\\\")\\n\\n from cocotb import simulator\\n\\n global SIM_NAME, SIM_VERSION\\n SIM_NAME = simulator.get_simulator_product().strip()\\n SIM_VERSION = simulator.get_simulator_version().strip()\\n\\n cocotb.log.info(f\\\"Running on {SIM_NAME} version {SIM_VERSION}\\\")\\n\\n memcheck_port = os.getenv('MEMCHECK')\\n if memcheck_port is not None:\\n mem_debug(int(memcheck_port))\\n\\n log.info(\\\"Running tests with cocotb v%s from %s\\\" %\\n (__version__, os.path.dirname(__file__)))\\n\\n # Create the base handle type\\n\\n process_plusargs()\\n\\n global scheduler\\n scheduler = Scheduler()\\n\\n # Seed the Python random number generator to make this repeatable\\n global RANDOM_SEED\\n RANDOM_SEED = os.getenv('RANDOM_SEED')\\n\\n if RANDOM_SEED is None:\\n if 'ntb_random_seed' in plusargs:\\n RANDOM_SEED = eval(plusargs['ntb_random_seed'])\\n elif 'seed' in plusargs:\\n RANDOM_SEED = eval(plusargs['seed'])\\n else:\\n RANDOM_SEED = int(time.time())\\n log.info(\\\"Seeding Python random module with %d\\\" % (RANDOM_SEED))\\n else:\\n RANDOM_SEED = int(RANDOM_SEED)\\n log.info(\\\"Seeding Python random module with supplied seed %d\\\" % (RANDOM_SEED))\\n random.seed(RANDOM_SEED)\\n\\n # Setup DUT object\\n from cocotb import simulator\\n\\n handle = simulator.get_root_handle(root_name)\\n if not handle:\\n raise RuntimeError(f\\\"Can not find root handle ({root_name})\\\")\\n\\n global top\\n top = cocotb.handle.SimHandle(handle)\\n\\n try:\\n import pytest\\n except ImportError:\\n log.warning(\\\"Pytest not found, assertion rewriting will not occur\\\")\\n else:\\n try:\\n # Install the assertion rewriting hook, which must be done before we\\n # import the test modules.\\n from _pytest.config import Config\\n from _pytest.assertion import install_importhook\\n pytest_conf = Config.fromdictargs({}, ['--capture=no'])\\n install_importhook(pytest_conf)\\n except Exception:\\n log.exception(\\n \\\"Configuring the assertion rewrite hook using pytest {} failed. \\\"\\n \\\"Please file a bug report!\\\".format(pytest.__version__))\\n\\n # start Regression Manager\\n global regression_manager\\n regression_manager = RegressionManager.from_discovery(top)\\n regression_manager.execute()\\n\\n return True\\n\\n\\ndef _sim_event(level, message):\\n \\\"\\\"\\\"Function that can be called externally to signal an event.\\\"\\\"\\\"\\n # SIM_INFO = 0\\n SIM_TEST_FAIL = 1\\n SIM_FAIL = 2\\n from cocotb.result import TestFailure, SimFailure\\n\\n if level is SIM_TEST_FAIL:\\n scheduler.log.error(\\\"Failing test at simulator request\\\")\\n scheduler._finish_test(TestFailure(f\\\"Failure from external source: {message}\\\"))\\n elif level is SIM_FAIL:\\n # We simply return here as the simulator will exit\\n # so no cleanup is needed\\n msg = f\\\"Failing test at simulator request before test run completion: {message}\\\"\\n scheduler.log.error(msg)\\n scheduler._finish_scheduler(SimFailure(msg))\\n else:\\n scheduler.log.error(\\\"Unsupported sim event\\\")\\n\\n return True\\n\\n\\ndef process_plusargs():\\n\\n global plusargs\\n\\n plusargs = {}\\n\\n for option in cocotb.argv:\\n if option.startswith('+'):\\n if option.find('=') != -1:\\n (name, value) = option[1:].split('=', 1)\\n plusargs[name] = value\\n else:\\n plusargs[option[1:]] = True\\n\",\n \"path\": \"cocotb/__init__.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/cocotb/__init__.py b/cocotb/__init__.py\nindex 6413f2ba16..37eb7f6fb6 100644\n--- a/cocotb/__init__.py\n+++ b/cocotb/__init__.py\n@@ -196,6 +196,18 @@ async def start(coro: Union[RunningTask, Coroutine]) -> RunningTask:\n return task\n \n \n+def create_task(coro: Union[RunningTask, Coroutine]) -> RunningTask:\n+ \"\"\"\n+ Constructs a coroutine into a Task without scheduling the Task.\n+\n+ The Task can later be scheduled with :func:`cocotb.fork`, :func:`cocotb.start`, or\n+ :func:`cocotb.start_soon`.\n+\n+ .. versionadded:: 1.6.0\n+ \"\"\"\n+ return cocotb.scheduler.create_task(coro)\n+\n+\n # FIXME is this really required?\n _rlock = threading.RLock()\n \ndiff --git a/documentation/source/library_reference.rst b/documentation/source/library_reference.rst\nindex 7fdada363a..2ee9c57c07 100644\n--- a/documentation/source/library_reference.rst\n+++ b/documentation/source/library_reference.rst\n@@ -62,6 +62,8 @@ Interacting with the Simulator\n \n .. autofunction:: cocotb.start\n \n+.. autofunction:: cocotb.create_task\n+\n .. autofunction:: cocotb.decorators.RunningTask.join\n \n .. autofunction:: cocotb.decorators.RunningTask.kill\ndiff --git a/documentation/source/newsfragments/2665.feature.rst b/documentation/source/newsfragments/2665.feature.rst\nnew file mode 100644\nindex 0000000000..b6c9e1439e\n--- /dev/null\n+++ b/documentation/source/newsfragments/2665.feature.rst\n@@ -0,0 +1 @@\n+Add :func:`cocotb.create_task` API for creating a Task from a Coroutine without scheduling.\ndiff --git a/tests/test_cases/test_cocotb/test_scheduler.py b/tests/test_cases/test_cocotb/test_scheduler.py\nindex ad5311548f..b2fc1594ef 100644\n--- a/tests/test_cases/test_cocotb/test_scheduler.py\n+++ b/tests/test_cases/test_cocotb/test_scheduler.py\n@@ -10,12 +10,25 @@\n \"\"\"\n import logging\n import re\n+from typing import Coroutine\n \n import cocotb\n-from cocotb.triggers import Join, Timer, RisingEdge, Trigger, NullTrigger, Combine, Event, ReadOnly, First\n+import pytest\n from cocotb.clock import Clock\n-from common import clock_gen\n+from cocotb.decorators import RunningTask\n+from cocotb.triggers import (\n+ Combine,\n+ Event,\n+ First,\n+ Join,\n+ NullTrigger,\n+ ReadOnly,\n+ RisingEdge,\n+ Timer,\n+ Trigger,\n+)\n \n+from common import clock_gen\n \n test_flag = False\n \n@@ -543,7 +556,7 @@ async def coro():\n await Timer(1, 'step')\n assert task1._finished\n \n- task2 = cocotb.scheduler.create_task(coro())\n+ task2 = cocotb.create_task(coro())\n task3 = await cocotb.start(task2)\n assert task3 is task2\n \n@@ -595,3 +608,55 @@ async def coro():\n assert coro_started is True\n await Timer(1, 'step') # await a GPITrigger to ensure control returns to simulator\n assert sim_resumed is True\n+\n+\n+@cocotb.test()\n+async def test_create_task(_):\n+\n+ # proper construction from coroutines\n+ async def coro():\n+ pass\n+\n+ assert type(cocotb.create_task(coro())) == RunningTask\n+\n+ # proper construction from Coroutine objects\n+ class CoroType(Coroutine):\n+ def __init__(self):\n+ self._coro = coro()\n+\n+ def send(self, value):\n+ return self._coro.send(value)\n+\n+ def throw(self, exception):\n+ self._coro.throw(exception)\n+\n+ def close(self):\n+ self._coro.close()\n+\n+ def __await__(self):\n+ yield from self._coro.__await__()\n+\n+ assert type(cocotb.create_task(CoroType())) == RunningTask\n+\n+ # fail if given async generators\n+ async def agen():\n+ yield None\n+\n+ with pytest.raises(TypeError):\n+ cocotb.create_task(agen())\n+\n+ # fail if given coroutine function\n+ with pytest.raises(TypeError):\n+ cocotb.create_task(coro)\n+\n+ # fail if given Coroutine Type\n+ with pytest.raises(TypeError):\n+ cocotb.create_task(CoroType)\n+\n+ # fail if given async generator function\n+ with pytest.raises(TypeError):\n+ cocotb.create_task(agen)\n+\n+ # fail if given random type\n+ with pytest.raises(TypeError):\n+ cocotb.create_task(object())\n"}}},{"rowIdx":4675,"cells":{"in_source_id":{"kind":"string","value":"instadeepai__Mava-800"},"issue":{"kind":"string","value":"[BUG] SMAC legal action masking \n### Describe the bug\r\nThere is a bug with legal action masking on the SMAC tasks leading to runs failing. This is happening on big run sweeps for both recurrent and feedforward systems on the `25m` and `bane_vs_bane` tasks so far. \r\n\r\n### To Reproduce\r\nA note. I was not able to reproduce this locally due to these tasks being to demanding for my machine to run effectively.\r\n\r\nSteps to reproduce the behavior:\r\n1. Run smac on `25m` or `bane_vs_bane` with either recurrent or feedforward policies. \r\n\r\n### Expected behavior\r\nThe following error occurs \r\n```\r\n2022/10/12 11:37:24 | Traceback:\r\n-- | --\r\n2022/10/12 11:37:24 | File \"/mava/lib/python3.8/site-packages/launchpad/nodes/python/process_entry.py\", line 126, in <module> app.run(main)\r\n2022/10/12 11:37:24 | File \"/mava/lib/python3.8/site-packages/absl/app.py\", line 308, in run _run_main(main, args)\r\n2022/10/12 11:37:24 | File \"/mava/lib/python3.8/site-packages/absl/app.py\", line 254, in _run_main sys.exit(main(argv))\r\n2022/10/12 11:37:24 | File \"/mava/lib/python3.8/site-packages/launchpad/nodes/python/process_entry.py\", line 121, in main functions[task_id]()\r\n2022/10/12 11:37:24 | File \"/mava/lib/python3.8/site-packages/launchpad/nodes/python/node.py\", line 75, in _construct_function return functools.partial(self._function, *args, **kwargs)()\r\n2022/10/12 11:37:24 | File \"/mava/lib/python3.8/site-packages/launchpad/nodes/courier/node.py\", line 130, in run instance.run()\r\n2022/10/12 11:37:24 | File \"/mava/lib/python3.8/site-packages/mava/environment_loop.py\", line 686, in run result = self.run_episode()\r\n2022/10/12 11:37:24 | File \"/mava/lib/python3.8/site-packages/mava/environment_loop.py\", line 511, in run_episode timestep = self._environment.step(env_actions)\r\n2022/10/12 11:37:24 | File \"/mava/lib/python3.8/site-packages/mava/wrappers/smac.py\", line 120, in step reward, self._done, self._info = self._environment.step(smac_actions)\r\n2022/10/12 11:37:24 | File \"/mava/lib/python3.8/site-packages/smac/env/starcraft2/starcraft2.py\", line 465, in step sc_action = self.get_agent_action(a_id, action)\r\n2022/10/12 11:37:24 | File \"/mava/lib/python3.8/site-packages/smac/env/starcraft2/starcraft2.py\", line 551, in get_agent_action assert (\r\n2022/10/12 11:37:24 | Agent 15 cannot perform action 18\r\n```\r\n\r\n### Context (Environment)\r\n - Occurring when using the `sc2-latest` Docker image. \r\n\r\n### Possible Solution\r\nNot obligatory, but suggest a fix/reason for the bug.\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"# python3\n# Copyright 2021 InstaDeep Ltd. All rights reserved.\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\"\"\"Wraper for SMAC.\"\"\"\nfrom typing import Any, Dict, List, Optional, Union\n\nimport dm_env\nimport numpy as np\nfrom acme import specs\nfrom smac.env import StarCraft2Env\n\nfrom mava import types\nfrom mava.utils.wrapper_utils import convert_np_type, parameterized_restart\nfrom mava.wrappers.env_wrappers import ParallelEnvWrapper\n\n\nclass SMACWrapper(ParallelEnvWrapper):\n \"\"\"Environment wrapper for PettingZoo MARL environments.\"\"\"\n\n def __init__(\n self,\n environment: StarCraft2Env,\n return_state_info: bool = True,\n death_masking: bool = False,\n ):\n \"\"\"Constructor for parallel PZ wrapper.\n\n Args:\n environment (ParallelEnv): parallel PZ env.\n env_preprocess_wrappers (Optional[List], optional): Wrappers\n that preprocess envs.\n Format (env_preprocessor, dict_with_preprocessor_params).\n death_masking: whether to mask out agent observations once dead.\n return_state_info: return extra state info\n \"\"\"\n self._environment = environment\n self._return_state_info = return_state_info\n self._agents = [f\"agent_{n}\" for n in range(self._environment.n_agents)]\n\n self._reset_next_step = True\n self._done = False\n\n self._battles_won = 0\n self._battles_game = 0\n\n self._death_masking = death_masking\n\n def reset(self) -> dm_env.TimeStep:\n \"\"\"Resets the env.\n\n Returns:\n dm_env.TimeStep: dm timestep.\n \"\"\"\n # Reset the environment\n self._environment.reset()\n self._done = False\n\n self._reset_next_step = False\n self._step_type = dm_env.StepType.FIRST\n\n # Get observation from env\n observation = self.environment.get_obs()\n legal_actions = self._get_legal_actions()\n observations = self._convert_observations(\n observation, legal_actions, self._done\n )\n\n # Set env discount to 1 for all agents\n discount_spec = self.discount_spec()\n self._discounts = {\n agent: convert_np_type(discount_spec[agent].dtype, 1)\n for agent in self._agents\n }\n\n # Set reward to zero for all agents\n rewards_spec = self.reward_spec()\n rewards = {\n agent: convert_np_type(rewards_spec[agent].dtype, 0)\n for agent in self._agents\n }\n\n # Possibly add state information to extras\n if self._return_state_info:\n state = self.get_state()\n extras = {\"s_t\": state}\n else:\n extras = {}\n\n return parameterized_restart(rewards, self._discounts, observations), extras\n\n def step(self, actions: Dict[str, np.ndarray]) -> dm_env.TimeStep:\n \"\"\"Steps in env.\n\n Args:\n actions (Dict[str, np.ndarray]): actions per agent.\n\n Returns:\n dm_env.TimeStep: dm timestep\n \"\"\"\n # Possibly reset the environment\n if self._reset_next_step:\n return self.reset()\n\n # Convert dict of actions to list for SMAC\n smac_actions = list(actions.values())\n\n # Step the SMAC environment\n reward, self._done, self._info = self._environment.step(smac_actions)\n\n # Get the next observations\n next_observations = self._environment.get_obs()\n legal_actions = self._get_legal_actions()\n next_observations = self._convert_observations(\n next_observations, legal_actions, self._done\n )\n\n # Convert team reward to agent-wise rewards\n rewards = self._convert_reward(reward)\n\n # Possibly add state information to extras\n if self._return_state_info:\n state = self.get_state()\n extras = {\"s_t\": state}\n else:\n extras = {}\n\n if self._done:\n self._step_type = dm_env.StepType.LAST\n self._reset_next_step = True\n\n # Discount on last timestep set to zero\n self._discounts = {\n agent: convert_np_type(self.discount_spec()[agent].dtype, 0.0)\n for agent in self._agents\n }\n else:\n self._step_type = dm_env.StepType.MID\n\n # Create timestep object\n timestep = dm_env.TimeStep(\n observation=next_observations,\n reward=rewards,\n discount=self._discounts,\n step_type=self._step_type,\n )\n\n return timestep, extras\n\n def env_done(self) -> bool:\n \"\"\"Check if env is done.\n\n Returns:\n bool: bool indicating if env is done.\n \"\"\"\n return self._done\n\n def _convert_reward(self, reward: float) -> Dict[str, float]:\n \"\"\"Convert rewards to be dm_env compatible.\n\n Args:\n reward: rewards per agent.\n \"\"\"\n rewards_spec = self.reward_spec()\n rewards = {}\n for agent in self._agents:\n rewards[agent] = convert_np_type(rewards_spec[agent].dtype, reward)\n return rewards\n\n def _get_legal_actions(self) -> List:\n \"\"\"Get legal actions from the environment.\"\"\"\n legal_actions = []\n for i, _ in enumerate(self._agents):\n legal_actions.append(\n np.array(self._environment.get_avail_agent_actions(i), dtype=\"int\")\n )\n return legal_actions\n\n def is_dead(self, agent: Any) -> bool:\n \"\"\"Check if the agent is dead.\n\n Returns:\n is_dead: boolean indicating whether the agent is alive or dead.\n \"\"\"\n is_dead = False\n if self._environment.agents[agent].health == 0.0:\n is_dead = True\n return is_dead\n\n def _convert_observations(\n self, observations: List, legal_actions: List, done: bool\n ) -> types.Observation:\n \"\"\"Convert SMAC observation so it's dm_env compatible.\n\n Args:\n observes (Dict[str, np.ndarray]): observations per agent.\n dones (Dict[str, bool]): dones per agent.\n\n Returns:\n types.Observation: dm compatible observations.\n \"\"\"\n olt_observations = {}\n for i, agent in enumerate(self._agents):\n # Check if agent is dead, if so, apply death mask.\n if self._death_masking and self.is_dead(i):\n observation = np.zeros_like(observations[i])\n else:\n observation = observations[i]\n\n olt_observations[agent] = types.OLT(\n observation=observation,\n legal_actions=legal_actions[i],\n terminal=np.asarray([done], dtype=np.float32),\n )\n\n return olt_observations\n\n def extras_spec(self) -> Dict[str, specs.BoundedArray]:\n \"\"\"Function returns extra spec (format) of the env.\n\n Returns:\n Dict[str, specs.BoundedArray]: extra spec.\n \"\"\"\n if self._return_state_info:\n return {\"s_t\": self._environment.get_state()}\n else:\n return {}\n\n def observation_spec(self) -> Dict[str, types.OLT]:\n \"\"\"Observation spec.\n\n Returns:\n types.Observation: spec for environment.\n \"\"\"\n self._environment.reset()\n\n observations = self._environment.get_obs()\n legal_actions = self._get_legal_actions()\n\n observation_specs = {}\n for i, agent in enumerate(self._agents):\n\n observation_specs[agent] = types.OLT(\n observation=observations[i],\n legal_actions=legal_actions[i],\n terminal=np.asarray([True], dtype=np.float32),\n )\n\n return observation_specs\n\n def action_spec(\n self,\n ) -> Dict[str, Union[specs.DiscreteArray, specs.BoundedArray]]:\n \"\"\"Action spec.\n\n Returns:\n spec for actions.\n \"\"\"\n action_specs = {}\n for agent in self._agents:\n action_specs[agent] = specs.DiscreteArray(\n num_values=self._environment.n_actions, dtype=int\n )\n return action_specs\n\n def reward_spec(self) -> Dict[str, specs.Array]:\n \"\"\"Reward spec.\n\n Returns:\n Dict[str, specs.Array]: spec for rewards.\n \"\"\"\n reward_specs = {}\n for agent in self._agents:\n reward_specs[agent] = specs.Array((), np.float32)\n return reward_specs\n\n def discount_spec(self) -> Dict[str, specs.BoundedArray]:\n \"\"\"Discount spec.\n\n Returns:\n Dict[str, specs.BoundedArray]: spec for discounts.\n \"\"\"\n discount_specs = {}\n for agent in self._agents:\n discount_specs[agent] = specs.BoundedArray(\n (), np.float32, minimum=0, maximum=1.0\n )\n return discount_specs\n\n def get_stats(self) -> Optional[Dict]:\n \"\"\"Return extra stats to be logged.\n\n Returns:\n extra stats to be logged.\n \"\"\"\n stats = self._environment.get_stats()\n stats[\"cumulative_win_rate\"] = stats[\"win_rate\"]\n del stats[\"win_rate\"]\n return stats\n\n def get_interval_stats(self) -> Optional[Dict]:\n \"\"\"Computes environment statistics which should be exclusively \\\n computed over a given number of evaluation episodes.\n\n An example would be a win rate calculation where it is required to\n keep track of the number of games won over a given set of evaluation\n episodes.\n\n Returns:\n Win rate\n \"\"\"\n interval_stats: Dict[str, Any] = {}\n interval_stats[\"win_rate\"] = (\n self._environment.battles_won - self._battles_won\n ) / (self._environment.battles_game - self._battles_game)\n self._battles_won = self._environment.battles_won\n self._battles_game = self._environment.battles_game\n return interval_stats\n\n @property\n def agents(self) -> List:\n \"\"\"Agents still alive in env (not done).\n\n Returns:\n List: alive agents in env.\n \"\"\"\n return self._agents\n\n @property\n def possible_agents(self) -> List:\n \"\"\"All possible agents in env.\n\n Returns:\n List: all possible agents in env.\n \"\"\"\n return self._agents\n\n @property\n def environment(self) -> StarCraft2Env:\n \"\"\"Returns the wrapped environment.\n\n Returns:\n ParallelEnv: parallel env.\n \"\"\"\n return self._environment\n\n def __getattr__(self, name: str) -> Any:\n \"\"\"Expose any other attributes of the underlying environment.\n\n Args:\n name (str): attribute.\n\n Returns:\n Any: return attribute from env or underlying env.\n \"\"\"\n if hasattr(self.__class__, name):\n return self.__getattribute__(name)\n else:\n return getattr(self._environment, name)\n","path":"mava/wrappers/smac.py"}],"string":"[\n {\n \"content\": \"# python3\\n# Copyright 2021 InstaDeep Ltd. All rights reserved.\\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\\\"\\\"\\\"Wraper for SMAC.\\\"\\\"\\\"\\nfrom typing import Any, Dict, List, Optional, Union\\n\\nimport dm_env\\nimport numpy as np\\nfrom acme import specs\\nfrom smac.env import StarCraft2Env\\n\\nfrom mava import types\\nfrom mava.utils.wrapper_utils import convert_np_type, parameterized_restart\\nfrom mava.wrappers.env_wrappers import ParallelEnvWrapper\\n\\n\\nclass SMACWrapper(ParallelEnvWrapper):\\n \\\"\\\"\\\"Environment wrapper for PettingZoo MARL environments.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n environment: StarCraft2Env,\\n return_state_info: bool = True,\\n death_masking: bool = False,\\n ):\\n \\\"\\\"\\\"Constructor for parallel PZ wrapper.\\n\\n Args:\\n environment (ParallelEnv): parallel PZ env.\\n env_preprocess_wrappers (Optional[List], optional): Wrappers\\n that preprocess envs.\\n Format (env_preprocessor, dict_with_preprocessor_params).\\n death_masking: whether to mask out agent observations once dead.\\n return_state_info: return extra state info\\n \\\"\\\"\\\"\\n self._environment = environment\\n self._return_state_info = return_state_info\\n self._agents = [f\\\"agent_{n}\\\" for n in range(self._environment.n_agents)]\\n\\n self._reset_next_step = True\\n self._done = False\\n\\n self._battles_won = 0\\n self._battles_game = 0\\n\\n self._death_masking = death_masking\\n\\n def reset(self) -> dm_env.TimeStep:\\n \\\"\\\"\\\"Resets the env.\\n\\n Returns:\\n dm_env.TimeStep: dm timestep.\\n \\\"\\\"\\\"\\n # Reset the environment\\n self._environment.reset()\\n self._done = False\\n\\n self._reset_next_step = False\\n self._step_type = dm_env.StepType.FIRST\\n\\n # Get observation from env\\n observation = self.environment.get_obs()\\n legal_actions = self._get_legal_actions()\\n observations = self._convert_observations(\\n observation, legal_actions, self._done\\n )\\n\\n # Set env discount to 1 for all agents\\n discount_spec = self.discount_spec()\\n self._discounts = {\\n agent: convert_np_type(discount_spec[agent].dtype, 1)\\n for agent in self._agents\\n }\\n\\n # Set reward to zero for all agents\\n rewards_spec = self.reward_spec()\\n rewards = {\\n agent: convert_np_type(rewards_spec[agent].dtype, 0)\\n for agent in self._agents\\n }\\n\\n # Possibly add state information to extras\\n if self._return_state_info:\\n state = self.get_state()\\n extras = {\\\"s_t\\\": state}\\n else:\\n extras = {}\\n\\n return parameterized_restart(rewards, self._discounts, observations), extras\\n\\n def step(self, actions: Dict[str, np.ndarray]) -> dm_env.TimeStep:\\n \\\"\\\"\\\"Steps in env.\\n\\n Args:\\n actions (Dict[str, np.ndarray]): actions per agent.\\n\\n Returns:\\n dm_env.TimeStep: dm timestep\\n \\\"\\\"\\\"\\n # Possibly reset the environment\\n if self._reset_next_step:\\n return self.reset()\\n\\n # Convert dict of actions to list for SMAC\\n smac_actions = list(actions.values())\\n\\n # Step the SMAC environment\\n reward, self._done, self._info = self._environment.step(smac_actions)\\n\\n # Get the next observations\\n next_observations = self._environment.get_obs()\\n legal_actions = self._get_legal_actions()\\n next_observations = self._convert_observations(\\n next_observations, legal_actions, self._done\\n )\\n\\n # Convert team reward to agent-wise rewards\\n rewards = self._convert_reward(reward)\\n\\n # Possibly add state information to extras\\n if self._return_state_info:\\n state = self.get_state()\\n extras = {\\\"s_t\\\": state}\\n else:\\n extras = {}\\n\\n if self._done:\\n self._step_type = dm_env.StepType.LAST\\n self._reset_next_step = True\\n\\n # Discount on last timestep set to zero\\n self._discounts = {\\n agent: convert_np_type(self.discount_spec()[agent].dtype, 0.0)\\n for agent in self._agents\\n }\\n else:\\n self._step_type = dm_env.StepType.MID\\n\\n # Create timestep object\\n timestep = dm_env.TimeStep(\\n observation=next_observations,\\n reward=rewards,\\n discount=self._discounts,\\n step_type=self._step_type,\\n )\\n\\n return timestep, extras\\n\\n def env_done(self) -> bool:\\n \\\"\\\"\\\"Check if env is done.\\n\\n Returns:\\n bool: bool indicating if env is done.\\n \\\"\\\"\\\"\\n return self._done\\n\\n def _convert_reward(self, reward: float) -> Dict[str, float]:\\n \\\"\\\"\\\"Convert rewards to be dm_env compatible.\\n\\n Args:\\n reward: rewards per agent.\\n \\\"\\\"\\\"\\n rewards_spec = self.reward_spec()\\n rewards = {}\\n for agent in self._agents:\\n rewards[agent] = convert_np_type(rewards_spec[agent].dtype, reward)\\n return rewards\\n\\n def _get_legal_actions(self) -> List:\\n \\\"\\\"\\\"Get legal actions from the environment.\\\"\\\"\\\"\\n legal_actions = []\\n for i, _ in enumerate(self._agents):\\n legal_actions.append(\\n np.array(self._environment.get_avail_agent_actions(i), dtype=\\\"int\\\")\\n )\\n return legal_actions\\n\\n def is_dead(self, agent: Any) -> bool:\\n \\\"\\\"\\\"Check if the agent is dead.\\n\\n Returns:\\n is_dead: boolean indicating whether the agent is alive or dead.\\n \\\"\\\"\\\"\\n is_dead = False\\n if self._environment.agents[agent].health == 0.0:\\n is_dead = True\\n return is_dead\\n\\n def _convert_observations(\\n self, observations: List, legal_actions: List, done: bool\\n ) -> types.Observation:\\n \\\"\\\"\\\"Convert SMAC observation so it's dm_env compatible.\\n\\n Args:\\n observes (Dict[str, np.ndarray]): observations per agent.\\n dones (Dict[str, bool]): dones per agent.\\n\\n Returns:\\n types.Observation: dm compatible observations.\\n \\\"\\\"\\\"\\n olt_observations = {}\\n for i, agent in enumerate(self._agents):\\n # Check if agent is dead, if so, apply death mask.\\n if self._death_masking and self.is_dead(i):\\n observation = np.zeros_like(observations[i])\\n else:\\n observation = observations[i]\\n\\n olt_observations[agent] = types.OLT(\\n observation=observation,\\n legal_actions=legal_actions[i],\\n terminal=np.asarray([done], dtype=np.float32),\\n )\\n\\n return olt_observations\\n\\n def extras_spec(self) -> Dict[str, specs.BoundedArray]:\\n \\\"\\\"\\\"Function returns extra spec (format) of the env.\\n\\n Returns:\\n Dict[str, specs.BoundedArray]: extra spec.\\n \\\"\\\"\\\"\\n if self._return_state_info:\\n return {\\\"s_t\\\": self._environment.get_state()}\\n else:\\n return {}\\n\\n def observation_spec(self) -> Dict[str, types.OLT]:\\n \\\"\\\"\\\"Observation spec.\\n\\n Returns:\\n types.Observation: spec for environment.\\n \\\"\\\"\\\"\\n self._environment.reset()\\n\\n observations = self._environment.get_obs()\\n legal_actions = self._get_legal_actions()\\n\\n observation_specs = {}\\n for i, agent in enumerate(self._agents):\\n\\n observation_specs[agent] = types.OLT(\\n observation=observations[i],\\n legal_actions=legal_actions[i],\\n terminal=np.asarray([True], dtype=np.float32),\\n )\\n\\n return observation_specs\\n\\n def action_spec(\\n self,\\n ) -> Dict[str, Union[specs.DiscreteArray, specs.BoundedArray]]:\\n \\\"\\\"\\\"Action spec.\\n\\n Returns:\\n spec for actions.\\n \\\"\\\"\\\"\\n action_specs = {}\\n for agent in self._agents:\\n action_specs[agent] = specs.DiscreteArray(\\n num_values=self._environment.n_actions, dtype=int\\n )\\n return action_specs\\n\\n def reward_spec(self) -> Dict[str, specs.Array]:\\n \\\"\\\"\\\"Reward spec.\\n\\n Returns:\\n Dict[str, specs.Array]: spec for rewards.\\n \\\"\\\"\\\"\\n reward_specs = {}\\n for agent in self._agents:\\n reward_specs[agent] = specs.Array((), np.float32)\\n return reward_specs\\n\\n def discount_spec(self) -> Dict[str, specs.BoundedArray]:\\n \\\"\\\"\\\"Discount spec.\\n\\n Returns:\\n Dict[str, specs.BoundedArray]: spec for discounts.\\n \\\"\\\"\\\"\\n discount_specs = {}\\n for agent in self._agents:\\n discount_specs[agent] = specs.BoundedArray(\\n (), np.float32, minimum=0, maximum=1.0\\n )\\n return discount_specs\\n\\n def get_stats(self) -> Optional[Dict]:\\n \\\"\\\"\\\"Return extra stats to be logged.\\n\\n Returns:\\n extra stats to be logged.\\n \\\"\\\"\\\"\\n stats = self._environment.get_stats()\\n stats[\\\"cumulative_win_rate\\\"] = stats[\\\"win_rate\\\"]\\n del stats[\\\"win_rate\\\"]\\n return stats\\n\\n def get_interval_stats(self) -> Optional[Dict]:\\n \\\"\\\"\\\"Computes environment statistics which should be exclusively \\\\\\n computed over a given number of evaluation episodes.\\n\\n An example would be a win rate calculation where it is required to\\n keep track of the number of games won over a given set of evaluation\\n episodes.\\n\\n Returns:\\n Win rate\\n \\\"\\\"\\\"\\n interval_stats: Dict[str, Any] = {}\\n interval_stats[\\\"win_rate\\\"] = (\\n self._environment.battles_won - self._battles_won\\n ) / (self._environment.battles_game - self._battles_game)\\n self._battles_won = self._environment.battles_won\\n self._battles_game = self._environment.battles_game\\n return interval_stats\\n\\n @property\\n def agents(self) -> List:\\n \\\"\\\"\\\"Agents still alive in env (not done).\\n\\n Returns:\\n List: alive agents in env.\\n \\\"\\\"\\\"\\n return self._agents\\n\\n @property\\n def possible_agents(self) -> List:\\n \\\"\\\"\\\"All possible agents in env.\\n\\n Returns:\\n List: all possible agents in env.\\n \\\"\\\"\\\"\\n return self._agents\\n\\n @property\\n def environment(self) -> StarCraft2Env:\\n \\\"\\\"\\\"Returns the wrapped environment.\\n\\n Returns:\\n ParallelEnv: parallel env.\\n \\\"\\\"\\\"\\n return self._environment\\n\\n def __getattr__(self, name: str) -> Any:\\n \\\"\\\"\\\"Expose any other attributes of the underlying environment.\\n\\n Args:\\n name (str): attribute.\\n\\n Returns:\\n Any: return attribute from env or underlying env.\\n \\\"\\\"\\\"\\n if hasattr(self.__class__, name):\\n return self.__getattribute__(name)\\n else:\\n return getattr(self._environment, name)\\n\",\n \"path\": \"mava/wrappers/smac.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# python3\n# Copyright 2021 InstaDeep Ltd. All rights reserved.\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\"\"\"Wraper for SMAC.\"\"\"\nfrom typing import Any, Dict, List, Optional, Union\n\nimport dm_env\nimport numpy as np\nfrom acme import specs\nfrom smac.env import StarCraft2Env\n\nfrom mava import types\nfrom mava.utils.wrapper_utils import convert_np_type, parameterized_restart\nfrom mava.wrappers.env_wrappers import ParallelEnvWrapper\n\n\nclass SMACWrapper(ParallelEnvWrapper):\n \"\"\"Environment wrapper for PettingZoo MARL environments.\"\"\"\n\n def __init__(\n self,\n environment: StarCraft2Env,\n return_state_info: bool = True,\n death_masking: bool = False,\n ):\n \"\"\"Constructor for parallel PZ wrapper.\n\n Args:\n environment (ParallelEnv): parallel PZ env.\n env_preprocess_wrappers (Optional[List], optional): Wrappers\n that preprocess envs.\n Format (env_preprocessor, dict_with_preprocessor_params).\n death_masking: whether to mask out agent observations once dead.\n return_state_info: return extra state info\n \"\"\"\n self._environment = environment\n self._return_state_info = return_state_info\n self._agents = [f\"agent_{n}\" for n in range(self._environment.n_agents)]\n\n self._reset_next_step = True\n self._done = False\n\n self._battles_won = 0\n self._battles_game = 0\n\n self._death_masking = death_masking\n\n def reset(self) -> dm_env.TimeStep:\n \"\"\"Resets the env.\n\n Returns:\n dm_env.TimeStep: dm timestep.\n \"\"\"\n # Reset the environment\n self._environment.reset()\n self._done = False\n\n self._reset_next_step = False\n self._step_type = dm_env.StepType.FIRST\n\n # Get observation from env\n observation = self.environment.get_obs()\n legal_actions = self._get_legal_actions()\n observations = self._convert_observations(\n observation, legal_actions, self._done\n )\n\n # Set env discount to 1 for all agents\n discount_spec = self.discount_spec()\n self._discounts = {\n agent: convert_np_type(discount_spec[agent].dtype, 1)\n for agent in self._agents\n }\n\n # Set reward to zero for all agents\n rewards_spec = self.reward_spec()\n rewards = {\n agent: convert_np_type(rewards_spec[agent].dtype, 0)\n for agent in self._agents\n }\n\n # Possibly add state information to extras\n if self._return_state_info:\n state = self.get_state()\n extras = {\"s_t\": state}\n else:\n extras = {}\n\n return parameterized_restart(rewards, self._discounts, observations), extras\n\n def step(self, actions: Dict[str, np.ndarray]) -> dm_env.TimeStep:\n \"\"\"Steps in env.\n\n Args:\n actions (Dict[str, np.ndarray]): actions per agent.\n\n Returns:\n dm_env.TimeStep: dm timestep\n \"\"\"\n # Possibly reset the environment\n if self._reset_next_step:\n return self.reset()\n\n # Convert dict of actions to list for SMAC\n smac_actions = [actions[agent] for agent in self._agents]\n\n # Step the SMAC environment\n reward, self._done, self._info = self._environment.step(smac_actions)\n\n # Get the next observations\n next_observations = self._environment.get_obs()\n legal_actions = self._get_legal_actions()\n next_observations = self._convert_observations(\n next_observations, legal_actions, self._done\n )\n\n # Convert team reward to agent-wise rewards\n rewards = self._convert_reward(reward)\n\n # Possibly add state information to extras\n if self._return_state_info:\n state = self.get_state()\n extras = {\"s_t\": state}\n else:\n extras = {}\n\n if self._done:\n self._step_type = dm_env.StepType.LAST\n self._reset_next_step = True\n\n # Discount on last timestep set to zero\n self._discounts = {\n agent: convert_np_type(self.discount_spec()[agent].dtype, 0.0)\n for agent in self._agents\n }\n else:\n self._step_type = dm_env.StepType.MID\n\n # Create timestep object\n timestep = dm_env.TimeStep(\n observation=next_observations,\n reward=rewards,\n discount=self._discounts,\n step_type=self._step_type,\n )\n\n return timestep, extras\n\n def env_done(self) -> bool:\n \"\"\"Check if env is done.\n\n Returns:\n bool: bool indicating if env is done.\n \"\"\"\n return self._done\n\n def _convert_reward(self, reward: float) -> Dict[str, float]:\n \"\"\"Convert rewards to be dm_env compatible.\n\n Args:\n reward: rewards per agent.\n \"\"\"\n rewards_spec = self.reward_spec()\n rewards = {}\n for agent in self._agents:\n rewards[agent] = convert_np_type(rewards_spec[agent].dtype, reward)\n return rewards\n\n def _get_legal_actions(self) -> List:\n \"\"\"Get legal actions from the environment.\"\"\"\n legal_actions = []\n for i, _ in enumerate(self._agents):\n legal_actions.append(\n np.array(self._environment.get_avail_agent_actions(i), dtype=\"int\")\n )\n return legal_actions\n\n def is_dead(self, agent: Any) -> bool:\n \"\"\"Check if the agent is dead.\n\n Returns:\n is_dead: boolean indicating whether the agent is alive or dead.\n \"\"\"\n is_dead = False\n if self._environment.agents[agent].health == 0.0:\n is_dead = True\n return is_dead\n\n def _convert_observations(\n self, observations: List, legal_actions: List, done: bool\n ) -> types.Observation:\n \"\"\"Convert SMAC observation so it's dm_env compatible.\n\n Args:\n observes (Dict[str, np.ndarray]): observations per agent.\n dones (Dict[str, bool]): dones per agent.\n\n Returns:\n types.Observation: dm compatible observations.\n \"\"\"\n olt_observations = {}\n for i, agent in enumerate(self._agents):\n # Check if agent is dead, if so, apply death mask.\n if self._death_masking and self.is_dead(i):\n observation = np.zeros_like(observations[i])\n else:\n observation = observations[i]\n\n olt_observations[agent] = types.OLT(\n observation=observation,\n legal_actions=legal_actions[i],\n terminal=np.asarray([done], dtype=np.float32),\n )\n\n return olt_observations\n\n def extras_spec(self) -> Dict[str, specs.BoundedArray]:\n \"\"\"Function returns extra spec (format) of the env.\n\n Returns:\n Dict[str, specs.BoundedArray]: extra spec.\n \"\"\"\n if self._return_state_info:\n return {\"s_t\": self._environment.get_state()}\n else:\n return {}\n\n def observation_spec(self) -> Dict[str, types.OLT]:\n \"\"\"Observation spec.\n\n Returns:\n types.Observation: spec for environment.\n \"\"\"\n self._environment.reset()\n\n observations = self._environment.get_obs()\n legal_actions = self._get_legal_actions()\n\n observation_specs = {}\n for i, agent in enumerate(self._agents):\n\n observation_specs[agent] = types.OLT(\n observation=observations[i],\n legal_actions=legal_actions[i],\n terminal=np.asarray([True], dtype=np.float32),\n )\n\n return observation_specs\n\n def action_spec(\n self,\n ) -> Dict[str, Union[specs.DiscreteArray, specs.BoundedArray]]:\n \"\"\"Action spec.\n\n Returns:\n spec for actions.\n \"\"\"\n action_specs = {}\n for agent in self._agents:\n action_specs[agent] = specs.DiscreteArray(\n num_values=self._environment.n_actions, dtype=int\n )\n return action_specs\n\n def reward_spec(self) -> Dict[str, specs.Array]:\n \"\"\"Reward spec.\n\n Returns:\n Dict[str, specs.Array]: spec for rewards.\n \"\"\"\n reward_specs = {}\n for agent in self._agents:\n reward_specs[agent] = specs.Array((), np.float32)\n return reward_specs\n\n def discount_spec(self) -> Dict[str, specs.BoundedArray]:\n \"\"\"Discount spec.\n\n Returns:\n Dict[str, specs.BoundedArray]: spec for discounts.\n \"\"\"\n discount_specs = {}\n for agent in self._agents:\n discount_specs[agent] = specs.BoundedArray(\n (), np.float32, minimum=0, maximum=1.0\n )\n return discount_specs\n\n def get_stats(self) -> Optional[Dict]:\n \"\"\"Return extra stats to be logged.\n\n Returns:\n extra stats to be logged.\n \"\"\"\n stats = self._environment.get_stats()\n stats[\"cumulative_win_rate\"] = stats[\"win_rate\"]\n del stats[\"win_rate\"]\n return stats\n\n def get_interval_stats(self) -> Optional[Dict]:\n \"\"\"Computes environment statistics which should be exclusively \\\n computed over a given number of evaluation episodes.\n\n An example would be a win rate calculation where it is required to\n keep track of the number of games won over a given set of evaluation\n episodes.\n\n Returns:\n Win rate\n \"\"\"\n interval_stats: Dict[str, Any] = {}\n interval_stats[\"win_rate\"] = (\n self._environment.battles_won - self._battles_won\n ) / (self._environment.battles_game - self._battles_game)\n self._battles_won = self._environment.battles_won\n self._battles_game = self._environment.battles_game\n return interval_stats\n\n @property\n def agents(self) -> List:\n \"\"\"Agents still alive in env (not done).\n\n Returns:\n List: alive agents in env.\n \"\"\"\n return self._agents\n\n @property\n def possible_agents(self) -> List:\n \"\"\"All possible agents in env.\n\n Returns:\n List: all possible agents in env.\n \"\"\"\n return self._agents\n\n @property\n def environment(self) -> StarCraft2Env:\n \"\"\"Returns the wrapped environment.\n\n Returns:\n ParallelEnv: parallel env.\n \"\"\"\n return self._environment\n\n def __getattr__(self, name: str) -> Any:\n \"\"\"Expose any other attributes of the underlying environment.\n\n Args:\n name (str): attribute.\n\n Returns:\n Any: return attribute from env or underlying env.\n \"\"\"\n if hasattr(self.__class__, name):\n return self.__getattribute__(name)\n else:\n return getattr(self._environment, name)\n","path":"mava/wrappers/smac.py"}],"string":"[\n {\n \"content\": \"# python3\\n# Copyright 2021 InstaDeep Ltd. All rights reserved.\\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\\\"\\\"\\\"Wraper for SMAC.\\\"\\\"\\\"\\nfrom typing import Any, Dict, List, Optional, Union\\n\\nimport dm_env\\nimport numpy as np\\nfrom acme import specs\\nfrom smac.env import StarCraft2Env\\n\\nfrom mava import types\\nfrom mava.utils.wrapper_utils import convert_np_type, parameterized_restart\\nfrom mava.wrappers.env_wrappers import ParallelEnvWrapper\\n\\n\\nclass SMACWrapper(ParallelEnvWrapper):\\n \\\"\\\"\\\"Environment wrapper for PettingZoo MARL environments.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n environment: StarCraft2Env,\\n return_state_info: bool = True,\\n death_masking: bool = False,\\n ):\\n \\\"\\\"\\\"Constructor for parallel PZ wrapper.\\n\\n Args:\\n environment (ParallelEnv): parallel PZ env.\\n env_preprocess_wrappers (Optional[List], optional): Wrappers\\n that preprocess envs.\\n Format (env_preprocessor, dict_with_preprocessor_params).\\n death_masking: whether to mask out agent observations once dead.\\n return_state_info: return extra state info\\n \\\"\\\"\\\"\\n self._environment = environment\\n self._return_state_info = return_state_info\\n self._agents = [f\\\"agent_{n}\\\" for n in range(self._environment.n_agents)]\\n\\n self._reset_next_step = True\\n self._done = False\\n\\n self._battles_won = 0\\n self._battles_game = 0\\n\\n self._death_masking = death_masking\\n\\n def reset(self) -> dm_env.TimeStep:\\n \\\"\\\"\\\"Resets the env.\\n\\n Returns:\\n dm_env.TimeStep: dm timestep.\\n \\\"\\\"\\\"\\n # Reset the environment\\n self._environment.reset()\\n self._done = False\\n\\n self._reset_next_step = False\\n self._step_type = dm_env.StepType.FIRST\\n\\n # Get observation from env\\n observation = self.environment.get_obs()\\n legal_actions = self._get_legal_actions()\\n observations = self._convert_observations(\\n observation, legal_actions, self._done\\n )\\n\\n # Set env discount to 1 for all agents\\n discount_spec = self.discount_spec()\\n self._discounts = {\\n agent: convert_np_type(discount_spec[agent].dtype, 1)\\n for agent in self._agents\\n }\\n\\n # Set reward to zero for all agents\\n rewards_spec = self.reward_spec()\\n rewards = {\\n agent: convert_np_type(rewards_spec[agent].dtype, 0)\\n for agent in self._agents\\n }\\n\\n # Possibly add state information to extras\\n if self._return_state_info:\\n state = self.get_state()\\n extras = {\\\"s_t\\\": state}\\n else:\\n extras = {}\\n\\n return parameterized_restart(rewards, self._discounts, observations), extras\\n\\n def step(self, actions: Dict[str, np.ndarray]) -> dm_env.TimeStep:\\n \\\"\\\"\\\"Steps in env.\\n\\n Args:\\n actions (Dict[str, np.ndarray]): actions per agent.\\n\\n Returns:\\n dm_env.TimeStep: dm timestep\\n \\\"\\\"\\\"\\n # Possibly reset the environment\\n if self._reset_next_step:\\n return self.reset()\\n\\n # Convert dict of actions to list for SMAC\\n smac_actions = [actions[agent] for agent in self._agents]\\n\\n # Step the SMAC environment\\n reward, self._done, self._info = self._environment.step(smac_actions)\\n\\n # Get the next observations\\n next_observations = self._environment.get_obs()\\n legal_actions = self._get_legal_actions()\\n next_observations = self._convert_observations(\\n next_observations, legal_actions, self._done\\n )\\n\\n # Convert team reward to agent-wise rewards\\n rewards = self._convert_reward(reward)\\n\\n # Possibly add state information to extras\\n if self._return_state_info:\\n state = self.get_state()\\n extras = {\\\"s_t\\\": state}\\n else:\\n extras = {}\\n\\n if self._done:\\n self._step_type = dm_env.StepType.LAST\\n self._reset_next_step = True\\n\\n # Discount on last timestep set to zero\\n self._discounts = {\\n agent: convert_np_type(self.discount_spec()[agent].dtype, 0.0)\\n for agent in self._agents\\n }\\n else:\\n self._step_type = dm_env.StepType.MID\\n\\n # Create timestep object\\n timestep = dm_env.TimeStep(\\n observation=next_observations,\\n reward=rewards,\\n discount=self._discounts,\\n step_type=self._step_type,\\n )\\n\\n return timestep, extras\\n\\n def env_done(self) -> bool:\\n \\\"\\\"\\\"Check if env is done.\\n\\n Returns:\\n bool: bool indicating if env is done.\\n \\\"\\\"\\\"\\n return self._done\\n\\n def _convert_reward(self, reward: float) -> Dict[str, float]:\\n \\\"\\\"\\\"Convert rewards to be dm_env compatible.\\n\\n Args:\\n reward: rewards per agent.\\n \\\"\\\"\\\"\\n rewards_spec = self.reward_spec()\\n rewards = {}\\n for agent in self._agents:\\n rewards[agent] = convert_np_type(rewards_spec[agent].dtype, reward)\\n return rewards\\n\\n def _get_legal_actions(self) -> List:\\n \\\"\\\"\\\"Get legal actions from the environment.\\\"\\\"\\\"\\n legal_actions = []\\n for i, _ in enumerate(self._agents):\\n legal_actions.append(\\n np.array(self._environment.get_avail_agent_actions(i), dtype=\\\"int\\\")\\n )\\n return legal_actions\\n\\n def is_dead(self, agent: Any) -> bool:\\n \\\"\\\"\\\"Check if the agent is dead.\\n\\n Returns:\\n is_dead: boolean indicating whether the agent is alive or dead.\\n \\\"\\\"\\\"\\n is_dead = False\\n if self._environment.agents[agent].health == 0.0:\\n is_dead = True\\n return is_dead\\n\\n def _convert_observations(\\n self, observations: List, legal_actions: List, done: bool\\n ) -> types.Observation:\\n \\\"\\\"\\\"Convert SMAC observation so it's dm_env compatible.\\n\\n Args:\\n observes (Dict[str, np.ndarray]): observations per agent.\\n dones (Dict[str, bool]): dones per agent.\\n\\n Returns:\\n types.Observation: dm compatible observations.\\n \\\"\\\"\\\"\\n olt_observations = {}\\n for i, agent in enumerate(self._agents):\\n # Check if agent is dead, if so, apply death mask.\\n if self._death_masking and self.is_dead(i):\\n observation = np.zeros_like(observations[i])\\n else:\\n observation = observations[i]\\n\\n olt_observations[agent] = types.OLT(\\n observation=observation,\\n legal_actions=legal_actions[i],\\n terminal=np.asarray([done], dtype=np.float32),\\n )\\n\\n return olt_observations\\n\\n def extras_spec(self) -> Dict[str, specs.BoundedArray]:\\n \\\"\\\"\\\"Function returns extra spec (format) of the env.\\n\\n Returns:\\n Dict[str, specs.BoundedArray]: extra spec.\\n \\\"\\\"\\\"\\n if self._return_state_info:\\n return {\\\"s_t\\\": self._environment.get_state()}\\n else:\\n return {}\\n\\n def observation_spec(self) -> Dict[str, types.OLT]:\\n \\\"\\\"\\\"Observation spec.\\n\\n Returns:\\n types.Observation: spec for environment.\\n \\\"\\\"\\\"\\n self._environment.reset()\\n\\n observations = self._environment.get_obs()\\n legal_actions = self._get_legal_actions()\\n\\n observation_specs = {}\\n for i, agent in enumerate(self._agents):\\n\\n observation_specs[agent] = types.OLT(\\n observation=observations[i],\\n legal_actions=legal_actions[i],\\n terminal=np.asarray([True], dtype=np.float32),\\n )\\n\\n return observation_specs\\n\\n def action_spec(\\n self,\\n ) -> Dict[str, Union[specs.DiscreteArray, specs.BoundedArray]]:\\n \\\"\\\"\\\"Action spec.\\n\\n Returns:\\n spec for actions.\\n \\\"\\\"\\\"\\n action_specs = {}\\n for agent in self._agents:\\n action_specs[agent] = specs.DiscreteArray(\\n num_values=self._environment.n_actions, dtype=int\\n )\\n return action_specs\\n\\n def reward_spec(self) -> Dict[str, specs.Array]:\\n \\\"\\\"\\\"Reward spec.\\n\\n Returns:\\n Dict[str, specs.Array]: spec for rewards.\\n \\\"\\\"\\\"\\n reward_specs = {}\\n for agent in self._agents:\\n reward_specs[agent] = specs.Array((), np.float32)\\n return reward_specs\\n\\n def discount_spec(self) -> Dict[str, specs.BoundedArray]:\\n \\\"\\\"\\\"Discount spec.\\n\\n Returns:\\n Dict[str, specs.BoundedArray]: spec for discounts.\\n \\\"\\\"\\\"\\n discount_specs = {}\\n for agent in self._agents:\\n discount_specs[agent] = specs.BoundedArray(\\n (), np.float32, minimum=0, maximum=1.0\\n )\\n return discount_specs\\n\\n def get_stats(self) -> Optional[Dict]:\\n \\\"\\\"\\\"Return extra stats to be logged.\\n\\n Returns:\\n extra stats to be logged.\\n \\\"\\\"\\\"\\n stats = self._environment.get_stats()\\n stats[\\\"cumulative_win_rate\\\"] = stats[\\\"win_rate\\\"]\\n del stats[\\\"win_rate\\\"]\\n return stats\\n\\n def get_interval_stats(self) -> Optional[Dict]:\\n \\\"\\\"\\\"Computes environment statistics which should be exclusively \\\\\\n computed over a given number of evaluation episodes.\\n\\n An example would be a win rate calculation where it is required to\\n keep track of the number of games won over a given set of evaluation\\n episodes.\\n\\n Returns:\\n Win rate\\n \\\"\\\"\\\"\\n interval_stats: Dict[str, Any] = {}\\n interval_stats[\\\"win_rate\\\"] = (\\n self._environment.battles_won - self._battles_won\\n ) / (self._environment.battles_game - self._battles_game)\\n self._battles_won = self._environment.battles_won\\n self._battles_game = self._environment.battles_game\\n return interval_stats\\n\\n @property\\n def agents(self) -> List:\\n \\\"\\\"\\\"Agents still alive in env (not done).\\n\\n Returns:\\n List: alive agents in env.\\n \\\"\\\"\\\"\\n return self._agents\\n\\n @property\\n def possible_agents(self) -> List:\\n \\\"\\\"\\\"All possible agents in env.\\n\\n Returns:\\n List: all possible agents in env.\\n \\\"\\\"\\\"\\n return self._agents\\n\\n @property\\n def environment(self) -> StarCraft2Env:\\n \\\"\\\"\\\"Returns the wrapped environment.\\n\\n Returns:\\n ParallelEnv: parallel env.\\n \\\"\\\"\\\"\\n return self._environment\\n\\n def __getattr__(self, name: str) -> Any:\\n \\\"\\\"\\\"Expose any other attributes of the underlying environment.\\n\\n Args:\\n name (str): attribute.\\n\\n Returns:\\n Any: return attribute from env or underlying env.\\n \\\"\\\"\\\"\\n if hasattr(self.__class__, name):\\n return self.__getattribute__(name)\\n else:\\n return getattr(self._environment, name)\\n\",\n \"path\": \"mava/wrappers/smac.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/mava/wrappers/smac.py b/mava/wrappers/smac.py\nindex 623bb97c1..676e59c89 100644\n--- a/mava/wrappers/smac.py\n+++ b/mava/wrappers/smac.py\n@@ -114,7 +114,7 @@ def step(self, actions: Dict[str, np.ndarray]) -> dm_env.TimeStep:\n return self.reset()\n \n # Convert dict of actions to list for SMAC\n- smac_actions = list(actions.values())\n+ smac_actions = [actions[agent] for agent in self._agents]\n \n # Step the SMAC environment\n reward, self._done, self._info = self._environment.step(smac_actions)\n"}}},{"rowIdx":4676,"cells":{"in_source_id":{"kind":"string","value":"digitalfabrik__integreat-cms-832"},"issue":{"kind":"string","value":"`UnboundLocalError` in imprint form\n### Describe the Bug\r\n<!-- A clear and concise description of what the bug is. -->\r\nThe imprint can only be created when it does not yet exist.\r\nOnce it exists, it cannot be changed anymore.\r\n\r\n### Steps to Reproduce\r\n\r\n1. Go to the imprint form\r\n2. Create imprint\r\n3. Change existing imprint translation\r\n4. See error\r\n\r\n### Expected Behavior\r\n<!-- A clear and concise description of what you expected to happen. -->\r\nThe imprint translation should be changed\r\n\r\n### Actual Behavior\r\n<!-- A clear and concise description of what actually happened. -->\r\n`UnboundLocalError at /augsburg/imprint/de/`\r\n`local variable 'imprint' referenced before assignment`\r\n### Additional Information\r\n<!-- Add any other context (e.g. logs, screenshots, etc.) about the problem here. -->\r\n\r\n<details>\r\n <summary>Traceback</summary>\r\n\r\n```\r\nEnvironment:\r\n\r\n\r\nRequest Method: POST\r\nRequest URL: http://localhost:8000/augsburg/imprint/de/\r\n\r\nDjango Version: 3.2.2\r\nPython Version: 3.7.10\r\nInstalled Applications:\r\n['cms.apps.CmsConfig',\r\n 'gvz_api.apps.GvzApiConfig',\r\n 'django.contrib.auth',\r\n 'django.contrib.contenttypes',\r\n 'django.contrib.messages',\r\n 'django.contrib.sessions',\r\n 'django.contrib.sitemaps',\r\n 'django.contrib.staticfiles',\r\n 'corsheaders',\r\n 'widget_tweaks',\r\n 'easy_thumbnails',\r\n 'filer',\r\n 'mptt',\r\n 'rules.apps.AutodiscoverRulesConfig',\r\n 'linkcheck',\r\n 'django.contrib.admin']\r\nInstalled Middleware:\r\n['corsheaders.middleware.CorsMiddleware',\r\n 'django.middleware.security.SecurityMiddleware',\r\n 'django.contrib.sessions.middleware.SessionMiddleware',\r\n 'django.middleware.locale.LocaleMiddleware',\r\n 'django.middleware.common.CommonMiddleware',\r\n 'django.middleware.csrf.CsrfViewMiddleware',\r\n 'django.contrib.auth.middleware.AuthenticationMiddleware',\r\n 'django.contrib.messages.middleware.MessageMiddleware',\r\n 'django.middleware.clickjacking.XFrameOptionsMiddleware',\r\n 'cms.middleware.timezone_middleware.TimezoneMiddleware']\r\n\r\nTraceback (most recent call last):\r\n File \"/home/timo/job/integreat/integreat-cms/.venv/lib/python3.7/site-packages/django/core/handlers/exception.py\", line 47, in inner\r\n response = get_response(request)\r\n File \"/home/timo/job/integreat/integreat-cms/.venv/lib/python3.7/site-packages/django/core/handlers/base.py\", line 181, in _get_response\r\n response = wrapped_callback(request, *callback_args, **callback_kwargs)\r\n File \"/home/timo/job/integreat/integreat-cms/.venv/lib/python3.7/site-packages/django/views/generic/base.py\", line 70, in view\r\n return self.dispatch(request, *args, **kwargs)\r\n File \"/home/timo/job/integreat/integreat-cms/.venv/lib/python3.7/site-packages/django/utils/decorators.py\", line 43, in _wrapper\r\n return bound_method(*args, **kwargs)\r\n File \"/home/timo/job/integreat/integreat-cms/.venv/lib/python3.7/site-packages/django/contrib/auth/decorators.py\", line 21, in _wrapped_view\r\n return view_func(request, *args, **kwargs)\r\n File \"/home/timo/job/integreat/integreat-cms/.venv/lib/python3.7/site-packages/django/utils/decorators.py\", line 43, in _wrapper\r\n return bound_method(*args, **kwargs)\r\n File \"/home/timo/job/integreat/integreat-cms/src/cms/decorators.py\", line 53, in wrap\r\n return function(request, *args, **kwargs)\r\n File \"/home/timo/job/integreat/integreat-cms/.venv/lib/python3.7/site-packages/django/contrib/auth/mixins.py\", line 104, in dispatch\r\n return super().dispatch(request, *args, **kwargs)\r\n File \"/home/timo/job/integreat/integreat-cms/.venv/lib/python3.7/site-packages/django/views/generic/base.py\", line 98, in dispatch\r\n return handler(request, *args, **kwargs)\r\n File \"/home/timo/job/integreat/integreat-cms/src/cms/views/imprint/imprint_view.py\", line 226, in post\r\n imprint=imprint,\r\n\r\nException Type: UnboundLocalError at /augsburg/imprint/de/\r\nException Value: local variable 'imprint' referenced before assignment\r\n```\r\n\r\n</details>\n"},"before_files":{"kind":"list like","value":[{"content":"import logging\n\nfrom django.contrib import messages\nfrom django.contrib.auth.decorators import login_required\nfrom django.contrib.auth.mixins import PermissionRequiredMixin\nfrom django.shortcuts import render, redirect, get_object_or_404\nfrom django.urls import reverse\nfrom django.utils.decorators import method_decorator\nfrom django.utils.translation import ugettext as _\nfrom django.views.generic import TemplateView\n\nfrom backend.settings import IMPRINT_SLUG, WEBAPP_URL\nfrom ...constants import status\nfrom ...decorators import region_permission_required\nfrom ...forms import ImprintTranslationForm\nfrom ...models import ImprintPageTranslation, ImprintPage, Region\n\nlogger = logging.getLogger(__name__)\n\n\n@method_decorator(login_required, name=\"dispatch\")\n@method_decorator(region_permission_required, name=\"dispatch\")\nclass ImprintView(PermissionRequiredMixin, TemplateView):\n \"\"\"\n View for the imprint page form and imprint page translation form\n \"\"\"\n\n permission_required = \"cms.manage_imprint\"\n raise_exception = True\n\n template_name = \"imprint/imprint_form.html\"\n base_context = {\n \"current_menu_item\": \"imprint\",\n \"WEBAPP_URL\": WEBAPP_URL,\n \"IMPRINT_SLUG\": IMPRINT_SLUG,\n }\n\n def get(self, request, *args, **kwargs):\n \"\"\"\n Render :class:`~cms.forms.imprint.imprint_translation_form.ImprintTranslationForm`\n\n :param request: The current request\n :type request: ~django.http.HttpResponse\n\n :param args: The supplied arguments\n :type args: list\n\n :param kwargs: The supplied keyword arguments\n :type kwargs: dict\n\n :raises ~django.core.exceptions.PermissionDenied: If user does not have the permission to edit the specific page\n\n :return: The rendered template response\n :rtype: ~django.template.response.TemplateResponse\n \"\"\"\n\n # current region\n region = Region.get_current_region(request)\n\n # current language\n language_slug = kwargs.get(\"language_slug\")\n if language_slug:\n language = get_object_or_404(region.languages, slug=language_slug)\n elif region.default_language:\n return redirect(\n \"edit_imprint\",\n **{\n \"region_slug\": region.slug,\n \"language_slug\": region.default_language.slug,\n },\n )\n else:\n messages.error(\n request,\n _(\"Please create at least one language node before creating pages.\"),\n )\n return redirect(\n \"language_tree\",\n **{\n \"region_slug\": region.slug,\n },\n )\n\n # get imprint and translation objects if they exist\n try:\n imprint = region.imprint\n except ImprintPage.DoesNotExist:\n imprint = None\n\n imprint_translation = ImprintPageTranslation.objects.filter(\n page=imprint,\n language=language,\n ).first()\n\n # Make form disabled if user has no permission to manage the imprint\n disabled = False\n if imprint:\n if imprint.archived:\n disabled = True\n messages.warning(\n request, _(\"You cannot manage the imprint because it is archived.\")\n )\n public_translation = imprint.get_public_translation(language.slug)\n if public_translation and imprint_translation != public_translation:\n messages.info(\n request,\n _(\n \"This is <b>not</b> the most recent public revision of this translation. Instead, <a href='%(revision_url)s' class='underline hover:no-underline'>revision %(revision)s</a> is shown in the apps.\"\n )\n % {\n \"revision_url\": reverse(\n \"imprint_revisions\",\n kwargs={\n \"region_slug\": region.slug,\n \"language_slug\": language.slug,\n \"selected_revision\": public_translation.version,\n },\n ),\n \"revision\": public_translation.version,\n },\n )\n\n imprint_translation_form = ImprintTranslationForm(\n instance=imprint_translation, disabled=disabled\n )\n\n # Pass side by side language options\n side_by_side_language_options = self.get_side_by_side_language_options(\n region, language, imprint\n )\n\n return render(\n request,\n self.template_name,\n {\n **self.base_context,\n \"imprint_translation_form\": imprint_translation_form,\n \"imprint\": imprint,\n \"language\": language,\n # Languages for tab view\n \"languages\": region.languages if imprint else [language],\n \"side_by_side_language_options\": side_by_side_language_options,\n },\n )\n\n # pylint: disable=too-many-branches,unused-argument\n def post(self, request, *args, **kwargs):\n \"\"\"\n Binds the user input data to the imprint form and validates the input.\n Forms containing images/files need to be additionally instantiated with the FILES attribute of request objects,\n see :doc:`django:topics/http/file-uploads`\n\n :param request: Request submitted for saving imprint form\n :type request: ~django.http.HttpRequest\n\n :param args: The supplied arguments\n :type args: list\n\n :param kwargs: The supplied keyword arguments\n :type kwargs: dict\n\n :return: Redirection to the populated imprint form\n :rtype: ~django.http.HttpResponseRedirect\n \"\"\"\n\n region = Region.get_current_region(request)\n language = get_object_or_404(region.languages, slug=kwargs.get(\"language_slug\"))\n\n try:\n imprint_instance = region.imprint\n except ImprintPage.DoesNotExist:\n imprint_instance = None\n\n imprint_translation_instance = ImprintPageTranslation.objects.filter(\n page=imprint_instance,\n language=language,\n ).first()\n\n imprint_translation_form = ImprintTranslationForm(\n request.POST,\n instance=imprint_translation_instance,\n region=region,\n language=language,\n )\n\n side_by_side_language_options = self.get_side_by_side_language_options(\n region, language, imprint_instance\n )\n\n # TODO: error handling\n if not imprint_translation_form.is_valid():\n messages.error(request, _(\"Errors have occurred.\"))\n return render(\n request,\n self.template_name,\n {\n **self.base_context,\n \"imprint_translation_form\": imprint_translation_form,\n \"imprint\": imprint_instance,\n \"language\": language,\n # Languages for tab view\n \"languages\": region.languages if imprint_instance else [language],\n \"side_by_side_language_options\": side_by_side_language_options,\n },\n )\n\n if not imprint_translation_form.has_changed():\n messages.info(request, _(\"No changes detected.\"))\n return render(\n request,\n self.template_name,\n {\n **self.base_context,\n \"imprint_translation_form\": imprint_translation_form,\n \"imprint\": imprint_instance,\n \"language\": language,\n # Languages for tab view\n \"languages\": region.languages if imprint_instance else [language],\n \"side_by_side_language_options\": side_by_side_language_options,\n },\n )\n\n if not imprint_instance:\n imprint = ImprintPage.objects.create(region=region)\n imprint_translation = imprint_translation_form.save(\n imprint=imprint,\n user=request.user,\n )\n\n published = imprint_translation.status == status.PUBLIC\n if not imprint_instance:\n if published:\n messages.success(\n request, _(\"imprint was successfully created and published\")\n )\n else:\n messages.success(request, _(\"imprint was successfully created\"))\n elif not imprint_translation_instance:\n if published:\n messages.success(\n request, _(\"Translation was successfully created and published\")\n )\n else:\n messages.success(request, _(\"Translation was successfully created\"))\n else:\n if published:\n messages.success(request, _(\"Translation was successfully published\"))\n else:\n messages.success(request, _(\"Translation was successfully saved\"))\n\n return redirect(\n \"edit_imprint\",\n **{\n \"region_slug\": region.slug,\n \"language_slug\": language.slug,\n },\n )\n\n @staticmethod\n def get_side_by_side_language_options(region, language, imprint):\n \"\"\"\n This is a helper function to generate the side-by-side language options for both the get and post requests.\n\n :param region: The current region\n :type region: ~cms.models.regions.region.Region\n\n :param language: The current language\n :type language: ~cms.models.languages.language.Language\n\n :param imprint: The current imprint\n :type imprint: ~cms.models.pages.imprint_page.ImprintPage\n\n :return: The list of language options, each represented by a dict\n :rtype: list\n \"\"\"\n side_by_side_language_options = []\n for language_node in region.language_tree_nodes.all():\n if language_node.parent:\n source_translation = ImprintPageTranslation.objects.filter(\n page=imprint,\n language=language_node.parent.language,\n )\n side_by_side_language_options.append(\n {\n \"value\": language_node.language.slug,\n \"label\": _(\"{source_language} to {target_language}\").format(\n source_language=language_node.parent.language.translated_name,\n target_language=language_node.language.translated_name,\n ),\n \"selected\": language_node.language == language,\n \"disabled\": not source_translation.exists(),\n }\n )\n return side_by_side_language_options\n","path":"src/cms/views/imprint/imprint_view.py"}],"string":"[\n {\n \"content\": \"import logging\\n\\nfrom django.contrib import messages\\nfrom django.contrib.auth.decorators import login_required\\nfrom django.contrib.auth.mixins import PermissionRequiredMixin\\nfrom django.shortcuts import render, redirect, get_object_or_404\\nfrom django.urls import reverse\\nfrom django.utils.decorators import method_decorator\\nfrom django.utils.translation import ugettext as _\\nfrom django.views.generic import TemplateView\\n\\nfrom backend.settings import IMPRINT_SLUG, WEBAPP_URL\\nfrom ...constants import status\\nfrom ...decorators import region_permission_required\\nfrom ...forms import ImprintTranslationForm\\nfrom ...models import ImprintPageTranslation, ImprintPage, Region\\n\\nlogger = logging.getLogger(__name__)\\n\\n\\n@method_decorator(login_required, name=\\\"dispatch\\\")\\n@method_decorator(region_permission_required, name=\\\"dispatch\\\")\\nclass ImprintView(PermissionRequiredMixin, TemplateView):\\n \\\"\\\"\\\"\\n View for the imprint page form and imprint page translation form\\n \\\"\\\"\\\"\\n\\n permission_required = \\\"cms.manage_imprint\\\"\\n raise_exception = True\\n\\n template_name = \\\"imprint/imprint_form.html\\\"\\n base_context = {\\n \\\"current_menu_item\\\": \\\"imprint\\\",\\n \\\"WEBAPP_URL\\\": WEBAPP_URL,\\n \\\"IMPRINT_SLUG\\\": IMPRINT_SLUG,\\n }\\n\\n def get(self, request, *args, **kwargs):\\n \\\"\\\"\\\"\\n Render :class:`~cms.forms.imprint.imprint_translation_form.ImprintTranslationForm`\\n\\n :param request: The current request\\n :type request: ~django.http.HttpResponse\\n\\n :param args: The supplied arguments\\n :type args: list\\n\\n :param kwargs: The supplied keyword arguments\\n :type kwargs: dict\\n\\n :raises ~django.core.exceptions.PermissionDenied: If user does not have the permission to edit the specific page\\n\\n :return: The rendered template response\\n :rtype: ~django.template.response.TemplateResponse\\n \\\"\\\"\\\"\\n\\n # current region\\n region = Region.get_current_region(request)\\n\\n # current language\\n language_slug = kwargs.get(\\\"language_slug\\\")\\n if language_slug:\\n language = get_object_or_404(region.languages, slug=language_slug)\\n elif region.default_language:\\n return redirect(\\n \\\"edit_imprint\\\",\\n **{\\n \\\"region_slug\\\": region.slug,\\n \\\"language_slug\\\": region.default_language.slug,\\n },\\n )\\n else:\\n messages.error(\\n request,\\n _(\\\"Please create at least one language node before creating pages.\\\"),\\n )\\n return redirect(\\n \\\"language_tree\\\",\\n **{\\n \\\"region_slug\\\": region.slug,\\n },\\n )\\n\\n # get imprint and translation objects if they exist\\n try:\\n imprint = region.imprint\\n except ImprintPage.DoesNotExist:\\n imprint = None\\n\\n imprint_translation = ImprintPageTranslation.objects.filter(\\n page=imprint,\\n language=language,\\n ).first()\\n\\n # Make form disabled if user has no permission to manage the imprint\\n disabled = False\\n if imprint:\\n if imprint.archived:\\n disabled = True\\n messages.warning(\\n request, _(\\\"You cannot manage the imprint because it is archived.\\\")\\n )\\n public_translation = imprint.get_public_translation(language.slug)\\n if public_translation and imprint_translation != public_translation:\\n messages.info(\\n request,\\n _(\\n \\\"This is <b>not</b> the most recent public revision of this translation. Instead, <a href='%(revision_url)s' class='underline hover:no-underline'>revision %(revision)s</a> is shown in the apps.\\\"\\n )\\n % {\\n \\\"revision_url\\\": reverse(\\n \\\"imprint_revisions\\\",\\n kwargs={\\n \\\"region_slug\\\": region.slug,\\n \\\"language_slug\\\": language.slug,\\n \\\"selected_revision\\\": public_translation.version,\\n },\\n ),\\n \\\"revision\\\": public_translation.version,\\n },\\n )\\n\\n imprint_translation_form = ImprintTranslationForm(\\n instance=imprint_translation, disabled=disabled\\n )\\n\\n # Pass side by side language options\\n side_by_side_language_options = self.get_side_by_side_language_options(\\n region, language, imprint\\n )\\n\\n return render(\\n request,\\n self.template_name,\\n {\\n **self.base_context,\\n \\\"imprint_translation_form\\\": imprint_translation_form,\\n \\\"imprint\\\": imprint,\\n \\\"language\\\": language,\\n # Languages for tab view\\n \\\"languages\\\": region.languages if imprint else [language],\\n \\\"side_by_side_language_options\\\": side_by_side_language_options,\\n },\\n )\\n\\n # pylint: disable=too-many-branches,unused-argument\\n def post(self, request, *args, **kwargs):\\n \\\"\\\"\\\"\\n Binds the user input data to the imprint form and validates the input.\\n Forms containing images/files need to be additionally instantiated with the FILES attribute of request objects,\\n see :doc:`django:topics/http/file-uploads`\\n\\n :param request: Request submitted for saving imprint form\\n :type request: ~django.http.HttpRequest\\n\\n :param args: The supplied arguments\\n :type args: list\\n\\n :param kwargs: The supplied keyword arguments\\n :type kwargs: dict\\n\\n :return: Redirection to the populated imprint form\\n :rtype: ~django.http.HttpResponseRedirect\\n \\\"\\\"\\\"\\n\\n region = Region.get_current_region(request)\\n language = get_object_or_404(region.languages, slug=kwargs.get(\\\"language_slug\\\"))\\n\\n try:\\n imprint_instance = region.imprint\\n except ImprintPage.DoesNotExist:\\n imprint_instance = None\\n\\n imprint_translation_instance = ImprintPageTranslation.objects.filter(\\n page=imprint_instance,\\n language=language,\\n ).first()\\n\\n imprint_translation_form = ImprintTranslationForm(\\n request.POST,\\n instance=imprint_translation_instance,\\n region=region,\\n language=language,\\n )\\n\\n side_by_side_language_options = self.get_side_by_side_language_options(\\n region, language, imprint_instance\\n )\\n\\n # TODO: error handling\\n if not imprint_translation_form.is_valid():\\n messages.error(request, _(\\\"Errors have occurred.\\\"))\\n return render(\\n request,\\n self.template_name,\\n {\\n **self.base_context,\\n \\\"imprint_translation_form\\\": imprint_translation_form,\\n \\\"imprint\\\": imprint_instance,\\n \\\"language\\\": language,\\n # Languages for tab view\\n \\\"languages\\\": region.languages if imprint_instance else [language],\\n \\\"side_by_side_language_options\\\": side_by_side_language_options,\\n },\\n )\\n\\n if not imprint_translation_form.has_changed():\\n messages.info(request, _(\\\"No changes detected.\\\"))\\n return render(\\n request,\\n self.template_name,\\n {\\n **self.base_context,\\n \\\"imprint_translation_form\\\": imprint_translation_form,\\n \\\"imprint\\\": imprint_instance,\\n \\\"language\\\": language,\\n # Languages for tab view\\n \\\"languages\\\": region.languages if imprint_instance else [language],\\n \\\"side_by_side_language_options\\\": side_by_side_language_options,\\n },\\n )\\n\\n if not imprint_instance:\\n imprint = ImprintPage.objects.create(region=region)\\n imprint_translation = imprint_translation_form.save(\\n imprint=imprint,\\n user=request.user,\\n )\\n\\n published = imprint_translation.status == status.PUBLIC\\n if not imprint_instance:\\n if published:\\n messages.success(\\n request, _(\\\"imprint was successfully created and published\\\")\\n )\\n else:\\n messages.success(request, _(\\\"imprint was successfully created\\\"))\\n elif not imprint_translation_instance:\\n if published:\\n messages.success(\\n request, _(\\\"Translation was successfully created and published\\\")\\n )\\n else:\\n messages.success(request, _(\\\"Translation was successfully created\\\"))\\n else:\\n if published:\\n messages.success(request, _(\\\"Translation was successfully published\\\"))\\n else:\\n messages.success(request, _(\\\"Translation was successfully saved\\\"))\\n\\n return redirect(\\n \\\"edit_imprint\\\",\\n **{\\n \\\"region_slug\\\": region.slug,\\n \\\"language_slug\\\": language.slug,\\n },\\n )\\n\\n @staticmethod\\n def get_side_by_side_language_options(region, language, imprint):\\n \\\"\\\"\\\"\\n This is a helper function to generate the side-by-side language options for both the get and post requests.\\n\\n :param region: The current region\\n :type region: ~cms.models.regions.region.Region\\n\\n :param language: The current language\\n :type language: ~cms.models.languages.language.Language\\n\\n :param imprint: The current imprint\\n :type imprint: ~cms.models.pages.imprint_page.ImprintPage\\n\\n :return: The list of language options, each represented by a dict\\n :rtype: list\\n \\\"\\\"\\\"\\n side_by_side_language_options = []\\n for language_node in region.language_tree_nodes.all():\\n if language_node.parent:\\n source_translation = ImprintPageTranslation.objects.filter(\\n page=imprint,\\n language=language_node.parent.language,\\n )\\n side_by_side_language_options.append(\\n {\\n \\\"value\\\": language_node.language.slug,\\n \\\"label\\\": _(\\\"{source_language} to {target_language}\\\").format(\\n source_language=language_node.parent.language.translated_name,\\n target_language=language_node.language.translated_name,\\n ),\\n \\\"selected\\\": language_node.language == language,\\n \\\"disabled\\\": not source_translation.exists(),\\n }\\n )\\n return side_by_side_language_options\\n\",\n \"path\": \"src/cms/views/imprint/imprint_view.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import logging\n\nfrom django.contrib import messages\nfrom django.contrib.auth.decorators import login_required\nfrom django.contrib.auth.mixins import PermissionRequiredMixin\nfrom django.shortcuts import render, redirect, get_object_or_404\nfrom django.urls import reverse\nfrom django.utils.decorators import method_decorator\nfrom django.utils.translation import ugettext as _\nfrom django.views.generic import TemplateView\n\nfrom backend.settings import IMPRINT_SLUG, WEBAPP_URL\nfrom ...constants import status\nfrom ...decorators import region_permission_required\nfrom ...forms import ImprintTranslationForm\nfrom ...models import ImprintPageTranslation, ImprintPage, Region\n\nlogger = logging.getLogger(__name__)\n\n\n@method_decorator(login_required, name=\"dispatch\")\n@method_decorator(region_permission_required, name=\"dispatch\")\nclass ImprintView(PermissionRequiredMixin, TemplateView):\n \"\"\"\n View for the imprint page form and imprint page translation form\n \"\"\"\n\n permission_required = \"cms.manage_imprint\"\n raise_exception = True\n\n template_name = \"imprint/imprint_form.html\"\n base_context = {\n \"current_menu_item\": \"imprint\",\n \"WEBAPP_URL\": WEBAPP_URL,\n \"IMPRINT_SLUG\": IMPRINT_SLUG,\n }\n\n def get(self, request, *args, **kwargs):\n \"\"\"\n Render :class:`~cms.forms.imprint.imprint_translation_form.ImprintTranslationForm`\n\n :param request: The current request\n :type request: ~django.http.HttpResponse\n\n :param args: The supplied arguments\n :type args: list\n\n :param kwargs: The supplied keyword arguments\n :type kwargs: dict\n\n :raises ~django.core.exceptions.PermissionDenied: If user does not have the permission to edit the specific page\n\n :return: The rendered template response\n :rtype: ~django.template.response.TemplateResponse\n \"\"\"\n\n # current region\n region = Region.get_current_region(request)\n\n # current language\n language_slug = kwargs.get(\"language_slug\")\n if language_slug:\n language = get_object_or_404(region.languages, slug=language_slug)\n elif region.default_language:\n return redirect(\n \"edit_imprint\",\n **{\n \"region_slug\": region.slug,\n \"language_slug\": region.default_language.slug,\n },\n )\n else:\n messages.error(\n request,\n _(\"Please create at least one language node before creating pages.\"),\n )\n return redirect(\n \"language_tree\",\n **{\n \"region_slug\": region.slug,\n },\n )\n\n # get imprint and translation objects if they exist\n try:\n imprint = region.imprint\n except ImprintPage.DoesNotExist:\n imprint = None\n\n imprint_translation = ImprintPageTranslation.objects.filter(\n page=imprint,\n language=language,\n ).first()\n\n # Make form disabled if user has no permission to manage the imprint\n disabled = False\n if imprint:\n if imprint.archived:\n disabled = True\n messages.warning(\n request, _(\"You cannot manage the imprint because it is archived.\")\n )\n public_translation = imprint.get_public_translation(language.slug)\n if public_translation and imprint_translation != public_translation:\n messages.info(\n request,\n _(\n \"This is <b>not</b> the most recent public revision of this translation. Instead, <a href='%(revision_url)s' class='underline hover:no-underline'>revision %(revision)s</a> is shown in the apps.\"\n )\n % {\n \"revision_url\": reverse(\n \"imprint_revisions\",\n kwargs={\n \"region_slug\": region.slug,\n \"language_slug\": language.slug,\n \"selected_revision\": public_translation.version,\n },\n ),\n \"revision\": public_translation.version,\n },\n )\n\n imprint_translation_form = ImprintTranslationForm(\n instance=imprint_translation, disabled=disabled\n )\n\n # Pass side by side language options\n side_by_side_language_options = self.get_side_by_side_language_options(\n region, language, imprint\n )\n\n return render(\n request,\n self.template_name,\n {\n **self.base_context,\n \"imprint_translation_form\": imprint_translation_form,\n \"imprint\": imprint,\n \"language\": language,\n # Languages for tab view\n \"languages\": region.languages if imprint else [language],\n \"side_by_side_language_options\": side_by_side_language_options,\n },\n )\n\n # pylint: disable=too-many-branches,unused-argument\n def post(self, request, *args, **kwargs):\n \"\"\"\n Binds the user input data to the imprint form and validates the input.\n Forms containing images/files need to be additionally instantiated with the FILES attribute of request objects,\n see :doc:`django:topics/http/file-uploads`\n\n :param request: Request submitted for saving imprint form\n :type request: ~django.http.HttpRequest\n\n :param args: The supplied arguments\n :type args: list\n\n :param kwargs: The supplied keyword arguments\n :type kwargs: dict\n\n :return: Redirection to the populated imprint form\n :rtype: ~django.http.HttpResponseRedirect\n \"\"\"\n\n region = Region.get_current_region(request)\n language = get_object_or_404(region.languages, slug=kwargs.get(\"language_slug\"))\n\n try:\n imprint_instance = region.imprint\n except ImprintPage.DoesNotExist:\n imprint_instance = None\n\n imprint_translation_instance = ImprintPageTranslation.objects.filter(\n page=imprint_instance,\n language=language,\n ).first()\n\n imprint_translation_form = ImprintTranslationForm(\n request.POST,\n instance=imprint_translation_instance,\n region=region,\n language=language,\n )\n\n side_by_side_language_options = self.get_side_by_side_language_options(\n region, language, imprint_instance\n )\n\n # TODO: error handling\n if not imprint_translation_form.is_valid():\n messages.error(request, _(\"Errors have occurred.\"))\n return render(\n request,\n self.template_name,\n {\n **self.base_context,\n \"imprint_translation_form\": imprint_translation_form,\n \"imprint\": imprint_instance,\n \"language\": language,\n # Languages for tab view\n \"languages\": region.languages if imprint_instance else [language],\n \"side_by_side_language_options\": side_by_side_language_options,\n },\n )\n\n if not imprint_translation_form.has_changed():\n messages.info(request, _(\"No changes detected.\"))\n return render(\n request,\n self.template_name,\n {\n **self.base_context,\n \"imprint_translation_form\": imprint_translation_form,\n \"imprint\": imprint_instance,\n \"language\": language,\n # Languages for tab view\n \"languages\": region.languages if imprint_instance else [language],\n \"side_by_side_language_options\": side_by_side_language_options,\n },\n )\n\n imprint = imprint_instance or ImprintPage.objects.create(region=region)\n\n imprint_translation = imprint_translation_form.save(\n imprint=imprint,\n user=request.user,\n )\n\n published = imprint_translation.status == status.PUBLIC\n if not imprint_instance:\n if published:\n messages.success(\n request, _(\"imprint was successfully created and published\")\n )\n else:\n messages.success(request, _(\"imprint was successfully created\"))\n elif not imprint_translation_instance:\n if published:\n messages.success(\n request, _(\"Translation was successfully created and published\")\n )\n else:\n messages.success(request, _(\"Translation was successfully created\"))\n else:\n if published:\n messages.success(request, _(\"Translation was successfully published\"))\n else:\n messages.success(request, _(\"Translation was successfully saved\"))\n\n return redirect(\n \"edit_imprint\",\n **{\n \"region_slug\": region.slug,\n \"language_slug\": language.slug,\n },\n )\n\n @staticmethod\n def get_side_by_side_language_options(region, language, imprint):\n \"\"\"\n This is a helper function to generate the side-by-side language options for both the get and post requests.\n\n :param region: The current region\n :type region: ~cms.models.regions.region.Region\n\n :param language: The current language\n :type language: ~cms.models.languages.language.Language\n\n :param imprint: The current imprint\n :type imprint: ~cms.models.pages.imprint_page.ImprintPage\n\n :return: The list of language options, each represented by a dict\n :rtype: list\n \"\"\"\n side_by_side_language_options = []\n for language_node in region.language_tree_nodes.all():\n if language_node.parent:\n source_translation = ImprintPageTranslation.objects.filter(\n page=imprint,\n language=language_node.parent.language,\n )\n side_by_side_language_options.append(\n {\n \"value\": language_node.language.slug,\n \"label\": _(\"{source_language} to {target_language}\").format(\n source_language=language_node.parent.language.translated_name,\n target_language=language_node.language.translated_name,\n ),\n \"selected\": language_node.language == language,\n \"disabled\": not source_translation.exists(),\n }\n )\n return side_by_side_language_options\n","path":"src/cms/views/imprint/imprint_view.py"}],"string":"[\n {\n \"content\": \"import logging\\n\\nfrom django.contrib import messages\\nfrom django.contrib.auth.decorators import login_required\\nfrom django.contrib.auth.mixins import PermissionRequiredMixin\\nfrom django.shortcuts import render, redirect, get_object_or_404\\nfrom django.urls import reverse\\nfrom django.utils.decorators import method_decorator\\nfrom django.utils.translation import ugettext as _\\nfrom django.views.generic import TemplateView\\n\\nfrom backend.settings import IMPRINT_SLUG, WEBAPP_URL\\nfrom ...constants import status\\nfrom ...decorators import region_permission_required\\nfrom ...forms import ImprintTranslationForm\\nfrom ...models import ImprintPageTranslation, ImprintPage, Region\\n\\nlogger = logging.getLogger(__name__)\\n\\n\\n@method_decorator(login_required, name=\\\"dispatch\\\")\\n@method_decorator(region_permission_required, name=\\\"dispatch\\\")\\nclass ImprintView(PermissionRequiredMixin, TemplateView):\\n \\\"\\\"\\\"\\n View for the imprint page form and imprint page translation form\\n \\\"\\\"\\\"\\n\\n permission_required = \\\"cms.manage_imprint\\\"\\n raise_exception = True\\n\\n template_name = \\\"imprint/imprint_form.html\\\"\\n base_context = {\\n \\\"current_menu_item\\\": \\\"imprint\\\",\\n \\\"WEBAPP_URL\\\": WEBAPP_URL,\\n \\\"IMPRINT_SLUG\\\": IMPRINT_SLUG,\\n }\\n\\n def get(self, request, *args, **kwargs):\\n \\\"\\\"\\\"\\n Render :class:`~cms.forms.imprint.imprint_translation_form.ImprintTranslationForm`\\n\\n :param request: The current request\\n :type request: ~django.http.HttpResponse\\n\\n :param args: The supplied arguments\\n :type args: list\\n\\n :param kwargs: The supplied keyword arguments\\n :type kwargs: dict\\n\\n :raises ~django.core.exceptions.PermissionDenied: If user does not have the permission to edit the specific page\\n\\n :return: The rendered template response\\n :rtype: ~django.template.response.TemplateResponse\\n \\\"\\\"\\\"\\n\\n # current region\\n region = Region.get_current_region(request)\\n\\n # current language\\n language_slug = kwargs.get(\\\"language_slug\\\")\\n if language_slug:\\n language = get_object_or_404(region.languages, slug=language_slug)\\n elif region.default_language:\\n return redirect(\\n \\\"edit_imprint\\\",\\n **{\\n \\\"region_slug\\\": region.slug,\\n \\\"language_slug\\\": region.default_language.slug,\\n },\\n )\\n else:\\n messages.error(\\n request,\\n _(\\\"Please create at least one language node before creating pages.\\\"),\\n )\\n return redirect(\\n \\\"language_tree\\\",\\n **{\\n \\\"region_slug\\\": region.slug,\\n },\\n )\\n\\n # get imprint and translation objects if they exist\\n try:\\n imprint = region.imprint\\n except ImprintPage.DoesNotExist:\\n imprint = None\\n\\n imprint_translation = ImprintPageTranslation.objects.filter(\\n page=imprint,\\n language=language,\\n ).first()\\n\\n # Make form disabled if user has no permission to manage the imprint\\n disabled = False\\n if imprint:\\n if imprint.archived:\\n disabled = True\\n messages.warning(\\n request, _(\\\"You cannot manage the imprint because it is archived.\\\")\\n )\\n public_translation = imprint.get_public_translation(language.slug)\\n if public_translation and imprint_translation != public_translation:\\n messages.info(\\n request,\\n _(\\n \\\"This is <b>not</b> the most recent public revision of this translation. Instead, <a href='%(revision_url)s' class='underline hover:no-underline'>revision %(revision)s</a> is shown in the apps.\\\"\\n )\\n % {\\n \\\"revision_url\\\": reverse(\\n \\\"imprint_revisions\\\",\\n kwargs={\\n \\\"region_slug\\\": region.slug,\\n \\\"language_slug\\\": language.slug,\\n \\\"selected_revision\\\": public_translation.version,\\n },\\n ),\\n \\\"revision\\\": public_translation.version,\\n },\\n )\\n\\n imprint_translation_form = ImprintTranslationForm(\\n instance=imprint_translation, disabled=disabled\\n )\\n\\n # Pass side by side language options\\n side_by_side_language_options = self.get_side_by_side_language_options(\\n region, language, imprint\\n )\\n\\n return render(\\n request,\\n self.template_name,\\n {\\n **self.base_context,\\n \\\"imprint_translation_form\\\": imprint_translation_form,\\n \\\"imprint\\\": imprint,\\n \\\"language\\\": language,\\n # Languages for tab view\\n \\\"languages\\\": region.languages if imprint else [language],\\n \\\"side_by_side_language_options\\\": side_by_side_language_options,\\n },\\n )\\n\\n # pylint: disable=too-many-branches,unused-argument\\n def post(self, request, *args, **kwargs):\\n \\\"\\\"\\\"\\n Binds the user input data to the imprint form and validates the input.\\n Forms containing images/files need to be additionally instantiated with the FILES attribute of request objects,\\n see :doc:`django:topics/http/file-uploads`\\n\\n :param request: Request submitted for saving imprint form\\n :type request: ~django.http.HttpRequest\\n\\n :param args: The supplied arguments\\n :type args: list\\n\\n :param kwargs: The supplied keyword arguments\\n :type kwargs: dict\\n\\n :return: Redirection to the populated imprint form\\n :rtype: ~django.http.HttpResponseRedirect\\n \\\"\\\"\\\"\\n\\n region = Region.get_current_region(request)\\n language = get_object_or_404(region.languages, slug=kwargs.get(\\\"language_slug\\\"))\\n\\n try:\\n imprint_instance = region.imprint\\n except ImprintPage.DoesNotExist:\\n imprint_instance = None\\n\\n imprint_translation_instance = ImprintPageTranslation.objects.filter(\\n page=imprint_instance,\\n language=language,\\n ).first()\\n\\n imprint_translation_form = ImprintTranslationForm(\\n request.POST,\\n instance=imprint_translation_instance,\\n region=region,\\n language=language,\\n )\\n\\n side_by_side_language_options = self.get_side_by_side_language_options(\\n region, language, imprint_instance\\n )\\n\\n # TODO: error handling\\n if not imprint_translation_form.is_valid():\\n messages.error(request, _(\\\"Errors have occurred.\\\"))\\n return render(\\n request,\\n self.template_name,\\n {\\n **self.base_context,\\n \\\"imprint_translation_form\\\": imprint_translation_form,\\n \\\"imprint\\\": imprint_instance,\\n \\\"language\\\": language,\\n # Languages for tab view\\n \\\"languages\\\": region.languages if imprint_instance else [language],\\n \\\"side_by_side_language_options\\\": side_by_side_language_options,\\n },\\n )\\n\\n if not imprint_translation_form.has_changed():\\n messages.info(request, _(\\\"No changes detected.\\\"))\\n return render(\\n request,\\n self.template_name,\\n {\\n **self.base_context,\\n \\\"imprint_translation_form\\\": imprint_translation_form,\\n \\\"imprint\\\": imprint_instance,\\n \\\"language\\\": language,\\n # Languages for tab view\\n \\\"languages\\\": region.languages if imprint_instance else [language],\\n \\\"side_by_side_language_options\\\": side_by_side_language_options,\\n },\\n )\\n\\n imprint = imprint_instance or ImprintPage.objects.create(region=region)\\n\\n imprint_translation = imprint_translation_form.save(\\n imprint=imprint,\\n user=request.user,\\n )\\n\\n published = imprint_translation.status == status.PUBLIC\\n if not imprint_instance:\\n if published:\\n messages.success(\\n request, _(\\\"imprint was successfully created and published\\\")\\n )\\n else:\\n messages.success(request, _(\\\"imprint was successfully created\\\"))\\n elif not imprint_translation_instance:\\n if published:\\n messages.success(\\n request, _(\\\"Translation was successfully created and published\\\")\\n )\\n else:\\n messages.success(request, _(\\\"Translation was successfully created\\\"))\\n else:\\n if published:\\n messages.success(request, _(\\\"Translation was successfully published\\\"))\\n else:\\n messages.success(request, _(\\\"Translation was successfully saved\\\"))\\n\\n return redirect(\\n \\\"edit_imprint\\\",\\n **{\\n \\\"region_slug\\\": region.slug,\\n \\\"language_slug\\\": language.slug,\\n },\\n )\\n\\n @staticmethod\\n def get_side_by_side_language_options(region, language, imprint):\\n \\\"\\\"\\\"\\n This is a helper function to generate the side-by-side language options for both the get and post requests.\\n\\n :param region: The current region\\n :type region: ~cms.models.regions.region.Region\\n\\n :param language: The current language\\n :type language: ~cms.models.languages.language.Language\\n\\n :param imprint: The current imprint\\n :type imprint: ~cms.models.pages.imprint_page.ImprintPage\\n\\n :return: The list of language options, each represented by a dict\\n :rtype: list\\n \\\"\\\"\\\"\\n side_by_side_language_options = []\\n for language_node in region.language_tree_nodes.all():\\n if language_node.parent:\\n source_translation = ImprintPageTranslation.objects.filter(\\n page=imprint,\\n language=language_node.parent.language,\\n )\\n side_by_side_language_options.append(\\n {\\n \\\"value\\\": language_node.language.slug,\\n \\\"label\\\": _(\\\"{source_language} to {target_language}\\\").format(\\n source_language=language_node.parent.language.translated_name,\\n target_language=language_node.language.translated_name,\\n ),\\n \\\"selected\\\": language_node.language == language,\\n \\\"disabled\\\": not source_translation.exists(),\\n }\\n )\\n return side_by_side_language_options\\n\",\n \"path\": \"src/cms/views/imprint/imprint_view.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/src/cms/views/imprint/imprint_view.py b/src/cms/views/imprint/imprint_view.py\nindex dcde7fbadb..fb66688f0f 100644\n--- a/src/cms/views/imprint/imprint_view.py\n+++ b/src/cms/views/imprint/imprint_view.py\n@@ -220,8 +220,8 @@ def post(self, request, *args, **kwargs):\n },\n )\n \n- if not imprint_instance:\n- imprint = ImprintPage.objects.create(region=region)\n+ imprint = imprint_instance or ImprintPage.objects.create(region=region)\n+\n imprint_translation = imprint_translation_form.save(\n imprint=imprint,\n user=request.user,\n"}}},{"rowIdx":4677,"cells":{"in_source_id":{"kind":"string","value":"mozmeao__basket-387"},"issue":{"kind":"string","value":"Capture credit card type in MoFo donations\n(MoFo work tracked [here](https://github.com/mozilla/donate-wagtail/issues/620))\r\n\r\nWe need to capture credit card type in donation opportunity records so that we can include it in emailed receipts to donors. It sounds like we need to\r\n\r\na.) add the `Credit_Card_Type_c` field to the donation opportunity record type so that MoFo users can see the value.\r\nb.) record the type when passed to Basket. I'm not sure if it needs to be a new key in the Basket payload or additional options for payment method, and I don't have an opinion. But whatever key we use should be able to not exist or be an empty string (or null?) like other optional fields already are.\n"},"before_files":{"kind":"list like","value":[{"content":"import json\nimport logging\nfrom copy import deepcopy\nfrom datetime import datetime, timedelta\nfrom email.utils import formatdate\nfrom functools import wraps\nfrom hashlib import sha256\nfrom time import mktime, time\nfrom urllib.parse import urlencode\n\nfrom django.conf import settings\nfrom django.core.cache import cache, caches\nfrom django.core.mail import send_mail\nfrom django.template.loader import render_to_string\n\nimport requests\nimport simple_salesforce as sfapi\nimport user_agents\nfrom celery.signals import task_failure, task_retry, task_success\nfrom django_statsd.clients import statsd\nfrom raven.contrib.django.raven_compat.models import client as sentry_client\n\nfrom basket.base.utils import email_is_testing\nfrom basket.news.backends.common import NewsletterException\nfrom basket.news.backends.sfdc import sfdc\nfrom basket.news.backends.sfmc import sfmc\nfrom basket.news.celery import app as celery_app\nfrom basket.news.models import (FailedTask, Newsletter, Interest,\n QueuedTask, TransactionalEmailMessage)\nfrom basket.news.newsletters import get_sms_vendor_id, get_transactional_message_ids, newsletter_map\nfrom basket.news.utils import (cents_to_dollars, generate_token, get_accept_languages, get_best_language,\n get_user_data, iso_format_unix_timestamp, parse_newsletters, parse_newsletters_csv,\n SUBSCRIBE, UNSUBSCRIBE, get_best_supported_lang, split_name)\n\nlog = logging.getLogger(__name__)\n\nBAD_MESSAGE_ID_CACHE = caches['bad_message_ids']\n\n# Base message ID for confirmation email\nCONFIRMATION_MESSAGE = \"confirmation_email\"\n\n# This is prefixed with the 2-letter language code + _ before sending,\n# e.g. 'en_recovery_message', and '_T' if text, e.g. 'en_recovery_message_T'.\nRECOVERY_MESSAGE_ID = 'SFDC_Recovery'\nFXACCOUNT_WELCOME = 'FxAccounts_Welcome'\n\n# don't propagate and don't retry if these are the error messages\nIGNORE_ERROR_MSGS = [\n 'InvalidEmailAddress',\n 'An invalid phone number was provided',\n]\n# don't propagate after max retries if these are the error messages\nIGNORE_ERROR_MSGS_POST_RETRY = [\n 'There are no valid subscribers',\n]\n# tasks exempt from maintenance mode queuing\nMAINTENANCE_EXEMPT = [\n 'news.tasks.add_sms_user',\n 'news.tasks.add_sms_user_optin',\n]\n\n\ndef ignore_error(exc, to_ignore=IGNORE_ERROR_MSGS):\n msg = str(exc)\n for ignore_msg in to_ignore:\n if ignore_msg in msg:\n return True\n\n return False\n\n\ndef ignore_error_post_retry(exc):\n return ignore_error(exc, IGNORE_ERROR_MSGS_POST_RETRY)\n\n\ndef get_lock(key, prefix='task'):\n \"\"\"Get a lock for a specific key (usually email address)\n\n Needs to be done with a timeout because SFDC needs some time to populate its\n indexes before the duplicate protection works and queries will return results.\n Releasing the lock right after the task was run still allowed dupes.\n\n Does nothing if you get the lock, and raises RetryTask if not.\n \"\"\"\n if not settings.TASK_LOCKING_ENABLE:\n return\n\n lock_key = 'basket-{}-{}'.format(prefix, key)\n lock_key = sha256(lock_key.encode()).hexdigest()\n got_lock = cache.add(lock_key, True, settings.TASK_LOCK_TIMEOUT)\n if not got_lock:\n statsd.incr('news.tasks.get_lock.no_lock_retry')\n raise RetryTask('Could not acquire lock')\n\n\nclass BasketError(Exception):\n \"\"\"Tasks can raise this when an error happens that we should not retry.\n E.g. if the error indicates we're passing bad parameters.\n (As opposed to an error connecting to ExactTarget at the moment,\n where we'd typically raise NewsletterException.)\n \"\"\"\n def __init__(self, msg):\n super(BasketError, self).__init__(msg)\n\n\nclass RetryTask(Exception):\n \"\"\"an exception to raise within a task if you just want to retry\"\"\"\n\n\n@task_failure.connect\ndef on_task_failure(sender, task_id, exception, einfo, args, kwargs, **skwargs):\n statsd.incr(sender.name + '.failure')\n if not sender.name.endswith('snitch'):\n statsd.incr('news.tasks.failure_total')\n if settings.STORE_TASK_FAILURES:\n FailedTask.objects.create(\n task_id=task_id,\n name=sender.name,\n args=args,\n kwargs=kwargs,\n exc=repr(exception),\n # str() gives more info than repr() on celery.datastructures.ExceptionInfo\n einfo=str(einfo),\n )\n\n\n@task_retry.connect\ndef on_task_retry(sender, **kwargs):\n statsd.incr(sender.name + '.retry')\n if not sender.name.endswith('snitch'):\n statsd.incr('news.tasks.retry_total')\n\n\n@task_success.connect\ndef on_task_success(sender, **kwargs):\n statsd.incr(sender.name + '.success')\n if not sender.name.endswith('snitch'):\n statsd.incr('news.tasks.success_total')\n\n\ndef et_task(func):\n \"\"\"Decorator to standardize ET Celery tasks.\"\"\"\n full_task_name = 'news.tasks.%s' % func.__name__\n\n # continue to use old names regardless of new layout\n @celery_app.task(name=full_task_name,\n bind=True,\n default_retry_delay=300, # 5 min\n max_retries=11)\n @wraps(func)\n def wrapped(self, *args, **kwargs):\n start_time = kwargs.pop('start_time', None)\n if start_time and not self.request.retries:\n total_time = int((time() - start_time) * 1000)\n statsd.timing(self.name + '.timing', total_time)\n statsd.incr(self.name + '.total')\n statsd.incr('news.tasks.all_total')\n if settings.MAINTENANCE_MODE and self.name not in MAINTENANCE_EXEMPT:\n if not settings.READ_ONLY_MODE:\n # record task for later\n QueuedTask.objects.create(\n name=self.name,\n args=args,\n kwargs=kwargs,\n )\n statsd.incr(self.name + '.queued')\n else:\n statsd.incr(self.name + '.not_queued')\n\n return\n\n try:\n return func(*args, **kwargs)\n except (IOError, NewsletterException, requests.RequestException, RetryTask,\n sfapi.SalesforceExpiredSession, sfapi.SalesforceGeneralError,\n sfapi.SalesforceRefusedRequest, sfapi.SalesforceResourceNotFound,\n sfapi.SalesforceAuthenticationFailed, sfapi.SalesforceMalformedRequest) as e:\n # These could all be connection issues, so try again later.\n # IOError covers URLError and SSLError.\n if ignore_error(e):\n return\n\n try:\n if not (isinstance(e, RetryTask) or ignore_error_post_retry(e)):\n sentry_client.captureException(tags={'action': 'retried'})\n\n # ~68 hr at 11 retries\n raise self.retry(countdown=2 ** (self.request.retries + 1) * 60)\n except self.MaxRetriesExceededError:\n statsd.incr(self.name + '.retry_max')\n statsd.incr('news.tasks.retry_max_total')\n # don't bubble certain errors\n if ignore_error_post_retry(e):\n return\n\n sentry_client.captureException()\n\n return wrapped\n\n\ndef gmttime(basetime=None):\n if basetime is None:\n basetime = datetime.now()\n d = basetime + timedelta(minutes=10)\n stamp = mktime(d.timetuple())\n return formatdate(timeval=stamp, localtime=False, usegmt=True)\n\n\ndef fxa_source_url(metrics):\n source_url = settings.FXA_REGISTER_SOURCE_URL\n query = {k: v for k, v in metrics.items() if k.startswith('utm_')}\n if query:\n source_url = '?'.join((source_url, urlencode(query)))\n\n return source_url\n\n\n@et_task\ndef fxa_email_changed(data):\n ts = data['ts']\n fxa_id = data['uid']\n email = data['email']\n cache_key = 'fxa_email_changed:%s' % fxa_id\n prev_ts = float(cache.get(cache_key, 0))\n if prev_ts and prev_ts > ts:\n # message older than our last update for this UID\n return\n\n sfmc.upsert_row('FXA_EmailUpdated', {\n 'FXA_ID': fxa_id,\n 'NewEmailAddress': email,\n })\n cache.set(cache_key, ts, 7200) # 2 hr\n\n\n@et_task\ndef fxa_delete(data):\n sfmc.upsert_row('FXA_Deleted', {'FXA_ID': data['uid']})\n user_data = get_user_data(fxa_id=data['uid'], extra_fields=['id'])\n if user_data:\n sfdc.update(user_data, {'fxa_deleted': True})\n\n\n@et_task\ndef fxa_verified(data):\n \"\"\"Add new FxA users to an SFMC data extension\"\"\"\n # used to be handled by the fxa_register view\n email = data['email']\n fxa_id = data['uid']\n create_date = data.get('createDate')\n if create_date:\n create_date = datetime.fromtimestamp(create_date)\n\n locale = data.get('locale')\n subscribe = data.get('marketingOptIn')\n newsletters = data.get('newsletters')\n metrics = data.get('metricsContext', {})\n service = data.get('service', '')\n country = data.get('countryCode', '')\n\n if not locale:\n statsd.incr('fxa_verified.ignored.no_locale')\n return\n\n # if we're not using the sandbox ignore testing domains\n if email_is_testing(email):\n return\n\n lang = get_best_language(get_accept_languages(locale))\n if not lang:\n return\n\n _update_fxa_info(email, lang, fxa_id, service, create_date)\n\n add_news = None\n if newsletters:\n if settings.FXA_REGISTER_NEWSLETTER not in newsletters:\n newsletters.append(settings.FXA_REGISTER_NEWSLETTER)\n\n add_news = ','.join(newsletters)\n elif subscribe:\n add_news = settings.FXA_REGISTER_NEWSLETTER\n\n if add_news:\n upsert_user.delay(SUBSCRIBE, {\n 'email': email,\n 'lang': lang,\n 'newsletters': add_news,\n 'source_url': fxa_source_url(metrics),\n 'country': country,\n })\n else:\n record_source_url(email, fxa_source_url(metrics), 'fxa-no-optin')\n\n\n@et_task\ndef fxa_login(data):\n email = data['email']\n # if we're not using the sandbox ignore testing domains\n if email_is_testing(email):\n return\n\n new_data = {\n 'user_agent': data['userAgent'],\n 'fxa_id': data['uid'],\n 'first_device': data['deviceCount'] == 1,\n 'service': data.get('service', '')\n }\n _add_fxa_activity(new_data)\n\n metrics = data.get('metricsContext', {})\n newsletter = settings.FXA_LOGIN_CAMPAIGNS.get(metrics.get('utm_campaign'))\n if newsletter:\n upsert_user.delay(SUBSCRIBE, {\n 'email': email,\n 'newsletters': newsletter,\n 'source_url': fxa_source_url(metrics),\n 'country': data.get('countryCode', ''),\n })\n\n\ndef _add_fxa_activity(data):\n user_agent = user_agents.parse(data['user_agent'])\n device_type = 'D'\n if user_agent.is_mobile:\n device_type = 'M'\n elif user_agent.is_tablet:\n device_type = 'T'\n\n apply_updates('Sync_Device_Logins', {\n 'FXA_ID': data['fxa_id'],\n 'SERVICE': data['service'],\n 'LOGIN_DATE': gmttime(),\n 'FIRST_DEVICE': 'y' if data.get('first_device') else 'n',\n 'OS': user_agent.os.family,\n 'OS_VERSION': user_agent.os.version_string,\n 'BROWSER': '{0} {1}'.format(user_agent.browser.family,\n user_agent.browser.version_string),\n 'DEVICE_NAME': user_agent.device.family,\n 'DEVICE_TYPE': device_type,\n })\n\n\ndef _update_fxa_info(email, lang, fxa_id, service, create_date=None):\n # leaving here because easier to test\n try:\n apply_updates('Firefox_Account_ID', {\n 'EMAIL_ADDRESS_': email,\n 'CREATED_DATE_': gmttime(create_date),\n 'FXA_ID': fxa_id,\n 'FXA_LANGUAGE_ISO2': lang,\n 'SERVICE': service,\n })\n except NewsletterException as e:\n # don't report these errors to sentry until retries exhausted\n raise RetryTask(str(e))\n\n\n@et_task\ndef update_get_involved(interest_id, lang, name, email, country, email_format,\n subscribe, message, source_url):\n \"\"\"Send a user contribution information. Should be removed soon.\"\"\"\n try:\n interest = Interest.objects.get(interest_id=interest_id)\n except Interest.DoesNotExist:\n # invalid request; no need to raise exception and retry\n return\n\n interest.notify_stewards(name, email, lang, message)\n\n\n@et_task\ndef update_user_meta(token, data):\n \"\"\"Update a user's metadata, not newsletters\"\"\"\n sfdc.update({'token': token}, data)\n\n\n@et_task\ndef upsert_user(api_call_type, data):\n \"\"\"\n Update or insert (upsert) a contact record in SFDC\n\n @param int api_call_type: What kind of API call it was. Could be\n SUBSCRIBE, UNSUBSCRIBE, or SET.\n @param dict data: POST data from the form submission\n @return:\n \"\"\"\n key = data.get('email') or data.get('token')\n get_lock(key)\n upsert_contact(api_call_type, data,\n get_user_data(token=data.get('token'),\n email=data.get('email'),\n extra_fields=['id']))\n\n\ndef upsert_contact(api_call_type, data, user_data):\n \"\"\"\n Update or insert (upsert) a contact record in SFDC\n\n @param int api_call_type: What kind of API call it was. Could be\n SUBSCRIBE, UNSUBSCRIBE, or SET.\n @param dict data: POST data from the form submission\n @param dict user_data: existing contact data from SFDC\n @return: token, created\n \"\"\"\n update_data = data.copy()\n forced_optin = data.pop('optin', False)\n if 'format' in data:\n update_data['format'] = 'T' if data['format'].upper().startswith('T') else 'H'\n\n newsletters = parse_newsletters_csv(data.get('newsletters'))\n\n if user_data:\n cur_newsletters = user_data.get('newsletters', None)\n else:\n cur_newsletters = None\n\n # check for and remove transactional newsletters\n if api_call_type == SUBSCRIBE:\n all_transactionals = set(get_transactional_message_ids())\n newsletters_set = set(newsletters)\n transactionals = newsletters_set & all_transactionals\n if transactionals:\n newsletters = list(newsletters_set - transactionals)\n send_transactional_messages(update_data, user_data, list(transactionals))\n if not newsletters:\n # no regular newsletters\n return None, None\n\n # Set the newsletter flags in the record by comparing to their\n # current subscriptions.\n update_data['newsletters'] = parse_newsletters(api_call_type, newsletters, cur_newsletters)\n\n if api_call_type != UNSUBSCRIBE:\n # Are they subscribing to any newsletters that don't require confirmation?\n # When including any newsletter that does not\n # require confirmation, user gets a pass on confirming and goes straight\n # to confirmed.\n to_subscribe = [nl for nl, sub in update_data['newsletters'].items() if sub]\n if to_subscribe and not (forced_optin or\n (user_data and user_data.get('optin'))):\n exempt_from_confirmation = Newsletter.objects \\\n .filter(slug__in=to_subscribe, requires_double_optin=False) \\\n .exists()\n if exempt_from_confirmation:\n update_data['optin'] = True\n\n # record source URL\n nl_map = newsletter_map()\n source_url = update_data.get('source_url')\n email = update_data.get('email')\n if not email:\n email = user_data.get('email') if user_data else None\n\n if email:\n # send all newsletters whether already subscribed or not\n # bug 1308971\n # if api_call_type == SET this is pref center, so only send new subscriptions\n nl_list = newsletters if api_call_type == SUBSCRIBE else to_subscribe\n for nlid in nl_list:\n if nlid in nl_map:\n record_source_url.delay(email, source_url, nl_map[nlid])\n\n if user_data is None:\n # no user found. create new one.\n update_data['token'] = generate_token()\n if settings.MAINTENANCE_MODE:\n sfdc_add_update.delay(update_data)\n else:\n # don't catch exceptions here. SalesforceError subclasses will retry.\n sfdc.add(update_data)\n\n return update_data['token'], True\n\n if forced_optin and not user_data.get('optin'):\n update_data['optin'] = True\n\n # they opted out of email before, but are subscribing again\n # clear the optout flag\n if api_call_type != UNSUBSCRIBE and user_data.get('optout'):\n update_data['optout'] = False\n\n # update record\n if user_data and user_data.get('token'):\n token = user_data['token']\n else:\n token = update_data['token'] = generate_token()\n\n if settings.MAINTENANCE_MODE:\n sfdc_add_update.delay(update_data, user_data)\n else:\n sfdc.update(user_data, update_data)\n\n return token, False\n\n\n@et_task\ndef sfdc_add_update(update_data, user_data=None):\n # for use with maintenance mode only\n # TODO remove after maintenance is over and queue is processed\n if user_data:\n sfdc.update(user_data, update_data)\n else:\n try:\n sfdc.add(update_data)\n except sfapi.SalesforceMalformedRequest as e: # noqa\n # possibly a duplicate email. try the update below.\n user_data = get_user_data(email=update_data['email'], extra_fields=['id'])\n if user_data:\n # we have a user, delete generated token\n # and continue with an update\n update_data.pop('token', None)\n sfdc.update(user_data, update_data)\n else:\n # still no user, try the add one more time\n sfdc.add(update_data)\n\n\ndef send_transactional_messages(data, user_data, transactionals):\n email = data['email']\n lang_code = data.get('lang', 'en')[:2].lower()\n msgs = TransactionalEmailMessage.objects.filter(message_id__in=transactionals)\n if user_data and 'id' in user_data:\n sfdc_id = user_data['id']\n else:\n sfdc_id = None\n\n for tm in msgs:\n languages = [lang[:2].lower() for lang in tm.language_list]\n if lang_code not in languages:\n # Newsletter does not support their preferred language, so\n # it doesn't have a welcome in that language either. Settle\n # for English, same as they'll be getting the newsletter in.\n lang_code = 'en'\n\n msg_id = mogrify_message_id(tm.vendor_id, lang_code, 'H')\n send_message.delay(msg_id, email, sfdc_id or email)\n\n\ndef apply_updates(database, record):\n \"\"\"Send the record data to ET to update the database named\n target_et.\n\n :param str database: Target database, e.g. 'Firefox_Account_ID'\n :param dict record: Data to send\n \"\"\"\n sfmc.upsert_row(database, record)\n\n\n@et_task\ndef send_message(message_id, email, subscriber_key, token=None):\n \"\"\"\n Ask ET to send a message.\n\n @param str message_id: ID of the message in ET\n @param str email: email to send it to\n @param str subscriber_key: id of the email user (email or SFDC id)\n @param token: optional token when sending recovery\n\n @raises: NewsletterException for retryable errors, BasketError for\n fatal errors.\n \"\"\"\n if BAD_MESSAGE_ID_CACHE.get(message_id, False):\n return\n\n try:\n sfmc.send_mail(message_id, email, subscriber_key, token)\n statsd.incr('news.tasks.send_message.' + message_id)\n except NewsletterException as e:\n # Better error messages for some cases. Also there's no point in\n # retrying these\n if 'Invalid Customer Key' in str(e):\n # remember it's a bad message ID so we don't try again during this process.\n BAD_MESSAGE_ID_CACHE.set(message_id, True)\n return\n # we should retry\n raise\n\n\ndef mogrify_message_id(message_id, lang, format):\n \"\"\"Given a bare message ID, a language code, and a format (T or H),\n return a message ID modified to specify that language and format.\n\n E.g. on input ('MESSAGE', 'fr', 'T') it returns 'fr_MESSAGE_T',\n or on input ('MESSAGE', 'pt', 'H') it returns 'pt_MESSAGE'\n\n If `lang` is None or empty, it skips prefixing the language.\n \"\"\"\n if lang:\n result = \"%s_%s\" % (lang.lower()[:2], message_id)\n else:\n result = message_id\n if format == 'T':\n result += \"_T\"\n return result\n\n\n@et_task\ndef confirm_user(token):\n \"\"\"\n Confirm any pending subscriptions for the user with this token.\n\n If any of the subscribed newsletters have welcome messages,\n send them.\n\n :param token: User's token\n :param user_data: Dictionary with user's data from Exact Target,\n as returned by get_user_data(), or None if that wasn't available\n when this was called.\n :raises: BasketError for fatal errors, NewsletterException for retryable\n errors.\n \"\"\"\n get_lock(token)\n user_data = get_user_data(token=token)\n\n if user_data is None:\n statsd.incr('news.tasks.confirm_user.confirm_user_not_found')\n return\n\n if user_data['optin']:\n # already confirmed\n return\n\n if not ('email' in user_data and user_data['email']):\n raise BasketError('token has no email in ET')\n\n sfdc.update(user_data, {'optin': True})\n\n\n@et_task\ndef add_sms_user(send_name, mobile_number, optin, vendor_id=None):\n # Adding vendor_id as optional to avoid issues with deployment.\n # Old tasks with the old sitnature will be on the queue when this is first deployed.\n # TODO change the task signature to replace send_name with vendor_id\n if not vendor_id:\n vendor_id = get_sms_vendor_id(send_name)\n if not vendor_id:\n return\n\n sfmc.send_sms(mobile_number, vendor_id)\n if optin:\n add_sms_user_optin.delay(mobile_number)\n\n\n@et_task\ndef add_sms_user_optin(mobile_number):\n record = {'Phone': mobile_number, 'SubscriberKey': mobile_number}\n sfmc.add_row('Mobile_Subscribers', record)\n\n\n@et_task\ndef update_custom_unsub(token, reason):\n \"\"\"Record a user's custom unsubscribe reason.\"\"\"\n get_lock(token)\n try:\n sfdc.update({'token': token}, {'reason': reason})\n except sfapi.SalesforceMalformedRequest:\n # likely the record can't be found. nothing to do.\n pass\n\n\n@et_task\ndef send_recovery_message_task(email):\n user_data = get_user_data(email=email, extra_fields=['id'])\n if not user_data:\n log.debug(\"In send_recovery_message_task, email not known: %s\" % email)\n return\n\n # make sure we have a language and format, no matter what ET returned\n lang = user_data.get('lang', 'en') or 'en'\n format = user_data.get('format', 'H') or 'H'\n\n if lang not in settings.RECOVER_MSG_LANGS:\n lang = 'en'\n\n message_id = mogrify_message_id(RECOVERY_MESSAGE_ID, lang, format)\n send_message.delay(message_id, email, user_data['id'], token=user_data['token'])\n\n\n@et_task\ndef record_common_voice_goals(data):\n # do not change the sent data in place. A retry will use the changed data.\n dcopy = data.copy()\n email = dcopy.pop('email')\n user_data = get_user_data(email=email, extra_fields=['id'])\n new_data = {\n 'source_url': 'https://voice.mozilla.org',\n 'newsletters': [settings.COMMON_VOICE_NEWSLETTER],\n }\n for k, v in dcopy.items():\n new_data['cv_' + k] = v\n\n if user_data:\n sfdc.update(user_data, new_data)\n else:\n new_data.update({\n 'email': email,\n 'token': generate_token(),\n })\n sfdc.add(new_data)\n\n\n@et_task\ndef record_fxa_concerts_rsvp(email, is_firefox, campaign_id):\n sfmc.add_row('FxAccounts_Concert_RSVP', {\n 'Email': email,\n 'Firefox': is_firefox,\n 'Campaign_ID': campaign_id,\n 'RSVP_Time': gmttime(),\n })\n\n\n@et_task\ndef record_source_url(email, source_url, newsletter_id):\n if not source_url:\n source_url = '__NONE__'\n else:\n source_url = source_url[:1000]\n\n sfmc.add_row('NEWSLETTER_SOURCE_URLS', {\n 'Email': email,\n 'Signup_Source_URL__c': source_url,\n 'Newsletter_Field_Name': newsletter_id,\n 'Newsletter_Date': gmttime(),\n })\n\n\n@et_task\ndef process_subhub_event_customer_created(data):\n \"\"\"\n Event name: customer.created\n\n Creates or updates a SFDC customer when a new payment processor/Stripe\n customer is created\n \"\"\"\n statsd.incr('news.tasks.process_subhub_event.customer_created')\n\n first, last = split_name(data['name'])\n contact_data = {\n 'fxa_id': data['user_id'],\n 'payee_id': data['customer_id']\n }\n\n user_data = get_user_data(email=data['email'])\n\n # if user was found in sfdc, see if we should update their name(s)\n if user_data:\n # if current last name is '_', update it\n if user_data['last_name'] == '_':\n contact_data['last_name'] = last\n\n # if current last name is blank/Null, update it\n if not user_data['first_name']:\n contact_data['first_name'] = first\n\n sfdc.update(user_data, contact_data)\n statsd.incr('news.tasks.process_subhub_event.customer_created.updated')\n # if no user was found, create new user in sfdc\n else:\n contact_data['email'] = data['email']\n contact_data['first_name'] = first\n contact_data['last_name'] = last\n\n # create the user in sfdc\n statsd.incr('news.tasks.process_subhub_event.customer_created.created')\n sfdc.add(contact_data)\n\n\n@et_task\ndef process_subhub_event_subscription_charge(data):\n \"\"\"\n Event names: customer.subscription.created, customer.recurring_charge\n\n This method handles both new and recurring charges.\n\n Each of the handled events contains the same payload data. The only variation below\n is in regards to Initial_Purchase__c, which will be True for the\n `customer.subscription.created` event, and False for the `customer.recurring_charge`\n event.\n \"\"\"\n\n statsd.incr('news.tasks.process_subhub_event.subscription_charge')\n user_data = get_user_data(payee_id=data['customer_id'],\n extra_fields=['id'])\n if not user_data:\n statsd.incr('news.tasks.process_subhub_event.subscription_charge.user_not_found')\n raise RetryTask('Could not find user. Try again.')\n\n nickname = data['nickname']\n if isinstance(nickname, list):\n nickname = nickname[0]\n\n # if a customer re-instates service after a cancellation, the record needs to be updated\n oppy_data = {\n 'Amount': cents_to_dollars(data['plan_amount']),\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\n 'Billing_Cycle_Start__c': iso_format_unix_timestamp(data['current_period_start']),\n 'CloseDate': iso_format_unix_timestamp(data['created']),\n 'Credit_Card_Type__c': data['brand'],\n 'currency__c': data['currency'],\n 'Donation_Contact__c': user_data['id'],\n 'Event_Id__c': data['event_id'],\n 'Event_Name__c': data['event_type'],\n 'Initial_Purchase__c': data['event_type'] == 'customer.subscription.created',\n 'Invoice_Number__c': data['invoice_number'],\n 'Last_4_Digits__c': data['last4'],\n 'Name': 'Subscription Services',\n 'Next_Invoice_Date__c': iso_format_unix_timestamp(data['next_invoice_date']),\n 'Payment_Source__c': 'Stripe',\n 'PMT_Subscription_ID__c': data['subscription_id'],\n 'PMT_Transaction_ID__c': data['charge'],\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\n 'Service_Plan__c': nickname,\n 'StageName': 'Closed Won',\n }\n if 'proration_amount' in data:\n oppy_data['Proration_Amount__c'] = cents_to_dollars(data['proration_amount'])\n\n if 'total_amount' in data:\n oppy_data['Total_Amount__c'] = cents_to_dollars(data['total_amount'])\n\n sfdc.opportunity.upsert(f'PMT_Invoice_ID__c/{data[\"invoice_id\"]}', oppy_data)\n\n\n@et_task\ndef process_subhub_event_subscription_reactivated(data):\n statsd.incr('news.tasks.process_subhub_event.subscription_reactivated')\n user_data = get_user_data(payee_id=data['customer_id'],\n extra_fields=['id'])\n if not user_data:\n statsd.incr('news.tasks.process_subhub_event.subscription_reactivated.user_not_found')\n raise RetryTask('Could not find user. Try again.')\n\n nickname = data['nickname']\n if isinstance(nickname, list):\n nickname = nickname[0]\n\n sfdc.opportunity.create({\n 'Amount': cents_to_dollars(data['plan_amount']),\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\n 'CloseDate': iso_format_unix_timestamp(data.get('close_date', time())),\n 'Credit_Card_Type__c': data['brand'],\n 'Last_4_Digits__c': data['last4'],\n 'Donation_Contact__c': user_data['id'],\n 'Event_Id__c': data['event_id'],\n 'Event_Name__c': data['event_type'],\n 'Name': 'Subscription Services',\n 'Payment_Source__c': 'Stripe',\n 'PMT_Subscription_ID__c': data['subscription_id'],\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\n 'Service_Plan__c': nickname,\n 'StageName': 'Reactivation',\n })\n\n\n@et_task\ndef process_subhub_event_subscription_updated(data):\n statsd.incr('news.tasks.process_subhub_event.subscription_updated')\n user_data = get_user_data(payee_id=data['customer_id'],\n extra_fields=['id'])\n if not user_data:\n statsd.incr('news.tasks.process_subhub_event.subscription_updated.user_not_found')\n raise RetryTask('Could not find user. Try again.')\n\n direction = 'Down' if data['event_type'].endswith('downgrade') else 'Up'\n stage_name = f'Subscription {direction}grade'\n sfdc.opportunity.create({\n 'Amount': cents_to_dollars(data['plan_amount_new']),\n 'Plan_Amount_Old__c': cents_to_dollars(data['plan_amount_old']),\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\n 'CloseDate': iso_format_unix_timestamp(data.get('close_date', time())),\n 'Donation_Contact__c': user_data['id'],\n 'Event_Id__c': data['event_id'],\n 'Event_Name__c': data['event_type'],\n 'Invoice_Number__c': data['invoice_number'],\n 'Name': 'Subscription Services',\n 'Payment_Interval__c': data['interval'],\n 'Payment_Source__c': 'Stripe',\n 'PMT_Invoice_ID__c': data['invoice_id'],\n 'PMT_Subscription_ID__c': data['subscription_id'],\n 'Proration_Amount__c': data['proration_amount'],\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\n 'Service_Plan__c': data['nickname_new'],\n 'Nickname_Old__c': data['nickname_old'],\n 'StageName': stage_name,\n })\n\n\nSUB_STAGE_NAMES = {\n 'customer.subscription_cancelled': 'Subscription Canceled',\n 'customer.deleted': 'Account Deleted',\n}\n\n\n@et_task\ndef process_subhub_event_subscription_cancel(data):\n \"\"\"\n Event name: customer.subscription_cancelled or customer.deleted\n \"\"\"\n statsd.incr('news.tasks.process_subhub_event.subscription_cancel')\n user_data = get_user_data(payee_id=data['customer_id'],\n extra_fields=['id'])\n if not user_data:\n statsd.incr('news.tasks.process_subhub_event_subscription_cancel.user_not_found')\n raise RetryTask('Could not find user. Try again.')\n\n nickname = data['nickname']\n if isinstance(nickname, list):\n nickname = nickname[0]\n\n sfdc.opportunity.create({\n 'Amount': cents_to_dollars(data['plan_amount']),\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\n 'Billing_Cycle_Start__c': iso_format_unix_timestamp(data['current_period_start']),\n 'CloseDate': iso_format_unix_timestamp(data.get('cancel_at', time())),\n 'Donation_Contact__c': user_data['id'],\n 'Event_Id__c': data['event_id'],\n 'Event_Name__c': data['event_type'],\n 'Name': 'Subscription Services',\n 'Payment_Source__c': 'Stripe',\n 'PMT_Subscription_ID__c': data['subscription_id'],\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\n 'Service_Plan__c': nickname,\n 'StageName': SUB_STAGE_NAMES[data['event_type']],\n })\n\n if data['event_type'] == 'customer.deleted':\n sfdc.update(user_data, {'fxa_deleted': True})\n\n\n@et_task\ndef process_subhub_event_credit_card_expiring(data):\n \"\"\"\n Event name: customer.source.expiring\n \"\"\"\n statsd.incr('news.tasks.process_subhub_event.credit_card_expiring')\n sfmc.send_mail(settings.SUBHUB_CC_EXPIRE_TRIGGER, data['email'], data['email'])\n\n\n@et_task\ndef process_subhub_event_payment_failed(data):\n \"\"\"\n Event name: invoice.payment_failed\n \"\"\"\n statsd.incr('news.tasks.process_subhub_event.payment_failed')\n\n user_data = get_user_data(payee_id=data['customer_id'],\n extra_fields=['id'])\n # the only user identifiable information available is the payment\n # processor/Stripe ID, so if the user wasn't found by that, there's really\n # nothing to be done here but retry.\n if not user_data:\n statsd.incr('news.tasks.process_subhub_event.payment_failed.user_not_found')\n raise RetryTask('Could not find user. Try again.')\n\n nickname = data['nickname']\n if isinstance(nickname, list):\n nickname = nickname[0]\n\n sfdc.opportunity.create({\n 'Amount': cents_to_dollars(data['amount_due']),\n 'CloseDate': iso_format_unix_timestamp(data['created']),\n 'Donation_Contact__c': user_data['id'],\n 'Event_Id__c': data['event_id'],\n 'Event_Name__c': data['event_type'],\n 'Name': 'Subscription Services',\n 'PMT_Subscription_ID__c': data['subscription_id'],\n 'PMT_Transaction_ID__c': data['charge_id'],\n 'Payment_Source__c': 'Stripe',\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\n 'Service_Plan__c': nickname,\n 'StageName': 'Payment Failed',\n 'currency__c': data['currency'],\n })\n\n\n@et_task\ndef process_donation_event(data):\n \"\"\"Process a followup event on a donation\"\"\"\n etype = data['event_type']\n txn_id = data['transaction_id']\n status = data.get('status')\n statsd.incr('news.tasks.process_donation_event.{}'.format(etype))\n if status:\n statsd.incr('news.tasks.process_donation_event.{}.{}'.format(etype, status))\n\n if etype.startswith('charge.dispute.'):\n if status not in ['charge_refunded', 'won', 'lost']:\n # only care about the above statuses\n statsd.incr('news.tasks.process_donation_event.{}.IGNORED'.format(etype))\n return\n elif etype == 'charge.refunded':\n if status not in ['succeeded', 'failed', 'cancelled']:\n # don't care about pending statuses\n statsd.incr('news.tasks.process_donation_event.{}.IGNORED'.format(etype))\n return\n\n if 'reason' in data:\n reason_lost = data['reason']\n else:\n reason_lost = data['failure_code']\n\n try:\n # will raise a SalesforceMalformedRequest if not found\n sfdc.opportunity.update('PMT_Transaction_ID__c/{}'.format(txn_id), {\n 'PMT_Type_Lost__c': etype,\n 'PMT_Reason_Lost__c': reason_lost,\n 'StageName': 'Closed Lost',\n })\n except sfapi.SalesforceMalformedRequest as e:\n # we don't know about this tx_id. Let someone know.\n do_notify = cache.add('donate-notify-{}'.format(txn_id), 1, 86400)\n if do_notify and settings.DONATE_UPDATE_FAIL_DE:\n sfmc.add_row(settings.DONATE_UPDATE_FAIL_DE, {\n 'PMT_Transaction_ID__c': txn_id,\n 'Payment_Type__c': etype,\n 'PMT_Reason_Lost__c': reason_lost,\n 'Error_Text': str(e)[:4000],\n 'Date': gmttime(),\n })\n\n if do_notify and settings.DONATE_NOTIFY_EMAIL:\n # don't notify about a transaction more than once per day\n first_mail = cache.add('donate-notify-{}'.format(txn_id), 1, 86400)\n if first_mail:\n body = render_to_string('news/donation_notify_email.txt', {\n 'txn_id': txn_id,\n 'type_lost': etype,\n 'reason_lost': reason_lost,\n 'server_name': settings.STATSD_PREFIX,\n })\n send_mail('Donation Record Not Found', body,\n 'noreply@mozilla.com', [settings.DONATE_NOTIFY_EMAIL])\n\n # retry\n raise\n\n\n# all strings and truncated at 2000 chars\nDONATION_OPTIONAL_FIELDS = {\n 'SourceURL__c': 'source_url',\n 'Donation_Form_URL__c': 'donation_url',\n 'Project__c': 'project',\n 'PMT_Subscription_ID__c': 'subscription_id',\n}\n# Add these fields as optional for now as some messages\n# could still come through without them. Mix of string\n# and numerical data.\nDONATION_NEW_FIELDS = {\n 'Donation_Locale__c': 'locale',\n 'Processors_Fee__c': 'transaction_fee',\n 'Net_Amount__c': 'net_amount',\n 'Conversion_Amount__c': 'conversion_amount',\n 'Last_4_Digits__c': 'last_4',\n}\n\n\n@et_task\ndef process_donation(data):\n get_lock(data['email'])\n # tells the backend to leave the \"subscriber\" flag alone\n contact_data = {'_set_subscriber': False}\n # do \"or ''\" because data can contain None values\n first_name = (data.get('first_name') or '').strip()\n last_name = (data.get('last_name') or '').strip()\n if first_name and last_name:\n contact_data['first_name'] = first_name\n contact_data['last_name'] = last_name\n elif first_name:\n contact_data['first_name'] = first_name\n elif last_name:\n names = data['last_name'].rsplit(None, 1)\n if len(names) == 2:\n first, last = names\n else:\n first, last = '', names[0]\n if first:\n contact_data['first_name'] = first\n if last:\n contact_data['last_name'] = last\n\n user_data = get_user_data(email=data['email'],\n extra_fields=['id'])\n if user_data:\n if contact_data and (\n ('first_name' in contact_data and contact_data['first_name'] != user_data['first_name']) or\n ('last_name' in contact_data and contact_data['last_name'] != user_data['last_name'])):\n sfdc.update(user_data, contact_data)\n else:\n contact_data['token'] = generate_token()\n contact_data['email'] = data['email']\n contact_data['record_type'] = settings.DONATE_CONTACT_RECORD_TYPE\n\n # returns a dict with the new ID but no other user data, but that's enough here\n user_data = sfdc.add(contact_data)\n if not user_data.get('id'):\n # retry here to make sure we associate the donation data with the proper account\n raise RetryTask('User not yet available')\n\n # add opportunity\n donation = {\n 'RecordTypeId': settings.DONATE_OPP_RECORD_TYPE,\n 'Name': 'Foundation Donation',\n 'Donation_Contact__c': user_data['id'],\n 'StageName': 'Closed Won',\n 'Amount': float(data['donation_amount']),\n 'Currency__c': data['currency'].upper(),\n 'Payment_Source__c': data['service'],\n 'PMT_Transaction_ID__c': data['transaction_id'],\n 'Payment_Type__c': 'Recurring' if data['recurring'] else 'One-Time',\n }\n # this is a unix timestamp in ms since epoc\n timestamp = data.get('created')\n if timestamp:\n donation['CloseDate'] = iso_format_unix_timestamp(timestamp)\n\n for dest_name, source_name in DONATION_NEW_FIELDS.items():\n if source_name in data:\n donation[dest_name] = data[source_name]\n\n for dest_name, source_name in DONATION_OPTIONAL_FIELDS.items():\n if data.get(source_name):\n # truncate at 2000 chars as that's the max for\n # a SFDC text field. We may do more granular\n # truncation per field in future.\n donation[dest_name] = data[source_name][:2000]\n\n try:\n sfdc.opportunity.create(donation)\n except sfapi.SalesforceMalformedRequest as e:\n if e.content and e.content[0].get('errorCode') == 'DUPLICATE_VALUE':\n # already in the system, ignore\n pass\n else:\n raise\n\n\n@et_task\ndef process_newsletter_subscribe(data):\n data = data['form']\n data['lang'] = get_best_supported_lang(data['lang'])\n upsert_user(SUBSCRIBE, data)\n\n\nPETITION_CONTACT_FIELDS = [\n 'first_name',\n 'last_name',\n 'country',\n 'postal_code',\n 'source_url',\n]\n\n\n@et_task\ndef process_petition_signature(data):\n \"\"\"\n Add petition signature to SFDC\n \"\"\"\n data = data['form']\n get_lock(data['email'])\n # tells the backend to leave the \"subscriber\" flag alone\n contact_data = {'_set_subscriber': False}\n contact_data.update({k: data[k] for k in PETITION_CONTACT_FIELDS if data.get(k)})\n\n user_data = get_user_data(email=data['email'],\n extra_fields=['id'])\n if user_data:\n sfdc.update(user_data, contact_data)\n else:\n contact_data['token'] = generate_token()\n contact_data['email'] = data['email']\n contact_data['record_type'] = settings.DONATE_CONTACT_RECORD_TYPE\n sfdc.add(contact_data)\n # fetch again to get ID\n user_data = get_user_data(email=data.get('email'),\n extra_fields=['id'])\n if not user_data:\n # retry here to make sure we associate the donation data with the proper account\n raise RetryTask('User not yet available')\n\n if data.get('email_subscription', False):\n upsert_user.delay(SUBSCRIBE, {\n 'token': user_data['token'],\n 'lang': data.get('lang', 'en-US'),\n 'newsletters': 'mozilla-foundation',\n 'source_url': data['source_url'],\n })\n\n campaign_member = {\n 'CampaignId': data['campaign_id'],\n 'ContactId': user_data['id'],\n 'Full_URL__c': data['source_url'],\n 'Status': 'Signed',\n }\n comments = data.get('comments')\n if comments:\n campaign_member['Petition_Comments__c'] = comments[:500]\n\n metadata = data.get('metadata')\n if metadata:\n campaign_member['Petition_Flex__c'] = json.dumps(metadata)[:500]\n\n try:\n sfdc.campaign_member.create(campaign_member)\n except sfapi.SalesforceMalformedRequest as e:\n if e.content and e.content[0].get('errorCode') == 'DUPLICATE_VALUE':\n # already in the system, ignore\n pass\n else:\n raise\n\n\ndef upsert_amo_user_data(data):\n \"\"\"\n Update AMO user data in the SFDC contact, or create a contact.\n Return the Contact data (the contact ID at a minimum).\n\n :param data: dict of amo user data\n :return: dict of SFDC contact data\n \"\"\"\n email = data.pop('email')\n amo_id = data.pop('id')\n amo_deleted = data.pop('deleted', False)\n amo_data = {f'amo_{k}': v for k, v in data.items() if v}\n amo_data['amo_user'] = not amo_deleted\n user = get_user_data(amo_id=amo_id, extra_fields=['id', 'amo_id'])\n if user:\n sfdc.update(user, amo_data)\n return user\n\n # include the ID in update or add since we couldn't find\n # the user with this ID above\n amo_data['amo_id'] = amo_id\n user = get_user_data(email=email, extra_fields=['id'])\n if user:\n sfdc.update(user, amo_data)\n # need amo_id for linking addons and authors\n user['amo_id'] = amo_id\n return user\n\n amo_data['email'] = email\n amo_data['source_url'] = 'https://addons.mozilla.org/'\n # returns only the new user ID in a dict, but that will work\n # when passed to e.g. `sfdc.update()`\n user = sfdc.add(amo_data)\n # need amo_id for linking addons and authors\n user['amo_id'] = amo_id\n return user\n\n\ndef amo_compress_categories(categories):\n cats_list = []\n for product, cats in categories.items():\n cats_list.extend([f'{product}-{cat}' for cat in cats])\n\n return ','.join(cats_list)\n\n\n@et_task\ndef amo_sync_addon(data):\n data = deepcopy(data)\n users = [upsert_amo_user_data(author) for author in data['authors']]\n addon_data = {\n 'AMO_Category__c': amo_compress_categories(data['categories']),\n 'AMO_Default_Language__c': data['default_locale'],\n 'AMO_GUID__c': data['guid'],\n 'AMO_Rating__c': data['ratings']['average'],\n 'AMO_Slug__c': data['slug'],\n 'AMO_Status__c': data['status'],\n 'AMO_Type__c': data['type'],\n 'AMO_Update__c': data['last_updated'],\n 'Average_Daily_Users__c': data['average_daily_users'],\n 'Dev_Disabled__c': 'Yes' if data['is_disabled'] else 'No',\n }\n # check for possible None or empty values\n if data['name']:\n addon_data['Name'] = data['name']\n\n # versions can be removed, so they should be removed if they are null\n if data['current_version']:\n addon_data['AMO_Current_Version__c'] = data['current_version']['version']\n else:\n addon_data['AMO_Current_Version__c'] = ''\n\n if data['latest_unlisted_version']:\n addon_data['AMO_Current_Version_Unlisted__c'] = data['latest_unlisted_version']['version']\n else:\n addon_data['AMO_Current_Version_Unlisted__c'] = ''\n\n sfdc.addon.upsert(f'AMO_AddOn_Id__c/{data[\"id\"]}', addon_data)\n addon_record = sfdc.addon.get_by_custom_id('AMO_AddOn_Id__c', data['id'])\n for user in users:\n try:\n sfdc.dev_addon.upsert(f'ConcatenateAMOID__c/{user[\"amo_id\"]}-{data[\"id\"]}', {\n 'AMO_AddOn_ID__c': addon_record['Id'],\n 'AMO_Contact_ID__c': user['id'],\n })\n except sfapi.SalesforceMalformedRequest as e:\n try:\n if e.content[0]['errorCode'] == 'DUPLICATE_VALUE':\n # dupe error, so we don't need to do this again\n pass\n else:\n raise e\n except Exception:\n # if anything else goes wrong just retry\n raise e\n\n\n@et_task\ndef amo_sync_user(data):\n # copy input so it's not modified for retry\n upsert_amo_user_data(data.copy())\n\n\n@celery_app.task()\ndef snitch(start_time=None):\n if start_time is None:\n snitch.delay(time())\n return\n\n snitch_id = settings.SNITCH_ID\n totalms = int((time() - start_time) * 1000)\n statsd.timing('news.tasks.snitch.timing', totalms)\n requests.post('https://nosnch.in/{}'.format(snitch_id), data={\n 'm': totalms,\n })\n","path":"basket/news/tasks.py"}],"string":"[\n {\n \"content\": \"import json\\nimport logging\\nfrom copy import deepcopy\\nfrom datetime import datetime, timedelta\\nfrom email.utils import formatdate\\nfrom functools import wraps\\nfrom hashlib import sha256\\nfrom time import mktime, time\\nfrom urllib.parse import urlencode\\n\\nfrom django.conf import settings\\nfrom django.core.cache import cache, caches\\nfrom django.core.mail import send_mail\\nfrom django.template.loader import render_to_string\\n\\nimport requests\\nimport simple_salesforce as sfapi\\nimport user_agents\\nfrom celery.signals import task_failure, task_retry, task_success\\nfrom django_statsd.clients import statsd\\nfrom raven.contrib.django.raven_compat.models import client as sentry_client\\n\\nfrom basket.base.utils import email_is_testing\\nfrom basket.news.backends.common import NewsletterException\\nfrom basket.news.backends.sfdc import sfdc\\nfrom basket.news.backends.sfmc import sfmc\\nfrom basket.news.celery import app as celery_app\\nfrom basket.news.models import (FailedTask, Newsletter, Interest,\\n QueuedTask, TransactionalEmailMessage)\\nfrom basket.news.newsletters import get_sms_vendor_id, get_transactional_message_ids, newsletter_map\\nfrom basket.news.utils import (cents_to_dollars, generate_token, get_accept_languages, get_best_language,\\n get_user_data, iso_format_unix_timestamp, parse_newsletters, parse_newsletters_csv,\\n SUBSCRIBE, UNSUBSCRIBE, get_best_supported_lang, split_name)\\n\\nlog = logging.getLogger(__name__)\\n\\nBAD_MESSAGE_ID_CACHE = caches['bad_message_ids']\\n\\n# Base message ID for confirmation email\\nCONFIRMATION_MESSAGE = \\\"confirmation_email\\\"\\n\\n# This is prefixed with the 2-letter language code + _ before sending,\\n# e.g. 'en_recovery_message', and '_T' if text, e.g. 'en_recovery_message_T'.\\nRECOVERY_MESSAGE_ID = 'SFDC_Recovery'\\nFXACCOUNT_WELCOME = 'FxAccounts_Welcome'\\n\\n# don't propagate and don't retry if these are the error messages\\nIGNORE_ERROR_MSGS = [\\n 'InvalidEmailAddress',\\n 'An invalid phone number was provided',\\n]\\n# don't propagate after max retries if these are the error messages\\nIGNORE_ERROR_MSGS_POST_RETRY = [\\n 'There are no valid subscribers',\\n]\\n# tasks exempt from maintenance mode queuing\\nMAINTENANCE_EXEMPT = [\\n 'news.tasks.add_sms_user',\\n 'news.tasks.add_sms_user_optin',\\n]\\n\\n\\ndef ignore_error(exc, to_ignore=IGNORE_ERROR_MSGS):\\n msg = str(exc)\\n for ignore_msg in to_ignore:\\n if ignore_msg in msg:\\n return True\\n\\n return False\\n\\n\\ndef ignore_error_post_retry(exc):\\n return ignore_error(exc, IGNORE_ERROR_MSGS_POST_RETRY)\\n\\n\\ndef get_lock(key, prefix='task'):\\n \\\"\\\"\\\"Get a lock for a specific key (usually email address)\\n\\n Needs to be done with a timeout because SFDC needs some time to populate its\\n indexes before the duplicate protection works and queries will return results.\\n Releasing the lock right after the task was run still allowed dupes.\\n\\n Does nothing if you get the lock, and raises RetryTask if not.\\n \\\"\\\"\\\"\\n if not settings.TASK_LOCKING_ENABLE:\\n return\\n\\n lock_key = 'basket-{}-{}'.format(prefix, key)\\n lock_key = sha256(lock_key.encode()).hexdigest()\\n got_lock = cache.add(lock_key, True, settings.TASK_LOCK_TIMEOUT)\\n if not got_lock:\\n statsd.incr('news.tasks.get_lock.no_lock_retry')\\n raise RetryTask('Could not acquire lock')\\n\\n\\nclass BasketError(Exception):\\n \\\"\\\"\\\"Tasks can raise this when an error happens that we should not retry.\\n E.g. if the error indicates we're passing bad parameters.\\n (As opposed to an error connecting to ExactTarget at the moment,\\n where we'd typically raise NewsletterException.)\\n \\\"\\\"\\\"\\n def __init__(self, msg):\\n super(BasketError, self).__init__(msg)\\n\\n\\nclass RetryTask(Exception):\\n \\\"\\\"\\\"an exception to raise within a task if you just want to retry\\\"\\\"\\\"\\n\\n\\n@task_failure.connect\\ndef on_task_failure(sender, task_id, exception, einfo, args, kwargs, **skwargs):\\n statsd.incr(sender.name + '.failure')\\n if not sender.name.endswith('snitch'):\\n statsd.incr('news.tasks.failure_total')\\n if settings.STORE_TASK_FAILURES:\\n FailedTask.objects.create(\\n task_id=task_id,\\n name=sender.name,\\n args=args,\\n kwargs=kwargs,\\n exc=repr(exception),\\n # str() gives more info than repr() on celery.datastructures.ExceptionInfo\\n einfo=str(einfo),\\n )\\n\\n\\n@task_retry.connect\\ndef on_task_retry(sender, **kwargs):\\n statsd.incr(sender.name + '.retry')\\n if not sender.name.endswith('snitch'):\\n statsd.incr('news.tasks.retry_total')\\n\\n\\n@task_success.connect\\ndef on_task_success(sender, **kwargs):\\n statsd.incr(sender.name + '.success')\\n if not sender.name.endswith('snitch'):\\n statsd.incr('news.tasks.success_total')\\n\\n\\ndef et_task(func):\\n \\\"\\\"\\\"Decorator to standardize ET Celery tasks.\\\"\\\"\\\"\\n full_task_name = 'news.tasks.%s' % func.__name__\\n\\n # continue to use old names regardless of new layout\\n @celery_app.task(name=full_task_name,\\n bind=True,\\n default_retry_delay=300, # 5 min\\n max_retries=11)\\n @wraps(func)\\n def wrapped(self, *args, **kwargs):\\n start_time = kwargs.pop('start_time', None)\\n if start_time and not self.request.retries:\\n total_time = int((time() - start_time) * 1000)\\n statsd.timing(self.name + '.timing', total_time)\\n statsd.incr(self.name + '.total')\\n statsd.incr('news.tasks.all_total')\\n if settings.MAINTENANCE_MODE and self.name not in MAINTENANCE_EXEMPT:\\n if not settings.READ_ONLY_MODE:\\n # record task for later\\n QueuedTask.objects.create(\\n name=self.name,\\n args=args,\\n kwargs=kwargs,\\n )\\n statsd.incr(self.name + '.queued')\\n else:\\n statsd.incr(self.name + '.not_queued')\\n\\n return\\n\\n try:\\n return func(*args, **kwargs)\\n except (IOError, NewsletterException, requests.RequestException, RetryTask,\\n sfapi.SalesforceExpiredSession, sfapi.SalesforceGeneralError,\\n sfapi.SalesforceRefusedRequest, sfapi.SalesforceResourceNotFound,\\n sfapi.SalesforceAuthenticationFailed, sfapi.SalesforceMalformedRequest) as e:\\n # These could all be connection issues, so try again later.\\n # IOError covers URLError and SSLError.\\n if ignore_error(e):\\n return\\n\\n try:\\n if not (isinstance(e, RetryTask) or ignore_error_post_retry(e)):\\n sentry_client.captureException(tags={'action': 'retried'})\\n\\n # ~68 hr at 11 retries\\n raise self.retry(countdown=2 ** (self.request.retries + 1) * 60)\\n except self.MaxRetriesExceededError:\\n statsd.incr(self.name + '.retry_max')\\n statsd.incr('news.tasks.retry_max_total')\\n # don't bubble certain errors\\n if ignore_error_post_retry(e):\\n return\\n\\n sentry_client.captureException()\\n\\n return wrapped\\n\\n\\ndef gmttime(basetime=None):\\n if basetime is None:\\n basetime = datetime.now()\\n d = basetime + timedelta(minutes=10)\\n stamp = mktime(d.timetuple())\\n return formatdate(timeval=stamp, localtime=False, usegmt=True)\\n\\n\\ndef fxa_source_url(metrics):\\n source_url = settings.FXA_REGISTER_SOURCE_URL\\n query = {k: v for k, v in metrics.items() if k.startswith('utm_')}\\n if query:\\n source_url = '?'.join((source_url, urlencode(query)))\\n\\n return source_url\\n\\n\\n@et_task\\ndef fxa_email_changed(data):\\n ts = data['ts']\\n fxa_id = data['uid']\\n email = data['email']\\n cache_key = 'fxa_email_changed:%s' % fxa_id\\n prev_ts = float(cache.get(cache_key, 0))\\n if prev_ts and prev_ts > ts:\\n # message older than our last update for this UID\\n return\\n\\n sfmc.upsert_row('FXA_EmailUpdated', {\\n 'FXA_ID': fxa_id,\\n 'NewEmailAddress': email,\\n })\\n cache.set(cache_key, ts, 7200) # 2 hr\\n\\n\\n@et_task\\ndef fxa_delete(data):\\n sfmc.upsert_row('FXA_Deleted', {'FXA_ID': data['uid']})\\n user_data = get_user_data(fxa_id=data['uid'], extra_fields=['id'])\\n if user_data:\\n sfdc.update(user_data, {'fxa_deleted': True})\\n\\n\\n@et_task\\ndef fxa_verified(data):\\n \\\"\\\"\\\"Add new FxA users to an SFMC data extension\\\"\\\"\\\"\\n # used to be handled by the fxa_register view\\n email = data['email']\\n fxa_id = data['uid']\\n create_date = data.get('createDate')\\n if create_date:\\n create_date = datetime.fromtimestamp(create_date)\\n\\n locale = data.get('locale')\\n subscribe = data.get('marketingOptIn')\\n newsletters = data.get('newsletters')\\n metrics = data.get('metricsContext', {})\\n service = data.get('service', '')\\n country = data.get('countryCode', '')\\n\\n if not locale:\\n statsd.incr('fxa_verified.ignored.no_locale')\\n return\\n\\n # if we're not using the sandbox ignore testing domains\\n if email_is_testing(email):\\n return\\n\\n lang = get_best_language(get_accept_languages(locale))\\n if not lang:\\n return\\n\\n _update_fxa_info(email, lang, fxa_id, service, create_date)\\n\\n add_news = None\\n if newsletters:\\n if settings.FXA_REGISTER_NEWSLETTER not in newsletters:\\n newsletters.append(settings.FXA_REGISTER_NEWSLETTER)\\n\\n add_news = ','.join(newsletters)\\n elif subscribe:\\n add_news = settings.FXA_REGISTER_NEWSLETTER\\n\\n if add_news:\\n upsert_user.delay(SUBSCRIBE, {\\n 'email': email,\\n 'lang': lang,\\n 'newsletters': add_news,\\n 'source_url': fxa_source_url(metrics),\\n 'country': country,\\n })\\n else:\\n record_source_url(email, fxa_source_url(metrics), 'fxa-no-optin')\\n\\n\\n@et_task\\ndef fxa_login(data):\\n email = data['email']\\n # if we're not using the sandbox ignore testing domains\\n if email_is_testing(email):\\n return\\n\\n new_data = {\\n 'user_agent': data['userAgent'],\\n 'fxa_id': data['uid'],\\n 'first_device': data['deviceCount'] == 1,\\n 'service': data.get('service', '')\\n }\\n _add_fxa_activity(new_data)\\n\\n metrics = data.get('metricsContext', {})\\n newsletter = settings.FXA_LOGIN_CAMPAIGNS.get(metrics.get('utm_campaign'))\\n if newsletter:\\n upsert_user.delay(SUBSCRIBE, {\\n 'email': email,\\n 'newsletters': newsletter,\\n 'source_url': fxa_source_url(metrics),\\n 'country': data.get('countryCode', ''),\\n })\\n\\n\\ndef _add_fxa_activity(data):\\n user_agent = user_agents.parse(data['user_agent'])\\n device_type = 'D'\\n if user_agent.is_mobile:\\n device_type = 'M'\\n elif user_agent.is_tablet:\\n device_type = 'T'\\n\\n apply_updates('Sync_Device_Logins', {\\n 'FXA_ID': data['fxa_id'],\\n 'SERVICE': data['service'],\\n 'LOGIN_DATE': gmttime(),\\n 'FIRST_DEVICE': 'y' if data.get('first_device') else 'n',\\n 'OS': user_agent.os.family,\\n 'OS_VERSION': user_agent.os.version_string,\\n 'BROWSER': '{0} {1}'.format(user_agent.browser.family,\\n user_agent.browser.version_string),\\n 'DEVICE_NAME': user_agent.device.family,\\n 'DEVICE_TYPE': device_type,\\n })\\n\\n\\ndef _update_fxa_info(email, lang, fxa_id, service, create_date=None):\\n # leaving here because easier to test\\n try:\\n apply_updates('Firefox_Account_ID', {\\n 'EMAIL_ADDRESS_': email,\\n 'CREATED_DATE_': gmttime(create_date),\\n 'FXA_ID': fxa_id,\\n 'FXA_LANGUAGE_ISO2': lang,\\n 'SERVICE': service,\\n })\\n except NewsletterException as e:\\n # don't report these errors to sentry until retries exhausted\\n raise RetryTask(str(e))\\n\\n\\n@et_task\\ndef update_get_involved(interest_id, lang, name, email, country, email_format,\\n subscribe, message, source_url):\\n \\\"\\\"\\\"Send a user contribution information. Should be removed soon.\\\"\\\"\\\"\\n try:\\n interest = Interest.objects.get(interest_id=interest_id)\\n except Interest.DoesNotExist:\\n # invalid request; no need to raise exception and retry\\n return\\n\\n interest.notify_stewards(name, email, lang, message)\\n\\n\\n@et_task\\ndef update_user_meta(token, data):\\n \\\"\\\"\\\"Update a user's metadata, not newsletters\\\"\\\"\\\"\\n sfdc.update({'token': token}, data)\\n\\n\\n@et_task\\ndef upsert_user(api_call_type, data):\\n \\\"\\\"\\\"\\n Update or insert (upsert) a contact record in SFDC\\n\\n @param int api_call_type: What kind of API call it was. Could be\\n SUBSCRIBE, UNSUBSCRIBE, or SET.\\n @param dict data: POST data from the form submission\\n @return:\\n \\\"\\\"\\\"\\n key = data.get('email') or data.get('token')\\n get_lock(key)\\n upsert_contact(api_call_type, data,\\n get_user_data(token=data.get('token'),\\n email=data.get('email'),\\n extra_fields=['id']))\\n\\n\\ndef upsert_contact(api_call_type, data, user_data):\\n \\\"\\\"\\\"\\n Update or insert (upsert) a contact record in SFDC\\n\\n @param int api_call_type: What kind of API call it was. Could be\\n SUBSCRIBE, UNSUBSCRIBE, or SET.\\n @param dict data: POST data from the form submission\\n @param dict user_data: existing contact data from SFDC\\n @return: token, created\\n \\\"\\\"\\\"\\n update_data = data.copy()\\n forced_optin = data.pop('optin', False)\\n if 'format' in data:\\n update_data['format'] = 'T' if data['format'].upper().startswith('T') else 'H'\\n\\n newsletters = parse_newsletters_csv(data.get('newsletters'))\\n\\n if user_data:\\n cur_newsletters = user_data.get('newsletters', None)\\n else:\\n cur_newsletters = None\\n\\n # check for and remove transactional newsletters\\n if api_call_type == SUBSCRIBE:\\n all_transactionals = set(get_transactional_message_ids())\\n newsletters_set = set(newsletters)\\n transactionals = newsletters_set & all_transactionals\\n if transactionals:\\n newsletters = list(newsletters_set - transactionals)\\n send_transactional_messages(update_data, user_data, list(transactionals))\\n if not newsletters:\\n # no regular newsletters\\n return None, None\\n\\n # Set the newsletter flags in the record by comparing to their\\n # current subscriptions.\\n update_data['newsletters'] = parse_newsletters(api_call_type, newsletters, cur_newsletters)\\n\\n if api_call_type != UNSUBSCRIBE:\\n # Are they subscribing to any newsletters that don't require confirmation?\\n # When including any newsletter that does not\\n # require confirmation, user gets a pass on confirming and goes straight\\n # to confirmed.\\n to_subscribe = [nl for nl, sub in update_data['newsletters'].items() if sub]\\n if to_subscribe and not (forced_optin or\\n (user_data and user_data.get('optin'))):\\n exempt_from_confirmation = Newsletter.objects \\\\\\n .filter(slug__in=to_subscribe, requires_double_optin=False) \\\\\\n .exists()\\n if exempt_from_confirmation:\\n update_data['optin'] = True\\n\\n # record source URL\\n nl_map = newsletter_map()\\n source_url = update_data.get('source_url')\\n email = update_data.get('email')\\n if not email:\\n email = user_data.get('email') if user_data else None\\n\\n if email:\\n # send all newsletters whether already subscribed or not\\n # bug 1308971\\n # if api_call_type == SET this is pref center, so only send new subscriptions\\n nl_list = newsletters if api_call_type == SUBSCRIBE else to_subscribe\\n for nlid in nl_list:\\n if nlid in nl_map:\\n record_source_url.delay(email, source_url, nl_map[nlid])\\n\\n if user_data is None:\\n # no user found. create new one.\\n update_data['token'] = generate_token()\\n if settings.MAINTENANCE_MODE:\\n sfdc_add_update.delay(update_data)\\n else:\\n # don't catch exceptions here. SalesforceError subclasses will retry.\\n sfdc.add(update_data)\\n\\n return update_data['token'], True\\n\\n if forced_optin and not user_data.get('optin'):\\n update_data['optin'] = True\\n\\n # they opted out of email before, but are subscribing again\\n # clear the optout flag\\n if api_call_type != UNSUBSCRIBE and user_data.get('optout'):\\n update_data['optout'] = False\\n\\n # update record\\n if user_data and user_data.get('token'):\\n token = user_data['token']\\n else:\\n token = update_data['token'] = generate_token()\\n\\n if settings.MAINTENANCE_MODE:\\n sfdc_add_update.delay(update_data, user_data)\\n else:\\n sfdc.update(user_data, update_data)\\n\\n return token, False\\n\\n\\n@et_task\\ndef sfdc_add_update(update_data, user_data=None):\\n # for use with maintenance mode only\\n # TODO remove after maintenance is over and queue is processed\\n if user_data:\\n sfdc.update(user_data, update_data)\\n else:\\n try:\\n sfdc.add(update_data)\\n except sfapi.SalesforceMalformedRequest as e: # noqa\\n # possibly a duplicate email. try the update below.\\n user_data = get_user_data(email=update_data['email'], extra_fields=['id'])\\n if user_data:\\n # we have a user, delete generated token\\n # and continue with an update\\n update_data.pop('token', None)\\n sfdc.update(user_data, update_data)\\n else:\\n # still no user, try the add one more time\\n sfdc.add(update_data)\\n\\n\\ndef send_transactional_messages(data, user_data, transactionals):\\n email = data['email']\\n lang_code = data.get('lang', 'en')[:2].lower()\\n msgs = TransactionalEmailMessage.objects.filter(message_id__in=transactionals)\\n if user_data and 'id' in user_data:\\n sfdc_id = user_data['id']\\n else:\\n sfdc_id = None\\n\\n for tm in msgs:\\n languages = [lang[:2].lower() for lang in tm.language_list]\\n if lang_code not in languages:\\n # Newsletter does not support their preferred language, so\\n # it doesn't have a welcome in that language either. Settle\\n # for English, same as they'll be getting the newsletter in.\\n lang_code = 'en'\\n\\n msg_id = mogrify_message_id(tm.vendor_id, lang_code, 'H')\\n send_message.delay(msg_id, email, sfdc_id or email)\\n\\n\\ndef apply_updates(database, record):\\n \\\"\\\"\\\"Send the record data to ET to update the database named\\n target_et.\\n\\n :param str database: Target database, e.g. 'Firefox_Account_ID'\\n :param dict record: Data to send\\n \\\"\\\"\\\"\\n sfmc.upsert_row(database, record)\\n\\n\\n@et_task\\ndef send_message(message_id, email, subscriber_key, token=None):\\n \\\"\\\"\\\"\\n Ask ET to send a message.\\n\\n @param str message_id: ID of the message in ET\\n @param str email: email to send it to\\n @param str subscriber_key: id of the email user (email or SFDC id)\\n @param token: optional token when sending recovery\\n\\n @raises: NewsletterException for retryable errors, BasketError for\\n fatal errors.\\n \\\"\\\"\\\"\\n if BAD_MESSAGE_ID_CACHE.get(message_id, False):\\n return\\n\\n try:\\n sfmc.send_mail(message_id, email, subscriber_key, token)\\n statsd.incr('news.tasks.send_message.' + message_id)\\n except NewsletterException as e:\\n # Better error messages for some cases. Also there's no point in\\n # retrying these\\n if 'Invalid Customer Key' in str(e):\\n # remember it's a bad message ID so we don't try again during this process.\\n BAD_MESSAGE_ID_CACHE.set(message_id, True)\\n return\\n # we should retry\\n raise\\n\\n\\ndef mogrify_message_id(message_id, lang, format):\\n \\\"\\\"\\\"Given a bare message ID, a language code, and a format (T or H),\\n return a message ID modified to specify that language and format.\\n\\n E.g. on input ('MESSAGE', 'fr', 'T') it returns 'fr_MESSAGE_T',\\n or on input ('MESSAGE', 'pt', 'H') it returns 'pt_MESSAGE'\\n\\n If `lang` is None or empty, it skips prefixing the language.\\n \\\"\\\"\\\"\\n if lang:\\n result = \\\"%s_%s\\\" % (lang.lower()[:2], message_id)\\n else:\\n result = message_id\\n if format == 'T':\\n result += \\\"_T\\\"\\n return result\\n\\n\\n@et_task\\ndef confirm_user(token):\\n \\\"\\\"\\\"\\n Confirm any pending subscriptions for the user with this token.\\n\\n If any of the subscribed newsletters have welcome messages,\\n send them.\\n\\n :param token: User's token\\n :param user_data: Dictionary with user's data from Exact Target,\\n as returned by get_user_data(), or None if that wasn't available\\n when this was called.\\n :raises: BasketError for fatal errors, NewsletterException for retryable\\n errors.\\n \\\"\\\"\\\"\\n get_lock(token)\\n user_data = get_user_data(token=token)\\n\\n if user_data is None:\\n statsd.incr('news.tasks.confirm_user.confirm_user_not_found')\\n return\\n\\n if user_data['optin']:\\n # already confirmed\\n return\\n\\n if not ('email' in user_data and user_data['email']):\\n raise BasketError('token has no email in ET')\\n\\n sfdc.update(user_data, {'optin': True})\\n\\n\\n@et_task\\ndef add_sms_user(send_name, mobile_number, optin, vendor_id=None):\\n # Adding vendor_id as optional to avoid issues with deployment.\\n # Old tasks with the old sitnature will be on the queue when this is first deployed.\\n # TODO change the task signature to replace send_name with vendor_id\\n if not vendor_id:\\n vendor_id = get_sms_vendor_id(send_name)\\n if not vendor_id:\\n return\\n\\n sfmc.send_sms(mobile_number, vendor_id)\\n if optin:\\n add_sms_user_optin.delay(mobile_number)\\n\\n\\n@et_task\\ndef add_sms_user_optin(mobile_number):\\n record = {'Phone': mobile_number, 'SubscriberKey': mobile_number}\\n sfmc.add_row('Mobile_Subscribers', record)\\n\\n\\n@et_task\\ndef update_custom_unsub(token, reason):\\n \\\"\\\"\\\"Record a user's custom unsubscribe reason.\\\"\\\"\\\"\\n get_lock(token)\\n try:\\n sfdc.update({'token': token}, {'reason': reason})\\n except sfapi.SalesforceMalformedRequest:\\n # likely the record can't be found. nothing to do.\\n pass\\n\\n\\n@et_task\\ndef send_recovery_message_task(email):\\n user_data = get_user_data(email=email, extra_fields=['id'])\\n if not user_data:\\n log.debug(\\\"In send_recovery_message_task, email not known: %s\\\" % email)\\n return\\n\\n # make sure we have a language and format, no matter what ET returned\\n lang = user_data.get('lang', 'en') or 'en'\\n format = user_data.get('format', 'H') or 'H'\\n\\n if lang not in settings.RECOVER_MSG_LANGS:\\n lang = 'en'\\n\\n message_id = mogrify_message_id(RECOVERY_MESSAGE_ID, lang, format)\\n send_message.delay(message_id, email, user_data['id'], token=user_data['token'])\\n\\n\\n@et_task\\ndef record_common_voice_goals(data):\\n # do not change the sent data in place. A retry will use the changed data.\\n dcopy = data.copy()\\n email = dcopy.pop('email')\\n user_data = get_user_data(email=email, extra_fields=['id'])\\n new_data = {\\n 'source_url': 'https://voice.mozilla.org',\\n 'newsletters': [settings.COMMON_VOICE_NEWSLETTER],\\n }\\n for k, v in dcopy.items():\\n new_data['cv_' + k] = v\\n\\n if user_data:\\n sfdc.update(user_data, new_data)\\n else:\\n new_data.update({\\n 'email': email,\\n 'token': generate_token(),\\n })\\n sfdc.add(new_data)\\n\\n\\n@et_task\\ndef record_fxa_concerts_rsvp(email, is_firefox, campaign_id):\\n sfmc.add_row('FxAccounts_Concert_RSVP', {\\n 'Email': email,\\n 'Firefox': is_firefox,\\n 'Campaign_ID': campaign_id,\\n 'RSVP_Time': gmttime(),\\n })\\n\\n\\n@et_task\\ndef record_source_url(email, source_url, newsletter_id):\\n if not source_url:\\n source_url = '__NONE__'\\n else:\\n source_url = source_url[:1000]\\n\\n sfmc.add_row('NEWSLETTER_SOURCE_URLS', {\\n 'Email': email,\\n 'Signup_Source_URL__c': source_url,\\n 'Newsletter_Field_Name': newsletter_id,\\n 'Newsletter_Date': gmttime(),\\n })\\n\\n\\n@et_task\\ndef process_subhub_event_customer_created(data):\\n \\\"\\\"\\\"\\n Event name: customer.created\\n\\n Creates or updates a SFDC customer when a new payment processor/Stripe\\n customer is created\\n \\\"\\\"\\\"\\n statsd.incr('news.tasks.process_subhub_event.customer_created')\\n\\n first, last = split_name(data['name'])\\n contact_data = {\\n 'fxa_id': data['user_id'],\\n 'payee_id': data['customer_id']\\n }\\n\\n user_data = get_user_data(email=data['email'])\\n\\n # if user was found in sfdc, see if we should update their name(s)\\n if user_data:\\n # if current last name is '_', update it\\n if user_data['last_name'] == '_':\\n contact_data['last_name'] = last\\n\\n # if current last name is blank/Null, update it\\n if not user_data['first_name']:\\n contact_data['first_name'] = first\\n\\n sfdc.update(user_data, contact_data)\\n statsd.incr('news.tasks.process_subhub_event.customer_created.updated')\\n # if no user was found, create new user in sfdc\\n else:\\n contact_data['email'] = data['email']\\n contact_data['first_name'] = first\\n contact_data['last_name'] = last\\n\\n # create the user in sfdc\\n statsd.incr('news.tasks.process_subhub_event.customer_created.created')\\n sfdc.add(contact_data)\\n\\n\\n@et_task\\ndef process_subhub_event_subscription_charge(data):\\n \\\"\\\"\\\"\\n Event names: customer.subscription.created, customer.recurring_charge\\n\\n This method handles both new and recurring charges.\\n\\n Each of the handled events contains the same payload data. The only variation below\\n is in regards to Initial_Purchase__c, which will be True for the\\n `customer.subscription.created` event, and False for the `customer.recurring_charge`\\n event.\\n \\\"\\\"\\\"\\n\\n statsd.incr('news.tasks.process_subhub_event.subscription_charge')\\n user_data = get_user_data(payee_id=data['customer_id'],\\n extra_fields=['id'])\\n if not user_data:\\n statsd.incr('news.tasks.process_subhub_event.subscription_charge.user_not_found')\\n raise RetryTask('Could not find user. Try again.')\\n\\n nickname = data['nickname']\\n if isinstance(nickname, list):\\n nickname = nickname[0]\\n\\n # if a customer re-instates service after a cancellation, the record needs to be updated\\n oppy_data = {\\n 'Amount': cents_to_dollars(data['plan_amount']),\\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\\n 'Billing_Cycle_Start__c': iso_format_unix_timestamp(data['current_period_start']),\\n 'CloseDate': iso_format_unix_timestamp(data['created']),\\n 'Credit_Card_Type__c': data['brand'],\\n 'currency__c': data['currency'],\\n 'Donation_Contact__c': user_data['id'],\\n 'Event_Id__c': data['event_id'],\\n 'Event_Name__c': data['event_type'],\\n 'Initial_Purchase__c': data['event_type'] == 'customer.subscription.created',\\n 'Invoice_Number__c': data['invoice_number'],\\n 'Last_4_Digits__c': data['last4'],\\n 'Name': 'Subscription Services',\\n 'Next_Invoice_Date__c': iso_format_unix_timestamp(data['next_invoice_date']),\\n 'Payment_Source__c': 'Stripe',\\n 'PMT_Subscription_ID__c': data['subscription_id'],\\n 'PMT_Transaction_ID__c': data['charge'],\\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\\n 'Service_Plan__c': nickname,\\n 'StageName': 'Closed Won',\\n }\\n if 'proration_amount' in data:\\n oppy_data['Proration_Amount__c'] = cents_to_dollars(data['proration_amount'])\\n\\n if 'total_amount' in data:\\n oppy_data['Total_Amount__c'] = cents_to_dollars(data['total_amount'])\\n\\n sfdc.opportunity.upsert(f'PMT_Invoice_ID__c/{data[\\\"invoice_id\\\"]}', oppy_data)\\n\\n\\n@et_task\\ndef process_subhub_event_subscription_reactivated(data):\\n statsd.incr('news.tasks.process_subhub_event.subscription_reactivated')\\n user_data = get_user_data(payee_id=data['customer_id'],\\n extra_fields=['id'])\\n if not user_data:\\n statsd.incr('news.tasks.process_subhub_event.subscription_reactivated.user_not_found')\\n raise RetryTask('Could not find user. Try again.')\\n\\n nickname = data['nickname']\\n if isinstance(nickname, list):\\n nickname = nickname[0]\\n\\n sfdc.opportunity.create({\\n 'Amount': cents_to_dollars(data['plan_amount']),\\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\\n 'CloseDate': iso_format_unix_timestamp(data.get('close_date', time())),\\n 'Credit_Card_Type__c': data['brand'],\\n 'Last_4_Digits__c': data['last4'],\\n 'Donation_Contact__c': user_data['id'],\\n 'Event_Id__c': data['event_id'],\\n 'Event_Name__c': data['event_type'],\\n 'Name': 'Subscription Services',\\n 'Payment_Source__c': 'Stripe',\\n 'PMT_Subscription_ID__c': data['subscription_id'],\\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\\n 'Service_Plan__c': nickname,\\n 'StageName': 'Reactivation',\\n })\\n\\n\\n@et_task\\ndef process_subhub_event_subscription_updated(data):\\n statsd.incr('news.tasks.process_subhub_event.subscription_updated')\\n user_data = get_user_data(payee_id=data['customer_id'],\\n extra_fields=['id'])\\n if not user_data:\\n statsd.incr('news.tasks.process_subhub_event.subscription_updated.user_not_found')\\n raise RetryTask('Could not find user. Try again.')\\n\\n direction = 'Down' if data['event_type'].endswith('downgrade') else 'Up'\\n stage_name = f'Subscription {direction}grade'\\n sfdc.opportunity.create({\\n 'Amount': cents_to_dollars(data['plan_amount_new']),\\n 'Plan_Amount_Old__c': cents_to_dollars(data['plan_amount_old']),\\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\\n 'CloseDate': iso_format_unix_timestamp(data.get('close_date', time())),\\n 'Donation_Contact__c': user_data['id'],\\n 'Event_Id__c': data['event_id'],\\n 'Event_Name__c': data['event_type'],\\n 'Invoice_Number__c': data['invoice_number'],\\n 'Name': 'Subscription Services',\\n 'Payment_Interval__c': data['interval'],\\n 'Payment_Source__c': 'Stripe',\\n 'PMT_Invoice_ID__c': data['invoice_id'],\\n 'PMT_Subscription_ID__c': data['subscription_id'],\\n 'Proration_Amount__c': data['proration_amount'],\\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\\n 'Service_Plan__c': data['nickname_new'],\\n 'Nickname_Old__c': data['nickname_old'],\\n 'StageName': stage_name,\\n })\\n\\n\\nSUB_STAGE_NAMES = {\\n 'customer.subscription_cancelled': 'Subscription Canceled',\\n 'customer.deleted': 'Account Deleted',\\n}\\n\\n\\n@et_task\\ndef process_subhub_event_subscription_cancel(data):\\n \\\"\\\"\\\"\\n Event name: customer.subscription_cancelled or customer.deleted\\n \\\"\\\"\\\"\\n statsd.incr('news.tasks.process_subhub_event.subscription_cancel')\\n user_data = get_user_data(payee_id=data['customer_id'],\\n extra_fields=['id'])\\n if not user_data:\\n statsd.incr('news.tasks.process_subhub_event_subscription_cancel.user_not_found')\\n raise RetryTask('Could not find user. Try again.')\\n\\n nickname = data['nickname']\\n if isinstance(nickname, list):\\n nickname = nickname[0]\\n\\n sfdc.opportunity.create({\\n 'Amount': cents_to_dollars(data['plan_amount']),\\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\\n 'Billing_Cycle_Start__c': iso_format_unix_timestamp(data['current_period_start']),\\n 'CloseDate': iso_format_unix_timestamp(data.get('cancel_at', time())),\\n 'Donation_Contact__c': user_data['id'],\\n 'Event_Id__c': data['event_id'],\\n 'Event_Name__c': data['event_type'],\\n 'Name': 'Subscription Services',\\n 'Payment_Source__c': 'Stripe',\\n 'PMT_Subscription_ID__c': data['subscription_id'],\\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\\n 'Service_Plan__c': nickname,\\n 'StageName': SUB_STAGE_NAMES[data['event_type']],\\n })\\n\\n if data['event_type'] == 'customer.deleted':\\n sfdc.update(user_data, {'fxa_deleted': True})\\n\\n\\n@et_task\\ndef process_subhub_event_credit_card_expiring(data):\\n \\\"\\\"\\\"\\n Event name: customer.source.expiring\\n \\\"\\\"\\\"\\n statsd.incr('news.tasks.process_subhub_event.credit_card_expiring')\\n sfmc.send_mail(settings.SUBHUB_CC_EXPIRE_TRIGGER, data['email'], data['email'])\\n\\n\\n@et_task\\ndef process_subhub_event_payment_failed(data):\\n \\\"\\\"\\\"\\n Event name: invoice.payment_failed\\n \\\"\\\"\\\"\\n statsd.incr('news.tasks.process_subhub_event.payment_failed')\\n\\n user_data = get_user_data(payee_id=data['customer_id'],\\n extra_fields=['id'])\\n # the only user identifiable information available is the payment\\n # processor/Stripe ID, so if the user wasn't found by that, there's really\\n # nothing to be done here but retry.\\n if not user_data:\\n statsd.incr('news.tasks.process_subhub_event.payment_failed.user_not_found')\\n raise RetryTask('Could not find user. Try again.')\\n\\n nickname = data['nickname']\\n if isinstance(nickname, list):\\n nickname = nickname[0]\\n\\n sfdc.opportunity.create({\\n 'Amount': cents_to_dollars(data['amount_due']),\\n 'CloseDate': iso_format_unix_timestamp(data['created']),\\n 'Donation_Contact__c': user_data['id'],\\n 'Event_Id__c': data['event_id'],\\n 'Event_Name__c': data['event_type'],\\n 'Name': 'Subscription Services',\\n 'PMT_Subscription_ID__c': data['subscription_id'],\\n 'PMT_Transaction_ID__c': data['charge_id'],\\n 'Payment_Source__c': 'Stripe',\\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\\n 'Service_Plan__c': nickname,\\n 'StageName': 'Payment Failed',\\n 'currency__c': data['currency'],\\n })\\n\\n\\n@et_task\\ndef process_donation_event(data):\\n \\\"\\\"\\\"Process a followup event on a donation\\\"\\\"\\\"\\n etype = data['event_type']\\n txn_id = data['transaction_id']\\n status = data.get('status')\\n statsd.incr('news.tasks.process_donation_event.{}'.format(etype))\\n if status:\\n statsd.incr('news.tasks.process_donation_event.{}.{}'.format(etype, status))\\n\\n if etype.startswith('charge.dispute.'):\\n if status not in ['charge_refunded', 'won', 'lost']:\\n # only care about the above statuses\\n statsd.incr('news.tasks.process_donation_event.{}.IGNORED'.format(etype))\\n return\\n elif etype == 'charge.refunded':\\n if status not in ['succeeded', 'failed', 'cancelled']:\\n # don't care about pending statuses\\n statsd.incr('news.tasks.process_donation_event.{}.IGNORED'.format(etype))\\n return\\n\\n if 'reason' in data:\\n reason_lost = data['reason']\\n else:\\n reason_lost = data['failure_code']\\n\\n try:\\n # will raise a SalesforceMalformedRequest if not found\\n sfdc.opportunity.update('PMT_Transaction_ID__c/{}'.format(txn_id), {\\n 'PMT_Type_Lost__c': etype,\\n 'PMT_Reason_Lost__c': reason_lost,\\n 'StageName': 'Closed Lost',\\n })\\n except sfapi.SalesforceMalformedRequest as e:\\n # we don't know about this tx_id. Let someone know.\\n do_notify = cache.add('donate-notify-{}'.format(txn_id), 1, 86400)\\n if do_notify and settings.DONATE_UPDATE_FAIL_DE:\\n sfmc.add_row(settings.DONATE_UPDATE_FAIL_DE, {\\n 'PMT_Transaction_ID__c': txn_id,\\n 'Payment_Type__c': etype,\\n 'PMT_Reason_Lost__c': reason_lost,\\n 'Error_Text': str(e)[:4000],\\n 'Date': gmttime(),\\n })\\n\\n if do_notify and settings.DONATE_NOTIFY_EMAIL:\\n # don't notify about a transaction more than once per day\\n first_mail = cache.add('donate-notify-{}'.format(txn_id), 1, 86400)\\n if first_mail:\\n body = render_to_string('news/donation_notify_email.txt', {\\n 'txn_id': txn_id,\\n 'type_lost': etype,\\n 'reason_lost': reason_lost,\\n 'server_name': settings.STATSD_PREFIX,\\n })\\n send_mail('Donation Record Not Found', body,\\n 'noreply@mozilla.com', [settings.DONATE_NOTIFY_EMAIL])\\n\\n # retry\\n raise\\n\\n\\n# all strings and truncated at 2000 chars\\nDONATION_OPTIONAL_FIELDS = {\\n 'SourceURL__c': 'source_url',\\n 'Donation_Form_URL__c': 'donation_url',\\n 'Project__c': 'project',\\n 'PMT_Subscription_ID__c': 'subscription_id',\\n}\\n# Add these fields as optional for now as some messages\\n# could still come through without them. Mix of string\\n# and numerical data.\\nDONATION_NEW_FIELDS = {\\n 'Donation_Locale__c': 'locale',\\n 'Processors_Fee__c': 'transaction_fee',\\n 'Net_Amount__c': 'net_amount',\\n 'Conversion_Amount__c': 'conversion_amount',\\n 'Last_4_Digits__c': 'last_4',\\n}\\n\\n\\n@et_task\\ndef process_donation(data):\\n get_lock(data['email'])\\n # tells the backend to leave the \\\"subscriber\\\" flag alone\\n contact_data = {'_set_subscriber': False}\\n # do \\\"or ''\\\" because data can contain None values\\n first_name = (data.get('first_name') or '').strip()\\n last_name = (data.get('last_name') or '').strip()\\n if first_name and last_name:\\n contact_data['first_name'] = first_name\\n contact_data['last_name'] = last_name\\n elif first_name:\\n contact_data['first_name'] = first_name\\n elif last_name:\\n names = data['last_name'].rsplit(None, 1)\\n if len(names) == 2:\\n first, last = names\\n else:\\n first, last = '', names[0]\\n if first:\\n contact_data['first_name'] = first\\n if last:\\n contact_data['last_name'] = last\\n\\n user_data = get_user_data(email=data['email'],\\n extra_fields=['id'])\\n if user_data:\\n if contact_data and (\\n ('first_name' in contact_data and contact_data['first_name'] != user_data['first_name']) or\\n ('last_name' in contact_data and contact_data['last_name'] != user_data['last_name'])):\\n sfdc.update(user_data, contact_data)\\n else:\\n contact_data['token'] = generate_token()\\n contact_data['email'] = data['email']\\n contact_data['record_type'] = settings.DONATE_CONTACT_RECORD_TYPE\\n\\n # returns a dict with the new ID but no other user data, but that's enough here\\n user_data = sfdc.add(contact_data)\\n if not user_data.get('id'):\\n # retry here to make sure we associate the donation data with the proper account\\n raise RetryTask('User not yet available')\\n\\n # add opportunity\\n donation = {\\n 'RecordTypeId': settings.DONATE_OPP_RECORD_TYPE,\\n 'Name': 'Foundation Donation',\\n 'Donation_Contact__c': user_data['id'],\\n 'StageName': 'Closed Won',\\n 'Amount': float(data['donation_amount']),\\n 'Currency__c': data['currency'].upper(),\\n 'Payment_Source__c': data['service'],\\n 'PMT_Transaction_ID__c': data['transaction_id'],\\n 'Payment_Type__c': 'Recurring' if data['recurring'] else 'One-Time',\\n }\\n # this is a unix timestamp in ms since epoc\\n timestamp = data.get('created')\\n if timestamp:\\n donation['CloseDate'] = iso_format_unix_timestamp(timestamp)\\n\\n for dest_name, source_name in DONATION_NEW_FIELDS.items():\\n if source_name in data:\\n donation[dest_name] = data[source_name]\\n\\n for dest_name, source_name in DONATION_OPTIONAL_FIELDS.items():\\n if data.get(source_name):\\n # truncate at 2000 chars as that's the max for\\n # a SFDC text field. We may do more granular\\n # truncation per field in future.\\n donation[dest_name] = data[source_name][:2000]\\n\\n try:\\n sfdc.opportunity.create(donation)\\n except sfapi.SalesforceMalformedRequest as e:\\n if e.content and e.content[0].get('errorCode') == 'DUPLICATE_VALUE':\\n # already in the system, ignore\\n pass\\n else:\\n raise\\n\\n\\n@et_task\\ndef process_newsletter_subscribe(data):\\n data = data['form']\\n data['lang'] = get_best_supported_lang(data['lang'])\\n upsert_user(SUBSCRIBE, data)\\n\\n\\nPETITION_CONTACT_FIELDS = [\\n 'first_name',\\n 'last_name',\\n 'country',\\n 'postal_code',\\n 'source_url',\\n]\\n\\n\\n@et_task\\ndef process_petition_signature(data):\\n \\\"\\\"\\\"\\n Add petition signature to SFDC\\n \\\"\\\"\\\"\\n data = data['form']\\n get_lock(data['email'])\\n # tells the backend to leave the \\\"subscriber\\\" flag alone\\n contact_data = {'_set_subscriber': False}\\n contact_data.update({k: data[k] for k in PETITION_CONTACT_FIELDS if data.get(k)})\\n\\n user_data = get_user_data(email=data['email'],\\n extra_fields=['id'])\\n if user_data:\\n sfdc.update(user_data, contact_data)\\n else:\\n contact_data['token'] = generate_token()\\n contact_data['email'] = data['email']\\n contact_data['record_type'] = settings.DONATE_CONTACT_RECORD_TYPE\\n sfdc.add(contact_data)\\n # fetch again to get ID\\n user_data = get_user_data(email=data.get('email'),\\n extra_fields=['id'])\\n if not user_data:\\n # retry here to make sure we associate the donation data with the proper account\\n raise RetryTask('User not yet available')\\n\\n if data.get('email_subscription', False):\\n upsert_user.delay(SUBSCRIBE, {\\n 'token': user_data['token'],\\n 'lang': data.get('lang', 'en-US'),\\n 'newsletters': 'mozilla-foundation',\\n 'source_url': data['source_url'],\\n })\\n\\n campaign_member = {\\n 'CampaignId': data['campaign_id'],\\n 'ContactId': user_data['id'],\\n 'Full_URL__c': data['source_url'],\\n 'Status': 'Signed',\\n }\\n comments = data.get('comments')\\n if comments:\\n campaign_member['Petition_Comments__c'] = comments[:500]\\n\\n metadata = data.get('metadata')\\n if metadata:\\n campaign_member['Petition_Flex__c'] = json.dumps(metadata)[:500]\\n\\n try:\\n sfdc.campaign_member.create(campaign_member)\\n except sfapi.SalesforceMalformedRequest as e:\\n if e.content and e.content[0].get('errorCode') == 'DUPLICATE_VALUE':\\n # already in the system, ignore\\n pass\\n else:\\n raise\\n\\n\\ndef upsert_amo_user_data(data):\\n \\\"\\\"\\\"\\n Update AMO user data in the SFDC contact, or create a contact.\\n Return the Contact data (the contact ID at a minimum).\\n\\n :param data: dict of amo user data\\n :return: dict of SFDC contact data\\n \\\"\\\"\\\"\\n email = data.pop('email')\\n amo_id = data.pop('id')\\n amo_deleted = data.pop('deleted', False)\\n amo_data = {f'amo_{k}': v for k, v in data.items() if v}\\n amo_data['amo_user'] = not amo_deleted\\n user = get_user_data(amo_id=amo_id, extra_fields=['id', 'amo_id'])\\n if user:\\n sfdc.update(user, amo_data)\\n return user\\n\\n # include the ID in update or add since we couldn't find\\n # the user with this ID above\\n amo_data['amo_id'] = amo_id\\n user = get_user_data(email=email, extra_fields=['id'])\\n if user:\\n sfdc.update(user, amo_data)\\n # need amo_id for linking addons and authors\\n user['amo_id'] = amo_id\\n return user\\n\\n amo_data['email'] = email\\n amo_data['source_url'] = 'https://addons.mozilla.org/'\\n # returns only the new user ID in a dict, but that will work\\n # when passed to e.g. `sfdc.update()`\\n user = sfdc.add(amo_data)\\n # need amo_id for linking addons and authors\\n user['amo_id'] = amo_id\\n return user\\n\\n\\ndef amo_compress_categories(categories):\\n cats_list = []\\n for product, cats in categories.items():\\n cats_list.extend([f'{product}-{cat}' for cat in cats])\\n\\n return ','.join(cats_list)\\n\\n\\n@et_task\\ndef amo_sync_addon(data):\\n data = deepcopy(data)\\n users = [upsert_amo_user_data(author) for author in data['authors']]\\n addon_data = {\\n 'AMO_Category__c': amo_compress_categories(data['categories']),\\n 'AMO_Default_Language__c': data['default_locale'],\\n 'AMO_GUID__c': data['guid'],\\n 'AMO_Rating__c': data['ratings']['average'],\\n 'AMO_Slug__c': data['slug'],\\n 'AMO_Status__c': data['status'],\\n 'AMO_Type__c': data['type'],\\n 'AMO_Update__c': data['last_updated'],\\n 'Average_Daily_Users__c': data['average_daily_users'],\\n 'Dev_Disabled__c': 'Yes' if data['is_disabled'] else 'No',\\n }\\n # check for possible None or empty values\\n if data['name']:\\n addon_data['Name'] = data['name']\\n\\n # versions can be removed, so they should be removed if they are null\\n if data['current_version']:\\n addon_data['AMO_Current_Version__c'] = data['current_version']['version']\\n else:\\n addon_data['AMO_Current_Version__c'] = ''\\n\\n if data['latest_unlisted_version']:\\n addon_data['AMO_Current_Version_Unlisted__c'] = data['latest_unlisted_version']['version']\\n else:\\n addon_data['AMO_Current_Version_Unlisted__c'] = ''\\n\\n sfdc.addon.upsert(f'AMO_AddOn_Id__c/{data[\\\"id\\\"]}', addon_data)\\n addon_record = sfdc.addon.get_by_custom_id('AMO_AddOn_Id__c', data['id'])\\n for user in users:\\n try:\\n sfdc.dev_addon.upsert(f'ConcatenateAMOID__c/{user[\\\"amo_id\\\"]}-{data[\\\"id\\\"]}', {\\n 'AMO_AddOn_ID__c': addon_record['Id'],\\n 'AMO_Contact_ID__c': user['id'],\\n })\\n except sfapi.SalesforceMalformedRequest as e:\\n try:\\n if e.content[0]['errorCode'] == 'DUPLICATE_VALUE':\\n # dupe error, so we don't need to do this again\\n pass\\n else:\\n raise e\\n except Exception:\\n # if anything else goes wrong just retry\\n raise e\\n\\n\\n@et_task\\ndef amo_sync_user(data):\\n # copy input so it's not modified for retry\\n upsert_amo_user_data(data.copy())\\n\\n\\n@celery_app.task()\\ndef snitch(start_time=None):\\n if start_time is None:\\n snitch.delay(time())\\n return\\n\\n snitch_id = settings.SNITCH_ID\\n totalms = int((time() - start_time) * 1000)\\n statsd.timing('news.tasks.snitch.timing', totalms)\\n requests.post('https://nosnch.in/{}'.format(snitch_id), data={\\n 'm': totalms,\\n })\\n\",\n \"path\": \"basket/news/tasks.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import json\nimport logging\nfrom copy import deepcopy\nfrom datetime import datetime, timedelta\nfrom email.utils import formatdate\nfrom functools import wraps\nfrom hashlib import sha256\nfrom time import mktime, time\nfrom urllib.parse import urlencode\n\nfrom django.conf import settings\nfrom django.core.cache import cache, caches\nfrom django.core.mail import send_mail\nfrom django.template.loader import render_to_string\n\nimport requests\nimport simple_salesforce as sfapi\nimport user_agents\nfrom celery.signals import task_failure, task_retry, task_success\nfrom django_statsd.clients import statsd\nfrom raven.contrib.django.raven_compat.models import client as sentry_client\n\nfrom basket.base.utils import email_is_testing\nfrom basket.news.backends.common import NewsletterException\nfrom basket.news.backends.sfdc import sfdc\nfrom basket.news.backends.sfmc import sfmc\nfrom basket.news.celery import app as celery_app\nfrom basket.news.models import (FailedTask, Newsletter, Interest,\n QueuedTask, TransactionalEmailMessage)\nfrom basket.news.newsletters import get_sms_vendor_id, get_transactional_message_ids, newsletter_map\nfrom basket.news.utils import (cents_to_dollars, generate_token, get_accept_languages, get_best_language,\n get_user_data, iso_format_unix_timestamp, parse_newsletters, parse_newsletters_csv,\n SUBSCRIBE, UNSUBSCRIBE, get_best_supported_lang, split_name)\n\nlog = logging.getLogger(__name__)\n\nBAD_MESSAGE_ID_CACHE = caches['bad_message_ids']\n\n# Base message ID for confirmation email\nCONFIRMATION_MESSAGE = \"confirmation_email\"\n\n# This is prefixed with the 2-letter language code + _ before sending,\n# e.g. 'en_recovery_message', and '_T' if text, e.g. 'en_recovery_message_T'.\nRECOVERY_MESSAGE_ID = 'SFDC_Recovery'\nFXACCOUNT_WELCOME = 'FxAccounts_Welcome'\n\n# don't propagate and don't retry if these are the error messages\nIGNORE_ERROR_MSGS = [\n 'InvalidEmailAddress',\n 'An invalid phone number was provided',\n]\n# don't propagate after max retries if these are the error messages\nIGNORE_ERROR_MSGS_POST_RETRY = [\n 'There are no valid subscribers',\n]\n# tasks exempt from maintenance mode queuing\nMAINTENANCE_EXEMPT = [\n 'news.tasks.add_sms_user',\n 'news.tasks.add_sms_user_optin',\n]\n\n\ndef ignore_error(exc, to_ignore=IGNORE_ERROR_MSGS):\n msg = str(exc)\n for ignore_msg in to_ignore:\n if ignore_msg in msg:\n return True\n\n return False\n\n\ndef ignore_error_post_retry(exc):\n return ignore_error(exc, IGNORE_ERROR_MSGS_POST_RETRY)\n\n\ndef get_lock(key, prefix='task'):\n \"\"\"Get a lock for a specific key (usually email address)\n\n Needs to be done with a timeout because SFDC needs some time to populate its\n indexes before the duplicate protection works and queries will return results.\n Releasing the lock right after the task was run still allowed dupes.\n\n Does nothing if you get the lock, and raises RetryTask if not.\n \"\"\"\n if not settings.TASK_LOCKING_ENABLE:\n return\n\n lock_key = 'basket-{}-{}'.format(prefix, key)\n lock_key = sha256(lock_key.encode()).hexdigest()\n got_lock = cache.add(lock_key, True, settings.TASK_LOCK_TIMEOUT)\n if not got_lock:\n statsd.incr('news.tasks.get_lock.no_lock_retry')\n raise RetryTask('Could not acquire lock')\n\n\nclass BasketError(Exception):\n \"\"\"Tasks can raise this when an error happens that we should not retry.\n E.g. if the error indicates we're passing bad parameters.\n (As opposed to an error connecting to ExactTarget at the moment,\n where we'd typically raise NewsletterException.)\n \"\"\"\n def __init__(self, msg):\n super(BasketError, self).__init__(msg)\n\n\nclass RetryTask(Exception):\n \"\"\"an exception to raise within a task if you just want to retry\"\"\"\n\n\n@task_failure.connect\ndef on_task_failure(sender, task_id, exception, einfo, args, kwargs, **skwargs):\n statsd.incr(sender.name + '.failure')\n if not sender.name.endswith('snitch'):\n statsd.incr('news.tasks.failure_total')\n if settings.STORE_TASK_FAILURES:\n FailedTask.objects.create(\n task_id=task_id,\n name=sender.name,\n args=args,\n kwargs=kwargs,\n exc=repr(exception),\n # str() gives more info than repr() on celery.datastructures.ExceptionInfo\n einfo=str(einfo),\n )\n\n\n@task_retry.connect\ndef on_task_retry(sender, **kwargs):\n statsd.incr(sender.name + '.retry')\n if not sender.name.endswith('snitch'):\n statsd.incr('news.tasks.retry_total')\n\n\n@task_success.connect\ndef on_task_success(sender, **kwargs):\n statsd.incr(sender.name + '.success')\n if not sender.name.endswith('snitch'):\n statsd.incr('news.tasks.success_total')\n\n\ndef et_task(func):\n \"\"\"Decorator to standardize ET Celery tasks.\"\"\"\n full_task_name = 'news.tasks.%s' % func.__name__\n\n # continue to use old names regardless of new layout\n @celery_app.task(name=full_task_name,\n bind=True,\n default_retry_delay=300, # 5 min\n max_retries=11)\n @wraps(func)\n def wrapped(self, *args, **kwargs):\n start_time = kwargs.pop('start_time', None)\n if start_time and not self.request.retries:\n total_time = int((time() - start_time) * 1000)\n statsd.timing(self.name + '.timing', total_time)\n statsd.incr(self.name + '.total')\n statsd.incr('news.tasks.all_total')\n if settings.MAINTENANCE_MODE and self.name not in MAINTENANCE_EXEMPT:\n if not settings.READ_ONLY_MODE:\n # record task for later\n QueuedTask.objects.create(\n name=self.name,\n args=args,\n kwargs=kwargs,\n )\n statsd.incr(self.name + '.queued')\n else:\n statsd.incr(self.name + '.not_queued')\n\n return\n\n try:\n return func(*args, **kwargs)\n except (IOError, NewsletterException, requests.RequestException, RetryTask,\n sfapi.SalesforceExpiredSession, sfapi.SalesforceGeneralError,\n sfapi.SalesforceRefusedRequest, sfapi.SalesforceResourceNotFound,\n sfapi.SalesforceAuthenticationFailed, sfapi.SalesforceMalformedRequest) as e:\n # These could all be connection issues, so try again later.\n # IOError covers URLError and SSLError.\n if ignore_error(e):\n return\n\n try:\n if not (isinstance(e, RetryTask) or ignore_error_post_retry(e)):\n sentry_client.captureException(tags={'action': 'retried'})\n\n # ~68 hr at 11 retries\n raise self.retry(countdown=2 ** (self.request.retries + 1) * 60)\n except self.MaxRetriesExceededError:\n statsd.incr(self.name + '.retry_max')\n statsd.incr('news.tasks.retry_max_total')\n # don't bubble certain errors\n if ignore_error_post_retry(e):\n return\n\n sentry_client.captureException()\n\n return wrapped\n\n\ndef gmttime(basetime=None):\n if basetime is None:\n basetime = datetime.now()\n d = basetime + timedelta(minutes=10)\n stamp = mktime(d.timetuple())\n return formatdate(timeval=stamp, localtime=False, usegmt=True)\n\n\ndef fxa_source_url(metrics):\n source_url = settings.FXA_REGISTER_SOURCE_URL\n query = {k: v for k, v in metrics.items() if k.startswith('utm_')}\n if query:\n source_url = '?'.join((source_url, urlencode(query)))\n\n return source_url\n\n\n@et_task\ndef fxa_email_changed(data):\n ts = data['ts']\n fxa_id = data['uid']\n email = data['email']\n cache_key = 'fxa_email_changed:%s' % fxa_id\n prev_ts = float(cache.get(cache_key, 0))\n if prev_ts and prev_ts > ts:\n # message older than our last update for this UID\n return\n\n sfmc.upsert_row('FXA_EmailUpdated', {\n 'FXA_ID': fxa_id,\n 'NewEmailAddress': email,\n })\n cache.set(cache_key, ts, 7200) # 2 hr\n\n\n@et_task\ndef fxa_delete(data):\n sfmc.upsert_row('FXA_Deleted', {'FXA_ID': data['uid']})\n user_data = get_user_data(fxa_id=data['uid'], extra_fields=['id'])\n if user_data:\n sfdc.update(user_data, {'fxa_deleted': True})\n\n\n@et_task\ndef fxa_verified(data):\n \"\"\"Add new FxA users to an SFMC data extension\"\"\"\n # used to be handled by the fxa_register view\n email = data['email']\n fxa_id = data['uid']\n create_date = data.get('createDate')\n if create_date:\n create_date = datetime.fromtimestamp(create_date)\n\n locale = data.get('locale')\n subscribe = data.get('marketingOptIn')\n newsletters = data.get('newsletters')\n metrics = data.get('metricsContext', {})\n service = data.get('service', '')\n country = data.get('countryCode', '')\n\n if not locale:\n statsd.incr('fxa_verified.ignored.no_locale')\n return\n\n # if we're not using the sandbox ignore testing domains\n if email_is_testing(email):\n return\n\n lang = get_best_language(get_accept_languages(locale))\n if not lang:\n return\n\n _update_fxa_info(email, lang, fxa_id, service, create_date)\n\n add_news = None\n if newsletters:\n if settings.FXA_REGISTER_NEWSLETTER not in newsletters:\n newsletters.append(settings.FXA_REGISTER_NEWSLETTER)\n\n add_news = ','.join(newsletters)\n elif subscribe:\n add_news = settings.FXA_REGISTER_NEWSLETTER\n\n if add_news:\n upsert_user.delay(SUBSCRIBE, {\n 'email': email,\n 'lang': lang,\n 'newsletters': add_news,\n 'source_url': fxa_source_url(metrics),\n 'country': country,\n })\n else:\n record_source_url(email, fxa_source_url(metrics), 'fxa-no-optin')\n\n\n@et_task\ndef fxa_login(data):\n email = data['email']\n # if we're not using the sandbox ignore testing domains\n if email_is_testing(email):\n return\n\n new_data = {\n 'user_agent': data['userAgent'],\n 'fxa_id': data['uid'],\n 'first_device': data['deviceCount'] == 1,\n 'service': data.get('service', '')\n }\n _add_fxa_activity(new_data)\n\n metrics = data.get('metricsContext', {})\n newsletter = settings.FXA_LOGIN_CAMPAIGNS.get(metrics.get('utm_campaign'))\n if newsletter:\n upsert_user.delay(SUBSCRIBE, {\n 'email': email,\n 'newsletters': newsletter,\n 'source_url': fxa_source_url(metrics),\n 'country': data.get('countryCode', ''),\n })\n\n\ndef _add_fxa_activity(data):\n user_agent = user_agents.parse(data['user_agent'])\n device_type = 'D'\n if user_agent.is_mobile:\n device_type = 'M'\n elif user_agent.is_tablet:\n device_type = 'T'\n\n apply_updates('Sync_Device_Logins', {\n 'FXA_ID': data['fxa_id'],\n 'SERVICE': data['service'],\n 'LOGIN_DATE': gmttime(),\n 'FIRST_DEVICE': 'y' if data.get('first_device') else 'n',\n 'OS': user_agent.os.family,\n 'OS_VERSION': user_agent.os.version_string,\n 'BROWSER': '{0} {1}'.format(user_agent.browser.family,\n user_agent.browser.version_string),\n 'DEVICE_NAME': user_agent.device.family,\n 'DEVICE_TYPE': device_type,\n })\n\n\ndef _update_fxa_info(email, lang, fxa_id, service, create_date=None):\n # leaving here because easier to test\n try:\n apply_updates('Firefox_Account_ID', {\n 'EMAIL_ADDRESS_': email,\n 'CREATED_DATE_': gmttime(create_date),\n 'FXA_ID': fxa_id,\n 'FXA_LANGUAGE_ISO2': lang,\n 'SERVICE': service,\n })\n except NewsletterException as e:\n # don't report these errors to sentry until retries exhausted\n raise RetryTask(str(e))\n\n\n@et_task\ndef update_get_involved(interest_id, lang, name, email, country, email_format,\n subscribe, message, source_url):\n \"\"\"Send a user contribution information. Should be removed soon.\"\"\"\n try:\n interest = Interest.objects.get(interest_id=interest_id)\n except Interest.DoesNotExist:\n # invalid request; no need to raise exception and retry\n return\n\n interest.notify_stewards(name, email, lang, message)\n\n\n@et_task\ndef update_user_meta(token, data):\n \"\"\"Update a user's metadata, not newsletters\"\"\"\n sfdc.update({'token': token}, data)\n\n\n@et_task\ndef upsert_user(api_call_type, data):\n \"\"\"\n Update or insert (upsert) a contact record in SFDC\n\n @param int api_call_type: What kind of API call it was. Could be\n SUBSCRIBE, UNSUBSCRIBE, or SET.\n @param dict data: POST data from the form submission\n @return:\n \"\"\"\n key = data.get('email') or data.get('token')\n get_lock(key)\n upsert_contact(api_call_type, data,\n get_user_data(token=data.get('token'),\n email=data.get('email'),\n extra_fields=['id']))\n\n\ndef upsert_contact(api_call_type, data, user_data):\n \"\"\"\n Update or insert (upsert) a contact record in SFDC\n\n @param int api_call_type: What kind of API call it was. Could be\n SUBSCRIBE, UNSUBSCRIBE, or SET.\n @param dict data: POST data from the form submission\n @param dict user_data: existing contact data from SFDC\n @return: token, created\n \"\"\"\n update_data = data.copy()\n forced_optin = data.pop('optin', False)\n if 'format' in data:\n update_data['format'] = 'T' if data['format'].upper().startswith('T') else 'H'\n\n newsletters = parse_newsletters_csv(data.get('newsletters'))\n\n if user_data:\n cur_newsletters = user_data.get('newsletters', None)\n else:\n cur_newsletters = None\n\n # check for and remove transactional newsletters\n if api_call_type == SUBSCRIBE:\n all_transactionals = set(get_transactional_message_ids())\n newsletters_set = set(newsletters)\n transactionals = newsletters_set & all_transactionals\n if transactionals:\n newsletters = list(newsletters_set - transactionals)\n send_transactional_messages(update_data, user_data, list(transactionals))\n if not newsletters:\n # no regular newsletters\n return None, None\n\n # Set the newsletter flags in the record by comparing to their\n # current subscriptions.\n update_data['newsletters'] = parse_newsletters(api_call_type, newsletters, cur_newsletters)\n\n if api_call_type != UNSUBSCRIBE:\n # Are they subscribing to any newsletters that don't require confirmation?\n # When including any newsletter that does not\n # require confirmation, user gets a pass on confirming and goes straight\n # to confirmed.\n to_subscribe = [nl for nl, sub in update_data['newsletters'].items() if sub]\n if to_subscribe and not (forced_optin or\n (user_data and user_data.get('optin'))):\n exempt_from_confirmation = Newsletter.objects \\\n .filter(slug__in=to_subscribe, requires_double_optin=False) \\\n .exists()\n if exempt_from_confirmation:\n update_data['optin'] = True\n\n # record source URL\n nl_map = newsletter_map()\n source_url = update_data.get('source_url')\n email = update_data.get('email')\n if not email:\n email = user_data.get('email') if user_data else None\n\n if email:\n # send all newsletters whether already subscribed or not\n # bug 1308971\n # if api_call_type == SET this is pref center, so only send new subscriptions\n nl_list = newsletters if api_call_type == SUBSCRIBE else to_subscribe\n for nlid in nl_list:\n if nlid in nl_map:\n record_source_url.delay(email, source_url, nl_map[nlid])\n\n if user_data is None:\n # no user found. create new one.\n update_data['token'] = generate_token()\n if settings.MAINTENANCE_MODE:\n sfdc_add_update.delay(update_data)\n else:\n # don't catch exceptions here. SalesforceError subclasses will retry.\n sfdc.add(update_data)\n\n return update_data['token'], True\n\n if forced_optin and not user_data.get('optin'):\n update_data['optin'] = True\n\n # they opted out of email before, but are subscribing again\n # clear the optout flag\n if api_call_type != UNSUBSCRIBE and user_data.get('optout'):\n update_data['optout'] = False\n\n # update record\n if user_data and user_data.get('token'):\n token = user_data['token']\n else:\n token = update_data['token'] = generate_token()\n\n if settings.MAINTENANCE_MODE:\n sfdc_add_update.delay(update_data, user_data)\n else:\n sfdc.update(user_data, update_data)\n\n return token, False\n\n\n@et_task\ndef sfdc_add_update(update_data, user_data=None):\n # for use with maintenance mode only\n # TODO remove after maintenance is over and queue is processed\n if user_data:\n sfdc.update(user_data, update_data)\n else:\n try:\n sfdc.add(update_data)\n except sfapi.SalesforceMalformedRequest as e: # noqa\n # possibly a duplicate email. try the update below.\n user_data = get_user_data(email=update_data['email'], extra_fields=['id'])\n if user_data:\n # we have a user, delete generated token\n # and continue with an update\n update_data.pop('token', None)\n sfdc.update(user_data, update_data)\n else:\n # still no user, try the add one more time\n sfdc.add(update_data)\n\n\ndef send_transactional_messages(data, user_data, transactionals):\n email = data['email']\n lang_code = data.get('lang', 'en')[:2].lower()\n msgs = TransactionalEmailMessage.objects.filter(message_id__in=transactionals)\n if user_data and 'id' in user_data:\n sfdc_id = user_data['id']\n else:\n sfdc_id = None\n\n for tm in msgs:\n languages = [lang[:2].lower() for lang in tm.language_list]\n if lang_code not in languages:\n # Newsletter does not support their preferred language, so\n # it doesn't have a welcome in that language either. Settle\n # for English, same as they'll be getting the newsletter in.\n lang_code = 'en'\n\n msg_id = mogrify_message_id(tm.vendor_id, lang_code, 'H')\n send_message.delay(msg_id, email, sfdc_id or email)\n\n\ndef apply_updates(database, record):\n \"\"\"Send the record data to ET to update the database named\n target_et.\n\n :param str database: Target database, e.g. 'Firefox_Account_ID'\n :param dict record: Data to send\n \"\"\"\n sfmc.upsert_row(database, record)\n\n\n@et_task\ndef send_message(message_id, email, subscriber_key, token=None):\n \"\"\"\n Ask ET to send a message.\n\n @param str message_id: ID of the message in ET\n @param str email: email to send it to\n @param str subscriber_key: id of the email user (email or SFDC id)\n @param token: optional token when sending recovery\n\n @raises: NewsletterException for retryable errors, BasketError for\n fatal errors.\n \"\"\"\n if BAD_MESSAGE_ID_CACHE.get(message_id, False):\n return\n\n try:\n sfmc.send_mail(message_id, email, subscriber_key, token)\n statsd.incr('news.tasks.send_message.' + message_id)\n except NewsletterException as e:\n # Better error messages for some cases. Also there's no point in\n # retrying these\n if 'Invalid Customer Key' in str(e):\n # remember it's a bad message ID so we don't try again during this process.\n BAD_MESSAGE_ID_CACHE.set(message_id, True)\n return\n # we should retry\n raise\n\n\ndef mogrify_message_id(message_id, lang, format):\n \"\"\"Given a bare message ID, a language code, and a format (T or H),\n return a message ID modified to specify that language and format.\n\n E.g. on input ('MESSAGE', 'fr', 'T') it returns 'fr_MESSAGE_T',\n or on input ('MESSAGE', 'pt', 'H') it returns 'pt_MESSAGE'\n\n If `lang` is None or empty, it skips prefixing the language.\n \"\"\"\n if lang:\n result = \"%s_%s\" % (lang.lower()[:2], message_id)\n else:\n result = message_id\n if format == 'T':\n result += \"_T\"\n return result\n\n\n@et_task\ndef confirm_user(token):\n \"\"\"\n Confirm any pending subscriptions for the user with this token.\n\n If any of the subscribed newsletters have welcome messages,\n send them.\n\n :param token: User's token\n :param user_data: Dictionary with user's data from Exact Target,\n as returned by get_user_data(), or None if that wasn't available\n when this was called.\n :raises: BasketError for fatal errors, NewsletterException for retryable\n errors.\n \"\"\"\n get_lock(token)\n user_data = get_user_data(token=token)\n\n if user_data is None:\n statsd.incr('news.tasks.confirm_user.confirm_user_not_found')\n return\n\n if user_data['optin']:\n # already confirmed\n return\n\n if not ('email' in user_data and user_data['email']):\n raise BasketError('token has no email in ET')\n\n sfdc.update(user_data, {'optin': True})\n\n\n@et_task\ndef add_sms_user(send_name, mobile_number, optin, vendor_id=None):\n # Adding vendor_id as optional to avoid issues with deployment.\n # Old tasks with the old sitnature will be on the queue when this is first deployed.\n # TODO change the task signature to replace send_name with vendor_id\n if not vendor_id:\n vendor_id = get_sms_vendor_id(send_name)\n if not vendor_id:\n return\n\n sfmc.send_sms(mobile_number, vendor_id)\n if optin:\n add_sms_user_optin.delay(mobile_number)\n\n\n@et_task\ndef add_sms_user_optin(mobile_number):\n record = {'Phone': mobile_number, 'SubscriberKey': mobile_number}\n sfmc.add_row('Mobile_Subscribers', record)\n\n\n@et_task\ndef update_custom_unsub(token, reason):\n \"\"\"Record a user's custom unsubscribe reason.\"\"\"\n get_lock(token)\n try:\n sfdc.update({'token': token}, {'reason': reason})\n except sfapi.SalesforceMalformedRequest:\n # likely the record can't be found. nothing to do.\n pass\n\n\n@et_task\ndef send_recovery_message_task(email):\n user_data = get_user_data(email=email, extra_fields=['id'])\n if not user_data:\n log.debug(\"In send_recovery_message_task, email not known: %s\" % email)\n return\n\n # make sure we have a language and format, no matter what ET returned\n lang = user_data.get('lang', 'en') or 'en'\n format = user_data.get('format', 'H') or 'H'\n\n if lang not in settings.RECOVER_MSG_LANGS:\n lang = 'en'\n\n message_id = mogrify_message_id(RECOVERY_MESSAGE_ID, lang, format)\n send_message.delay(message_id, email, user_data['id'], token=user_data['token'])\n\n\n@et_task\ndef record_common_voice_goals(data):\n # do not change the sent data in place. A retry will use the changed data.\n dcopy = data.copy()\n email = dcopy.pop('email')\n user_data = get_user_data(email=email, extra_fields=['id'])\n new_data = {\n 'source_url': 'https://voice.mozilla.org',\n 'newsletters': [settings.COMMON_VOICE_NEWSLETTER],\n }\n for k, v in dcopy.items():\n new_data['cv_' + k] = v\n\n if user_data:\n sfdc.update(user_data, new_data)\n else:\n new_data.update({\n 'email': email,\n 'token': generate_token(),\n })\n sfdc.add(new_data)\n\n\n@et_task\ndef record_fxa_concerts_rsvp(email, is_firefox, campaign_id):\n sfmc.add_row('FxAccounts_Concert_RSVP', {\n 'Email': email,\n 'Firefox': is_firefox,\n 'Campaign_ID': campaign_id,\n 'RSVP_Time': gmttime(),\n })\n\n\n@et_task\ndef record_source_url(email, source_url, newsletter_id):\n if not source_url:\n source_url = '__NONE__'\n else:\n source_url = source_url[:1000]\n\n sfmc.add_row('NEWSLETTER_SOURCE_URLS', {\n 'Email': email,\n 'Signup_Source_URL__c': source_url,\n 'Newsletter_Field_Name': newsletter_id,\n 'Newsletter_Date': gmttime(),\n })\n\n\n@et_task\ndef process_subhub_event_customer_created(data):\n \"\"\"\n Event name: customer.created\n\n Creates or updates a SFDC customer when a new payment processor/Stripe\n customer is created\n \"\"\"\n statsd.incr('news.tasks.process_subhub_event.customer_created')\n\n first, last = split_name(data['name'])\n contact_data = {\n 'fxa_id': data['user_id'],\n 'payee_id': data['customer_id']\n }\n\n user_data = get_user_data(email=data['email'])\n\n # if user was found in sfdc, see if we should update their name(s)\n if user_data:\n # if current last name is '_', update it\n if user_data['last_name'] == '_':\n contact_data['last_name'] = last\n\n # if current last name is blank/Null, update it\n if not user_data['first_name']:\n contact_data['first_name'] = first\n\n sfdc.update(user_data, contact_data)\n statsd.incr('news.tasks.process_subhub_event.customer_created.updated')\n # if no user was found, create new user in sfdc\n else:\n contact_data['email'] = data['email']\n contact_data['first_name'] = first\n contact_data['last_name'] = last\n\n # create the user in sfdc\n statsd.incr('news.tasks.process_subhub_event.customer_created.created')\n sfdc.add(contact_data)\n\n\n@et_task\ndef process_subhub_event_subscription_charge(data):\n \"\"\"\n Event names: customer.subscription.created, customer.recurring_charge\n\n This method handles both new and recurring charges.\n\n Each of the handled events contains the same payload data. The only variation below\n is in regards to Initial_Purchase__c, which will be True for the\n `customer.subscription.created` event, and False for the `customer.recurring_charge`\n event.\n \"\"\"\n\n statsd.incr('news.tasks.process_subhub_event.subscription_charge')\n user_data = get_user_data(payee_id=data['customer_id'],\n extra_fields=['id'])\n if not user_data:\n statsd.incr('news.tasks.process_subhub_event.subscription_charge.user_not_found')\n raise RetryTask('Could not find user. Try again.')\n\n nickname = data['nickname']\n if isinstance(nickname, list):\n nickname = nickname[0]\n\n # if a customer re-instates service after a cancellation, the record needs to be updated\n oppy_data = {\n 'Amount': cents_to_dollars(data['plan_amount']),\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\n 'Billing_Cycle_Start__c': iso_format_unix_timestamp(data['current_period_start']),\n 'CloseDate': iso_format_unix_timestamp(data['created']),\n 'Credit_Card_Type__c': data['brand'],\n 'currency__c': data['currency'],\n 'Donation_Contact__c': user_data['id'],\n 'Event_Id__c': data['event_id'],\n 'Event_Name__c': data['event_type'],\n 'Initial_Purchase__c': data['event_type'] == 'customer.subscription.created',\n 'Invoice_Number__c': data['invoice_number'],\n 'Last_4_Digits__c': data['last4'],\n 'Name': 'Subscription Services',\n 'Next_Invoice_Date__c': iso_format_unix_timestamp(data['next_invoice_date']),\n 'Payment_Source__c': 'Stripe',\n 'PMT_Subscription_ID__c': data['subscription_id'],\n 'PMT_Transaction_ID__c': data['charge'],\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\n 'Service_Plan__c': nickname,\n 'StageName': 'Closed Won',\n }\n if 'proration_amount' in data:\n oppy_data['Proration_Amount__c'] = cents_to_dollars(data['proration_amount'])\n\n if 'total_amount' in data:\n oppy_data['Total_Amount__c'] = cents_to_dollars(data['total_amount'])\n\n sfdc.opportunity.upsert(f'PMT_Invoice_ID__c/{data[\"invoice_id\"]}', oppy_data)\n\n\n@et_task\ndef process_subhub_event_subscription_reactivated(data):\n statsd.incr('news.tasks.process_subhub_event.subscription_reactivated')\n user_data = get_user_data(payee_id=data['customer_id'],\n extra_fields=['id'])\n if not user_data:\n statsd.incr('news.tasks.process_subhub_event.subscription_reactivated.user_not_found')\n raise RetryTask('Could not find user. Try again.')\n\n nickname = data['nickname']\n if isinstance(nickname, list):\n nickname = nickname[0]\n\n sfdc.opportunity.create({\n 'Amount': cents_to_dollars(data['plan_amount']),\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\n 'CloseDate': iso_format_unix_timestamp(data.get('close_date', time())),\n 'Credit_Card_Type__c': data['brand'],\n 'Last_4_Digits__c': data['last4'],\n 'Donation_Contact__c': user_data['id'],\n 'Event_Id__c': data['event_id'],\n 'Event_Name__c': data['event_type'],\n 'Name': 'Subscription Services',\n 'Payment_Source__c': 'Stripe',\n 'PMT_Subscription_ID__c': data['subscription_id'],\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\n 'Service_Plan__c': nickname,\n 'StageName': 'Reactivation',\n })\n\n\n@et_task\ndef process_subhub_event_subscription_updated(data):\n statsd.incr('news.tasks.process_subhub_event.subscription_updated')\n user_data = get_user_data(payee_id=data['customer_id'],\n extra_fields=['id'])\n if not user_data:\n statsd.incr('news.tasks.process_subhub_event.subscription_updated.user_not_found')\n raise RetryTask('Could not find user. Try again.')\n\n direction = 'Down' if data['event_type'].endswith('downgrade') else 'Up'\n stage_name = f'Subscription {direction}grade'\n sfdc.opportunity.create({\n 'Amount': cents_to_dollars(data['plan_amount_new']),\n 'Plan_Amount_Old__c': cents_to_dollars(data['plan_amount_old']),\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\n 'CloseDate': iso_format_unix_timestamp(data.get('close_date', time())),\n 'Donation_Contact__c': user_data['id'],\n 'Event_Id__c': data['event_id'],\n 'Event_Name__c': data['event_type'],\n 'Invoice_Number__c': data['invoice_number'],\n 'Name': 'Subscription Services',\n 'Payment_Interval__c': data['interval'],\n 'Payment_Source__c': 'Stripe',\n 'PMT_Invoice_ID__c': data['invoice_id'],\n 'PMT_Subscription_ID__c': data['subscription_id'],\n 'Proration_Amount__c': data['proration_amount'],\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\n 'Service_Plan__c': data['nickname_new'],\n 'Nickname_Old__c': data['nickname_old'],\n 'StageName': stage_name,\n })\n\n\nSUB_STAGE_NAMES = {\n 'customer.subscription_cancelled': 'Subscription Canceled',\n 'customer.deleted': 'Account Deleted',\n}\n\n\n@et_task\ndef process_subhub_event_subscription_cancel(data):\n \"\"\"\n Event name: customer.subscription_cancelled or customer.deleted\n \"\"\"\n statsd.incr('news.tasks.process_subhub_event.subscription_cancel')\n user_data = get_user_data(payee_id=data['customer_id'],\n extra_fields=['id'])\n if not user_data:\n statsd.incr('news.tasks.process_subhub_event_subscription_cancel.user_not_found')\n raise RetryTask('Could not find user. Try again.')\n\n nickname = data['nickname']\n if isinstance(nickname, list):\n nickname = nickname[0]\n\n sfdc.opportunity.create({\n 'Amount': cents_to_dollars(data['plan_amount']),\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\n 'Billing_Cycle_Start__c': iso_format_unix_timestamp(data['current_period_start']),\n 'CloseDate': iso_format_unix_timestamp(data.get('cancel_at', time())),\n 'Donation_Contact__c': user_data['id'],\n 'Event_Id__c': data['event_id'],\n 'Event_Name__c': data['event_type'],\n 'Name': 'Subscription Services',\n 'Payment_Source__c': 'Stripe',\n 'PMT_Subscription_ID__c': data['subscription_id'],\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\n 'Service_Plan__c': nickname,\n 'StageName': SUB_STAGE_NAMES[data['event_type']],\n })\n\n if data['event_type'] == 'customer.deleted':\n sfdc.update(user_data, {'fxa_deleted': True})\n\n\n@et_task\ndef process_subhub_event_credit_card_expiring(data):\n \"\"\"\n Event name: customer.source.expiring\n \"\"\"\n statsd.incr('news.tasks.process_subhub_event.credit_card_expiring')\n sfmc.send_mail(settings.SUBHUB_CC_EXPIRE_TRIGGER, data['email'], data['email'])\n\n\n@et_task\ndef process_subhub_event_payment_failed(data):\n \"\"\"\n Event name: invoice.payment_failed\n \"\"\"\n statsd.incr('news.tasks.process_subhub_event.payment_failed')\n\n user_data = get_user_data(payee_id=data['customer_id'],\n extra_fields=['id'])\n # the only user identifiable information available is the payment\n # processor/Stripe ID, so if the user wasn't found by that, there's really\n # nothing to be done here but retry.\n if not user_data:\n statsd.incr('news.tasks.process_subhub_event.payment_failed.user_not_found')\n raise RetryTask('Could not find user. Try again.')\n\n nickname = data['nickname']\n if isinstance(nickname, list):\n nickname = nickname[0]\n\n sfdc.opportunity.create({\n 'Amount': cents_to_dollars(data['amount_due']),\n 'CloseDate': iso_format_unix_timestamp(data['created']),\n 'Donation_Contact__c': user_data['id'],\n 'Event_Id__c': data['event_id'],\n 'Event_Name__c': data['event_type'],\n 'Name': 'Subscription Services',\n 'PMT_Subscription_ID__c': data['subscription_id'],\n 'PMT_Transaction_ID__c': data['charge_id'],\n 'Payment_Source__c': 'Stripe',\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\n 'Service_Plan__c': nickname,\n 'StageName': 'Payment Failed',\n 'currency__c': data['currency'],\n })\n\n\n@et_task\ndef process_donation_event(data):\n \"\"\"Process a followup event on a donation\"\"\"\n etype = data['event_type']\n txn_id = data['transaction_id']\n status = data.get('status')\n statsd.incr('news.tasks.process_donation_event.{}'.format(etype))\n if status:\n statsd.incr('news.tasks.process_donation_event.{}.{}'.format(etype, status))\n\n if etype.startswith('charge.dispute.'):\n if status not in ['charge_refunded', 'won', 'lost']:\n # only care about the above statuses\n statsd.incr('news.tasks.process_donation_event.{}.IGNORED'.format(etype))\n return\n elif etype == 'charge.refunded':\n if status not in ['succeeded', 'failed', 'cancelled']:\n # don't care about pending statuses\n statsd.incr('news.tasks.process_donation_event.{}.IGNORED'.format(etype))\n return\n\n if 'reason' in data:\n reason_lost = data['reason']\n else:\n reason_lost = data['failure_code']\n\n try:\n # will raise a SalesforceMalformedRequest if not found\n sfdc.opportunity.update('PMT_Transaction_ID__c/{}'.format(txn_id), {\n 'PMT_Type_Lost__c': etype,\n 'PMT_Reason_Lost__c': reason_lost,\n 'StageName': 'Closed Lost',\n })\n except sfapi.SalesforceMalformedRequest as e:\n # we don't know about this tx_id. Let someone know.\n do_notify = cache.add('donate-notify-{}'.format(txn_id), 1, 86400)\n if do_notify and settings.DONATE_UPDATE_FAIL_DE:\n sfmc.add_row(settings.DONATE_UPDATE_FAIL_DE, {\n 'PMT_Transaction_ID__c': txn_id,\n 'Payment_Type__c': etype,\n 'PMT_Reason_Lost__c': reason_lost,\n 'Error_Text': str(e)[:4000],\n 'Date': gmttime(),\n })\n\n if do_notify and settings.DONATE_NOTIFY_EMAIL:\n # don't notify about a transaction more than once per day\n first_mail = cache.add('donate-notify-{}'.format(txn_id), 1, 86400)\n if first_mail:\n body = render_to_string('news/donation_notify_email.txt', {\n 'txn_id': txn_id,\n 'type_lost': etype,\n 'reason_lost': reason_lost,\n 'server_name': settings.STATSD_PREFIX,\n })\n send_mail('Donation Record Not Found', body,\n 'noreply@mozilla.com', [settings.DONATE_NOTIFY_EMAIL])\n\n # retry\n raise\n\n\n# all strings and truncated at 2000 chars\nDONATION_OPTIONAL_FIELDS = {\n 'SourceURL__c': 'source_url',\n 'Donation_Form_URL__c': 'donation_url',\n 'Project__c': 'project',\n 'PMT_Subscription_ID__c': 'subscription_id',\n 'Credit_Card_Type__c': 'card_type',\n}\n# Add these fields as optional for now as some messages\n# could still come through without them. Mix of string\n# and numerical data.\nDONATION_NEW_FIELDS = {\n 'Donation_Locale__c': 'locale',\n 'Processors_Fee__c': 'transaction_fee',\n 'Net_Amount__c': 'net_amount',\n 'Conversion_Amount__c': 'conversion_amount',\n 'Last_4_Digits__c': 'last_4',\n}\n\n\n@et_task\ndef process_donation(data):\n get_lock(data['email'])\n # tells the backend to leave the \"subscriber\" flag alone\n contact_data = {'_set_subscriber': False}\n # do \"or ''\" because data can contain None values\n first_name = (data.get('first_name') or '').strip()\n last_name = (data.get('last_name') or '').strip()\n if first_name and last_name:\n contact_data['first_name'] = first_name\n contact_data['last_name'] = last_name\n elif first_name:\n contact_data['first_name'] = first_name\n elif last_name:\n names = data['last_name'].rsplit(None, 1)\n if len(names) == 2:\n first, last = names\n else:\n first, last = '', names[0]\n if first:\n contact_data['first_name'] = first\n if last:\n contact_data['last_name'] = last\n\n user_data = get_user_data(email=data['email'],\n extra_fields=['id'])\n if user_data:\n if contact_data and (\n ('first_name' in contact_data and contact_data['first_name'] != user_data['first_name']) or\n ('last_name' in contact_data and contact_data['last_name'] != user_data['last_name'])):\n sfdc.update(user_data, contact_data)\n else:\n contact_data['token'] = generate_token()\n contact_data['email'] = data['email']\n contact_data['record_type'] = settings.DONATE_CONTACT_RECORD_TYPE\n\n # returns a dict with the new ID but no other user data, but that's enough here\n user_data = sfdc.add(contact_data)\n if not user_data.get('id'):\n # retry here to make sure we associate the donation data with the proper account\n raise RetryTask('User not yet available')\n\n # add opportunity\n donation = {\n 'RecordTypeId': settings.DONATE_OPP_RECORD_TYPE,\n 'Name': 'Foundation Donation',\n 'Donation_Contact__c': user_data['id'],\n 'StageName': 'Closed Won',\n 'Amount': float(data['donation_amount']),\n 'Currency__c': data['currency'].upper(),\n 'Payment_Source__c': data['service'],\n 'PMT_Transaction_ID__c': data['transaction_id'],\n 'Payment_Type__c': 'Recurring' if data['recurring'] else 'One-Time',\n }\n # this is a unix timestamp in ms since epoc\n timestamp = data.get('created')\n if timestamp:\n donation['CloseDate'] = iso_format_unix_timestamp(timestamp)\n\n for dest_name, source_name in DONATION_NEW_FIELDS.items():\n if source_name in data:\n donation[dest_name] = data[source_name]\n\n for dest_name, source_name in DONATION_OPTIONAL_FIELDS.items():\n if data.get(source_name):\n # truncate at 2000 chars as that's the max for\n # a SFDC text field. We may do more granular\n # truncation per field in future.\n donation[dest_name] = data[source_name][:2000]\n\n try:\n sfdc.opportunity.create(donation)\n except sfapi.SalesforceMalformedRequest as e:\n if e.content and e.content[0].get('errorCode') == 'DUPLICATE_VALUE':\n # already in the system, ignore\n pass\n else:\n raise\n\n\n@et_task\ndef process_newsletter_subscribe(data):\n data = data['form']\n data['lang'] = get_best_supported_lang(data['lang'])\n upsert_user(SUBSCRIBE, data)\n\n\nPETITION_CONTACT_FIELDS = [\n 'first_name',\n 'last_name',\n 'country',\n 'postal_code',\n 'source_url',\n]\n\n\n@et_task\ndef process_petition_signature(data):\n \"\"\"\n Add petition signature to SFDC\n \"\"\"\n data = data['form']\n get_lock(data['email'])\n # tells the backend to leave the \"subscriber\" flag alone\n contact_data = {'_set_subscriber': False}\n contact_data.update({k: data[k] for k in PETITION_CONTACT_FIELDS if data.get(k)})\n\n user_data = get_user_data(email=data['email'],\n extra_fields=['id'])\n if user_data:\n sfdc.update(user_data, contact_data)\n else:\n contact_data['token'] = generate_token()\n contact_data['email'] = data['email']\n contact_data['record_type'] = settings.DONATE_CONTACT_RECORD_TYPE\n sfdc.add(contact_data)\n # fetch again to get ID\n user_data = get_user_data(email=data.get('email'),\n extra_fields=['id'])\n if not user_data:\n # retry here to make sure we associate the donation data with the proper account\n raise RetryTask('User not yet available')\n\n if data.get('email_subscription', False):\n upsert_user.delay(SUBSCRIBE, {\n 'token': user_data['token'],\n 'lang': data.get('lang', 'en-US'),\n 'newsletters': 'mozilla-foundation',\n 'source_url': data['source_url'],\n })\n\n campaign_member = {\n 'CampaignId': data['campaign_id'],\n 'ContactId': user_data['id'],\n 'Full_URL__c': data['source_url'],\n 'Status': 'Signed',\n }\n comments = data.get('comments')\n if comments:\n campaign_member['Petition_Comments__c'] = comments[:500]\n\n metadata = data.get('metadata')\n if metadata:\n campaign_member['Petition_Flex__c'] = json.dumps(metadata)[:500]\n\n try:\n sfdc.campaign_member.create(campaign_member)\n except sfapi.SalesforceMalformedRequest as e:\n if e.content and e.content[0].get('errorCode') == 'DUPLICATE_VALUE':\n # already in the system, ignore\n pass\n else:\n raise\n\n\ndef upsert_amo_user_data(data):\n \"\"\"\n Update AMO user data in the SFDC contact, or create a contact.\n Return the Contact data (the contact ID at a minimum).\n\n :param data: dict of amo user data\n :return: dict of SFDC contact data\n \"\"\"\n email = data.pop('email')\n amo_id = data.pop('id')\n amo_deleted = data.pop('deleted', False)\n amo_data = {f'amo_{k}': v for k, v in data.items() if v}\n amo_data['amo_user'] = not amo_deleted\n user = get_user_data(amo_id=amo_id, extra_fields=['id', 'amo_id'])\n if user:\n sfdc.update(user, amo_data)\n return user\n\n # include the ID in update or add since we couldn't find\n # the user with this ID above\n amo_data['amo_id'] = amo_id\n user = get_user_data(email=email, extra_fields=['id'])\n if user:\n sfdc.update(user, amo_data)\n # need amo_id for linking addons and authors\n user['amo_id'] = amo_id\n return user\n\n amo_data['email'] = email\n amo_data['source_url'] = 'https://addons.mozilla.org/'\n # returns only the new user ID in a dict, but that will work\n # when passed to e.g. `sfdc.update()`\n user = sfdc.add(amo_data)\n # need amo_id for linking addons and authors\n user['amo_id'] = amo_id\n return user\n\n\ndef amo_compress_categories(categories):\n cats_list = []\n for product, cats in categories.items():\n cats_list.extend([f'{product}-{cat}' for cat in cats])\n\n return ','.join(cats_list)\n\n\n@et_task\ndef amo_sync_addon(data):\n data = deepcopy(data)\n users = [upsert_amo_user_data(author) for author in data['authors']]\n addon_data = {\n 'AMO_Category__c': amo_compress_categories(data['categories']),\n 'AMO_Default_Language__c': data['default_locale'],\n 'AMO_GUID__c': data['guid'],\n 'AMO_Rating__c': data['ratings']['average'],\n 'AMO_Slug__c': data['slug'],\n 'AMO_Status__c': data['status'],\n 'AMO_Type__c': data['type'],\n 'AMO_Update__c': data['last_updated'],\n 'Average_Daily_Users__c': data['average_daily_users'],\n 'Dev_Disabled__c': 'Yes' if data['is_disabled'] else 'No',\n }\n # check for possible None or empty values\n if data['name']:\n addon_data['Name'] = data['name']\n\n # versions can be removed, so they should be removed if they are null\n if data['current_version']:\n addon_data['AMO_Current_Version__c'] = data['current_version']['version']\n else:\n addon_data['AMO_Current_Version__c'] = ''\n\n if data['latest_unlisted_version']:\n addon_data['AMO_Current_Version_Unlisted__c'] = data['latest_unlisted_version']['version']\n else:\n addon_data['AMO_Current_Version_Unlisted__c'] = ''\n\n sfdc.addon.upsert(f'AMO_AddOn_Id__c/{data[\"id\"]}', addon_data)\n addon_record = sfdc.addon.get_by_custom_id('AMO_AddOn_Id__c', data['id'])\n for user in users:\n try:\n sfdc.dev_addon.upsert(f'ConcatenateAMOID__c/{user[\"amo_id\"]}-{data[\"id\"]}', {\n 'AMO_AddOn_ID__c': addon_record['Id'],\n 'AMO_Contact_ID__c': user['id'],\n })\n except sfapi.SalesforceMalformedRequest as e:\n try:\n if e.content[0]['errorCode'] == 'DUPLICATE_VALUE':\n # dupe error, so we don't need to do this again\n pass\n else:\n raise e\n except Exception:\n # if anything else goes wrong just retry\n raise e\n\n\n@et_task\ndef amo_sync_user(data):\n # copy input so it's not modified for retry\n upsert_amo_user_data(data.copy())\n\n\n@celery_app.task()\ndef snitch(start_time=None):\n if start_time is None:\n snitch.delay(time())\n return\n\n snitch_id = settings.SNITCH_ID\n totalms = int((time() - start_time) * 1000)\n statsd.timing('news.tasks.snitch.timing', totalms)\n requests.post('https://nosnch.in/{}'.format(snitch_id), data={\n 'm': totalms,\n })\n","path":"basket/news/tasks.py"}],"string":"[\n {\n \"content\": \"import json\\nimport logging\\nfrom copy import deepcopy\\nfrom datetime import datetime, timedelta\\nfrom email.utils import formatdate\\nfrom functools import wraps\\nfrom hashlib import sha256\\nfrom time import mktime, time\\nfrom urllib.parse import urlencode\\n\\nfrom django.conf import settings\\nfrom django.core.cache import cache, caches\\nfrom django.core.mail import send_mail\\nfrom django.template.loader import render_to_string\\n\\nimport requests\\nimport simple_salesforce as sfapi\\nimport user_agents\\nfrom celery.signals import task_failure, task_retry, task_success\\nfrom django_statsd.clients import statsd\\nfrom raven.contrib.django.raven_compat.models import client as sentry_client\\n\\nfrom basket.base.utils import email_is_testing\\nfrom basket.news.backends.common import NewsletterException\\nfrom basket.news.backends.sfdc import sfdc\\nfrom basket.news.backends.sfmc import sfmc\\nfrom basket.news.celery import app as celery_app\\nfrom basket.news.models import (FailedTask, Newsletter, Interest,\\n QueuedTask, TransactionalEmailMessage)\\nfrom basket.news.newsletters import get_sms_vendor_id, get_transactional_message_ids, newsletter_map\\nfrom basket.news.utils import (cents_to_dollars, generate_token, get_accept_languages, get_best_language,\\n get_user_data, iso_format_unix_timestamp, parse_newsletters, parse_newsletters_csv,\\n SUBSCRIBE, UNSUBSCRIBE, get_best_supported_lang, split_name)\\n\\nlog = logging.getLogger(__name__)\\n\\nBAD_MESSAGE_ID_CACHE = caches['bad_message_ids']\\n\\n# Base message ID for confirmation email\\nCONFIRMATION_MESSAGE = \\\"confirmation_email\\\"\\n\\n# This is prefixed with the 2-letter language code + _ before sending,\\n# e.g. 'en_recovery_message', and '_T' if text, e.g. 'en_recovery_message_T'.\\nRECOVERY_MESSAGE_ID = 'SFDC_Recovery'\\nFXACCOUNT_WELCOME = 'FxAccounts_Welcome'\\n\\n# don't propagate and don't retry if these are the error messages\\nIGNORE_ERROR_MSGS = [\\n 'InvalidEmailAddress',\\n 'An invalid phone number was provided',\\n]\\n# don't propagate after max retries if these are the error messages\\nIGNORE_ERROR_MSGS_POST_RETRY = [\\n 'There are no valid subscribers',\\n]\\n# tasks exempt from maintenance mode queuing\\nMAINTENANCE_EXEMPT = [\\n 'news.tasks.add_sms_user',\\n 'news.tasks.add_sms_user_optin',\\n]\\n\\n\\ndef ignore_error(exc, to_ignore=IGNORE_ERROR_MSGS):\\n msg = str(exc)\\n for ignore_msg in to_ignore:\\n if ignore_msg in msg:\\n return True\\n\\n return False\\n\\n\\ndef ignore_error_post_retry(exc):\\n return ignore_error(exc, IGNORE_ERROR_MSGS_POST_RETRY)\\n\\n\\ndef get_lock(key, prefix='task'):\\n \\\"\\\"\\\"Get a lock for a specific key (usually email address)\\n\\n Needs to be done with a timeout because SFDC needs some time to populate its\\n indexes before the duplicate protection works and queries will return results.\\n Releasing the lock right after the task was run still allowed dupes.\\n\\n Does nothing if you get the lock, and raises RetryTask if not.\\n \\\"\\\"\\\"\\n if not settings.TASK_LOCKING_ENABLE:\\n return\\n\\n lock_key = 'basket-{}-{}'.format(prefix, key)\\n lock_key = sha256(lock_key.encode()).hexdigest()\\n got_lock = cache.add(lock_key, True, settings.TASK_LOCK_TIMEOUT)\\n if not got_lock:\\n statsd.incr('news.tasks.get_lock.no_lock_retry')\\n raise RetryTask('Could not acquire lock')\\n\\n\\nclass BasketError(Exception):\\n \\\"\\\"\\\"Tasks can raise this when an error happens that we should not retry.\\n E.g. if the error indicates we're passing bad parameters.\\n (As opposed to an error connecting to ExactTarget at the moment,\\n where we'd typically raise NewsletterException.)\\n \\\"\\\"\\\"\\n def __init__(self, msg):\\n super(BasketError, self).__init__(msg)\\n\\n\\nclass RetryTask(Exception):\\n \\\"\\\"\\\"an exception to raise within a task if you just want to retry\\\"\\\"\\\"\\n\\n\\n@task_failure.connect\\ndef on_task_failure(sender, task_id, exception, einfo, args, kwargs, **skwargs):\\n statsd.incr(sender.name + '.failure')\\n if not sender.name.endswith('snitch'):\\n statsd.incr('news.tasks.failure_total')\\n if settings.STORE_TASK_FAILURES:\\n FailedTask.objects.create(\\n task_id=task_id,\\n name=sender.name,\\n args=args,\\n kwargs=kwargs,\\n exc=repr(exception),\\n # str() gives more info than repr() on celery.datastructures.ExceptionInfo\\n einfo=str(einfo),\\n )\\n\\n\\n@task_retry.connect\\ndef on_task_retry(sender, **kwargs):\\n statsd.incr(sender.name + '.retry')\\n if not sender.name.endswith('snitch'):\\n statsd.incr('news.tasks.retry_total')\\n\\n\\n@task_success.connect\\ndef on_task_success(sender, **kwargs):\\n statsd.incr(sender.name + '.success')\\n if not sender.name.endswith('snitch'):\\n statsd.incr('news.tasks.success_total')\\n\\n\\ndef et_task(func):\\n \\\"\\\"\\\"Decorator to standardize ET Celery tasks.\\\"\\\"\\\"\\n full_task_name = 'news.tasks.%s' % func.__name__\\n\\n # continue to use old names regardless of new layout\\n @celery_app.task(name=full_task_name,\\n bind=True,\\n default_retry_delay=300, # 5 min\\n max_retries=11)\\n @wraps(func)\\n def wrapped(self, *args, **kwargs):\\n start_time = kwargs.pop('start_time', None)\\n if start_time and not self.request.retries:\\n total_time = int((time() - start_time) * 1000)\\n statsd.timing(self.name + '.timing', total_time)\\n statsd.incr(self.name + '.total')\\n statsd.incr('news.tasks.all_total')\\n if settings.MAINTENANCE_MODE and self.name not in MAINTENANCE_EXEMPT:\\n if not settings.READ_ONLY_MODE:\\n # record task for later\\n QueuedTask.objects.create(\\n name=self.name,\\n args=args,\\n kwargs=kwargs,\\n )\\n statsd.incr(self.name + '.queued')\\n else:\\n statsd.incr(self.name + '.not_queued')\\n\\n return\\n\\n try:\\n return func(*args, **kwargs)\\n except (IOError, NewsletterException, requests.RequestException, RetryTask,\\n sfapi.SalesforceExpiredSession, sfapi.SalesforceGeneralError,\\n sfapi.SalesforceRefusedRequest, sfapi.SalesforceResourceNotFound,\\n sfapi.SalesforceAuthenticationFailed, sfapi.SalesforceMalformedRequest) as e:\\n # These could all be connection issues, so try again later.\\n # IOError covers URLError and SSLError.\\n if ignore_error(e):\\n return\\n\\n try:\\n if not (isinstance(e, RetryTask) or ignore_error_post_retry(e)):\\n sentry_client.captureException(tags={'action': 'retried'})\\n\\n # ~68 hr at 11 retries\\n raise self.retry(countdown=2 ** (self.request.retries + 1) * 60)\\n except self.MaxRetriesExceededError:\\n statsd.incr(self.name + '.retry_max')\\n statsd.incr('news.tasks.retry_max_total')\\n # don't bubble certain errors\\n if ignore_error_post_retry(e):\\n return\\n\\n sentry_client.captureException()\\n\\n return wrapped\\n\\n\\ndef gmttime(basetime=None):\\n if basetime is None:\\n basetime = datetime.now()\\n d = basetime + timedelta(minutes=10)\\n stamp = mktime(d.timetuple())\\n return formatdate(timeval=stamp, localtime=False, usegmt=True)\\n\\n\\ndef fxa_source_url(metrics):\\n source_url = settings.FXA_REGISTER_SOURCE_URL\\n query = {k: v for k, v in metrics.items() if k.startswith('utm_')}\\n if query:\\n source_url = '?'.join((source_url, urlencode(query)))\\n\\n return source_url\\n\\n\\n@et_task\\ndef fxa_email_changed(data):\\n ts = data['ts']\\n fxa_id = data['uid']\\n email = data['email']\\n cache_key = 'fxa_email_changed:%s' % fxa_id\\n prev_ts = float(cache.get(cache_key, 0))\\n if prev_ts and prev_ts > ts:\\n # message older than our last update for this UID\\n return\\n\\n sfmc.upsert_row('FXA_EmailUpdated', {\\n 'FXA_ID': fxa_id,\\n 'NewEmailAddress': email,\\n })\\n cache.set(cache_key, ts, 7200) # 2 hr\\n\\n\\n@et_task\\ndef fxa_delete(data):\\n sfmc.upsert_row('FXA_Deleted', {'FXA_ID': data['uid']})\\n user_data = get_user_data(fxa_id=data['uid'], extra_fields=['id'])\\n if user_data:\\n sfdc.update(user_data, {'fxa_deleted': True})\\n\\n\\n@et_task\\ndef fxa_verified(data):\\n \\\"\\\"\\\"Add new FxA users to an SFMC data extension\\\"\\\"\\\"\\n # used to be handled by the fxa_register view\\n email = data['email']\\n fxa_id = data['uid']\\n create_date = data.get('createDate')\\n if create_date:\\n create_date = datetime.fromtimestamp(create_date)\\n\\n locale = data.get('locale')\\n subscribe = data.get('marketingOptIn')\\n newsletters = data.get('newsletters')\\n metrics = data.get('metricsContext', {})\\n service = data.get('service', '')\\n country = data.get('countryCode', '')\\n\\n if not locale:\\n statsd.incr('fxa_verified.ignored.no_locale')\\n return\\n\\n # if we're not using the sandbox ignore testing domains\\n if email_is_testing(email):\\n return\\n\\n lang = get_best_language(get_accept_languages(locale))\\n if not lang:\\n return\\n\\n _update_fxa_info(email, lang, fxa_id, service, create_date)\\n\\n add_news = None\\n if newsletters:\\n if settings.FXA_REGISTER_NEWSLETTER not in newsletters:\\n newsletters.append(settings.FXA_REGISTER_NEWSLETTER)\\n\\n add_news = ','.join(newsletters)\\n elif subscribe:\\n add_news = settings.FXA_REGISTER_NEWSLETTER\\n\\n if add_news:\\n upsert_user.delay(SUBSCRIBE, {\\n 'email': email,\\n 'lang': lang,\\n 'newsletters': add_news,\\n 'source_url': fxa_source_url(metrics),\\n 'country': country,\\n })\\n else:\\n record_source_url(email, fxa_source_url(metrics), 'fxa-no-optin')\\n\\n\\n@et_task\\ndef fxa_login(data):\\n email = data['email']\\n # if we're not using the sandbox ignore testing domains\\n if email_is_testing(email):\\n return\\n\\n new_data = {\\n 'user_agent': data['userAgent'],\\n 'fxa_id': data['uid'],\\n 'first_device': data['deviceCount'] == 1,\\n 'service': data.get('service', '')\\n }\\n _add_fxa_activity(new_data)\\n\\n metrics = data.get('metricsContext', {})\\n newsletter = settings.FXA_LOGIN_CAMPAIGNS.get(metrics.get('utm_campaign'))\\n if newsletter:\\n upsert_user.delay(SUBSCRIBE, {\\n 'email': email,\\n 'newsletters': newsletter,\\n 'source_url': fxa_source_url(metrics),\\n 'country': data.get('countryCode', ''),\\n })\\n\\n\\ndef _add_fxa_activity(data):\\n user_agent = user_agents.parse(data['user_agent'])\\n device_type = 'D'\\n if user_agent.is_mobile:\\n device_type = 'M'\\n elif user_agent.is_tablet:\\n device_type = 'T'\\n\\n apply_updates('Sync_Device_Logins', {\\n 'FXA_ID': data['fxa_id'],\\n 'SERVICE': data['service'],\\n 'LOGIN_DATE': gmttime(),\\n 'FIRST_DEVICE': 'y' if data.get('first_device') else 'n',\\n 'OS': user_agent.os.family,\\n 'OS_VERSION': user_agent.os.version_string,\\n 'BROWSER': '{0} {1}'.format(user_agent.browser.family,\\n user_agent.browser.version_string),\\n 'DEVICE_NAME': user_agent.device.family,\\n 'DEVICE_TYPE': device_type,\\n })\\n\\n\\ndef _update_fxa_info(email, lang, fxa_id, service, create_date=None):\\n # leaving here because easier to test\\n try:\\n apply_updates('Firefox_Account_ID', {\\n 'EMAIL_ADDRESS_': email,\\n 'CREATED_DATE_': gmttime(create_date),\\n 'FXA_ID': fxa_id,\\n 'FXA_LANGUAGE_ISO2': lang,\\n 'SERVICE': service,\\n })\\n except NewsletterException as e:\\n # don't report these errors to sentry until retries exhausted\\n raise RetryTask(str(e))\\n\\n\\n@et_task\\ndef update_get_involved(interest_id, lang, name, email, country, email_format,\\n subscribe, message, source_url):\\n \\\"\\\"\\\"Send a user contribution information. Should be removed soon.\\\"\\\"\\\"\\n try:\\n interest = Interest.objects.get(interest_id=interest_id)\\n except Interest.DoesNotExist:\\n # invalid request; no need to raise exception and retry\\n return\\n\\n interest.notify_stewards(name, email, lang, message)\\n\\n\\n@et_task\\ndef update_user_meta(token, data):\\n \\\"\\\"\\\"Update a user's metadata, not newsletters\\\"\\\"\\\"\\n sfdc.update({'token': token}, data)\\n\\n\\n@et_task\\ndef upsert_user(api_call_type, data):\\n \\\"\\\"\\\"\\n Update or insert (upsert) a contact record in SFDC\\n\\n @param int api_call_type: What kind of API call it was. Could be\\n SUBSCRIBE, UNSUBSCRIBE, or SET.\\n @param dict data: POST data from the form submission\\n @return:\\n \\\"\\\"\\\"\\n key = data.get('email') or data.get('token')\\n get_lock(key)\\n upsert_contact(api_call_type, data,\\n get_user_data(token=data.get('token'),\\n email=data.get('email'),\\n extra_fields=['id']))\\n\\n\\ndef upsert_contact(api_call_type, data, user_data):\\n \\\"\\\"\\\"\\n Update or insert (upsert) a contact record in SFDC\\n\\n @param int api_call_type: What kind of API call it was. Could be\\n SUBSCRIBE, UNSUBSCRIBE, or SET.\\n @param dict data: POST data from the form submission\\n @param dict user_data: existing contact data from SFDC\\n @return: token, created\\n \\\"\\\"\\\"\\n update_data = data.copy()\\n forced_optin = data.pop('optin', False)\\n if 'format' in data:\\n update_data['format'] = 'T' if data['format'].upper().startswith('T') else 'H'\\n\\n newsletters = parse_newsletters_csv(data.get('newsletters'))\\n\\n if user_data:\\n cur_newsletters = user_data.get('newsletters', None)\\n else:\\n cur_newsletters = None\\n\\n # check for and remove transactional newsletters\\n if api_call_type == SUBSCRIBE:\\n all_transactionals = set(get_transactional_message_ids())\\n newsletters_set = set(newsletters)\\n transactionals = newsletters_set & all_transactionals\\n if transactionals:\\n newsletters = list(newsletters_set - transactionals)\\n send_transactional_messages(update_data, user_data, list(transactionals))\\n if not newsletters:\\n # no regular newsletters\\n return None, None\\n\\n # Set the newsletter flags in the record by comparing to their\\n # current subscriptions.\\n update_data['newsletters'] = parse_newsletters(api_call_type, newsletters, cur_newsletters)\\n\\n if api_call_type != UNSUBSCRIBE:\\n # Are they subscribing to any newsletters that don't require confirmation?\\n # When including any newsletter that does not\\n # require confirmation, user gets a pass on confirming and goes straight\\n # to confirmed.\\n to_subscribe = [nl for nl, sub in update_data['newsletters'].items() if sub]\\n if to_subscribe and not (forced_optin or\\n (user_data and user_data.get('optin'))):\\n exempt_from_confirmation = Newsletter.objects \\\\\\n .filter(slug__in=to_subscribe, requires_double_optin=False) \\\\\\n .exists()\\n if exempt_from_confirmation:\\n update_data['optin'] = True\\n\\n # record source URL\\n nl_map = newsletter_map()\\n source_url = update_data.get('source_url')\\n email = update_data.get('email')\\n if not email:\\n email = user_data.get('email') if user_data else None\\n\\n if email:\\n # send all newsletters whether already subscribed or not\\n # bug 1308971\\n # if api_call_type == SET this is pref center, so only send new subscriptions\\n nl_list = newsletters if api_call_type == SUBSCRIBE else to_subscribe\\n for nlid in nl_list:\\n if nlid in nl_map:\\n record_source_url.delay(email, source_url, nl_map[nlid])\\n\\n if user_data is None:\\n # no user found. create new one.\\n update_data['token'] = generate_token()\\n if settings.MAINTENANCE_MODE:\\n sfdc_add_update.delay(update_data)\\n else:\\n # don't catch exceptions here. SalesforceError subclasses will retry.\\n sfdc.add(update_data)\\n\\n return update_data['token'], True\\n\\n if forced_optin and not user_data.get('optin'):\\n update_data['optin'] = True\\n\\n # they opted out of email before, but are subscribing again\\n # clear the optout flag\\n if api_call_type != UNSUBSCRIBE and user_data.get('optout'):\\n update_data['optout'] = False\\n\\n # update record\\n if user_data and user_data.get('token'):\\n token = user_data['token']\\n else:\\n token = update_data['token'] = generate_token()\\n\\n if settings.MAINTENANCE_MODE:\\n sfdc_add_update.delay(update_data, user_data)\\n else:\\n sfdc.update(user_data, update_data)\\n\\n return token, False\\n\\n\\n@et_task\\ndef sfdc_add_update(update_data, user_data=None):\\n # for use with maintenance mode only\\n # TODO remove after maintenance is over and queue is processed\\n if user_data:\\n sfdc.update(user_data, update_data)\\n else:\\n try:\\n sfdc.add(update_data)\\n except sfapi.SalesforceMalformedRequest as e: # noqa\\n # possibly a duplicate email. try the update below.\\n user_data = get_user_data(email=update_data['email'], extra_fields=['id'])\\n if user_data:\\n # we have a user, delete generated token\\n # and continue with an update\\n update_data.pop('token', None)\\n sfdc.update(user_data, update_data)\\n else:\\n # still no user, try the add one more time\\n sfdc.add(update_data)\\n\\n\\ndef send_transactional_messages(data, user_data, transactionals):\\n email = data['email']\\n lang_code = data.get('lang', 'en')[:2].lower()\\n msgs = TransactionalEmailMessage.objects.filter(message_id__in=transactionals)\\n if user_data and 'id' in user_data:\\n sfdc_id = user_data['id']\\n else:\\n sfdc_id = None\\n\\n for tm in msgs:\\n languages = [lang[:2].lower() for lang in tm.language_list]\\n if lang_code not in languages:\\n # Newsletter does not support their preferred language, so\\n # it doesn't have a welcome in that language either. Settle\\n # for English, same as they'll be getting the newsletter in.\\n lang_code = 'en'\\n\\n msg_id = mogrify_message_id(tm.vendor_id, lang_code, 'H')\\n send_message.delay(msg_id, email, sfdc_id or email)\\n\\n\\ndef apply_updates(database, record):\\n \\\"\\\"\\\"Send the record data to ET to update the database named\\n target_et.\\n\\n :param str database: Target database, e.g. 'Firefox_Account_ID'\\n :param dict record: Data to send\\n \\\"\\\"\\\"\\n sfmc.upsert_row(database, record)\\n\\n\\n@et_task\\ndef send_message(message_id, email, subscriber_key, token=None):\\n \\\"\\\"\\\"\\n Ask ET to send a message.\\n\\n @param str message_id: ID of the message in ET\\n @param str email: email to send it to\\n @param str subscriber_key: id of the email user (email or SFDC id)\\n @param token: optional token when sending recovery\\n\\n @raises: NewsletterException for retryable errors, BasketError for\\n fatal errors.\\n \\\"\\\"\\\"\\n if BAD_MESSAGE_ID_CACHE.get(message_id, False):\\n return\\n\\n try:\\n sfmc.send_mail(message_id, email, subscriber_key, token)\\n statsd.incr('news.tasks.send_message.' + message_id)\\n except NewsletterException as e:\\n # Better error messages for some cases. Also there's no point in\\n # retrying these\\n if 'Invalid Customer Key' in str(e):\\n # remember it's a bad message ID so we don't try again during this process.\\n BAD_MESSAGE_ID_CACHE.set(message_id, True)\\n return\\n # we should retry\\n raise\\n\\n\\ndef mogrify_message_id(message_id, lang, format):\\n \\\"\\\"\\\"Given a bare message ID, a language code, and a format (T or H),\\n return a message ID modified to specify that language and format.\\n\\n E.g. on input ('MESSAGE', 'fr', 'T') it returns 'fr_MESSAGE_T',\\n or on input ('MESSAGE', 'pt', 'H') it returns 'pt_MESSAGE'\\n\\n If `lang` is None or empty, it skips prefixing the language.\\n \\\"\\\"\\\"\\n if lang:\\n result = \\\"%s_%s\\\" % (lang.lower()[:2], message_id)\\n else:\\n result = message_id\\n if format == 'T':\\n result += \\\"_T\\\"\\n return result\\n\\n\\n@et_task\\ndef confirm_user(token):\\n \\\"\\\"\\\"\\n Confirm any pending subscriptions for the user with this token.\\n\\n If any of the subscribed newsletters have welcome messages,\\n send them.\\n\\n :param token: User's token\\n :param user_data: Dictionary with user's data from Exact Target,\\n as returned by get_user_data(), or None if that wasn't available\\n when this was called.\\n :raises: BasketError for fatal errors, NewsletterException for retryable\\n errors.\\n \\\"\\\"\\\"\\n get_lock(token)\\n user_data = get_user_data(token=token)\\n\\n if user_data is None:\\n statsd.incr('news.tasks.confirm_user.confirm_user_not_found')\\n return\\n\\n if user_data['optin']:\\n # already confirmed\\n return\\n\\n if not ('email' in user_data and user_data['email']):\\n raise BasketError('token has no email in ET')\\n\\n sfdc.update(user_data, {'optin': True})\\n\\n\\n@et_task\\ndef add_sms_user(send_name, mobile_number, optin, vendor_id=None):\\n # Adding vendor_id as optional to avoid issues with deployment.\\n # Old tasks with the old sitnature will be on the queue when this is first deployed.\\n # TODO change the task signature to replace send_name with vendor_id\\n if not vendor_id:\\n vendor_id = get_sms_vendor_id(send_name)\\n if not vendor_id:\\n return\\n\\n sfmc.send_sms(mobile_number, vendor_id)\\n if optin:\\n add_sms_user_optin.delay(mobile_number)\\n\\n\\n@et_task\\ndef add_sms_user_optin(mobile_number):\\n record = {'Phone': mobile_number, 'SubscriberKey': mobile_number}\\n sfmc.add_row('Mobile_Subscribers', record)\\n\\n\\n@et_task\\ndef update_custom_unsub(token, reason):\\n \\\"\\\"\\\"Record a user's custom unsubscribe reason.\\\"\\\"\\\"\\n get_lock(token)\\n try:\\n sfdc.update({'token': token}, {'reason': reason})\\n except sfapi.SalesforceMalformedRequest:\\n # likely the record can't be found. nothing to do.\\n pass\\n\\n\\n@et_task\\ndef send_recovery_message_task(email):\\n user_data = get_user_data(email=email, extra_fields=['id'])\\n if not user_data:\\n log.debug(\\\"In send_recovery_message_task, email not known: %s\\\" % email)\\n return\\n\\n # make sure we have a language and format, no matter what ET returned\\n lang = user_data.get('lang', 'en') or 'en'\\n format = user_data.get('format', 'H') or 'H'\\n\\n if lang not in settings.RECOVER_MSG_LANGS:\\n lang = 'en'\\n\\n message_id = mogrify_message_id(RECOVERY_MESSAGE_ID, lang, format)\\n send_message.delay(message_id, email, user_data['id'], token=user_data['token'])\\n\\n\\n@et_task\\ndef record_common_voice_goals(data):\\n # do not change the sent data in place. A retry will use the changed data.\\n dcopy = data.copy()\\n email = dcopy.pop('email')\\n user_data = get_user_data(email=email, extra_fields=['id'])\\n new_data = {\\n 'source_url': 'https://voice.mozilla.org',\\n 'newsletters': [settings.COMMON_VOICE_NEWSLETTER],\\n }\\n for k, v in dcopy.items():\\n new_data['cv_' + k] = v\\n\\n if user_data:\\n sfdc.update(user_data, new_data)\\n else:\\n new_data.update({\\n 'email': email,\\n 'token': generate_token(),\\n })\\n sfdc.add(new_data)\\n\\n\\n@et_task\\ndef record_fxa_concerts_rsvp(email, is_firefox, campaign_id):\\n sfmc.add_row('FxAccounts_Concert_RSVP', {\\n 'Email': email,\\n 'Firefox': is_firefox,\\n 'Campaign_ID': campaign_id,\\n 'RSVP_Time': gmttime(),\\n })\\n\\n\\n@et_task\\ndef record_source_url(email, source_url, newsletter_id):\\n if not source_url:\\n source_url = '__NONE__'\\n else:\\n source_url = source_url[:1000]\\n\\n sfmc.add_row('NEWSLETTER_SOURCE_URLS', {\\n 'Email': email,\\n 'Signup_Source_URL__c': source_url,\\n 'Newsletter_Field_Name': newsletter_id,\\n 'Newsletter_Date': gmttime(),\\n })\\n\\n\\n@et_task\\ndef process_subhub_event_customer_created(data):\\n \\\"\\\"\\\"\\n Event name: customer.created\\n\\n Creates or updates a SFDC customer when a new payment processor/Stripe\\n customer is created\\n \\\"\\\"\\\"\\n statsd.incr('news.tasks.process_subhub_event.customer_created')\\n\\n first, last = split_name(data['name'])\\n contact_data = {\\n 'fxa_id': data['user_id'],\\n 'payee_id': data['customer_id']\\n }\\n\\n user_data = get_user_data(email=data['email'])\\n\\n # if user was found in sfdc, see if we should update their name(s)\\n if user_data:\\n # if current last name is '_', update it\\n if user_data['last_name'] == '_':\\n contact_data['last_name'] = last\\n\\n # if current last name is blank/Null, update it\\n if not user_data['first_name']:\\n contact_data['first_name'] = first\\n\\n sfdc.update(user_data, contact_data)\\n statsd.incr('news.tasks.process_subhub_event.customer_created.updated')\\n # if no user was found, create new user in sfdc\\n else:\\n contact_data['email'] = data['email']\\n contact_data['first_name'] = first\\n contact_data['last_name'] = last\\n\\n # create the user in sfdc\\n statsd.incr('news.tasks.process_subhub_event.customer_created.created')\\n sfdc.add(contact_data)\\n\\n\\n@et_task\\ndef process_subhub_event_subscription_charge(data):\\n \\\"\\\"\\\"\\n Event names: customer.subscription.created, customer.recurring_charge\\n\\n This method handles both new and recurring charges.\\n\\n Each of the handled events contains the same payload data. The only variation below\\n is in regards to Initial_Purchase__c, which will be True for the\\n `customer.subscription.created` event, and False for the `customer.recurring_charge`\\n event.\\n \\\"\\\"\\\"\\n\\n statsd.incr('news.tasks.process_subhub_event.subscription_charge')\\n user_data = get_user_data(payee_id=data['customer_id'],\\n extra_fields=['id'])\\n if not user_data:\\n statsd.incr('news.tasks.process_subhub_event.subscription_charge.user_not_found')\\n raise RetryTask('Could not find user. Try again.')\\n\\n nickname = data['nickname']\\n if isinstance(nickname, list):\\n nickname = nickname[0]\\n\\n # if a customer re-instates service after a cancellation, the record needs to be updated\\n oppy_data = {\\n 'Amount': cents_to_dollars(data['plan_amount']),\\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\\n 'Billing_Cycle_Start__c': iso_format_unix_timestamp(data['current_period_start']),\\n 'CloseDate': iso_format_unix_timestamp(data['created']),\\n 'Credit_Card_Type__c': data['brand'],\\n 'currency__c': data['currency'],\\n 'Donation_Contact__c': user_data['id'],\\n 'Event_Id__c': data['event_id'],\\n 'Event_Name__c': data['event_type'],\\n 'Initial_Purchase__c': data['event_type'] == 'customer.subscription.created',\\n 'Invoice_Number__c': data['invoice_number'],\\n 'Last_4_Digits__c': data['last4'],\\n 'Name': 'Subscription Services',\\n 'Next_Invoice_Date__c': iso_format_unix_timestamp(data['next_invoice_date']),\\n 'Payment_Source__c': 'Stripe',\\n 'PMT_Subscription_ID__c': data['subscription_id'],\\n 'PMT_Transaction_ID__c': data['charge'],\\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\\n 'Service_Plan__c': nickname,\\n 'StageName': 'Closed Won',\\n }\\n if 'proration_amount' in data:\\n oppy_data['Proration_Amount__c'] = cents_to_dollars(data['proration_amount'])\\n\\n if 'total_amount' in data:\\n oppy_data['Total_Amount__c'] = cents_to_dollars(data['total_amount'])\\n\\n sfdc.opportunity.upsert(f'PMT_Invoice_ID__c/{data[\\\"invoice_id\\\"]}', oppy_data)\\n\\n\\n@et_task\\ndef process_subhub_event_subscription_reactivated(data):\\n statsd.incr('news.tasks.process_subhub_event.subscription_reactivated')\\n user_data = get_user_data(payee_id=data['customer_id'],\\n extra_fields=['id'])\\n if not user_data:\\n statsd.incr('news.tasks.process_subhub_event.subscription_reactivated.user_not_found')\\n raise RetryTask('Could not find user. Try again.')\\n\\n nickname = data['nickname']\\n if isinstance(nickname, list):\\n nickname = nickname[0]\\n\\n sfdc.opportunity.create({\\n 'Amount': cents_to_dollars(data['plan_amount']),\\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\\n 'CloseDate': iso_format_unix_timestamp(data.get('close_date', time())),\\n 'Credit_Card_Type__c': data['brand'],\\n 'Last_4_Digits__c': data['last4'],\\n 'Donation_Contact__c': user_data['id'],\\n 'Event_Id__c': data['event_id'],\\n 'Event_Name__c': data['event_type'],\\n 'Name': 'Subscription Services',\\n 'Payment_Source__c': 'Stripe',\\n 'PMT_Subscription_ID__c': data['subscription_id'],\\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\\n 'Service_Plan__c': nickname,\\n 'StageName': 'Reactivation',\\n })\\n\\n\\n@et_task\\ndef process_subhub_event_subscription_updated(data):\\n statsd.incr('news.tasks.process_subhub_event.subscription_updated')\\n user_data = get_user_data(payee_id=data['customer_id'],\\n extra_fields=['id'])\\n if not user_data:\\n statsd.incr('news.tasks.process_subhub_event.subscription_updated.user_not_found')\\n raise RetryTask('Could not find user. Try again.')\\n\\n direction = 'Down' if data['event_type'].endswith('downgrade') else 'Up'\\n stage_name = f'Subscription {direction}grade'\\n sfdc.opportunity.create({\\n 'Amount': cents_to_dollars(data['plan_amount_new']),\\n 'Plan_Amount_Old__c': cents_to_dollars(data['plan_amount_old']),\\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\\n 'CloseDate': iso_format_unix_timestamp(data.get('close_date', time())),\\n 'Donation_Contact__c': user_data['id'],\\n 'Event_Id__c': data['event_id'],\\n 'Event_Name__c': data['event_type'],\\n 'Invoice_Number__c': data['invoice_number'],\\n 'Name': 'Subscription Services',\\n 'Payment_Interval__c': data['interval'],\\n 'Payment_Source__c': 'Stripe',\\n 'PMT_Invoice_ID__c': data['invoice_id'],\\n 'PMT_Subscription_ID__c': data['subscription_id'],\\n 'Proration_Amount__c': data['proration_amount'],\\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\\n 'Service_Plan__c': data['nickname_new'],\\n 'Nickname_Old__c': data['nickname_old'],\\n 'StageName': stage_name,\\n })\\n\\n\\nSUB_STAGE_NAMES = {\\n 'customer.subscription_cancelled': 'Subscription Canceled',\\n 'customer.deleted': 'Account Deleted',\\n}\\n\\n\\n@et_task\\ndef process_subhub_event_subscription_cancel(data):\\n \\\"\\\"\\\"\\n Event name: customer.subscription_cancelled or customer.deleted\\n \\\"\\\"\\\"\\n statsd.incr('news.tasks.process_subhub_event.subscription_cancel')\\n user_data = get_user_data(payee_id=data['customer_id'],\\n extra_fields=['id'])\\n if not user_data:\\n statsd.incr('news.tasks.process_subhub_event_subscription_cancel.user_not_found')\\n raise RetryTask('Could not find user. Try again.')\\n\\n nickname = data['nickname']\\n if isinstance(nickname, list):\\n nickname = nickname[0]\\n\\n sfdc.opportunity.create({\\n 'Amount': cents_to_dollars(data['plan_amount']),\\n 'Billing_Cycle_End__c': iso_format_unix_timestamp(data['current_period_end']),\\n 'Billing_Cycle_Start__c': iso_format_unix_timestamp(data['current_period_start']),\\n 'CloseDate': iso_format_unix_timestamp(data.get('cancel_at', time())),\\n 'Donation_Contact__c': user_data['id'],\\n 'Event_Id__c': data['event_id'],\\n 'Event_Name__c': data['event_type'],\\n 'Name': 'Subscription Services',\\n 'Payment_Source__c': 'Stripe',\\n 'PMT_Subscription_ID__c': data['subscription_id'],\\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\\n 'Service_Plan__c': nickname,\\n 'StageName': SUB_STAGE_NAMES[data['event_type']],\\n })\\n\\n if data['event_type'] == 'customer.deleted':\\n sfdc.update(user_data, {'fxa_deleted': True})\\n\\n\\n@et_task\\ndef process_subhub_event_credit_card_expiring(data):\\n \\\"\\\"\\\"\\n Event name: customer.source.expiring\\n \\\"\\\"\\\"\\n statsd.incr('news.tasks.process_subhub_event.credit_card_expiring')\\n sfmc.send_mail(settings.SUBHUB_CC_EXPIRE_TRIGGER, data['email'], data['email'])\\n\\n\\n@et_task\\ndef process_subhub_event_payment_failed(data):\\n \\\"\\\"\\\"\\n Event name: invoice.payment_failed\\n \\\"\\\"\\\"\\n statsd.incr('news.tasks.process_subhub_event.payment_failed')\\n\\n user_data = get_user_data(payee_id=data['customer_id'],\\n extra_fields=['id'])\\n # the only user identifiable information available is the payment\\n # processor/Stripe ID, so if the user wasn't found by that, there's really\\n # nothing to be done here but retry.\\n if not user_data:\\n statsd.incr('news.tasks.process_subhub_event.payment_failed.user_not_found')\\n raise RetryTask('Could not find user. Try again.')\\n\\n nickname = data['nickname']\\n if isinstance(nickname, list):\\n nickname = nickname[0]\\n\\n sfdc.opportunity.create({\\n 'Amount': cents_to_dollars(data['amount_due']),\\n 'CloseDate': iso_format_unix_timestamp(data['created']),\\n 'Donation_Contact__c': user_data['id'],\\n 'Event_Id__c': data['event_id'],\\n 'Event_Name__c': data['event_type'],\\n 'Name': 'Subscription Services',\\n 'PMT_Subscription_ID__c': data['subscription_id'],\\n 'PMT_Transaction_ID__c': data['charge_id'],\\n 'Payment_Source__c': 'Stripe',\\n 'RecordTypeId': settings.SUBHUB_OPP_RECORD_TYPE,\\n 'Service_Plan__c': nickname,\\n 'StageName': 'Payment Failed',\\n 'currency__c': data['currency'],\\n })\\n\\n\\n@et_task\\ndef process_donation_event(data):\\n \\\"\\\"\\\"Process a followup event on a donation\\\"\\\"\\\"\\n etype = data['event_type']\\n txn_id = data['transaction_id']\\n status = data.get('status')\\n statsd.incr('news.tasks.process_donation_event.{}'.format(etype))\\n if status:\\n statsd.incr('news.tasks.process_donation_event.{}.{}'.format(etype, status))\\n\\n if etype.startswith('charge.dispute.'):\\n if status not in ['charge_refunded', 'won', 'lost']:\\n # only care about the above statuses\\n statsd.incr('news.tasks.process_donation_event.{}.IGNORED'.format(etype))\\n return\\n elif etype == 'charge.refunded':\\n if status not in ['succeeded', 'failed', 'cancelled']:\\n # don't care about pending statuses\\n statsd.incr('news.tasks.process_donation_event.{}.IGNORED'.format(etype))\\n return\\n\\n if 'reason' in data:\\n reason_lost = data['reason']\\n else:\\n reason_lost = data['failure_code']\\n\\n try:\\n # will raise a SalesforceMalformedRequest if not found\\n sfdc.opportunity.update('PMT_Transaction_ID__c/{}'.format(txn_id), {\\n 'PMT_Type_Lost__c': etype,\\n 'PMT_Reason_Lost__c': reason_lost,\\n 'StageName': 'Closed Lost',\\n })\\n except sfapi.SalesforceMalformedRequest as e:\\n # we don't know about this tx_id. Let someone know.\\n do_notify = cache.add('donate-notify-{}'.format(txn_id), 1, 86400)\\n if do_notify and settings.DONATE_UPDATE_FAIL_DE:\\n sfmc.add_row(settings.DONATE_UPDATE_FAIL_DE, {\\n 'PMT_Transaction_ID__c': txn_id,\\n 'Payment_Type__c': etype,\\n 'PMT_Reason_Lost__c': reason_lost,\\n 'Error_Text': str(e)[:4000],\\n 'Date': gmttime(),\\n })\\n\\n if do_notify and settings.DONATE_NOTIFY_EMAIL:\\n # don't notify about a transaction more than once per day\\n first_mail = cache.add('donate-notify-{}'.format(txn_id), 1, 86400)\\n if first_mail:\\n body = render_to_string('news/donation_notify_email.txt', {\\n 'txn_id': txn_id,\\n 'type_lost': etype,\\n 'reason_lost': reason_lost,\\n 'server_name': settings.STATSD_PREFIX,\\n })\\n send_mail('Donation Record Not Found', body,\\n 'noreply@mozilla.com', [settings.DONATE_NOTIFY_EMAIL])\\n\\n # retry\\n raise\\n\\n\\n# all strings and truncated at 2000 chars\\nDONATION_OPTIONAL_FIELDS = {\\n 'SourceURL__c': 'source_url',\\n 'Donation_Form_URL__c': 'donation_url',\\n 'Project__c': 'project',\\n 'PMT_Subscription_ID__c': 'subscription_id',\\n 'Credit_Card_Type__c': 'card_type',\\n}\\n# Add these fields as optional for now as some messages\\n# could still come through without them. Mix of string\\n# and numerical data.\\nDONATION_NEW_FIELDS = {\\n 'Donation_Locale__c': 'locale',\\n 'Processors_Fee__c': 'transaction_fee',\\n 'Net_Amount__c': 'net_amount',\\n 'Conversion_Amount__c': 'conversion_amount',\\n 'Last_4_Digits__c': 'last_4',\\n}\\n\\n\\n@et_task\\ndef process_donation(data):\\n get_lock(data['email'])\\n # tells the backend to leave the \\\"subscriber\\\" flag alone\\n contact_data = {'_set_subscriber': False}\\n # do \\\"or ''\\\" because data can contain None values\\n first_name = (data.get('first_name') or '').strip()\\n last_name = (data.get('last_name') or '').strip()\\n if first_name and last_name:\\n contact_data['first_name'] = first_name\\n contact_data['last_name'] = last_name\\n elif first_name:\\n contact_data['first_name'] = first_name\\n elif last_name:\\n names = data['last_name'].rsplit(None, 1)\\n if len(names) == 2:\\n first, last = names\\n else:\\n first, last = '', names[0]\\n if first:\\n contact_data['first_name'] = first\\n if last:\\n contact_data['last_name'] = last\\n\\n user_data = get_user_data(email=data['email'],\\n extra_fields=['id'])\\n if user_data:\\n if contact_data and (\\n ('first_name' in contact_data and contact_data['first_name'] != user_data['first_name']) or\\n ('last_name' in contact_data and contact_data['last_name'] != user_data['last_name'])):\\n sfdc.update(user_data, contact_data)\\n else:\\n contact_data['token'] = generate_token()\\n contact_data['email'] = data['email']\\n contact_data['record_type'] = settings.DONATE_CONTACT_RECORD_TYPE\\n\\n # returns a dict with the new ID but no other user data, but that's enough here\\n user_data = sfdc.add(contact_data)\\n if not user_data.get('id'):\\n # retry here to make sure we associate the donation data with the proper account\\n raise RetryTask('User not yet available')\\n\\n # add opportunity\\n donation = {\\n 'RecordTypeId': settings.DONATE_OPP_RECORD_TYPE,\\n 'Name': 'Foundation Donation',\\n 'Donation_Contact__c': user_data['id'],\\n 'StageName': 'Closed Won',\\n 'Amount': float(data['donation_amount']),\\n 'Currency__c': data['currency'].upper(),\\n 'Payment_Source__c': data['service'],\\n 'PMT_Transaction_ID__c': data['transaction_id'],\\n 'Payment_Type__c': 'Recurring' if data['recurring'] else 'One-Time',\\n }\\n # this is a unix timestamp in ms since epoc\\n timestamp = data.get('created')\\n if timestamp:\\n donation['CloseDate'] = iso_format_unix_timestamp(timestamp)\\n\\n for dest_name, source_name in DONATION_NEW_FIELDS.items():\\n if source_name in data:\\n donation[dest_name] = data[source_name]\\n\\n for dest_name, source_name in DONATION_OPTIONAL_FIELDS.items():\\n if data.get(source_name):\\n # truncate at 2000 chars as that's the max for\\n # a SFDC text field. We may do more granular\\n # truncation per field in future.\\n donation[dest_name] = data[source_name][:2000]\\n\\n try:\\n sfdc.opportunity.create(donation)\\n except sfapi.SalesforceMalformedRequest as e:\\n if e.content and e.content[0].get('errorCode') == 'DUPLICATE_VALUE':\\n # already in the system, ignore\\n pass\\n else:\\n raise\\n\\n\\n@et_task\\ndef process_newsletter_subscribe(data):\\n data = data['form']\\n data['lang'] = get_best_supported_lang(data['lang'])\\n upsert_user(SUBSCRIBE, data)\\n\\n\\nPETITION_CONTACT_FIELDS = [\\n 'first_name',\\n 'last_name',\\n 'country',\\n 'postal_code',\\n 'source_url',\\n]\\n\\n\\n@et_task\\ndef process_petition_signature(data):\\n \\\"\\\"\\\"\\n Add petition signature to SFDC\\n \\\"\\\"\\\"\\n data = data['form']\\n get_lock(data['email'])\\n # tells the backend to leave the \\\"subscriber\\\" flag alone\\n contact_data = {'_set_subscriber': False}\\n contact_data.update({k: data[k] for k in PETITION_CONTACT_FIELDS if data.get(k)})\\n\\n user_data = get_user_data(email=data['email'],\\n extra_fields=['id'])\\n if user_data:\\n sfdc.update(user_data, contact_data)\\n else:\\n contact_data['token'] = generate_token()\\n contact_data['email'] = data['email']\\n contact_data['record_type'] = settings.DONATE_CONTACT_RECORD_TYPE\\n sfdc.add(contact_data)\\n # fetch again to get ID\\n user_data = get_user_data(email=data.get('email'),\\n extra_fields=['id'])\\n if not user_data:\\n # retry here to make sure we associate the donation data with the proper account\\n raise RetryTask('User not yet available')\\n\\n if data.get('email_subscription', False):\\n upsert_user.delay(SUBSCRIBE, {\\n 'token': user_data['token'],\\n 'lang': data.get('lang', 'en-US'),\\n 'newsletters': 'mozilla-foundation',\\n 'source_url': data['source_url'],\\n })\\n\\n campaign_member = {\\n 'CampaignId': data['campaign_id'],\\n 'ContactId': user_data['id'],\\n 'Full_URL__c': data['source_url'],\\n 'Status': 'Signed',\\n }\\n comments = data.get('comments')\\n if comments:\\n campaign_member['Petition_Comments__c'] = comments[:500]\\n\\n metadata = data.get('metadata')\\n if metadata:\\n campaign_member['Petition_Flex__c'] = json.dumps(metadata)[:500]\\n\\n try:\\n sfdc.campaign_member.create(campaign_member)\\n except sfapi.SalesforceMalformedRequest as e:\\n if e.content and e.content[0].get('errorCode') == 'DUPLICATE_VALUE':\\n # already in the system, ignore\\n pass\\n else:\\n raise\\n\\n\\ndef upsert_amo_user_data(data):\\n \\\"\\\"\\\"\\n Update AMO user data in the SFDC contact, or create a contact.\\n Return the Contact data (the contact ID at a minimum).\\n\\n :param data: dict of amo user data\\n :return: dict of SFDC contact data\\n \\\"\\\"\\\"\\n email = data.pop('email')\\n amo_id = data.pop('id')\\n amo_deleted = data.pop('deleted', False)\\n amo_data = {f'amo_{k}': v for k, v in data.items() if v}\\n amo_data['amo_user'] = not amo_deleted\\n user = get_user_data(amo_id=amo_id, extra_fields=['id', 'amo_id'])\\n if user:\\n sfdc.update(user, amo_data)\\n return user\\n\\n # include the ID in update or add since we couldn't find\\n # the user with this ID above\\n amo_data['amo_id'] = amo_id\\n user = get_user_data(email=email, extra_fields=['id'])\\n if user:\\n sfdc.update(user, amo_data)\\n # need amo_id for linking addons and authors\\n user['amo_id'] = amo_id\\n return user\\n\\n amo_data['email'] = email\\n amo_data['source_url'] = 'https://addons.mozilla.org/'\\n # returns only the new user ID in a dict, but that will work\\n # when passed to e.g. `sfdc.update()`\\n user = sfdc.add(amo_data)\\n # need amo_id for linking addons and authors\\n user['amo_id'] = amo_id\\n return user\\n\\n\\ndef amo_compress_categories(categories):\\n cats_list = []\\n for product, cats in categories.items():\\n cats_list.extend([f'{product}-{cat}' for cat in cats])\\n\\n return ','.join(cats_list)\\n\\n\\n@et_task\\ndef amo_sync_addon(data):\\n data = deepcopy(data)\\n users = [upsert_amo_user_data(author) for author in data['authors']]\\n addon_data = {\\n 'AMO_Category__c': amo_compress_categories(data['categories']),\\n 'AMO_Default_Language__c': data['default_locale'],\\n 'AMO_GUID__c': data['guid'],\\n 'AMO_Rating__c': data['ratings']['average'],\\n 'AMO_Slug__c': data['slug'],\\n 'AMO_Status__c': data['status'],\\n 'AMO_Type__c': data['type'],\\n 'AMO_Update__c': data['last_updated'],\\n 'Average_Daily_Users__c': data['average_daily_users'],\\n 'Dev_Disabled__c': 'Yes' if data['is_disabled'] else 'No',\\n }\\n # check for possible None or empty values\\n if data['name']:\\n addon_data['Name'] = data['name']\\n\\n # versions can be removed, so they should be removed if they are null\\n if data['current_version']:\\n addon_data['AMO_Current_Version__c'] = data['current_version']['version']\\n else:\\n addon_data['AMO_Current_Version__c'] = ''\\n\\n if data['latest_unlisted_version']:\\n addon_data['AMO_Current_Version_Unlisted__c'] = data['latest_unlisted_version']['version']\\n else:\\n addon_data['AMO_Current_Version_Unlisted__c'] = ''\\n\\n sfdc.addon.upsert(f'AMO_AddOn_Id__c/{data[\\\"id\\\"]}', addon_data)\\n addon_record = sfdc.addon.get_by_custom_id('AMO_AddOn_Id__c', data['id'])\\n for user in users:\\n try:\\n sfdc.dev_addon.upsert(f'ConcatenateAMOID__c/{user[\\\"amo_id\\\"]}-{data[\\\"id\\\"]}', {\\n 'AMO_AddOn_ID__c': addon_record['Id'],\\n 'AMO_Contact_ID__c': user['id'],\\n })\\n except sfapi.SalesforceMalformedRequest as e:\\n try:\\n if e.content[0]['errorCode'] == 'DUPLICATE_VALUE':\\n # dupe error, so we don't need to do this again\\n pass\\n else:\\n raise e\\n except Exception:\\n # if anything else goes wrong just retry\\n raise e\\n\\n\\n@et_task\\ndef amo_sync_user(data):\\n # copy input so it's not modified for retry\\n upsert_amo_user_data(data.copy())\\n\\n\\n@celery_app.task()\\ndef snitch(start_time=None):\\n if start_time is None:\\n snitch.delay(time())\\n return\\n\\n snitch_id = settings.SNITCH_ID\\n totalms = int((time() - start_time) * 1000)\\n statsd.timing('news.tasks.snitch.timing', totalms)\\n requests.post('https://nosnch.in/{}'.format(snitch_id), data={\\n 'm': totalms,\\n })\\n\",\n \"path\": \"basket/news/tasks.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/basket/news/tasks.py b/basket/news/tasks.py\nindex 17b28d1a8..d81075b18 100644\n--- a/basket/news/tasks.py\n+++ b/basket/news/tasks.py\n@@ -1042,6 +1042,7 @@ def process_donation_event(data):\n 'Donation_Form_URL__c': 'donation_url',\n 'Project__c': 'project',\n 'PMT_Subscription_ID__c': 'subscription_id',\n+ 'Credit_Card_Type__c': 'card_type',\n }\n # Add these fields as optional for now as some messages\n # could still come through without them. Mix of string\n"}}},{"rowIdx":4678,"cells":{"in_source_id":{"kind":"string","value":"rootpy__rootpy-723"},"issue":{"kind":"string","value":"AttributeError when using root_open\nI am pretty new to both root and rootpy. But this seams wrong Dont really know how to find the error. I am just trying to open a root file using rootpy and I get an AttributeError - No matter if the file exists or not.\r\n\r\nI can open a root file using PyROOT though. Any thoughts\r\n\r\nIpython session:\r\n```\r\nIn [1]: import ROOT\r\n\r\nIn [2]: ROOT.gROOT.GetVersion()\r\nOut[2]: '6.09/01'\r\n\r\nIn [3]: f = ROOT.TFile.Open(\"blah.root\", \"new\")\r\n\r\nIn [4]: from rootpy.io import root_open\r\n\r\nIn [5]: myfile = root_open('myfile.root', 'new')\r\n---------------------------------------------------------------------------\r\nAttributeError Traceback (most recent call last)\r\n<ipython-input-5-b3f40971348f> in <module>()\r\n----> 1 myfile = root_open('myfile.root', 'new')\r\n\r\n/usr/local/lib/python2.7/dist-packages/rootpy-0.8.3.dev0-py2.7.egg/rootpy/io/file.pyc in root_open(filename, mode)\r\n 135 \r\n 136 filename = expand_path(filename)\r\n--> 137 prev_dir = ROOT.gDirectory.func()\r\n 138 root_file = ROOT.R.TFile.Open(filename, mode)\r\n 139 if not root_file:\r\n\r\n/usr/local/lib/python2.7/dist-packages/rootpy-0.8.3.dev0-py2.7.egg/rootpy/utils/module_facade.pyc in __getattr__(self, key)\r\n 82 sup = super(_wrapper_cls, self)\r\n 83 if hasattr(sup, \"__getattr__\"):\r\n---> 84 result = sup.__getattr__(key)\r\n 85 if result is not None:\r\n 86 return result\r\n\r\n/usr/local/lib/python2.7/dist-packages/rootpy-0.8.3.dev0-py2.7.egg/rootpy/ROOT.pyc in __getattr__(self, what)\r\n 116 \r\n 117 # Memoize\r\n--> 118 setattr(self, what, result)\r\n 119 return result\r\n 120 \r\n\r\nAttributeError: can't set attribute\r\n\r\nIn [6]: from rootpy import asrootpy\r\n\r\nIn [7]: frpy = asrootpy(f)\r\n\r\nIn [8]: frpy.ls()\r\nTFile**\t\tblah.root\t\r\n TFile*\t\tblah.root\t\r\n\r\n```\n"},"before_files":{"kind":"list like","value":[{"content":"# Copyright 2012 the rootpy developers\n# distributed under the terms of the GNU General Public License\n\"\"\"\n:py:mod:`rootpy.ROOT`\n=====================\n\nThis module is intended to be a drop-in replacement for ordinary\nPyROOT imports by mimicking PyROOT's interface. If you find a case where it is\nnot, please report an issue to the rootpy developers.\n\nBoth ROOT and rootpy classes can be accessed in a harmonized way through this\nmodule. This means you can take advantage of rootpy classes automatically by\nreplacing ``import ROOT`` with ``import rootpy.ROOT as ROOT`` or\n``from rootpy import ROOT`` in your code, while maintaining backward\ncompatibility with existing use of ROOT's classes.\n\nROOT classes are automatically \"asrootpy'd\" *after* the constructor in ROOT has\nbeen called:\n\n.. sourcecode:: python\n\n >>> import rootpy.ROOT as ROOT\n >>> h = ROOT.TH1F('name', 'title', 10, 0, 1)\n >>> h\n Hist('name')\n >>> h.TYPE\n 'F'\n\nAlso access rootpy classes under this same module without needing to remember\nwhere to import them from in rootpy:\n\n.. sourcecode:: python\n\n >>> import rootpy.ROOT as ROOT\n >>> h = ROOT.Hist(10, 0, 1, name='name', type='F')\n >>> h\n Hist('name')\n >>> h.TYPE\n 'F'\n\nPlain old ROOT can still be accessed through the ``R`` property:\n\n.. sourcecode:: python\n\n >>> from rootpy import ROOT\n >>> ROOT.R.TFile\n <class 'ROOT.TFile'>\n\n\"\"\"\nfrom __future__ import absolute_import\n\nfrom copy import copy\n\nimport ROOT\n\nfrom . import asrootpy, lookup_rootpy, ROOT_VERSION\nfrom . import QROOT, stl\nfrom .utils.module_facade import Facade\n\n__all__ = []\n\n\ndef proxy_global(name, no_expand_macro=False):\n \"\"\"\n Used to automatically asrootpy ROOT's thread local variables\n \"\"\"\n if no_expand_macro: # pragma: no cover\n # handle older ROOT versions without _ExpandMacroFunction wrapping\n @property\n def gSomething_no_func(self):\n glob = self(getattr(ROOT, name))\n # create a fake func() that just returns self\n def func():\n return glob\n glob.func = func\n return glob\n return gSomething_no_func\n\n @property\n def gSomething(self):\n glob = getattr(ROOT, name)\n orig_func = glob.func\n\n def asrootpy_izing_func():\n return self(orig_func())\n\n # new_glob = copy(glob)\n new_glob = glob.__class__.__new__(glob.__class__)\n new_glob.func = asrootpy_izing_func\n # Memoize\n setattr(type(self), name, new_glob)\n return new_glob\n return gSomething\n\n\n@Facade(__name__, expose_internal=False)\nclass Module(object):\n\n __version__ = ROOT_VERSION\n\n def __call__(self, arg, after_init=False):\n return asrootpy(arg, warn=False, after_init=after_init)\n\n def __getattr__(self, what):\n try:\n # check ROOT\n result = self(getattr(ROOT, what), after_init=True)\n except AttributeError:\n # check rootpy\n result = lookup_rootpy(what)\n if result is None:\n raise AttributeError(\n 'ROOT does not have the attribute `{0}` '\n 'and rootpy does not contain the class `{0}`'.format(what))\n return result\n\n # Memoize\n setattr(self, what, result)\n return result\n\n @property\n def R(self):\n return ROOT\n\n gPad = proxy_global(\"gPad\")\n gVirtualX = proxy_global(\"gVirtualX\")\n\n if ROOT_VERSION < (5, 32, 0): # pragma: no cover\n # handle versions of ROOT older than 5.32.00\n gDirectory = proxy_global(\"gDirectory\", no_expand_macro=True)\n gFile = proxy_global(\"gFile\", no_expand_macro=True)\n gInterpreter = proxy_global(\"gInterpreter\", no_expand_macro=True)\n else:\n gDirectory = proxy_global(\"gDirectory\")\n gFile = proxy_global(\"gFile\")\n gInterpreter = proxy_global(\"gInterpreter\")\n\n # use the smart template STL types from rootpy.stl instead\n for t in QROOT.std.stlclasses:\n locals()[t] = getattr(stl, t)\n del t\n","path":"rootpy/ROOT.py"}],"string":"[\n {\n \"content\": \"# Copyright 2012 the rootpy developers\\n# distributed under the terms of the GNU General Public License\\n\\\"\\\"\\\"\\n:py:mod:`rootpy.ROOT`\\n=====================\\n\\nThis module is intended to be a drop-in replacement for ordinary\\nPyROOT imports by mimicking PyROOT's interface. If you find a case where it is\\nnot, please report an issue to the rootpy developers.\\n\\nBoth ROOT and rootpy classes can be accessed in a harmonized way through this\\nmodule. This means you can take advantage of rootpy classes automatically by\\nreplacing ``import ROOT`` with ``import rootpy.ROOT as ROOT`` or\\n``from rootpy import ROOT`` in your code, while maintaining backward\\ncompatibility with existing use of ROOT's classes.\\n\\nROOT classes are automatically \\\"asrootpy'd\\\" *after* the constructor in ROOT has\\nbeen called:\\n\\n.. sourcecode:: python\\n\\n >>> import rootpy.ROOT as ROOT\\n >>> h = ROOT.TH1F('name', 'title', 10, 0, 1)\\n >>> h\\n Hist('name')\\n >>> h.TYPE\\n 'F'\\n\\nAlso access rootpy classes under this same module without needing to remember\\nwhere to import them from in rootpy:\\n\\n.. sourcecode:: python\\n\\n >>> import rootpy.ROOT as ROOT\\n >>> h = ROOT.Hist(10, 0, 1, name='name', type='F')\\n >>> h\\n Hist('name')\\n >>> h.TYPE\\n 'F'\\n\\nPlain old ROOT can still be accessed through the ``R`` property:\\n\\n.. sourcecode:: python\\n\\n >>> from rootpy import ROOT\\n >>> ROOT.R.TFile\\n <class 'ROOT.TFile'>\\n\\n\\\"\\\"\\\"\\nfrom __future__ import absolute_import\\n\\nfrom copy import copy\\n\\nimport ROOT\\n\\nfrom . import asrootpy, lookup_rootpy, ROOT_VERSION\\nfrom . import QROOT, stl\\nfrom .utils.module_facade import Facade\\n\\n__all__ = []\\n\\n\\ndef proxy_global(name, no_expand_macro=False):\\n \\\"\\\"\\\"\\n Used to automatically asrootpy ROOT's thread local variables\\n \\\"\\\"\\\"\\n if no_expand_macro: # pragma: no cover\\n # handle older ROOT versions without _ExpandMacroFunction wrapping\\n @property\\n def gSomething_no_func(self):\\n glob = self(getattr(ROOT, name))\\n # create a fake func() that just returns self\\n def func():\\n return glob\\n glob.func = func\\n return glob\\n return gSomething_no_func\\n\\n @property\\n def gSomething(self):\\n glob = getattr(ROOT, name)\\n orig_func = glob.func\\n\\n def asrootpy_izing_func():\\n return self(orig_func())\\n\\n # new_glob = copy(glob)\\n new_glob = glob.__class__.__new__(glob.__class__)\\n new_glob.func = asrootpy_izing_func\\n # Memoize\\n setattr(type(self), name, new_glob)\\n return new_glob\\n return gSomething\\n\\n\\n@Facade(__name__, expose_internal=False)\\nclass Module(object):\\n\\n __version__ = ROOT_VERSION\\n\\n def __call__(self, arg, after_init=False):\\n return asrootpy(arg, warn=False, after_init=after_init)\\n\\n def __getattr__(self, what):\\n try:\\n # check ROOT\\n result = self(getattr(ROOT, what), after_init=True)\\n except AttributeError:\\n # check rootpy\\n result = lookup_rootpy(what)\\n if result is None:\\n raise AttributeError(\\n 'ROOT does not have the attribute `{0}` '\\n 'and rootpy does not contain the class `{0}`'.format(what))\\n return result\\n\\n # Memoize\\n setattr(self, what, result)\\n return result\\n\\n @property\\n def R(self):\\n return ROOT\\n\\n gPad = proxy_global(\\\"gPad\\\")\\n gVirtualX = proxy_global(\\\"gVirtualX\\\")\\n\\n if ROOT_VERSION < (5, 32, 0): # pragma: no cover\\n # handle versions of ROOT older than 5.32.00\\n gDirectory = proxy_global(\\\"gDirectory\\\", no_expand_macro=True)\\n gFile = proxy_global(\\\"gFile\\\", no_expand_macro=True)\\n gInterpreter = proxy_global(\\\"gInterpreter\\\", no_expand_macro=True)\\n else:\\n gDirectory = proxy_global(\\\"gDirectory\\\")\\n gFile = proxy_global(\\\"gFile\\\")\\n gInterpreter = proxy_global(\\\"gInterpreter\\\")\\n\\n # use the smart template STL types from rootpy.stl instead\\n for t in QROOT.std.stlclasses:\\n locals()[t] = getattr(stl, t)\\n del t\\n\",\n \"path\": \"rootpy/ROOT.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# Copyright 2012 the rootpy developers\n# distributed under the terms of the GNU General Public License\n\"\"\"\n:py:mod:`rootpy.ROOT`\n=====================\n\nThis module is intended to be a drop-in replacement for ordinary\nPyROOT imports by mimicking PyROOT's interface. If you find a case where it is\nnot, please report an issue to the rootpy developers.\n\nBoth ROOT and rootpy classes can be accessed in a harmonized way through this\nmodule. This means you can take advantage of rootpy classes automatically by\nreplacing ``import ROOT`` with ``import rootpy.ROOT as ROOT`` or\n``from rootpy import ROOT`` in your code, while maintaining backward\ncompatibility with existing use of ROOT's classes.\n\nROOT classes are automatically \"asrootpy'd\" *after* the constructor in ROOT has\nbeen called:\n\n.. sourcecode:: python\n\n >>> import rootpy.ROOT as ROOT\n >>> h = ROOT.TH1F('name', 'title', 10, 0, 1)\n >>> h\n Hist('name')\n >>> h.TYPE\n 'F'\n\nAlso access rootpy classes under this same module without needing to remember\nwhere to import them from in rootpy:\n\n.. sourcecode:: python\n\n >>> import rootpy.ROOT as ROOT\n >>> h = ROOT.Hist(10, 0, 1, name='name', type='F')\n >>> h\n Hist('name')\n >>> h.TYPE\n 'F'\n\nPlain old ROOT can still be accessed through the ``R`` property:\n\n.. sourcecode:: python\n\n >>> from rootpy import ROOT\n >>> ROOT.R.TFile\n <class 'ROOT.TFile'>\n\n\"\"\"\nfrom __future__ import absolute_import\n\nfrom copy import copy\n\nimport ROOT\n\nfrom . import asrootpy, lookup_rootpy, ROOT_VERSION\nfrom . import QROOT, stl\nfrom .utils.module_facade import Facade\n\n__all__ = []\n\n\ndef proxy_global(name, no_expand_macro=False):\n \"\"\"\n Used to automatically asrootpy ROOT's thread local variables\n \"\"\"\n if no_expand_macro: # pragma: no cover\n # handle older ROOT versions without _ExpandMacroFunction wrapping\n @property\n def gSomething_no_func(self):\n glob = self(getattr(ROOT, name))\n # create a fake func() that just returns self\n def func():\n return glob\n glob.func = func\n return glob\n return gSomething_no_func\n\n @property\n def gSomething(self):\n glob = getattr(ROOT, name)\n orig_func = glob.func\n\n def asrootpy_izing_func():\n return self(orig_func())\n\n # new_glob = copy(glob)\n new_glob = glob.__class__.__new__(glob.__class__)\n new_glob.func = asrootpy_izing_func\n # Memoize\n setattr(type(self), name, new_glob)\n return new_glob\n return gSomething\n\n\n@Facade(__name__, expose_internal=False)\nclass Module(object):\n\n __version__ = ROOT_VERSION\n\n def __call__(self, arg, after_init=False):\n return asrootpy(arg, warn=False, after_init=after_init)\n\n def __getattr__(self, what):\n try:\n # check ROOT\n result = self(getattr(ROOT, what), after_init=True)\n except AttributeError:\n # check rootpy\n result = lookup_rootpy(what)\n if result is None:\n raise AttributeError(\n 'ROOT does not have the attribute `{0}` '\n 'and rootpy does not contain the class `{0}`'.format(what))\n return result\n\n try:\n # Memoize\n setattr(self, what, result)\n except AttributeError:\n # Oops... Oh well. I tried.\n pass\n\n return result\n\n @property\n def R(self):\n return ROOT\n\n gPad = proxy_global(\"gPad\")\n gVirtualX = proxy_global(\"gVirtualX\")\n\n if ROOT_VERSION < (5, 32, 0): # pragma: no cover\n # handle versions of ROOT older than 5.32.00\n gDirectory = proxy_global(\"gDirectory\", no_expand_macro=True)\n gFile = proxy_global(\"gFile\", no_expand_macro=True)\n gInterpreter = proxy_global(\"gInterpreter\", no_expand_macro=True)\n else:\n gDirectory = proxy_global(\"gDirectory\")\n gFile = proxy_global(\"gFile\")\n gInterpreter = proxy_global(\"gInterpreter\")\n\n # use the smart template STL types from rootpy.stl instead\n for t in QROOT.std.stlclasses:\n locals()[t] = getattr(stl, t)\n del t\n","path":"rootpy/ROOT.py"}],"string":"[\n {\n \"content\": \"# Copyright 2012 the rootpy developers\\n# distributed under the terms of the GNU General Public License\\n\\\"\\\"\\\"\\n:py:mod:`rootpy.ROOT`\\n=====================\\n\\nThis module is intended to be a drop-in replacement for ordinary\\nPyROOT imports by mimicking PyROOT's interface. If you find a case where it is\\nnot, please report an issue to the rootpy developers.\\n\\nBoth ROOT and rootpy classes can be accessed in a harmonized way through this\\nmodule. This means you can take advantage of rootpy classes automatically by\\nreplacing ``import ROOT`` with ``import rootpy.ROOT as ROOT`` or\\n``from rootpy import ROOT`` in your code, while maintaining backward\\ncompatibility with existing use of ROOT's classes.\\n\\nROOT classes are automatically \\\"asrootpy'd\\\" *after* the constructor in ROOT has\\nbeen called:\\n\\n.. sourcecode:: python\\n\\n >>> import rootpy.ROOT as ROOT\\n >>> h = ROOT.TH1F('name', 'title', 10, 0, 1)\\n >>> h\\n Hist('name')\\n >>> h.TYPE\\n 'F'\\n\\nAlso access rootpy classes under this same module without needing to remember\\nwhere to import them from in rootpy:\\n\\n.. sourcecode:: python\\n\\n >>> import rootpy.ROOT as ROOT\\n >>> h = ROOT.Hist(10, 0, 1, name='name', type='F')\\n >>> h\\n Hist('name')\\n >>> h.TYPE\\n 'F'\\n\\nPlain old ROOT can still be accessed through the ``R`` property:\\n\\n.. sourcecode:: python\\n\\n >>> from rootpy import ROOT\\n >>> ROOT.R.TFile\\n <class 'ROOT.TFile'>\\n\\n\\\"\\\"\\\"\\nfrom __future__ import absolute_import\\n\\nfrom copy import copy\\n\\nimport ROOT\\n\\nfrom . import asrootpy, lookup_rootpy, ROOT_VERSION\\nfrom . import QROOT, stl\\nfrom .utils.module_facade import Facade\\n\\n__all__ = []\\n\\n\\ndef proxy_global(name, no_expand_macro=False):\\n \\\"\\\"\\\"\\n Used to automatically asrootpy ROOT's thread local variables\\n \\\"\\\"\\\"\\n if no_expand_macro: # pragma: no cover\\n # handle older ROOT versions without _ExpandMacroFunction wrapping\\n @property\\n def gSomething_no_func(self):\\n glob = self(getattr(ROOT, name))\\n # create a fake func() that just returns self\\n def func():\\n return glob\\n glob.func = func\\n return glob\\n return gSomething_no_func\\n\\n @property\\n def gSomething(self):\\n glob = getattr(ROOT, name)\\n orig_func = glob.func\\n\\n def asrootpy_izing_func():\\n return self(orig_func())\\n\\n # new_glob = copy(glob)\\n new_glob = glob.__class__.__new__(glob.__class__)\\n new_glob.func = asrootpy_izing_func\\n # Memoize\\n setattr(type(self), name, new_glob)\\n return new_glob\\n return gSomething\\n\\n\\n@Facade(__name__, expose_internal=False)\\nclass Module(object):\\n\\n __version__ = ROOT_VERSION\\n\\n def __call__(self, arg, after_init=False):\\n return asrootpy(arg, warn=False, after_init=after_init)\\n\\n def __getattr__(self, what):\\n try:\\n # check ROOT\\n result = self(getattr(ROOT, what), after_init=True)\\n except AttributeError:\\n # check rootpy\\n result = lookup_rootpy(what)\\n if result is None:\\n raise AttributeError(\\n 'ROOT does not have the attribute `{0}` '\\n 'and rootpy does not contain the class `{0}`'.format(what))\\n return result\\n\\n try:\\n # Memoize\\n setattr(self, what, result)\\n except AttributeError:\\n # Oops... Oh well. I tried.\\n pass\\n\\n return result\\n\\n @property\\n def R(self):\\n return ROOT\\n\\n gPad = proxy_global(\\\"gPad\\\")\\n gVirtualX = proxy_global(\\\"gVirtualX\\\")\\n\\n if ROOT_VERSION < (5, 32, 0): # pragma: no cover\\n # handle versions of ROOT older than 5.32.00\\n gDirectory = proxy_global(\\\"gDirectory\\\", no_expand_macro=True)\\n gFile = proxy_global(\\\"gFile\\\", no_expand_macro=True)\\n gInterpreter = proxy_global(\\\"gInterpreter\\\", no_expand_macro=True)\\n else:\\n gDirectory = proxy_global(\\\"gDirectory\\\")\\n gFile = proxy_global(\\\"gFile\\\")\\n gInterpreter = proxy_global(\\\"gInterpreter\\\")\\n\\n # use the smart template STL types from rootpy.stl instead\\n for t in QROOT.std.stlclasses:\\n locals()[t] = getattr(stl, t)\\n del t\\n\",\n \"path\": \"rootpy/ROOT.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/rootpy/ROOT.py b/rootpy/ROOT.py\nindex 8f843c96..4553253f 100644\n--- a/rootpy/ROOT.py\n+++ b/rootpy/ROOT.py\n@@ -114,8 +114,13 @@ def __getattr__(self, what):\n 'and rootpy does not contain the class `{0}`'.format(what))\n return result\n \n- # Memoize\n- setattr(self, what, result)\n+ try:\n+ # Memoize\n+ setattr(self, what, result)\n+ except AttributeError:\n+ # Oops... Oh well. I tried.\n+ pass\n+\n return result\n \n @property\n"}}},{"rowIdx":4679,"cells":{"in_source_id":{"kind":"string","value":"celery__celery-6288"},"issue":{"kind":"string","value":"stop loading pytest plugin by default\ncurrently celery, by default, will add a set of fixtures and a mark, which can be confusing to new developers on a project when running `pytest --fixtures` and begin using them even through we've not yet opted into and started configuring them.\r\n\r\nAn alternative is to use an approach like https://github.com/aio-libs/pytest-aiohttp/ where there is a shim package that just lists an entrypoint, and depends on aiohttp.\r\n\r\nThose that don't want to install the shim package can add `pytest_plugins = 'celery.contrib.pytest'` to their `pytest.ini`\r\n\r\n\r\n\r\n<!--\r\nPlease fill this template entirely and do not erase parts of it.\r\nWe reserve the right to close without a response\r\nfeature requests which are incomplete.\r\n-->\r\n# Checklist\r\n<!--\r\nTo check an item on the list replace [ ] with [x].\r\n-->\r\n\r\n- [ ] I have checked the [issues list](https://github.com/celery/celery/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A%22Issue+Type%3A+Feature+Request%22+)\r\n for similar or identical feature requests.\r\n- [ ] I have checked the [pull requests list](https://github.com/celery/celery/pulls?utf8=%E2%9C%93&q=is%3Apr+label%3A%22PR+Type%3A+Feature%22+)\r\n for existing proposed implementations of this feature.\r\n- [ ] I have checked the [commit log](https://github.com/celery/celery/commits/master)\r\n to find out if the if the same feature was already implemented in the\r\n master branch.\r\n- [ ] I have included all related issues and possible duplicate issues\r\n in this issue (If there are none, check this box anyway).\r\n\r\n## Related Issues and Possible Duplicates\r\n<!--\r\nPlease make sure to search and mention any related issues\r\nor possible duplicates to this issue as requested by the checklist above.\r\n\r\nThis may or may not include issues in other repositories that the Celery project\r\nmaintains or other repositories that are dependencies of Celery.\r\n\r\nIf you don't know how to mention issues, please refer to Github's documentation\r\non the subject: https://help.github.com/en/articles/autolinked-references-and-urls#issues-and-pull-requests\r\n-->\r\n\r\n#### Related Issues\r\n\r\n- None\r\n\r\n#### Possible Duplicates\r\n\r\n- None\r\n\r\n# Brief Summary\r\n<!--\r\nPlease include a brief summary of what the feature does\r\nand why it is needed.\r\n-->\r\n\r\n# Design\r\n\r\n## Architectural Considerations\r\n<!--\r\nIf more components other than Celery are involved,\r\ndescribe them here and the effect it would have on Celery.\r\n-->\r\nNone\r\n\r\n## Proposed Behavior\r\n<!--\r\nPlease describe in detail how this feature is going to behave.\r\nDescribe what happens in case of failures as well if applicable.\r\n-->\r\n\r\n## Proposed UI/UX\r\n<!--\r\nPlease provide your ideas for the API, CLI options,\r\nconfiguration key names etc. that will be introduced for this feature.\r\n-->\r\n\r\n## Diagrams\r\n<!--\r\nPlease include any diagrams that might be relevant\r\nto the implementation of this feature such as:\r\n* Class Diagrams\r\n* Sequence Diagrams\r\n* Activity Diagrams\r\nYou can drag and drop images into the text box to attach them to this issue.\r\n-->\r\nN/A\r\n\r\n## Alternatives\r\n<!--\r\nIf you have considered any alternative implementations\r\ndescribe them in detail below.\r\n-->\r\nNone\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"#!/usr/bin/env python\n# -*- coding: utf-8 -*-\nimport codecs\nimport os\nimport re\nimport sys\n\nimport setuptools\nimport setuptools.command.test\n\ntry:\n from platform import python_implementation as _pyimp\nexcept (AttributeError, ImportError):\n def _pyimp():\n return 'Python (unknown)'\n\nNAME = 'celery'\n\n# -*- Python Versions -*-\n\nE_UNSUPPORTED_PYTHON = \"\"\"\n----------------------------------------\n Celery 4.0 requires %s %s or later\n----------------------------------------\n\n- For CPython 2.6, PyPy 1.x, Jython 2.6, CPython 3.2->3.3; use Celery 3.1:\n\n $ pip install 'celery<4'\n\n- For CPython 2.5, Jython 2.5; use Celery 3.0:\n\n $ pip install 'celery<3.1'\n\n- For CPython 2.4; use Celery 2.2:\n\n $ pip install 'celery<2.3'\n\"\"\"\n\nPYIMP = _pyimp()\nPY26_OR_LESS = sys.version_info < (2, 7)\nPY3 = sys.version_info[0] == 3\nPY34_OR_LESS = PY3 and sys.version_info < (3, 5)\nPYPY_VERSION = getattr(sys, 'pypy_version_info', None)\nPYPY = PYPY_VERSION is not None\nPYPY24_ATLEAST = PYPY_VERSION and PYPY_VERSION >= (2, 4)\n\nif PY26_OR_LESS:\n raise Exception(E_UNSUPPORTED_PYTHON % (PYIMP, '2.7'))\nelif PY34_OR_LESS and not PYPY24_ATLEAST:\n raise Exception(E_UNSUPPORTED_PYTHON % (PYIMP, '3.5'))\n\n# -*- Extras -*-\n\nEXTENSIONS = {\n 'arangodb',\n 'auth',\n 'azureblockblob',\n 'brotli',\n 'cassandra',\n 'consul',\n 'cosmosdbsql',\n 'couchbase',\n 'couchdb',\n 'django',\n 'dynamodb',\n 'elasticsearch',\n 'eventlet',\n 'gevent',\n 'librabbitmq',\n 'lzma',\n 'memcache',\n 'mongodb',\n 'msgpack',\n 'pymemcache',\n 'pyro',\n 'redis',\n 'riak',\n 's3',\n 'slmq',\n 'solar',\n 'sqlalchemy',\n 'sqs',\n 'tblib',\n 'yaml',\n 'zookeeper',\n 'zstd'\n}\n\n# -*- Distribution Meta -*-\n\nre_meta = re.compile(r'__(\\w+?)__\\s*=\\s*(.*)')\nre_doc = re.compile(r'^\"\"\"(.+?)\"\"\"')\n\n\ndef _add_default(m):\n attr_name, attr_value = m.groups()\n return ((attr_name, attr_value.strip(\"\\\"'\")),)\n\n\ndef _add_doc(m):\n return (('doc', m.groups()[0]),)\n\n\ndef parse_dist_meta():\n \"\"\"Extract metadata information from ``$dist/__init__.py``.\"\"\"\n pats = {re_meta: _add_default, re_doc: _add_doc}\n here = os.path.abspath(os.path.dirname(__file__))\n with open(os.path.join(here, NAME, '__init__.py')) as meta_fh:\n distmeta = {}\n for line in meta_fh:\n if line.strip() == '# -eof meta-':\n break\n for pattern, handler in pats.items():\n m = pattern.match(line.strip())\n if m:\n distmeta.update(handler(m))\n return distmeta\n\n# -*- Requirements -*-\n\n\ndef _strip_comments(l):\n return l.split('#', 1)[0].strip()\n\n\ndef _pip_requirement(req):\n if req.startswith('-r '):\n _, path = req.split()\n return reqs(*path.split('/'))\n return [req]\n\n\ndef _reqs(*f):\n return [\n _pip_requirement(r) for r in (\n _strip_comments(l) for l in open(\n os.path.join(os.getcwd(), 'requirements', *f)).readlines()\n ) if r]\n\n\ndef reqs(*f):\n \"\"\"Parse requirement file.\n\n Example:\n reqs('default.txt') # requirements/default.txt\n reqs('extras', 'redis.txt') # requirements/extras/redis.txt\n Returns:\n List[str]: list of requirements specified in the file.\n \"\"\"\n return [req for subreq in _reqs(*f) for req in subreq]\n\n\ndef extras(*p):\n \"\"\"Parse requirement in the requirements/extras/ directory.\"\"\"\n return reqs('extras', *p)\n\n\ndef install_requires():\n \"\"\"Get list of requirements required for installation.\"\"\"\n return reqs('default.txt')\n\n\ndef extras_require():\n \"\"\"Get map of all extra requirements.\"\"\"\n return {x: extras(x + '.txt') for x in EXTENSIONS}\n\n# -*- Long Description -*-\n\n\ndef long_description():\n try:\n return codecs.open('README.rst', 'r', 'utf-8').read()\n except IOError:\n return 'Long description error: Missing README.rst file'\n\n# -*- Command: setup.py test -*-\n\n\nclass pytest(setuptools.command.test.test):\n user_options = [('pytest-args=', 'a', 'Arguments to pass to py.test')]\n\n def initialize_options(self):\n setuptools.command.test.test.initialize_options(self)\n self.pytest_args = []\n\n def run_tests(self):\n import pytest as _pytest\n sys.exit(_pytest.main(self.pytest_args))\n\n# -*- %%% -*-\n\n\nmeta = parse_dist_meta()\nsetuptools.setup(\n name=NAME,\n packages=setuptools.find_packages(exclude=['t', 't.*']),\n version=meta['version'],\n description=meta['doc'],\n long_description=long_description(),\n keywords=meta['keywords'],\n author=meta['author'],\n author_email=meta['contact'],\n url=meta['homepage'],\n license='BSD',\n platforms=['any'],\n install_requires=install_requires(),\n python_requires=\">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*\",\n tests_require=reqs('test.txt'),\n extras_require=extras_require(),\n cmdclass={'test': pytest},\n include_package_data=True,\n zip_safe=False,\n entry_points={\n 'console_scripts': [\n 'celery = celery.__main__:main',\n ],\n 'pytest11': [\n 'celery = celery.contrib.pytest',\n ],\n },\n project_urls={\n \"Documentation\": \"http://docs.celeryproject.org/en/latest/index.html\",\n \"Code\": \"https://github.com/celery/celery\",\n \"Tracker\": \"https://github.com/celery/celery/issues\",\n \"Funding\": \"https://opencollective.com/celery\"\n },\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"License :: OSI Approved :: BSD License\",\n \"Topic :: System :: Distributed Computing\",\n \"Topic :: Software Development :: Object Brokering\",\n \"Programming Language :: Python\",\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 :: 3.8\",\n \"Programming Language :: Python :: Implementation :: CPython\",\n \"Programming Language :: Python :: Implementation :: PyPy\",\n \"Operating System :: OS Independent\"\n ]\n)\n","path":"setup.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/env python\\n# -*- coding: utf-8 -*-\\nimport codecs\\nimport os\\nimport re\\nimport sys\\n\\nimport setuptools\\nimport setuptools.command.test\\n\\ntry:\\n from platform import python_implementation as _pyimp\\nexcept (AttributeError, ImportError):\\n def _pyimp():\\n return 'Python (unknown)'\\n\\nNAME = 'celery'\\n\\n# -*- Python Versions -*-\\n\\nE_UNSUPPORTED_PYTHON = \\\"\\\"\\\"\\n----------------------------------------\\n Celery 4.0 requires %s %s or later\\n----------------------------------------\\n\\n- For CPython 2.6, PyPy 1.x, Jython 2.6, CPython 3.2->3.3; use Celery 3.1:\\n\\n $ pip install 'celery<4'\\n\\n- For CPython 2.5, Jython 2.5; use Celery 3.0:\\n\\n $ pip install 'celery<3.1'\\n\\n- For CPython 2.4; use Celery 2.2:\\n\\n $ pip install 'celery<2.3'\\n\\\"\\\"\\\"\\n\\nPYIMP = _pyimp()\\nPY26_OR_LESS = sys.version_info < (2, 7)\\nPY3 = sys.version_info[0] == 3\\nPY34_OR_LESS = PY3 and sys.version_info < (3, 5)\\nPYPY_VERSION = getattr(sys, 'pypy_version_info', None)\\nPYPY = PYPY_VERSION is not None\\nPYPY24_ATLEAST = PYPY_VERSION and PYPY_VERSION >= (2, 4)\\n\\nif PY26_OR_LESS:\\n raise Exception(E_UNSUPPORTED_PYTHON % (PYIMP, '2.7'))\\nelif PY34_OR_LESS and not PYPY24_ATLEAST:\\n raise Exception(E_UNSUPPORTED_PYTHON % (PYIMP, '3.5'))\\n\\n# -*- Extras -*-\\n\\nEXTENSIONS = {\\n 'arangodb',\\n 'auth',\\n 'azureblockblob',\\n 'brotli',\\n 'cassandra',\\n 'consul',\\n 'cosmosdbsql',\\n 'couchbase',\\n 'couchdb',\\n 'django',\\n 'dynamodb',\\n 'elasticsearch',\\n 'eventlet',\\n 'gevent',\\n 'librabbitmq',\\n 'lzma',\\n 'memcache',\\n 'mongodb',\\n 'msgpack',\\n 'pymemcache',\\n 'pyro',\\n 'redis',\\n 'riak',\\n 's3',\\n 'slmq',\\n 'solar',\\n 'sqlalchemy',\\n 'sqs',\\n 'tblib',\\n 'yaml',\\n 'zookeeper',\\n 'zstd'\\n}\\n\\n# -*- Distribution Meta -*-\\n\\nre_meta = re.compile(r'__(\\\\w+?)__\\\\s*=\\\\s*(.*)')\\nre_doc = re.compile(r'^\\\"\\\"\\\"(.+?)\\\"\\\"\\\"')\\n\\n\\ndef _add_default(m):\\n attr_name, attr_value = m.groups()\\n return ((attr_name, attr_value.strip(\\\"\\\\\\\"'\\\")),)\\n\\n\\ndef _add_doc(m):\\n return (('doc', m.groups()[0]),)\\n\\n\\ndef parse_dist_meta():\\n \\\"\\\"\\\"Extract metadata information from ``$dist/__init__.py``.\\\"\\\"\\\"\\n pats = {re_meta: _add_default, re_doc: _add_doc}\\n here = os.path.abspath(os.path.dirname(__file__))\\n with open(os.path.join(here, NAME, '__init__.py')) as meta_fh:\\n distmeta = {}\\n for line in meta_fh:\\n if line.strip() == '# -eof meta-':\\n break\\n for pattern, handler in pats.items():\\n m = pattern.match(line.strip())\\n if m:\\n distmeta.update(handler(m))\\n return distmeta\\n\\n# -*- Requirements -*-\\n\\n\\ndef _strip_comments(l):\\n return l.split('#', 1)[0].strip()\\n\\n\\ndef _pip_requirement(req):\\n if req.startswith('-r '):\\n _, path = req.split()\\n return reqs(*path.split('/'))\\n return [req]\\n\\n\\ndef _reqs(*f):\\n return [\\n _pip_requirement(r) for r in (\\n _strip_comments(l) for l in open(\\n os.path.join(os.getcwd(), 'requirements', *f)).readlines()\\n ) if r]\\n\\n\\ndef reqs(*f):\\n \\\"\\\"\\\"Parse requirement file.\\n\\n Example:\\n reqs('default.txt') # requirements/default.txt\\n reqs('extras', 'redis.txt') # requirements/extras/redis.txt\\n Returns:\\n List[str]: list of requirements specified in the file.\\n \\\"\\\"\\\"\\n return [req for subreq in _reqs(*f) for req in subreq]\\n\\n\\ndef extras(*p):\\n \\\"\\\"\\\"Parse requirement in the requirements/extras/ directory.\\\"\\\"\\\"\\n return reqs('extras', *p)\\n\\n\\ndef install_requires():\\n \\\"\\\"\\\"Get list of requirements required for installation.\\\"\\\"\\\"\\n return reqs('default.txt')\\n\\n\\ndef extras_require():\\n \\\"\\\"\\\"Get map of all extra requirements.\\\"\\\"\\\"\\n return {x: extras(x + '.txt') for x in EXTENSIONS}\\n\\n# -*- Long Description -*-\\n\\n\\ndef long_description():\\n try:\\n return codecs.open('README.rst', 'r', 'utf-8').read()\\n except IOError:\\n return 'Long description error: Missing README.rst file'\\n\\n# -*- Command: setup.py test -*-\\n\\n\\nclass pytest(setuptools.command.test.test):\\n user_options = [('pytest-args=', 'a', 'Arguments to pass to py.test')]\\n\\n def initialize_options(self):\\n setuptools.command.test.test.initialize_options(self)\\n self.pytest_args = []\\n\\n def run_tests(self):\\n import pytest as _pytest\\n sys.exit(_pytest.main(self.pytest_args))\\n\\n# -*- %%% -*-\\n\\n\\nmeta = parse_dist_meta()\\nsetuptools.setup(\\n name=NAME,\\n packages=setuptools.find_packages(exclude=['t', 't.*']),\\n version=meta['version'],\\n description=meta['doc'],\\n long_description=long_description(),\\n keywords=meta['keywords'],\\n author=meta['author'],\\n author_email=meta['contact'],\\n url=meta['homepage'],\\n license='BSD',\\n platforms=['any'],\\n install_requires=install_requires(),\\n python_requires=\\\">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*\\\",\\n tests_require=reqs('test.txt'),\\n extras_require=extras_require(),\\n cmdclass={'test': pytest},\\n include_package_data=True,\\n zip_safe=False,\\n entry_points={\\n 'console_scripts': [\\n 'celery = celery.__main__:main',\\n ],\\n 'pytest11': [\\n 'celery = celery.contrib.pytest',\\n ],\\n },\\n project_urls={\\n \\\"Documentation\\\": \\\"http://docs.celeryproject.org/en/latest/index.html\\\",\\n \\\"Code\\\": \\\"https://github.com/celery/celery\\\",\\n \\\"Tracker\\\": \\\"https://github.com/celery/celery/issues\\\",\\n \\\"Funding\\\": \\\"https://opencollective.com/celery\\\"\\n },\\n classifiers=[\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Topic :: System :: Distributed Computing\\\",\\n \\\"Topic :: Software Development :: Object Brokering\\\",\\n \\\"Programming Language :: Python\\\",\\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 :: 3.8\\\",\\n \\\"Programming Language :: Python :: Implementation :: CPython\\\",\\n \\\"Programming Language :: Python :: Implementation :: PyPy\\\",\\n \\\"Operating System :: OS Independent\\\"\\n ]\\n)\\n\",\n \"path\": \"setup.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"#!/usr/bin/env python\n# -*- coding: utf-8 -*-\nimport codecs\nimport os\nimport re\nimport sys\n\nimport setuptools\nimport setuptools.command.test\n\ntry:\n from platform import python_implementation as _pyimp\nexcept (AttributeError, ImportError):\n def _pyimp():\n return 'Python (unknown)'\n\nNAME = 'celery'\n\n# -*- Python Versions -*-\n\nE_UNSUPPORTED_PYTHON = \"\"\"\n----------------------------------------\n Celery 4.0 requires %s %s or later\n----------------------------------------\n\n- For CPython 2.6, PyPy 1.x, Jython 2.6, CPython 3.2->3.3; use Celery 3.1:\n\n $ pip install 'celery<4'\n\n- For CPython 2.5, Jython 2.5; use Celery 3.0:\n\n $ pip install 'celery<3.1'\n\n- For CPython 2.4; use Celery 2.2:\n\n $ pip install 'celery<2.3'\n\"\"\"\n\nPYIMP = _pyimp()\nPY26_OR_LESS = sys.version_info < (2, 7)\nPY3 = sys.version_info[0] == 3\nPY34_OR_LESS = PY3 and sys.version_info < (3, 5)\nPYPY_VERSION = getattr(sys, 'pypy_version_info', None)\nPYPY = PYPY_VERSION is not None\nPYPY24_ATLEAST = PYPY_VERSION and PYPY_VERSION >= (2, 4)\n\nif PY26_OR_LESS:\n raise Exception(E_UNSUPPORTED_PYTHON % (PYIMP, '2.7'))\nelif PY34_OR_LESS and not PYPY24_ATLEAST:\n raise Exception(E_UNSUPPORTED_PYTHON % (PYIMP, '3.5'))\n\n# -*- Extras -*-\n\nEXTENSIONS = {\n 'arangodb',\n 'auth',\n 'azureblockblob',\n 'brotli',\n 'cassandra',\n 'consul',\n 'cosmosdbsql',\n 'couchbase',\n 'couchdb',\n 'django',\n 'dynamodb',\n 'elasticsearch',\n 'eventlet',\n 'gevent',\n 'librabbitmq',\n 'lzma',\n 'memcache',\n 'mongodb',\n 'msgpack',\n 'pymemcache',\n 'pyro',\n 'redis',\n 'riak',\n 's3',\n 'slmq',\n 'solar',\n 'sqlalchemy',\n 'sqs',\n 'tblib',\n 'yaml',\n 'zookeeper',\n 'zstd'\n}\n\n# -*- Distribution Meta -*-\n\nre_meta = re.compile(r'__(\\w+?)__\\s*=\\s*(.*)')\nre_doc = re.compile(r'^\"\"\"(.+?)\"\"\"')\n\n\ndef _add_default(m):\n attr_name, attr_value = m.groups()\n return ((attr_name, attr_value.strip(\"\\\"'\")),)\n\n\ndef _add_doc(m):\n return (('doc', m.groups()[0]),)\n\n\ndef parse_dist_meta():\n \"\"\"Extract metadata information from ``$dist/__init__.py``.\"\"\"\n pats = {re_meta: _add_default, re_doc: _add_doc}\n here = os.path.abspath(os.path.dirname(__file__))\n with open(os.path.join(here, NAME, '__init__.py')) as meta_fh:\n distmeta = {}\n for line in meta_fh:\n if line.strip() == '# -eof meta-':\n break\n for pattern, handler in pats.items():\n m = pattern.match(line.strip())\n if m:\n distmeta.update(handler(m))\n return distmeta\n\n# -*- Requirements -*-\n\n\ndef _strip_comments(l):\n return l.split('#', 1)[0].strip()\n\n\ndef _pip_requirement(req):\n if req.startswith('-r '):\n _, path = req.split()\n return reqs(*path.split('/'))\n return [req]\n\n\ndef _reqs(*f):\n return [\n _pip_requirement(r) for r in (\n _strip_comments(l) for l in open(\n os.path.join(os.getcwd(), 'requirements', *f)).readlines()\n ) if r]\n\n\ndef reqs(*f):\n \"\"\"Parse requirement file.\n\n Example:\n reqs('default.txt') # requirements/default.txt\n reqs('extras', 'redis.txt') # requirements/extras/redis.txt\n Returns:\n List[str]: list of requirements specified in the file.\n \"\"\"\n return [req for subreq in _reqs(*f) for req in subreq]\n\n\ndef extras(*p):\n \"\"\"Parse requirement in the requirements/extras/ directory.\"\"\"\n return reqs('extras', *p)\n\n\ndef install_requires():\n \"\"\"Get list of requirements required for installation.\"\"\"\n return reqs('default.txt')\n\n\ndef extras_require():\n \"\"\"Get map of all extra requirements.\"\"\"\n return {x: extras(x + '.txt') for x in EXTENSIONS}\n\n# -*- Long Description -*-\n\n\ndef long_description():\n try:\n return codecs.open('README.rst', 'r', 'utf-8').read()\n except IOError:\n return 'Long description error: Missing README.rst file'\n\n# -*- Command: setup.py test -*-\n\n\nclass pytest(setuptools.command.test.test):\n user_options = [('pytest-args=', 'a', 'Arguments to pass to py.test')]\n\n def initialize_options(self):\n setuptools.command.test.test.initialize_options(self)\n self.pytest_args = []\n\n def run_tests(self):\n import pytest as _pytest\n sys.exit(_pytest.main(self.pytest_args))\n\n# -*- %%% -*-\n\n\nmeta = parse_dist_meta()\nsetuptools.setup(\n name=NAME,\n packages=setuptools.find_packages(exclude=['t', 't.*']),\n version=meta['version'],\n description=meta['doc'],\n long_description=long_description(),\n keywords=meta['keywords'],\n author=meta['author'],\n author_email=meta['contact'],\n url=meta['homepage'],\n license='BSD',\n platforms=['any'],\n install_requires=install_requires(),\n python_requires=\">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*\",\n tests_require=reqs('test.txt'),\n extras_require=extras_require(),\n cmdclass={'test': pytest},\n include_package_data=True,\n zip_safe=False,\n entry_points={\n 'console_scripts': [\n 'celery = celery.__main__:main',\n ]\n },\n project_urls={\n \"Documentation\": \"http://docs.celeryproject.org/en/latest/index.html\",\n \"Code\": \"https://github.com/celery/celery\",\n \"Tracker\": \"https://github.com/celery/celery/issues\",\n \"Funding\": \"https://opencollective.com/celery\"\n },\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"License :: OSI Approved :: BSD License\",\n \"Topic :: System :: Distributed Computing\",\n \"Topic :: Software Development :: Object Brokering\",\n \"Programming Language :: Python\",\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 :: 3.8\",\n \"Programming Language :: Python :: Implementation :: CPython\",\n \"Programming Language :: Python :: Implementation :: PyPy\",\n \"Operating System :: OS Independent\"\n ]\n)\n","path":"setup.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/env python\\n# -*- coding: utf-8 -*-\\nimport codecs\\nimport os\\nimport re\\nimport sys\\n\\nimport setuptools\\nimport setuptools.command.test\\n\\ntry:\\n from platform import python_implementation as _pyimp\\nexcept (AttributeError, ImportError):\\n def _pyimp():\\n return 'Python (unknown)'\\n\\nNAME = 'celery'\\n\\n# -*- Python Versions -*-\\n\\nE_UNSUPPORTED_PYTHON = \\\"\\\"\\\"\\n----------------------------------------\\n Celery 4.0 requires %s %s or later\\n----------------------------------------\\n\\n- For CPython 2.6, PyPy 1.x, Jython 2.6, CPython 3.2->3.3; use Celery 3.1:\\n\\n $ pip install 'celery<4'\\n\\n- For CPython 2.5, Jython 2.5; use Celery 3.0:\\n\\n $ pip install 'celery<3.1'\\n\\n- For CPython 2.4; use Celery 2.2:\\n\\n $ pip install 'celery<2.3'\\n\\\"\\\"\\\"\\n\\nPYIMP = _pyimp()\\nPY26_OR_LESS = sys.version_info < (2, 7)\\nPY3 = sys.version_info[0] == 3\\nPY34_OR_LESS = PY3 and sys.version_info < (3, 5)\\nPYPY_VERSION = getattr(sys, 'pypy_version_info', None)\\nPYPY = PYPY_VERSION is not None\\nPYPY24_ATLEAST = PYPY_VERSION and PYPY_VERSION >= (2, 4)\\n\\nif PY26_OR_LESS:\\n raise Exception(E_UNSUPPORTED_PYTHON % (PYIMP, '2.7'))\\nelif PY34_OR_LESS and not PYPY24_ATLEAST:\\n raise Exception(E_UNSUPPORTED_PYTHON % (PYIMP, '3.5'))\\n\\n# -*- Extras -*-\\n\\nEXTENSIONS = {\\n 'arangodb',\\n 'auth',\\n 'azureblockblob',\\n 'brotli',\\n 'cassandra',\\n 'consul',\\n 'cosmosdbsql',\\n 'couchbase',\\n 'couchdb',\\n 'django',\\n 'dynamodb',\\n 'elasticsearch',\\n 'eventlet',\\n 'gevent',\\n 'librabbitmq',\\n 'lzma',\\n 'memcache',\\n 'mongodb',\\n 'msgpack',\\n 'pymemcache',\\n 'pyro',\\n 'redis',\\n 'riak',\\n 's3',\\n 'slmq',\\n 'solar',\\n 'sqlalchemy',\\n 'sqs',\\n 'tblib',\\n 'yaml',\\n 'zookeeper',\\n 'zstd'\\n}\\n\\n# -*- Distribution Meta -*-\\n\\nre_meta = re.compile(r'__(\\\\w+?)__\\\\s*=\\\\s*(.*)')\\nre_doc = re.compile(r'^\\\"\\\"\\\"(.+?)\\\"\\\"\\\"')\\n\\n\\ndef _add_default(m):\\n attr_name, attr_value = m.groups()\\n return ((attr_name, attr_value.strip(\\\"\\\\\\\"'\\\")),)\\n\\n\\ndef _add_doc(m):\\n return (('doc', m.groups()[0]),)\\n\\n\\ndef parse_dist_meta():\\n \\\"\\\"\\\"Extract metadata information from ``$dist/__init__.py``.\\\"\\\"\\\"\\n pats = {re_meta: _add_default, re_doc: _add_doc}\\n here = os.path.abspath(os.path.dirname(__file__))\\n with open(os.path.join(here, NAME, '__init__.py')) as meta_fh:\\n distmeta = {}\\n for line in meta_fh:\\n if line.strip() == '# -eof meta-':\\n break\\n for pattern, handler in pats.items():\\n m = pattern.match(line.strip())\\n if m:\\n distmeta.update(handler(m))\\n return distmeta\\n\\n# -*- Requirements -*-\\n\\n\\ndef _strip_comments(l):\\n return l.split('#', 1)[0].strip()\\n\\n\\ndef _pip_requirement(req):\\n if req.startswith('-r '):\\n _, path = req.split()\\n return reqs(*path.split('/'))\\n return [req]\\n\\n\\ndef _reqs(*f):\\n return [\\n _pip_requirement(r) for r in (\\n _strip_comments(l) for l in open(\\n os.path.join(os.getcwd(), 'requirements', *f)).readlines()\\n ) if r]\\n\\n\\ndef reqs(*f):\\n \\\"\\\"\\\"Parse requirement file.\\n\\n Example:\\n reqs('default.txt') # requirements/default.txt\\n reqs('extras', 'redis.txt') # requirements/extras/redis.txt\\n Returns:\\n List[str]: list of requirements specified in the file.\\n \\\"\\\"\\\"\\n return [req for subreq in _reqs(*f) for req in subreq]\\n\\n\\ndef extras(*p):\\n \\\"\\\"\\\"Parse requirement in the requirements/extras/ directory.\\\"\\\"\\\"\\n return reqs('extras', *p)\\n\\n\\ndef install_requires():\\n \\\"\\\"\\\"Get list of requirements required for installation.\\\"\\\"\\\"\\n return reqs('default.txt')\\n\\n\\ndef extras_require():\\n \\\"\\\"\\\"Get map of all extra requirements.\\\"\\\"\\\"\\n return {x: extras(x + '.txt') for x in EXTENSIONS}\\n\\n# -*- Long Description -*-\\n\\n\\ndef long_description():\\n try:\\n return codecs.open('README.rst', 'r', 'utf-8').read()\\n except IOError:\\n return 'Long description error: Missing README.rst file'\\n\\n# -*- Command: setup.py test -*-\\n\\n\\nclass pytest(setuptools.command.test.test):\\n user_options = [('pytest-args=', 'a', 'Arguments to pass to py.test')]\\n\\n def initialize_options(self):\\n setuptools.command.test.test.initialize_options(self)\\n self.pytest_args = []\\n\\n def run_tests(self):\\n import pytest as _pytest\\n sys.exit(_pytest.main(self.pytest_args))\\n\\n# -*- %%% -*-\\n\\n\\nmeta = parse_dist_meta()\\nsetuptools.setup(\\n name=NAME,\\n packages=setuptools.find_packages(exclude=['t', 't.*']),\\n version=meta['version'],\\n description=meta['doc'],\\n long_description=long_description(),\\n keywords=meta['keywords'],\\n author=meta['author'],\\n author_email=meta['contact'],\\n url=meta['homepage'],\\n license='BSD',\\n platforms=['any'],\\n install_requires=install_requires(),\\n python_requires=\\\">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*\\\",\\n tests_require=reqs('test.txt'),\\n extras_require=extras_require(),\\n cmdclass={'test': pytest},\\n include_package_data=True,\\n zip_safe=False,\\n entry_points={\\n 'console_scripts': [\\n 'celery = celery.__main__:main',\\n ]\\n },\\n project_urls={\\n \\\"Documentation\\\": \\\"http://docs.celeryproject.org/en/latest/index.html\\\",\\n \\\"Code\\\": \\\"https://github.com/celery/celery\\\",\\n \\\"Tracker\\\": \\\"https://github.com/celery/celery/issues\\\",\\n \\\"Funding\\\": \\\"https://opencollective.com/celery\\\"\\n },\\n classifiers=[\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Topic :: System :: Distributed Computing\\\",\\n \\\"Topic :: Software Development :: Object Brokering\\\",\\n \\\"Programming Language :: Python\\\",\\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 :: 3.8\\\",\\n \\\"Programming Language :: Python :: Implementation :: CPython\\\",\\n \\\"Programming Language :: Python :: Implementation :: PyPy\\\",\\n \\\"Operating System :: OS Independent\\\"\\n ]\\n)\\n\",\n \"path\": \"setup.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/requirements/extras/pytest.txt b/requirements/extras/pytest.txt\nnew file mode 100644\nindex 00000000000..8e0e5f3471b\n--- /dev/null\n+++ b/requirements/extras/pytest.txt\n@@ -0,0 +1 @@\n+pytest-celery\ndiff --git a/requirements/test.txt b/requirements/test.txt\nindex 755905cbb55..fd0ba172f90 100644\n--- a/requirements/test.txt\n+++ b/requirements/test.txt\n@@ -1,6 +1,7 @@\n case>=1.3.1\n pytest~=4.6; python_version < '3.0'\n pytest~=6.0; python_version >= '3.0'\n+pytest-celery\n pytest-timeout~=1.4.2\n boto3>=1.9.178\n python-dateutil<2.8.1,>=2.1; python_version < '3.0'\ndiff --git a/setup.py b/setup.py\nindex f0b45858a4c..f3abf671b23 100644\n--- a/setup.py\n+++ b/setup.py\n@@ -213,10 +213,7 @@ def run_tests(self):\n entry_points={\n 'console_scripts': [\n 'celery = celery.__main__:main',\n- ],\n- 'pytest11': [\n- 'celery = celery.contrib.pytest',\n- ],\n+ ]\n },\n project_urls={\n \"Documentation\": \"http://docs.celeryproject.org/en/latest/index.html\",\n"}}},{"rowIdx":4680,"cells":{"in_source_id":{"kind":"string","value":"sunpy__sunpy-3333"},"issue":{"kind":"string","value":"[1.0.3] test_print_config_files fails with installed sunpy\n<!-- This comments are hidden when you submit the issue so you do not need to remove them!\r\nPlease be sure to check out our contributing guidelines: https://github.com/sunpy/sunpy/blob/master/CONTRIBUTING.rst\r\nPlease be sure to check out our code of conduct:\r\nhttps://github.com/sunpy/sunpy/blob/master/CODE_OF_CONDUCT.rst -->\r\n\r\n<!-- Please have a search on our GitHub repository to see if a similar issue has already been posted.\r\nIf a similar issue is closed, have a quick look to see if you are satisfied by the resolution.\r\nIf not please go ahead and open an issue! -->\r\n\r\n### Description\r\n\r\nOn Debian, we run the provided tests regularly on the installed package (\"CI test\") to ensure that it still works in the current environment. \r\nWith Version 1.0.3 (or before; I didn't check 1.0 … 1.0.2), I see the following failure:\r\n\r\n### Actual behavior\r\n`print_test_config_files` tries to write to the installed package, which is denied for an ordinary user:\r\n```\r\n_____________________________________ test_print_config_files _____________________________________\r\n\r\nundo_download_dir_patch = None\r\n\r\n def test_print_config_files(undo_download_dir_patch):\r\n # TODO: Tidy this up.\r\n stdout = sys.stdout\r\n out = io.StringIO()\r\n sys.stdout = out\r\n> print_config()\r\n\r\n/usr/lib/python3/dist-packages/sunpy/util/tests/test_config.py:51: \r\n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _\r\n/usr/lib/python3/dist-packages/sunpy/util/config.py:107: in print_config\r\n for file_ in _find_config_files():\r\n/usr/lib/python3/dist-packages/sunpy/util/config.py:69: in _find_config_files\r\n config_path = Path(_get_user_configdir())\r\n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _\r\n\r\n def _get_user_configdir():\r\n \"\"\"[…]\"\"\"\r\n configdir = os.environ.get('SUNPY_CONFIGDIR', CONFIG_DIR)\r\n \r\n if not _is_writable_dir(configdir):\r\n> raise RuntimeError(f'Could not write to SUNPY_CONFIGDIR=\"{configdir}\"')\r\nE RuntimeError: Could not write to SUNPY_CONFIGDIR=\"/usr/lib/python3/dist-packages/sunpy/data\"\r\n```\r\nThis also happens when I explicitly set `SUNPY_CONFIGDIR` to a different directory; the path mentioned in the `RuntimeError` then still is `/usr/lib/python3/dist-packages/sunpy/data`.\r\n\r\n### Steps to Reproduce\r\n\r\n```\r\n$ cd /tmp\r\n$ SUNPY_CONFIGDIR=/tmp python3 -c \"import sunpy; exit(sunpy.self_test(args=\\\"-k 'not figure and not online'\\\"))\"\r\n```\r\n\r\n\r\n### System Details\r\n<!-- We at least need to know the SunPy version you are using. -->\r\n<!-- We provide a short function in SunPy that will provide some of the below information. -->\r\n<!-- It is sunpy.util.system_info(), this is optional but strongly recommended. -->\r\n\r\n - SunPy Version: 1.0.3\r\n - Astropy Version: 3.2.1\r\n - Python Version: 3.7.4\r\n - OS information: Debian unstable\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"import os\nimport json\nimport pathlib\nimport warnings\nimport importlib\nimport tempfile\n\nimport pytest\n\nimport astropy\nimport astropy.config.paths\n\nimport sunpy.tests.helpers\nfrom sunpy.tests.hash import HASH_LIBRARY_NAME\nfrom sunpy.tests.helpers import new_hash_library, generate_figure_webpage\nfrom sunpy.util.exceptions import SunpyDeprecationWarning\n\n# Force MPL to use non-gui backends for testing.\ntry:\n import matplotlib\nexcept ImportError:\n pass\nelse:\n matplotlib.use('Agg')\n\n# Don't actually import pytest_remotedata because that can do things to the\n# entrypoints code in pytest.\nremotedata_spec = importlib.util.find_spec(\"pytest_remotedata\")\nHAVE_REMOTEDATA = remotedata_spec is not None\n\n\ndef pytest_addoption(parser):\n parser.addoption(\"--figure_dir\", action=\"store\", default=\"./figure_test_images\")\n\n\n@pytest.fixture(scope='session', autouse=True)\ndef figure_base_dir(request):\n sunpy.tests.helpers.figure_base_dir = pathlib.Path(\n request.config.getoption(\"--figure_dir\"))\n\n\n@pytest.fixture(scope='session', autouse=True)\ndef tmp_config_dir(request):\n \"\"\"\n Globally set the default config for all tests.\n \"\"\"\n tmpdir = tempfile.TemporaryDirectory()\n\n os.environ[\"SUNPY_CONFIGDIR\"] = str(pathlib.Path(__file__).parent / \"data\")\n astropy.config.paths.set_temp_config._temp_path = str(tmpdir.name)\n astropy.config.paths.set_temp_cache._temp_path = str(tmpdir.name)\n\n yield\n\n del os.environ[\"SUNPY_CONFIGDIR\"]\n astropy.config.paths.set_temp_config._temp_path = None\n astropy.config.paths.set_temp_cache._temp_path = None\n\n\n@pytest.fixture()\ndef undo_config_dir_patch():\n \"\"\"\n Provide a way for certain tests to not have the config dir.\n \"\"\"\n oridir = os.environ[\"SUNPY_CONFIGDIR\"]\n del os.environ[\"SUNPY_CONFIGDIR\"]\n yield\n os.environ[\"SUNPY_CONFIGDIR\"] = oridir\n\n\n@pytest.fixture(scope='session', autouse=True)\ndef tmp_dl_dir(request):\n \"\"\"\n Globally set the default download directory for the test run to a tmp dir.\n \"\"\"\n with tempfile.TemporaryDirectory() as tmpdir:\n os.environ[\"SUNPY_DOWNLOADDIR\"] = tmpdir\n yield tmpdir\n del os.environ[\"SUNPY_DOWNLOADDIR\"]\n\n\n@pytest.fixture()\ndef undo_download_dir_patch():\n \"\"\"\n Provide a way for certain tests to not have tmp download dir.\n \"\"\"\n oridir = os.environ[\"SUNPY_DOWNLOADDIR\"]\n del os.environ[\"SUNPY_DOWNLOADDIR\"]\n yield\n os.environ[\"SUNPY_DOWNLOADDIR\"] = oridir\n\n\ndef pytest_runtest_setup(item):\n \"\"\"\n pytest hook to skip all tests that have the mark 'remotedata' if the\n pytest_remotedata plugin is not installed.\n \"\"\"\n if isinstance(item, pytest.Function):\n if 'remote_data' in item.keywords and not HAVE_REMOTEDATA:\n pytest.skip(\"skipping remotedata tests as pytest-remotedata is not installed\")\n\n\ndef pytest_unconfigure(config):\n\n # If at least one figure test has been run, print result image directory\n if len(new_hash_library) > 0:\n # Write the new hash library in JSON\n figure_base_dir = pathlib.Path(config.getoption(\"--figure_dir\"))\n hashfile = figure_base_dir / HASH_LIBRARY_NAME\n with open(hashfile, 'w') as outfile:\n json.dump(new_hash_library, outfile, sort_keys=True, indent=4, separators=(',', ': '))\n\n \"\"\"\n Turn on internet when generating the figure comparison webpage.\n \"\"\"\n if HAVE_REMOTEDATA:\n from pytest_remotedata.disable_internet import turn_on_internet, turn_off_internet\n else:\n def turn_on_internet(): pass\n def turn_off_internet(): pass\n\n turn_on_internet()\n generate_figure_webpage(new_hash_library)\n turn_off_internet()\n\n print('All images from image tests can be found in {}'.format(figure_base_dir.resolve()))\n print(\"The corresponding hash library is {}\".format(hashfile.resolve()))\n\n\ndef pytest_sessionstart(session):\n warnings.simplefilter(\"error\", SunpyDeprecationWarning)\n","path":"sunpy/conftest.py"}],"string":"[\n {\n \"content\": \"import os\\nimport json\\nimport pathlib\\nimport warnings\\nimport importlib\\nimport tempfile\\n\\nimport pytest\\n\\nimport astropy\\nimport astropy.config.paths\\n\\nimport sunpy.tests.helpers\\nfrom sunpy.tests.hash import HASH_LIBRARY_NAME\\nfrom sunpy.tests.helpers import new_hash_library, generate_figure_webpage\\nfrom sunpy.util.exceptions import SunpyDeprecationWarning\\n\\n# Force MPL to use non-gui backends for testing.\\ntry:\\n import matplotlib\\nexcept ImportError:\\n pass\\nelse:\\n matplotlib.use('Agg')\\n\\n# Don't actually import pytest_remotedata because that can do things to the\\n# entrypoints code in pytest.\\nremotedata_spec = importlib.util.find_spec(\\\"pytest_remotedata\\\")\\nHAVE_REMOTEDATA = remotedata_spec is not None\\n\\n\\ndef pytest_addoption(parser):\\n parser.addoption(\\\"--figure_dir\\\", action=\\\"store\\\", default=\\\"./figure_test_images\\\")\\n\\n\\n@pytest.fixture(scope='session', autouse=True)\\ndef figure_base_dir(request):\\n sunpy.tests.helpers.figure_base_dir = pathlib.Path(\\n request.config.getoption(\\\"--figure_dir\\\"))\\n\\n\\n@pytest.fixture(scope='session', autouse=True)\\ndef tmp_config_dir(request):\\n \\\"\\\"\\\"\\n Globally set the default config for all tests.\\n \\\"\\\"\\\"\\n tmpdir = tempfile.TemporaryDirectory()\\n\\n os.environ[\\\"SUNPY_CONFIGDIR\\\"] = str(pathlib.Path(__file__).parent / \\\"data\\\")\\n astropy.config.paths.set_temp_config._temp_path = str(tmpdir.name)\\n astropy.config.paths.set_temp_cache._temp_path = str(tmpdir.name)\\n\\n yield\\n\\n del os.environ[\\\"SUNPY_CONFIGDIR\\\"]\\n astropy.config.paths.set_temp_config._temp_path = None\\n astropy.config.paths.set_temp_cache._temp_path = None\\n\\n\\n@pytest.fixture()\\ndef undo_config_dir_patch():\\n \\\"\\\"\\\"\\n Provide a way for certain tests to not have the config dir.\\n \\\"\\\"\\\"\\n oridir = os.environ[\\\"SUNPY_CONFIGDIR\\\"]\\n del os.environ[\\\"SUNPY_CONFIGDIR\\\"]\\n yield\\n os.environ[\\\"SUNPY_CONFIGDIR\\\"] = oridir\\n\\n\\n@pytest.fixture(scope='session', autouse=True)\\ndef tmp_dl_dir(request):\\n \\\"\\\"\\\"\\n Globally set the default download directory for the test run to a tmp dir.\\n \\\"\\\"\\\"\\n with tempfile.TemporaryDirectory() as tmpdir:\\n os.environ[\\\"SUNPY_DOWNLOADDIR\\\"] = tmpdir\\n yield tmpdir\\n del os.environ[\\\"SUNPY_DOWNLOADDIR\\\"]\\n\\n\\n@pytest.fixture()\\ndef undo_download_dir_patch():\\n \\\"\\\"\\\"\\n Provide a way for certain tests to not have tmp download dir.\\n \\\"\\\"\\\"\\n oridir = os.environ[\\\"SUNPY_DOWNLOADDIR\\\"]\\n del os.environ[\\\"SUNPY_DOWNLOADDIR\\\"]\\n yield\\n os.environ[\\\"SUNPY_DOWNLOADDIR\\\"] = oridir\\n\\n\\ndef pytest_runtest_setup(item):\\n \\\"\\\"\\\"\\n pytest hook to skip all tests that have the mark 'remotedata' if the\\n pytest_remotedata plugin is not installed.\\n \\\"\\\"\\\"\\n if isinstance(item, pytest.Function):\\n if 'remote_data' in item.keywords and not HAVE_REMOTEDATA:\\n pytest.skip(\\\"skipping remotedata tests as pytest-remotedata is not installed\\\")\\n\\n\\ndef pytest_unconfigure(config):\\n\\n # If at least one figure test has been run, print result image directory\\n if len(new_hash_library) > 0:\\n # Write the new hash library in JSON\\n figure_base_dir = pathlib.Path(config.getoption(\\\"--figure_dir\\\"))\\n hashfile = figure_base_dir / HASH_LIBRARY_NAME\\n with open(hashfile, 'w') as outfile:\\n json.dump(new_hash_library, outfile, sort_keys=True, indent=4, separators=(',', ': '))\\n\\n \\\"\\\"\\\"\\n Turn on internet when generating the figure comparison webpage.\\n \\\"\\\"\\\"\\n if HAVE_REMOTEDATA:\\n from pytest_remotedata.disable_internet import turn_on_internet, turn_off_internet\\n else:\\n def turn_on_internet(): pass\\n def turn_off_internet(): pass\\n\\n turn_on_internet()\\n generate_figure_webpage(new_hash_library)\\n turn_off_internet()\\n\\n print('All images from image tests can be found in {}'.format(figure_base_dir.resolve()))\\n print(\\\"The corresponding hash library is {}\\\".format(hashfile.resolve()))\\n\\n\\ndef pytest_sessionstart(session):\\n warnings.simplefilter(\\\"error\\\", SunpyDeprecationWarning)\\n\",\n \"path\": \"sunpy/conftest.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import os\nimport json\nimport pathlib\nimport warnings\nimport importlib\nimport tempfile\n\nimport pytest\n\nimport astropy\nimport astropy.config.paths\n\nimport sunpy.tests.helpers\nfrom sunpy.tests.hash import HASH_LIBRARY_NAME\nfrom sunpy.tests.helpers import new_hash_library, generate_figure_webpage\nfrom sunpy.util.exceptions import SunpyDeprecationWarning\n\n# Force MPL to use non-gui backends for testing.\ntry:\n import matplotlib\nexcept ImportError:\n pass\nelse:\n matplotlib.use('Agg')\n\n# Don't actually import pytest_remotedata because that can do things to the\n# entrypoints code in pytest.\nremotedata_spec = importlib.util.find_spec(\"pytest_remotedata\")\nHAVE_REMOTEDATA = remotedata_spec is not None\n\n\ndef pytest_addoption(parser):\n parser.addoption(\"--figure_dir\", action=\"store\", default=\"./figure_test_images\")\n\n\n@pytest.fixture(scope='session', autouse=True)\ndef figure_base_dir(request):\n sunpy.tests.helpers.figure_base_dir = pathlib.Path(\n request.config.getoption(\"--figure_dir\"))\n\n\n@pytest.fixture(scope='session', autouse=True)\ndef tmp_config_dir(request):\n \"\"\"\n Globally set the default config for all tests.\n \"\"\"\n tmpdir = tempfile.TemporaryDirectory()\n\n os.environ[\"SUNPY_CONFIGDIR\"] = str(tmpdir.name)\n astropy.config.paths.set_temp_config._temp_path = str(tmpdir.name)\n astropy.config.paths.set_temp_cache._temp_path = str(tmpdir.name)\n\n yield\n\n del os.environ[\"SUNPY_CONFIGDIR\"]\n astropy.config.paths.set_temp_config._temp_path = None\n astropy.config.paths.set_temp_cache._temp_path = None\n\n\n@pytest.fixture()\ndef undo_config_dir_patch():\n \"\"\"\n Provide a way for certain tests to not have the config dir.\n \"\"\"\n oridir = os.environ[\"SUNPY_CONFIGDIR\"]\n del os.environ[\"SUNPY_CONFIGDIR\"]\n yield\n os.environ[\"SUNPY_CONFIGDIR\"] = oridir\n\n\n@pytest.fixture(scope='session', autouse=True)\ndef tmp_dl_dir(request):\n \"\"\"\n Globally set the default download directory for the test run to a tmp dir.\n \"\"\"\n with tempfile.TemporaryDirectory() as tmpdir:\n os.environ[\"SUNPY_DOWNLOADDIR\"] = tmpdir\n yield tmpdir\n del os.environ[\"SUNPY_DOWNLOADDIR\"]\n\n\n@pytest.fixture()\ndef undo_download_dir_patch():\n \"\"\"\n Provide a way for certain tests to not have tmp download dir.\n \"\"\"\n oridir = os.environ[\"SUNPY_DOWNLOADDIR\"]\n del os.environ[\"SUNPY_DOWNLOADDIR\"]\n yield\n os.environ[\"SUNPY_DOWNLOADDIR\"] = oridir\n\n\ndef pytest_runtest_setup(item):\n \"\"\"\n pytest hook to skip all tests that have the mark 'remotedata' if the\n pytest_remotedata plugin is not installed.\n \"\"\"\n if isinstance(item, pytest.Function):\n if 'remote_data' in item.keywords and not HAVE_REMOTEDATA:\n pytest.skip(\"skipping remotedata tests as pytest-remotedata is not installed\")\n\n\ndef pytest_unconfigure(config):\n\n # If at least one figure test has been run, print result image directory\n if len(new_hash_library) > 0:\n # Write the new hash library in JSON\n figure_base_dir = pathlib.Path(config.getoption(\"--figure_dir\"))\n hashfile = figure_base_dir / HASH_LIBRARY_NAME\n with open(hashfile, 'w') as outfile:\n json.dump(new_hash_library, outfile, sort_keys=True, indent=4, separators=(',', ': '))\n\n \"\"\"\n Turn on internet when generating the figure comparison webpage.\n \"\"\"\n if HAVE_REMOTEDATA:\n from pytest_remotedata.disable_internet import turn_on_internet, turn_off_internet\n else:\n def turn_on_internet(): pass\n def turn_off_internet(): pass\n\n turn_on_internet()\n generate_figure_webpage(new_hash_library)\n turn_off_internet()\n\n print('All images from image tests can be found in {}'.format(figure_base_dir.resolve()))\n print(\"The corresponding hash library is {}\".format(hashfile.resolve()))\n\n\ndef pytest_sessionstart(session):\n warnings.simplefilter(\"error\", SunpyDeprecationWarning)\n","path":"sunpy/conftest.py"}],"string":"[\n {\n \"content\": \"import os\\nimport json\\nimport pathlib\\nimport warnings\\nimport importlib\\nimport tempfile\\n\\nimport pytest\\n\\nimport astropy\\nimport astropy.config.paths\\n\\nimport sunpy.tests.helpers\\nfrom sunpy.tests.hash import HASH_LIBRARY_NAME\\nfrom sunpy.tests.helpers import new_hash_library, generate_figure_webpage\\nfrom sunpy.util.exceptions import SunpyDeprecationWarning\\n\\n# Force MPL to use non-gui backends for testing.\\ntry:\\n import matplotlib\\nexcept ImportError:\\n pass\\nelse:\\n matplotlib.use('Agg')\\n\\n# Don't actually import pytest_remotedata because that can do things to the\\n# entrypoints code in pytest.\\nremotedata_spec = importlib.util.find_spec(\\\"pytest_remotedata\\\")\\nHAVE_REMOTEDATA = remotedata_spec is not None\\n\\n\\ndef pytest_addoption(parser):\\n parser.addoption(\\\"--figure_dir\\\", action=\\\"store\\\", default=\\\"./figure_test_images\\\")\\n\\n\\n@pytest.fixture(scope='session', autouse=True)\\ndef figure_base_dir(request):\\n sunpy.tests.helpers.figure_base_dir = pathlib.Path(\\n request.config.getoption(\\\"--figure_dir\\\"))\\n\\n\\n@pytest.fixture(scope='session', autouse=True)\\ndef tmp_config_dir(request):\\n \\\"\\\"\\\"\\n Globally set the default config for all tests.\\n \\\"\\\"\\\"\\n tmpdir = tempfile.TemporaryDirectory()\\n\\n os.environ[\\\"SUNPY_CONFIGDIR\\\"] = str(tmpdir.name)\\n astropy.config.paths.set_temp_config._temp_path = str(tmpdir.name)\\n astropy.config.paths.set_temp_cache._temp_path = str(tmpdir.name)\\n\\n yield\\n\\n del os.environ[\\\"SUNPY_CONFIGDIR\\\"]\\n astropy.config.paths.set_temp_config._temp_path = None\\n astropy.config.paths.set_temp_cache._temp_path = None\\n\\n\\n@pytest.fixture()\\ndef undo_config_dir_patch():\\n \\\"\\\"\\\"\\n Provide a way for certain tests to not have the config dir.\\n \\\"\\\"\\\"\\n oridir = os.environ[\\\"SUNPY_CONFIGDIR\\\"]\\n del os.environ[\\\"SUNPY_CONFIGDIR\\\"]\\n yield\\n os.environ[\\\"SUNPY_CONFIGDIR\\\"] = oridir\\n\\n\\n@pytest.fixture(scope='session', autouse=True)\\ndef tmp_dl_dir(request):\\n \\\"\\\"\\\"\\n Globally set the default download directory for the test run to a tmp dir.\\n \\\"\\\"\\\"\\n with tempfile.TemporaryDirectory() as tmpdir:\\n os.environ[\\\"SUNPY_DOWNLOADDIR\\\"] = tmpdir\\n yield tmpdir\\n del os.environ[\\\"SUNPY_DOWNLOADDIR\\\"]\\n\\n\\n@pytest.fixture()\\ndef undo_download_dir_patch():\\n \\\"\\\"\\\"\\n Provide a way for certain tests to not have tmp download dir.\\n \\\"\\\"\\\"\\n oridir = os.environ[\\\"SUNPY_DOWNLOADDIR\\\"]\\n del os.environ[\\\"SUNPY_DOWNLOADDIR\\\"]\\n yield\\n os.environ[\\\"SUNPY_DOWNLOADDIR\\\"] = oridir\\n\\n\\ndef pytest_runtest_setup(item):\\n \\\"\\\"\\\"\\n pytest hook to skip all tests that have the mark 'remotedata' if the\\n pytest_remotedata plugin is not installed.\\n \\\"\\\"\\\"\\n if isinstance(item, pytest.Function):\\n if 'remote_data' in item.keywords and not HAVE_REMOTEDATA:\\n pytest.skip(\\\"skipping remotedata tests as pytest-remotedata is not installed\\\")\\n\\n\\ndef pytest_unconfigure(config):\\n\\n # If at least one figure test has been run, print result image directory\\n if len(new_hash_library) > 0:\\n # Write the new hash library in JSON\\n figure_base_dir = pathlib.Path(config.getoption(\\\"--figure_dir\\\"))\\n hashfile = figure_base_dir / HASH_LIBRARY_NAME\\n with open(hashfile, 'w') as outfile:\\n json.dump(new_hash_library, outfile, sort_keys=True, indent=4, separators=(',', ': '))\\n\\n \\\"\\\"\\\"\\n Turn on internet when generating the figure comparison webpage.\\n \\\"\\\"\\\"\\n if HAVE_REMOTEDATA:\\n from pytest_remotedata.disable_internet import turn_on_internet, turn_off_internet\\n else:\\n def turn_on_internet(): pass\\n def turn_off_internet(): pass\\n\\n turn_on_internet()\\n generate_figure_webpage(new_hash_library)\\n turn_off_internet()\\n\\n print('All images from image tests can be found in {}'.format(figure_base_dir.resolve()))\\n print(\\\"The corresponding hash library is {}\\\".format(hashfile.resolve()))\\n\\n\\ndef pytest_sessionstart(session):\\n warnings.simplefilter(\\\"error\\\", SunpyDeprecationWarning)\\n\",\n \"path\": \"sunpy/conftest.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/sunpy/conftest.py b/sunpy/conftest.py\nindex 60632d3a116..4dd35dfbb78 100644\n--- a/sunpy/conftest.py\n+++ b/sunpy/conftest.py\n@@ -46,7 +46,7 @@ def tmp_config_dir(request):\n \"\"\"\n tmpdir = tempfile.TemporaryDirectory()\n \n- os.environ[\"SUNPY_CONFIGDIR\"] = str(pathlib.Path(__file__).parent / \"data\")\n+ os.environ[\"SUNPY_CONFIGDIR\"] = str(tmpdir.name)\n astropy.config.paths.set_temp_config._temp_path = str(tmpdir.name)\n astropy.config.paths.set_temp_cache._temp_path = str(tmpdir.name)\n \ndiff --git a/sunpy/util/tests/test_config.py b/sunpy/util/tests/test_config.py\nindex b7a9720a46c..18c598ba44d 100644\n--- a/sunpy/util/tests/test_config.py\n+++ b/sunpy/util/tests/test_config.py\n@@ -1,6 +1,6 @@\n import io\n import os\n-import sys\n+from contextlib import redirect_stdout\n from pathlib import Path\n \n from sunpy import config\n@@ -21,6 +21,7 @@ def test_is_writable_dir(tmpdir, tmp_path):\n # Checks a filepath instead of directory\n assert not _is_writable_dir(tmp_file)\n \n+\n def test_get_user_configdir(tmpdir, tmp_path, undo_config_dir_patch):\n # Default\n assert USER in CONFIG_DIR\n@@ -43,15 +44,10 @@ def test_get_user_configdir(tmpdir, tmp_path, undo_config_dir_patch):\n del os.environ[\"SUNPY_CONFIGDIR\"]\n \n \n-def test_print_config_files(undo_download_dir_patch):\n- # TODO: Tidy this up.\n- stdout = sys.stdout\n- out = io.StringIO()\n- sys.stdout = out\n- print_config()\n- sys.stdout = stdout\n- out.seek(0)\n- printed = out.read()\n+def test_print_config_files(tmpdir, tmp_path, undo_download_dir_patch):\n+ with io.StringIO() as buf, redirect_stdout(buf):\n+ print_config()\n+ printed = buf.getvalue()\n assert \"time_format = %Y-%m-%d %H:%M:%S\" in printed\n assert _find_config_files()[0] in printed\n assert get_and_create_download_dir() in printed\n"}}},{"rowIdx":4681,"cells":{"in_source_id":{"kind":"string","value":"cupy__cupy-5362"},"issue":{"kind":"string","value":"Need housekeeping macros for HIP\nAccording to an earlier discussion (https://github.com/cupy/cupy/pull/4367#discussion_r542051342), it's better to collect the macro redefinitions for functions that are not supported by HIP (ex: `__shfl*sync()`) in one place so that they are always correctly included when compiling on HIP. This would benefit CuPy JIT too (ex: #5335). I could try to work on this later next week...\n"},"before_files":{"kind":"list like","value":[{"content":"import warnings\n\nimport cupy\n\nfrom cupy_backends.cuda.api import runtime\nfrom cupyx.jit import _cuda_types\nfrom cupyx.jit._internal_types import BuiltinFunc\nfrom cupyx.jit._internal_types import Data\nfrom cupyx.jit._internal_types import Constant\nfrom cupyx.jit._internal_types import Range\nfrom cupyx.jit import _compile\n\nfrom functools import reduce\n\n\nclass RangeFunc(BuiltinFunc):\n\n def call(self, env, *args, **kwargs):\n if len(args) == 0:\n raise TypeError('range expected at least 1 argument, got 0')\n elif len(args) == 1:\n start, stop, step = Constant(0), args[0], Constant(1)\n elif len(args) == 2:\n start, stop, step = args[0], args[1], Constant(1)\n elif len(args) == 3:\n start, stop, step = args\n else:\n raise TypeError(\n f'range expected at most 3 argument, got {len(args)}')\n\n if isinstance(step, Constant):\n step_is_positive = step.obj >= 0\n elif step.ctype.dtype.kind == 'u':\n step_is_positive = True\n else:\n step_is_positive = None\n\n stop = Data.init(stop, env)\n start = Data.init(start, env)\n step = Data.init(step, env)\n\n if start.ctype.dtype.kind not in 'iu':\n raise TypeError('range supports only for integer type.')\n if stop.ctype.dtype.kind not in 'iu':\n raise TypeError('range supports only for integer type.')\n if step.ctype.dtype.kind not in 'iu':\n raise TypeError('range supports only for integer type.')\n\n if env.mode == 'numpy':\n ctype = _cuda_types.Scalar(int)\n elif env.mode == 'cuda':\n ctype = stop.ctype\n else:\n assert False\n\n return Range(start, stop, step, ctype, step_is_positive)\n\n\nclass LenFunc(BuiltinFunc):\n def call(self, env, *args, **kwds):\n if len(args) != 1:\n raise TypeError(f'len() expects only 1 argument, got {len(args)}')\n if kwds:\n raise TypeError('keyword arguments are not supported')\n arg = args[0]\n if not isinstance(arg.ctype, _cuda_types.CArray):\n raise TypeError('len() supports only array type')\n if not arg.ctype.ndim:\n raise TypeError('len() of unsized array')\n return Data(f'static_cast<long long>({arg.code}.shape()[0])',\n _cuda_types.Scalar('q'))\n\n\nclass MinFunc(BuiltinFunc):\n def call(self, env, *args, **kwds):\n if len(args) < 2:\n raise TypeError(\n f'min() expects at least 2 arguments, got {len(args)}')\n if kwds:\n raise TypeError('keyword arguments are not supported')\n return reduce(lambda a, b: _compile._call_ufunc(\n cupy.minimum, (a, b), None, env), args)\n\n\nclass MaxFunc(BuiltinFunc):\n def call(self, env, *args, **kwds):\n if len(args) < 2:\n raise TypeError(\n f'max() expects at least 2 arguments, got {len(args)}')\n if kwds:\n raise TypeError('keyword arguments are not supported')\n return reduce(lambda a, b: _compile._call_ufunc(\n cupy.maximum, (a, b), None, env), args)\n\n\nclass SyncThreads(BuiltinFunc):\n\n def __call__(self):\n \"\"\"Calls ``__syncthreads()``.\n\n .. seealso:: `Synchronization functions`_\n\n .. _Synchronization functions:\n https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#synchronization-functions\n \"\"\"\n super.__call__(self)\n\n def call_const(self, env):\n return Data('__syncthreads()', _cuda_types.void)\n\n\nclass SyncWarp(BuiltinFunc):\n\n def __call__(self, *, mask=0xffffffff):\n \"\"\"Calls ``__syncwarp()``.\n\n Args:\n mask (int): Active threads in a warp. Default is 0xffffffff.\n\n .. seealso:: `Synchronization functions`_\n\n .. _Synchronization functions:\n https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#synchronization-functions\n \"\"\"\n super().__call__()\n\n def call(self, env, *, mask=None):\n if runtime.is_hip:\n warnings.warn(f'mask {mask} is ignored on HIP', RuntimeWarning)\n mask = None\n\n if mask:\n if isinstance(mask, Constant):\n if not (0x0 <= mask.obj <= 0xffffffff):\n raise ValueError('mask is out of range')\n mask = _compile._astype_scalar(\n mask, _cuda_types.int32, 'same_kind', env)\n mask = Data.init(mask, env)\n code = f'__syncwarp({mask.code})'\n else:\n code = '__syncwarp()'\n return Data(code, _cuda_types.void)\n\n\nclass SharedMemory(BuiltinFunc):\n\n def __call__(self, dtype, size):\n \"\"\"Allocates shared memory and returns the 1-dim array.\n\n Args:\n dtype (dtype):\n The dtype of the returned array.\n size (int or None):\n If ``int`` type, the size of static shared memory.\n If ``None``, declares the shared memory with extern specifier.\n \"\"\"\n super.__call__(self)\n\n def call_const(self, env, dtype, size):\n name = env.get_fresh_variable_name(prefix='_smem')\n child_type = _cuda_types.Scalar(dtype)\n while env[name] is not None:\n name = env.get_fresh_variable_name(prefix='_smem') # retry\n env[name] = Data(name, _cuda_types.SharedMem(child_type, size))\n return Data(name, _cuda_types.Ptr(child_type))\n\n\nclass AtomicOp(BuiltinFunc):\n\n def __init__(self, op, dtypes):\n self._op = op\n self._name = 'atomic' + op\n self._dtypes = dtypes\n super().__init__()\n\n def call(self, env, array, index, value):\n array = Data.init(array, env)\n if not isinstance(array.ctype, (_cuda_types.CArray, _cuda_types.Ptr)):\n raise TypeError('The first argument must be of array type.')\n target = _compile._indexing(array, index, env)\n ctype = target.ctype\n value = _compile._astype_scalar(value, ctype, 'same_kind', env)\n name = self._name\n value = Data.init(value, env)\n if ctype.dtype.char not in self._dtypes:\n raise TypeError(f'`{name}` does not support {ctype.dtype} input.')\n if ctype.dtype.char == 'e' and runtime.runtimeGetVersion() < 10000:\n raise RuntimeError(\n 'float16 atomic operation is not supported this CUDA version.')\n return Data(f'{name}(&{target.code}, {value.code})', ctype)\n\n\nclass Grid(BuiltinFunc):\n\n def __call__(self, ndim):\n \"\"\"Compute the thread index in the grid.\n\n Computation of the first integer is as follows::\n\n jit.threadIdx.x + jit.blockIdx.x * jit.blockDim.x\n\n and for the other two integers the ``y`` and ``z`` attributes are used.\n\n Args:\n ndim (int): The dimension of the grid. Only 1, 2, or 3 is allowed.\n\n Returns:\n int or tuple:\n If ``ndim`` is 1, an integer is returned, otherwise a tuple.\n\n .. note::\n This function follows the convention of Numba's `numba.cuda.grid`_.\n\n .. _numba.cuda.grid:\n https://numba.readthedocs.io/en/stable/cuda/kernels.html#absolute-positions\n\n \"\"\"\n super.__call__(self)\n\n def call_const(self, env, ndim):\n if not isinstance(ndim, int):\n raise TypeError('ndim must be an integer')\n\n # Numba convention: for 1D we return a single variable,\n # otherwise a tuple\n code = 'threadIdx.{n} + blockIdx.{n} * blockDim.{n}'\n if ndim == 1:\n return Data(code.format(n='x'), _cuda_types.uint32)\n elif ndim == 2:\n dims = ('x', 'y')\n elif ndim == 3:\n dims = ('x', 'y', 'z')\n else:\n raise ValueError('Only ndim=1,2,3 are supported')\n\n elts_code = ', '.join(code.format(n=n) for n in dims)\n ctype = _cuda_types.Tuple([_cuda_types.uint32]*ndim)\n return Data(f'thrust::make_tuple({elts_code})', ctype)\n\n\nclass WarpShuffleOp(BuiltinFunc):\n\n def __init__(self, op, dtypes):\n self._op = op\n self._name = '__shfl_' + (op + '_' if op else '') + 'sync'\n self._dtypes = dtypes\n doc = f\"\"\"Call the {self._name} function. Please refer to\n `Warp Shuffle Functions`_ for detail explanation.\n\n .. _Warp Shuffle Functions:\n https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#warp-shuffle-functions\n \"\"\"\n self.__doc__ = doc\n\n def __call__(self, mask, var, val_id, *, width=32):\n super().__call__()\n\n def call(self, env, mask, var, val_id, *, width=None):\n name = self._name\n\n var = Data.init(var, env)\n ctype = var.ctype\n if ctype.dtype.char not in self._dtypes:\n raise TypeError(f'`{name}` does not support {ctype.dtype} input.')\n\n try:\n mask = mask.obj\n except Exception:\n raise TypeError('mask must be an integer')\n if runtime.is_hip:\n warnings.warn(f'mask {mask} is ignored on HIP', RuntimeWarning)\n elif not (0x0 <= mask <= 0xffffffff):\n raise ValueError('mask is out of range')\n\n # val_id refers to \"delta\" for shfl_{up, down}, \"srcLane\" for shfl, and\n # \"laneMask\" for shfl_xor\n if self._op in ('up', 'down'):\n val_id_t = _cuda_types.uint32\n else:\n val_id_t = _cuda_types.int32\n val_id = _compile._astype_scalar(val_id, val_id_t, 'same_kind', env)\n val_id = Data.init(val_id, env)\n\n if width:\n if isinstance(width, Constant):\n if width.obj not in (2, 4, 8, 16, 32):\n raise ValueError('width needs to be power of 2')\n else:\n width = Constant(64) if runtime.is_hip else Constant(32)\n width = _compile._astype_scalar(\n width, _cuda_types.int32, 'same_kind', env)\n width = Data.init(width, env)\n\n code = f'{name}({hex(mask)}, {var.code}, {val_id.code}'\n code += f', {width.code})'\n return Data(code, ctype)\n\n\nbuiltin_functions_dict = {\n range: RangeFunc(),\n len: LenFunc(),\n min: MinFunc(),\n max: MaxFunc(),\n}\n\nsyncthreads = SyncThreads()\nsyncwarp = SyncWarp()\nshared_memory = SharedMemory()\ngrid = Grid()\n\n# TODO: Add more atomic functions.\natomic_add = AtomicOp('Add', 'iILQefd')\n\n# warp-shuffle functions\nshfl_sync = WarpShuffleOp('', 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\nshfl_up_sync = WarpShuffleOp('up', 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\nshfl_down_sync = WarpShuffleOp('down',\n 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\nshfl_xor_sync = WarpShuffleOp('xor',\n 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\n","path":"cupyx/jit/_builtin_funcs.py"}],"string":"[\n {\n \"content\": \"import warnings\\n\\nimport cupy\\n\\nfrom cupy_backends.cuda.api import runtime\\nfrom cupyx.jit import _cuda_types\\nfrom cupyx.jit._internal_types import BuiltinFunc\\nfrom cupyx.jit._internal_types import Data\\nfrom cupyx.jit._internal_types import Constant\\nfrom cupyx.jit._internal_types import Range\\nfrom cupyx.jit import _compile\\n\\nfrom functools import reduce\\n\\n\\nclass RangeFunc(BuiltinFunc):\\n\\n def call(self, env, *args, **kwargs):\\n if len(args) == 0:\\n raise TypeError('range expected at least 1 argument, got 0')\\n elif len(args) == 1:\\n start, stop, step = Constant(0), args[0], Constant(1)\\n elif len(args) == 2:\\n start, stop, step = args[0], args[1], Constant(1)\\n elif len(args) == 3:\\n start, stop, step = args\\n else:\\n raise TypeError(\\n f'range expected at most 3 argument, got {len(args)}')\\n\\n if isinstance(step, Constant):\\n step_is_positive = step.obj >= 0\\n elif step.ctype.dtype.kind == 'u':\\n step_is_positive = True\\n else:\\n step_is_positive = None\\n\\n stop = Data.init(stop, env)\\n start = Data.init(start, env)\\n step = Data.init(step, env)\\n\\n if start.ctype.dtype.kind not in 'iu':\\n raise TypeError('range supports only for integer type.')\\n if stop.ctype.dtype.kind not in 'iu':\\n raise TypeError('range supports only for integer type.')\\n if step.ctype.dtype.kind not in 'iu':\\n raise TypeError('range supports only for integer type.')\\n\\n if env.mode == 'numpy':\\n ctype = _cuda_types.Scalar(int)\\n elif env.mode == 'cuda':\\n ctype = stop.ctype\\n else:\\n assert False\\n\\n return Range(start, stop, step, ctype, step_is_positive)\\n\\n\\nclass LenFunc(BuiltinFunc):\\n def call(self, env, *args, **kwds):\\n if len(args) != 1:\\n raise TypeError(f'len() expects only 1 argument, got {len(args)}')\\n if kwds:\\n raise TypeError('keyword arguments are not supported')\\n arg = args[0]\\n if not isinstance(arg.ctype, _cuda_types.CArray):\\n raise TypeError('len() supports only array type')\\n if not arg.ctype.ndim:\\n raise TypeError('len() of unsized array')\\n return Data(f'static_cast<long long>({arg.code}.shape()[0])',\\n _cuda_types.Scalar('q'))\\n\\n\\nclass MinFunc(BuiltinFunc):\\n def call(self, env, *args, **kwds):\\n if len(args) < 2:\\n raise TypeError(\\n f'min() expects at least 2 arguments, got {len(args)}')\\n if kwds:\\n raise TypeError('keyword arguments are not supported')\\n return reduce(lambda a, b: _compile._call_ufunc(\\n cupy.minimum, (a, b), None, env), args)\\n\\n\\nclass MaxFunc(BuiltinFunc):\\n def call(self, env, *args, **kwds):\\n if len(args) < 2:\\n raise TypeError(\\n f'max() expects at least 2 arguments, got {len(args)}')\\n if kwds:\\n raise TypeError('keyword arguments are not supported')\\n return reduce(lambda a, b: _compile._call_ufunc(\\n cupy.maximum, (a, b), None, env), args)\\n\\n\\nclass SyncThreads(BuiltinFunc):\\n\\n def __call__(self):\\n \\\"\\\"\\\"Calls ``__syncthreads()``.\\n\\n .. seealso:: `Synchronization functions`_\\n\\n .. _Synchronization functions:\\n https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#synchronization-functions\\n \\\"\\\"\\\"\\n super.__call__(self)\\n\\n def call_const(self, env):\\n return Data('__syncthreads()', _cuda_types.void)\\n\\n\\nclass SyncWarp(BuiltinFunc):\\n\\n def __call__(self, *, mask=0xffffffff):\\n \\\"\\\"\\\"Calls ``__syncwarp()``.\\n\\n Args:\\n mask (int): Active threads in a warp. Default is 0xffffffff.\\n\\n .. seealso:: `Synchronization functions`_\\n\\n .. _Synchronization functions:\\n https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#synchronization-functions\\n \\\"\\\"\\\"\\n super().__call__()\\n\\n def call(self, env, *, mask=None):\\n if runtime.is_hip:\\n warnings.warn(f'mask {mask} is ignored on HIP', RuntimeWarning)\\n mask = None\\n\\n if mask:\\n if isinstance(mask, Constant):\\n if not (0x0 <= mask.obj <= 0xffffffff):\\n raise ValueError('mask is out of range')\\n mask = _compile._astype_scalar(\\n mask, _cuda_types.int32, 'same_kind', env)\\n mask = Data.init(mask, env)\\n code = f'__syncwarp({mask.code})'\\n else:\\n code = '__syncwarp()'\\n return Data(code, _cuda_types.void)\\n\\n\\nclass SharedMemory(BuiltinFunc):\\n\\n def __call__(self, dtype, size):\\n \\\"\\\"\\\"Allocates shared memory and returns the 1-dim array.\\n\\n Args:\\n dtype (dtype):\\n The dtype of the returned array.\\n size (int or None):\\n If ``int`` type, the size of static shared memory.\\n If ``None``, declares the shared memory with extern specifier.\\n \\\"\\\"\\\"\\n super.__call__(self)\\n\\n def call_const(self, env, dtype, size):\\n name = env.get_fresh_variable_name(prefix='_smem')\\n child_type = _cuda_types.Scalar(dtype)\\n while env[name] is not None:\\n name = env.get_fresh_variable_name(prefix='_smem') # retry\\n env[name] = Data(name, _cuda_types.SharedMem(child_type, size))\\n return Data(name, _cuda_types.Ptr(child_type))\\n\\n\\nclass AtomicOp(BuiltinFunc):\\n\\n def __init__(self, op, dtypes):\\n self._op = op\\n self._name = 'atomic' + op\\n self._dtypes = dtypes\\n super().__init__()\\n\\n def call(self, env, array, index, value):\\n array = Data.init(array, env)\\n if not isinstance(array.ctype, (_cuda_types.CArray, _cuda_types.Ptr)):\\n raise TypeError('The first argument must be of array type.')\\n target = _compile._indexing(array, index, env)\\n ctype = target.ctype\\n value = _compile._astype_scalar(value, ctype, 'same_kind', env)\\n name = self._name\\n value = Data.init(value, env)\\n if ctype.dtype.char not in self._dtypes:\\n raise TypeError(f'`{name}` does not support {ctype.dtype} input.')\\n if ctype.dtype.char == 'e' and runtime.runtimeGetVersion() < 10000:\\n raise RuntimeError(\\n 'float16 atomic operation is not supported this CUDA version.')\\n return Data(f'{name}(&{target.code}, {value.code})', ctype)\\n\\n\\nclass Grid(BuiltinFunc):\\n\\n def __call__(self, ndim):\\n \\\"\\\"\\\"Compute the thread index in the grid.\\n\\n Computation of the first integer is as follows::\\n\\n jit.threadIdx.x + jit.blockIdx.x * jit.blockDim.x\\n\\n and for the other two integers the ``y`` and ``z`` attributes are used.\\n\\n Args:\\n ndim (int): The dimension of the grid. Only 1, 2, or 3 is allowed.\\n\\n Returns:\\n int or tuple:\\n If ``ndim`` is 1, an integer is returned, otherwise a tuple.\\n\\n .. note::\\n This function follows the convention of Numba's `numba.cuda.grid`_.\\n\\n .. _numba.cuda.grid:\\n https://numba.readthedocs.io/en/stable/cuda/kernels.html#absolute-positions\\n\\n \\\"\\\"\\\"\\n super.__call__(self)\\n\\n def call_const(self, env, ndim):\\n if not isinstance(ndim, int):\\n raise TypeError('ndim must be an integer')\\n\\n # Numba convention: for 1D we return a single variable,\\n # otherwise a tuple\\n code = 'threadIdx.{n} + blockIdx.{n} * blockDim.{n}'\\n if ndim == 1:\\n return Data(code.format(n='x'), _cuda_types.uint32)\\n elif ndim == 2:\\n dims = ('x', 'y')\\n elif ndim == 3:\\n dims = ('x', 'y', 'z')\\n else:\\n raise ValueError('Only ndim=1,2,3 are supported')\\n\\n elts_code = ', '.join(code.format(n=n) for n in dims)\\n ctype = _cuda_types.Tuple([_cuda_types.uint32]*ndim)\\n return Data(f'thrust::make_tuple({elts_code})', ctype)\\n\\n\\nclass WarpShuffleOp(BuiltinFunc):\\n\\n def __init__(self, op, dtypes):\\n self._op = op\\n self._name = '__shfl_' + (op + '_' if op else '') + 'sync'\\n self._dtypes = dtypes\\n doc = f\\\"\\\"\\\"Call the {self._name} function. Please refer to\\n `Warp Shuffle Functions`_ for detail explanation.\\n\\n .. _Warp Shuffle Functions:\\n https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#warp-shuffle-functions\\n \\\"\\\"\\\"\\n self.__doc__ = doc\\n\\n def __call__(self, mask, var, val_id, *, width=32):\\n super().__call__()\\n\\n def call(self, env, mask, var, val_id, *, width=None):\\n name = self._name\\n\\n var = Data.init(var, env)\\n ctype = var.ctype\\n if ctype.dtype.char not in self._dtypes:\\n raise TypeError(f'`{name}` does not support {ctype.dtype} input.')\\n\\n try:\\n mask = mask.obj\\n except Exception:\\n raise TypeError('mask must be an integer')\\n if runtime.is_hip:\\n warnings.warn(f'mask {mask} is ignored on HIP', RuntimeWarning)\\n elif not (0x0 <= mask <= 0xffffffff):\\n raise ValueError('mask is out of range')\\n\\n # val_id refers to \\\"delta\\\" for shfl_{up, down}, \\\"srcLane\\\" for shfl, and\\n # \\\"laneMask\\\" for shfl_xor\\n if self._op in ('up', 'down'):\\n val_id_t = _cuda_types.uint32\\n else:\\n val_id_t = _cuda_types.int32\\n val_id = _compile._astype_scalar(val_id, val_id_t, 'same_kind', env)\\n val_id = Data.init(val_id, env)\\n\\n if width:\\n if isinstance(width, Constant):\\n if width.obj not in (2, 4, 8, 16, 32):\\n raise ValueError('width needs to be power of 2')\\n else:\\n width = Constant(64) if runtime.is_hip else Constant(32)\\n width = _compile._astype_scalar(\\n width, _cuda_types.int32, 'same_kind', env)\\n width = Data.init(width, env)\\n\\n code = f'{name}({hex(mask)}, {var.code}, {val_id.code}'\\n code += f', {width.code})'\\n return Data(code, ctype)\\n\\n\\nbuiltin_functions_dict = {\\n range: RangeFunc(),\\n len: LenFunc(),\\n min: MinFunc(),\\n max: MaxFunc(),\\n}\\n\\nsyncthreads = SyncThreads()\\nsyncwarp = SyncWarp()\\nshared_memory = SharedMemory()\\ngrid = Grid()\\n\\n# TODO: Add more atomic functions.\\natomic_add = AtomicOp('Add', 'iILQefd')\\n\\n# warp-shuffle functions\\nshfl_sync = WarpShuffleOp('', 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\\nshfl_up_sync = WarpShuffleOp('up', 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\\nshfl_down_sync = WarpShuffleOp('down',\\n 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\\nshfl_xor_sync = WarpShuffleOp('xor',\\n 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\\n\",\n \"path\": \"cupyx/jit/_builtin_funcs.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import warnings\n\nimport cupy\n\nfrom cupy_backends.cuda.api import runtime\nfrom cupyx.jit import _cuda_types\nfrom cupyx.jit._internal_types import BuiltinFunc\nfrom cupyx.jit._internal_types import Data\nfrom cupyx.jit._internal_types import Constant\nfrom cupyx.jit._internal_types import Range\nfrom cupyx.jit import _compile\n\nfrom functools import reduce\n\n\nclass RangeFunc(BuiltinFunc):\n\n def call(self, env, *args, **kwargs):\n if len(args) == 0:\n raise TypeError('range expected at least 1 argument, got 0')\n elif len(args) == 1:\n start, stop, step = Constant(0), args[0], Constant(1)\n elif len(args) == 2:\n start, stop, step = args[0], args[1], Constant(1)\n elif len(args) == 3:\n start, stop, step = args\n else:\n raise TypeError(\n f'range expected at most 3 argument, got {len(args)}')\n\n if isinstance(step, Constant):\n step_is_positive = step.obj >= 0\n elif step.ctype.dtype.kind == 'u':\n step_is_positive = True\n else:\n step_is_positive = None\n\n stop = Data.init(stop, env)\n start = Data.init(start, env)\n step = Data.init(step, env)\n\n if start.ctype.dtype.kind not in 'iu':\n raise TypeError('range supports only for integer type.')\n if stop.ctype.dtype.kind not in 'iu':\n raise TypeError('range supports only for integer type.')\n if step.ctype.dtype.kind not in 'iu':\n raise TypeError('range supports only for integer type.')\n\n if env.mode == 'numpy':\n ctype = _cuda_types.Scalar(int)\n elif env.mode == 'cuda':\n ctype = stop.ctype\n else:\n assert False\n\n return Range(start, stop, step, ctype, step_is_positive)\n\n\nclass LenFunc(BuiltinFunc):\n def call(self, env, *args, **kwds):\n if len(args) != 1:\n raise TypeError(f'len() expects only 1 argument, got {len(args)}')\n if kwds:\n raise TypeError('keyword arguments are not supported')\n arg = args[0]\n if not isinstance(arg.ctype, _cuda_types.CArray):\n raise TypeError('len() supports only array type')\n if not arg.ctype.ndim:\n raise TypeError('len() of unsized array')\n return Data(f'static_cast<long long>({arg.code}.shape()[0])',\n _cuda_types.Scalar('q'))\n\n\nclass MinFunc(BuiltinFunc):\n def call(self, env, *args, **kwds):\n if len(args) < 2:\n raise TypeError(\n f'min() expects at least 2 arguments, got {len(args)}')\n if kwds:\n raise TypeError('keyword arguments are not supported')\n return reduce(lambda a, b: _compile._call_ufunc(\n cupy.minimum, (a, b), None, env), args)\n\n\nclass MaxFunc(BuiltinFunc):\n def call(self, env, *args, **kwds):\n if len(args) < 2:\n raise TypeError(\n f'max() expects at least 2 arguments, got {len(args)}')\n if kwds:\n raise TypeError('keyword arguments are not supported')\n return reduce(lambda a, b: _compile._call_ufunc(\n cupy.maximum, (a, b), None, env), args)\n\n\nclass SyncThreads(BuiltinFunc):\n\n def __call__(self):\n \"\"\"Calls ``__syncthreads()``.\n\n .. seealso:: `Synchronization functions`_\n\n .. _Synchronization functions:\n https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#synchronization-functions\n \"\"\"\n super.__call__(self)\n\n def call_const(self, env):\n return Data('__syncthreads()', _cuda_types.void)\n\n\nclass SyncWarp(BuiltinFunc):\n\n def __call__(self, *, mask=0xffffffff):\n \"\"\"Calls ``__syncwarp()``.\n\n Args:\n mask (int): Active threads in a warp. Default is 0xffffffff.\n\n .. seealso:: `Synchronization functions`_\n\n .. _Synchronization functions:\n https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#synchronization-functions\n \"\"\"\n super().__call__()\n\n def call(self, env, *, mask=None):\n if runtime.is_hip:\n if mask is not None:\n warnings.warn(f'mask {mask} is ignored on HIP', RuntimeWarning)\n mask = None\n\n if mask:\n if isinstance(mask, Constant):\n if not (0x0 <= mask.obj <= 0xffffffff):\n raise ValueError('mask is out of range')\n mask = _compile._astype_scalar(\n mask, _cuda_types.int32, 'same_kind', env)\n mask = Data.init(mask, env)\n code = f'__syncwarp({mask.code})'\n else:\n code = '__syncwarp()'\n return Data(code, _cuda_types.void)\n\n\nclass SharedMemory(BuiltinFunc):\n\n def __call__(self, dtype, size):\n \"\"\"Allocates shared memory and returns the 1-dim array.\n\n Args:\n dtype (dtype):\n The dtype of the returned array.\n size (int or None):\n If ``int`` type, the size of static shared memory.\n If ``None``, declares the shared memory with extern specifier.\n \"\"\"\n super.__call__(self)\n\n def call_const(self, env, dtype, size):\n name = env.get_fresh_variable_name(prefix='_smem')\n child_type = _cuda_types.Scalar(dtype)\n while env[name] is not None:\n name = env.get_fresh_variable_name(prefix='_smem') # retry\n env[name] = Data(name, _cuda_types.SharedMem(child_type, size))\n return Data(name, _cuda_types.Ptr(child_type))\n\n\nclass AtomicOp(BuiltinFunc):\n\n def __init__(self, op, dtypes):\n self._op = op\n self._name = 'atomic' + op\n self._dtypes = dtypes\n super().__init__()\n\n def call(self, env, array, index, value):\n array = Data.init(array, env)\n if not isinstance(array.ctype, (_cuda_types.CArray, _cuda_types.Ptr)):\n raise TypeError('The first argument must be of array type.')\n target = _compile._indexing(array, index, env)\n ctype = target.ctype\n value = _compile._astype_scalar(value, ctype, 'same_kind', env)\n name = self._name\n value = Data.init(value, env)\n if ctype.dtype.char not in self._dtypes:\n raise TypeError(f'`{name}` does not support {ctype.dtype} input.')\n if ctype.dtype.char == 'e' and runtime.runtimeGetVersion() < 10000:\n raise RuntimeError(\n 'float16 atomic operation is not supported this CUDA version.')\n return Data(f'{name}(&{target.code}, {value.code})', ctype)\n\n\nclass Grid(BuiltinFunc):\n\n def __call__(self, ndim):\n \"\"\"Compute the thread index in the grid.\n\n Computation of the first integer is as follows::\n\n jit.threadIdx.x + jit.blockIdx.x * jit.blockDim.x\n\n and for the other two integers the ``y`` and ``z`` attributes are used.\n\n Args:\n ndim (int): The dimension of the grid. Only 1, 2, or 3 is allowed.\n\n Returns:\n int or tuple:\n If ``ndim`` is 1, an integer is returned, otherwise a tuple.\n\n .. note::\n This function follows the convention of Numba's `numba.cuda.grid`_.\n\n .. _numba.cuda.grid:\n https://numba.readthedocs.io/en/stable/cuda/kernels.html#absolute-positions\n\n \"\"\"\n super.__call__(self)\n\n def call_const(self, env, ndim):\n if not isinstance(ndim, int):\n raise TypeError('ndim must be an integer')\n\n # Numba convention: for 1D we return a single variable,\n # otherwise a tuple\n code = 'threadIdx.{n} + blockIdx.{n} * blockDim.{n}'\n if ndim == 1:\n return Data(code.format(n='x'), _cuda_types.uint32)\n elif ndim == 2:\n dims = ('x', 'y')\n elif ndim == 3:\n dims = ('x', 'y', 'z')\n else:\n raise ValueError('Only ndim=1,2,3 are supported')\n\n elts_code = ', '.join(code.format(n=n) for n in dims)\n ctype = _cuda_types.Tuple([_cuda_types.uint32]*ndim)\n return Data(f'thrust::make_tuple({elts_code})', ctype)\n\n\nclass WarpShuffleOp(BuiltinFunc):\n\n def __init__(self, op, dtypes):\n self._op = op\n self._name = '__shfl_' + (op + '_' if op else '') + 'sync'\n self._dtypes = dtypes\n doc = f\"\"\"Call the {self._name} function. Please refer to\n `Warp Shuffle Functions`_ for detail explanation.\n\n .. _Warp Shuffle Functions:\n https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#warp-shuffle-functions\n \"\"\"\n self.__doc__ = doc\n\n def __call__(self, mask, var, val_id, *, width=32):\n super().__call__()\n\n def call(self, env, mask, var, val_id, *, width=None):\n name = self._name\n\n var = Data.init(var, env)\n ctype = var.ctype\n if ctype.dtype.char not in self._dtypes:\n raise TypeError(f'`{name}` does not support {ctype.dtype} input.')\n\n try:\n mask = mask.obj\n except Exception:\n raise TypeError('mask must be an integer')\n if runtime.is_hip:\n warnings.warn(f'mask {mask} is ignored on HIP', RuntimeWarning)\n elif not (0x0 <= mask <= 0xffffffff):\n raise ValueError('mask is out of range')\n\n # val_id refers to \"delta\" for shfl_{up, down}, \"srcLane\" for shfl, and\n # \"laneMask\" for shfl_xor\n if self._op in ('up', 'down'):\n val_id_t = _cuda_types.uint32\n else:\n val_id_t = _cuda_types.int32\n val_id = _compile._astype_scalar(val_id, val_id_t, 'same_kind', env)\n val_id = Data.init(val_id, env)\n\n if width:\n if isinstance(width, Constant):\n if width.obj not in (2, 4, 8, 16, 32):\n raise ValueError('width needs to be power of 2')\n else:\n width = Constant(64) if runtime.is_hip else Constant(32)\n width = _compile._astype_scalar(\n width, _cuda_types.int32, 'same_kind', env)\n width = Data.init(width, env)\n\n code = f'{name}({hex(mask)}, {var.code}, {val_id.code}'\n code += f', {width.code})'\n return Data(code, ctype)\n\n\nbuiltin_functions_dict = {\n range: RangeFunc(),\n len: LenFunc(),\n min: MinFunc(),\n max: MaxFunc(),\n}\n\nsyncthreads = SyncThreads()\nsyncwarp = SyncWarp()\nshared_memory = SharedMemory()\ngrid = Grid()\n\n# TODO: Add more atomic functions.\natomic_add = AtomicOp('Add', 'iILQefd')\n\n# warp-shuffle functions\nshfl_sync = WarpShuffleOp('', 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\nshfl_up_sync = WarpShuffleOp('up', 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\nshfl_down_sync = WarpShuffleOp('down',\n 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\nshfl_xor_sync = WarpShuffleOp('xor',\n 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\n","path":"cupyx/jit/_builtin_funcs.py"}],"string":"[\n {\n \"content\": \"import warnings\\n\\nimport cupy\\n\\nfrom cupy_backends.cuda.api import runtime\\nfrom cupyx.jit import _cuda_types\\nfrom cupyx.jit._internal_types import BuiltinFunc\\nfrom cupyx.jit._internal_types import Data\\nfrom cupyx.jit._internal_types import Constant\\nfrom cupyx.jit._internal_types import Range\\nfrom cupyx.jit import _compile\\n\\nfrom functools import reduce\\n\\n\\nclass RangeFunc(BuiltinFunc):\\n\\n def call(self, env, *args, **kwargs):\\n if len(args) == 0:\\n raise TypeError('range expected at least 1 argument, got 0')\\n elif len(args) == 1:\\n start, stop, step = Constant(0), args[0], Constant(1)\\n elif len(args) == 2:\\n start, stop, step = args[0], args[1], Constant(1)\\n elif len(args) == 3:\\n start, stop, step = args\\n else:\\n raise TypeError(\\n f'range expected at most 3 argument, got {len(args)}')\\n\\n if isinstance(step, Constant):\\n step_is_positive = step.obj >= 0\\n elif step.ctype.dtype.kind == 'u':\\n step_is_positive = True\\n else:\\n step_is_positive = None\\n\\n stop = Data.init(stop, env)\\n start = Data.init(start, env)\\n step = Data.init(step, env)\\n\\n if start.ctype.dtype.kind not in 'iu':\\n raise TypeError('range supports only for integer type.')\\n if stop.ctype.dtype.kind not in 'iu':\\n raise TypeError('range supports only for integer type.')\\n if step.ctype.dtype.kind not in 'iu':\\n raise TypeError('range supports only for integer type.')\\n\\n if env.mode == 'numpy':\\n ctype = _cuda_types.Scalar(int)\\n elif env.mode == 'cuda':\\n ctype = stop.ctype\\n else:\\n assert False\\n\\n return Range(start, stop, step, ctype, step_is_positive)\\n\\n\\nclass LenFunc(BuiltinFunc):\\n def call(self, env, *args, **kwds):\\n if len(args) != 1:\\n raise TypeError(f'len() expects only 1 argument, got {len(args)}')\\n if kwds:\\n raise TypeError('keyword arguments are not supported')\\n arg = args[0]\\n if not isinstance(arg.ctype, _cuda_types.CArray):\\n raise TypeError('len() supports only array type')\\n if not arg.ctype.ndim:\\n raise TypeError('len() of unsized array')\\n return Data(f'static_cast<long long>({arg.code}.shape()[0])',\\n _cuda_types.Scalar('q'))\\n\\n\\nclass MinFunc(BuiltinFunc):\\n def call(self, env, *args, **kwds):\\n if len(args) < 2:\\n raise TypeError(\\n f'min() expects at least 2 arguments, got {len(args)}')\\n if kwds:\\n raise TypeError('keyword arguments are not supported')\\n return reduce(lambda a, b: _compile._call_ufunc(\\n cupy.minimum, (a, b), None, env), args)\\n\\n\\nclass MaxFunc(BuiltinFunc):\\n def call(self, env, *args, **kwds):\\n if len(args) < 2:\\n raise TypeError(\\n f'max() expects at least 2 arguments, got {len(args)}')\\n if kwds:\\n raise TypeError('keyword arguments are not supported')\\n return reduce(lambda a, b: _compile._call_ufunc(\\n cupy.maximum, (a, b), None, env), args)\\n\\n\\nclass SyncThreads(BuiltinFunc):\\n\\n def __call__(self):\\n \\\"\\\"\\\"Calls ``__syncthreads()``.\\n\\n .. seealso:: `Synchronization functions`_\\n\\n .. _Synchronization functions:\\n https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#synchronization-functions\\n \\\"\\\"\\\"\\n super.__call__(self)\\n\\n def call_const(self, env):\\n return Data('__syncthreads()', _cuda_types.void)\\n\\n\\nclass SyncWarp(BuiltinFunc):\\n\\n def __call__(self, *, mask=0xffffffff):\\n \\\"\\\"\\\"Calls ``__syncwarp()``.\\n\\n Args:\\n mask (int): Active threads in a warp. Default is 0xffffffff.\\n\\n .. seealso:: `Synchronization functions`_\\n\\n .. _Synchronization functions:\\n https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#synchronization-functions\\n \\\"\\\"\\\"\\n super().__call__()\\n\\n def call(self, env, *, mask=None):\\n if runtime.is_hip:\\n if mask is not None:\\n warnings.warn(f'mask {mask} is ignored on HIP', RuntimeWarning)\\n mask = None\\n\\n if mask:\\n if isinstance(mask, Constant):\\n if not (0x0 <= mask.obj <= 0xffffffff):\\n raise ValueError('mask is out of range')\\n mask = _compile._astype_scalar(\\n mask, _cuda_types.int32, 'same_kind', env)\\n mask = Data.init(mask, env)\\n code = f'__syncwarp({mask.code})'\\n else:\\n code = '__syncwarp()'\\n return Data(code, _cuda_types.void)\\n\\n\\nclass SharedMemory(BuiltinFunc):\\n\\n def __call__(self, dtype, size):\\n \\\"\\\"\\\"Allocates shared memory and returns the 1-dim array.\\n\\n Args:\\n dtype (dtype):\\n The dtype of the returned array.\\n size (int or None):\\n If ``int`` type, the size of static shared memory.\\n If ``None``, declares the shared memory with extern specifier.\\n \\\"\\\"\\\"\\n super.__call__(self)\\n\\n def call_const(self, env, dtype, size):\\n name = env.get_fresh_variable_name(prefix='_smem')\\n child_type = _cuda_types.Scalar(dtype)\\n while env[name] is not None:\\n name = env.get_fresh_variable_name(prefix='_smem') # retry\\n env[name] = Data(name, _cuda_types.SharedMem(child_type, size))\\n return Data(name, _cuda_types.Ptr(child_type))\\n\\n\\nclass AtomicOp(BuiltinFunc):\\n\\n def __init__(self, op, dtypes):\\n self._op = op\\n self._name = 'atomic' + op\\n self._dtypes = dtypes\\n super().__init__()\\n\\n def call(self, env, array, index, value):\\n array = Data.init(array, env)\\n if not isinstance(array.ctype, (_cuda_types.CArray, _cuda_types.Ptr)):\\n raise TypeError('The first argument must be of array type.')\\n target = _compile._indexing(array, index, env)\\n ctype = target.ctype\\n value = _compile._astype_scalar(value, ctype, 'same_kind', env)\\n name = self._name\\n value = Data.init(value, env)\\n if ctype.dtype.char not in self._dtypes:\\n raise TypeError(f'`{name}` does not support {ctype.dtype} input.')\\n if ctype.dtype.char == 'e' and runtime.runtimeGetVersion() < 10000:\\n raise RuntimeError(\\n 'float16 atomic operation is not supported this CUDA version.')\\n return Data(f'{name}(&{target.code}, {value.code})', ctype)\\n\\n\\nclass Grid(BuiltinFunc):\\n\\n def __call__(self, ndim):\\n \\\"\\\"\\\"Compute the thread index in the grid.\\n\\n Computation of the first integer is as follows::\\n\\n jit.threadIdx.x + jit.blockIdx.x * jit.blockDim.x\\n\\n and for the other two integers the ``y`` and ``z`` attributes are used.\\n\\n Args:\\n ndim (int): The dimension of the grid. Only 1, 2, or 3 is allowed.\\n\\n Returns:\\n int or tuple:\\n If ``ndim`` is 1, an integer is returned, otherwise a tuple.\\n\\n .. note::\\n This function follows the convention of Numba's `numba.cuda.grid`_.\\n\\n .. _numba.cuda.grid:\\n https://numba.readthedocs.io/en/stable/cuda/kernels.html#absolute-positions\\n\\n \\\"\\\"\\\"\\n super.__call__(self)\\n\\n def call_const(self, env, ndim):\\n if not isinstance(ndim, int):\\n raise TypeError('ndim must be an integer')\\n\\n # Numba convention: for 1D we return a single variable,\\n # otherwise a tuple\\n code = 'threadIdx.{n} + blockIdx.{n} * blockDim.{n}'\\n if ndim == 1:\\n return Data(code.format(n='x'), _cuda_types.uint32)\\n elif ndim == 2:\\n dims = ('x', 'y')\\n elif ndim == 3:\\n dims = ('x', 'y', 'z')\\n else:\\n raise ValueError('Only ndim=1,2,3 are supported')\\n\\n elts_code = ', '.join(code.format(n=n) for n in dims)\\n ctype = _cuda_types.Tuple([_cuda_types.uint32]*ndim)\\n return Data(f'thrust::make_tuple({elts_code})', ctype)\\n\\n\\nclass WarpShuffleOp(BuiltinFunc):\\n\\n def __init__(self, op, dtypes):\\n self._op = op\\n self._name = '__shfl_' + (op + '_' if op else '') + 'sync'\\n self._dtypes = dtypes\\n doc = f\\\"\\\"\\\"Call the {self._name} function. Please refer to\\n `Warp Shuffle Functions`_ for detail explanation.\\n\\n .. _Warp Shuffle Functions:\\n https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#warp-shuffle-functions\\n \\\"\\\"\\\"\\n self.__doc__ = doc\\n\\n def __call__(self, mask, var, val_id, *, width=32):\\n super().__call__()\\n\\n def call(self, env, mask, var, val_id, *, width=None):\\n name = self._name\\n\\n var = Data.init(var, env)\\n ctype = var.ctype\\n if ctype.dtype.char not in self._dtypes:\\n raise TypeError(f'`{name}` does not support {ctype.dtype} input.')\\n\\n try:\\n mask = mask.obj\\n except Exception:\\n raise TypeError('mask must be an integer')\\n if runtime.is_hip:\\n warnings.warn(f'mask {mask} is ignored on HIP', RuntimeWarning)\\n elif not (0x0 <= mask <= 0xffffffff):\\n raise ValueError('mask is out of range')\\n\\n # val_id refers to \\\"delta\\\" for shfl_{up, down}, \\\"srcLane\\\" for shfl, and\\n # \\\"laneMask\\\" for shfl_xor\\n if self._op in ('up', 'down'):\\n val_id_t = _cuda_types.uint32\\n else:\\n val_id_t = _cuda_types.int32\\n val_id = _compile._astype_scalar(val_id, val_id_t, 'same_kind', env)\\n val_id = Data.init(val_id, env)\\n\\n if width:\\n if isinstance(width, Constant):\\n if width.obj not in (2, 4, 8, 16, 32):\\n raise ValueError('width needs to be power of 2')\\n else:\\n width = Constant(64) if runtime.is_hip else Constant(32)\\n width = _compile._astype_scalar(\\n width, _cuda_types.int32, 'same_kind', env)\\n width = Data.init(width, env)\\n\\n code = f'{name}({hex(mask)}, {var.code}, {val_id.code}'\\n code += f', {width.code})'\\n return Data(code, ctype)\\n\\n\\nbuiltin_functions_dict = {\\n range: RangeFunc(),\\n len: LenFunc(),\\n min: MinFunc(),\\n max: MaxFunc(),\\n}\\n\\nsyncthreads = SyncThreads()\\nsyncwarp = SyncWarp()\\nshared_memory = SharedMemory()\\ngrid = Grid()\\n\\n# TODO: Add more atomic functions.\\natomic_add = AtomicOp('Add', 'iILQefd')\\n\\n# warp-shuffle functions\\nshfl_sync = WarpShuffleOp('', 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\\nshfl_up_sync = WarpShuffleOp('up', 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\\nshfl_down_sync = WarpShuffleOp('down',\\n 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\\nshfl_xor_sync = WarpShuffleOp('xor',\\n 'iIlqfd' if runtime.is_hip else 'iIlLqQefd')\\n\",\n \"path\": \"cupyx/jit/_builtin_funcs.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/cupy/_core/_routines_indexing.pyx b/cupy/_core/_routines_indexing.pyx\nindex 0661fe0211f..462c408fd83 100644\n--- a/cupy/_core/_routines_indexing.pyx\n+++ b/cupy/_core/_routines_indexing.pyx\n@@ -429,12 +429,6 @@ cdef ndarray _simple_getitem(ndarray a, list slice_list):\n return v\n \n \n-_preamble = '' if not runtime._is_hip_environment else r'''\n- // ignore mask\n- #define __shfl_up_sync(m, x, y, z) __shfl_up(x, y, z)\n- '''\n-\n-\n @cupy._util.memoize(for_each_device=True)\n def _nonzero_kernel_incomplete_scan(block_size, warp_size=32):\n in_params = 'raw T a, raw S b'\n@@ -485,7 +479,7 @@ def _nonzero_kernel_incomplete_scan(block_size, warp_size=32):\n \"\"\").substitute(block_size=block_size, warp_size=warp_size)\n return cupy.ElementwiseKernel(in_params, out_params, loop_body,\n 'nonzero_kernel_incomplete_scan',\n- loop_prep=loop_prep, preamble=_preamble)\n+ loop_prep=loop_prep)\n \n \n _nonzero_kernel = ElementwiseKernel(\ndiff --git a/cupy/_core/_routines_math.pyx b/cupy/_core/_routines_math.pyx\nindex dd6c20292aa..598bc9bedf8 100644\n--- a/cupy/_core/_routines_math.pyx\n+++ b/cupy/_core/_routines_math.pyx\n@@ -150,14 +150,6 @@ cdef ndarray _ndarray_clip(ndarray self, a_min, a_max, out):\n \n _op_char = {scan_op.SCAN_SUM: '+', scan_op.SCAN_PROD: '*'}\n _identity = {scan_op.SCAN_SUM: 0, scan_op.SCAN_PROD: 1}\n-_preamble = '' if not runtime._is_hip_environment else r'''\n- // ignore mask\n- #define __shfl_xor_sync(m, x, y, z) __shfl_xor(x, y, z)\n-\n- // It is guaranteed to be safe on AMD's hardware, see\n- // https://rocmdocs.amd.com/en/latest/Programming_Guides/HIP-GUIDE.html#warp-cross-lane-functions # NOQA\n- #define __syncwarp() {}\n- '''\n \n \n @cupy._util.memoize(for_each_device=True)\n@@ -213,8 +205,7 @@ def _cupy_bsum_shfl(op, chunk_size, warp_size=32):\n \"\"\").substitute(block_size=block_size, warp_size=warp_size,\n op=_op_char[op], identity=_identity[op])\n return cupy.ElementwiseKernel(in_params, out_params, loop_body,\n- 'cupy_bsum_shfl', loop_prep=loop_prep,\n- preamble=_preamble)\n+ 'cupy_bsum_shfl', loop_prep=loop_prep)\n \n \n @cupy._util.memoize(for_each_device=True)\n@@ -271,8 +262,7 @@ def _cupy_bsum_smem(op, chunk_size, warp_size=32):\n \"\"\").substitute(block_size=block_size, warp_size=warp_size,\n op=_op_char[op], identity=_identity[op])\n return cupy.ElementwiseKernel(in_params, out_params, loop_body,\n- 'cupy_bsum_smem', loop_prep=loop_prep,\n- preamble=_preamble)\n+ 'cupy_bsum_smem', loop_prep=loop_prep)\n \n \n @cupy._util.memoize(for_each_device=True)\n@@ -339,8 +329,7 @@ def _cupy_scan_naive(op, chunk_size, warp_size=32):\n \"\"\").substitute(block_size=chunk_size, warp_size=warp_size,\n op=_op_char[op], identity=_identity[op])\n return cupy.ElementwiseKernel(in_params, out_params, loop_body,\n- 'cupy_scan_naive', loop_prep=loop_prep,\n- preamble=_preamble)\n+ 'cupy_scan_naive', loop_prep=loop_prep)\n \n \n @cupy._util.memoize(for_each_device=True)\n@@ -435,8 +424,7 @@ def _cupy_scan_btree(op, chunk_size, warp_size=32):\n \"\"\").substitute(block_size=chunk_size, warp_size=warp_size,\n op=_op_char[op], identity=_identity[op])\n return cupy.ElementwiseKernel(in_params, out_params, loop_body,\n- 'cupy_scan_btree', loop_prep=loop_prep,\n- preamble=_preamble)\n+ 'cupy_scan_btree', loop_prep=loop_prep)\n \n \n cdef ndarray scan(ndarray a, op, dtype=None, ndarray out=None,\ndiff --git a/cupy/_core/core.pyx b/cupy/_core/core.pyx\nindex 526a2e01a0b..f7671e998f9 100644\n--- a/cupy/_core/core.pyx\n+++ b/cupy/_core/core.pyx\n@@ -1839,6 +1839,7 @@ cdef list cupy_header_list = [\n ]\n if _is_hip:\n cupy_header_list.append('cupy/math_constants.h')\n+ cupy_header_list.append('cupy/hip_workaround.cuh')\n \n # expose to Python for unit testing\n _cupy_header_list = cupy_header_list\ndiff --git a/cupy/_core/include/cupy/hip_workaround.cuh b/cupy/_core/include/cupy/hip_workaround.cuh\nnew file mode 100644\nindex 00000000000..bcf7b36099e\n--- /dev/null\n+++ b/cupy/_core/include/cupy/hip_workaround.cuh\n@@ -0,0 +1,18 @@\n+#ifndef INCLUDE_GUARD_CUPY_HIP_WORKAROUND_H\n+#define INCLUDE_GUARD_CUPY_HIP_WORKAROUND_H\n+\n+#ifdef __HIP_DEVICE_COMPILE__\n+\n+// ignore mask\n+#define __shfl_sync(mask, ...) __shfl(__VA_ARGS__)\n+#define __shfl_up_sync(mask, ...) __shfl_up(__VA_ARGS__)\n+#define __shfl_down_sync(mask, ...) __shfl_down(__VA_ARGS__)\n+#define __shfl_xor_sync(mask, ...) __shfl_xor(__VA_ARGS__)\n+\n+// It is guaranteed to be safe on AMD's hardware, see\n+// https://rocmdocs.amd.com/en/latest/Programming_Guides/HIP-GUIDE.html#warp-cross-lane-functions\n+#define __syncwarp() {}\n+\n+#endif // __HIP_DEVICE_COMPILE__\n+\n+#endif // INCLUDE_GUARD_CUPY_HIP_WORKAROUND_H\ndiff --git a/cupyx/jit/_builtin_funcs.py b/cupyx/jit/_builtin_funcs.py\nindex 6141e9434a6..ff5f74d6c71 100644\n--- a/cupyx/jit/_builtin_funcs.py\n+++ b/cupyx/jit/_builtin_funcs.py\n@@ -126,8 +126,9 @@ def __call__(self, *, mask=0xffffffff):\n \n def call(self, env, *, mask=None):\n if runtime.is_hip:\n- warnings.warn(f'mask {mask} is ignored on HIP', RuntimeWarning)\n- mask = None\n+ if mask is not None:\n+ warnings.warn(f'mask {mask} is ignored on HIP', RuntimeWarning)\n+ mask = None\n \n if mask:\n if isinstance(mask, Constant):\ndiff --git a/tests/cupyx_tests/jit_tests/test_raw.py b/tests/cupyx_tests/jit_tests/test_raw.py\nindex fe556c33d5c..18f3f8e2b03 100644\n--- a/tests/cupyx_tests/jit_tests/test_raw.py\n+++ b/tests/cupyx_tests/jit_tests/test_raw.py\n@@ -210,8 +210,6 @@ def f(x, y, buf):\n f((1,), (32, 32), (x, y, buf))\n assert bool((x == y).all())\n \n- # TODO(leofang): enable HIP when cupy/cupy#5348 is resolved\n- @unittest.skipIf(runtime.is_hip, 'HIP is not yet supported')\n def test_syncwarp(self):\n @jit.rawkernel()\n def f(x):\n@@ -228,8 +226,6 @@ def f(x):\n y[16:] += 1\n assert bool((x == y).all())\n \n- # TODO(leofang): enable HIP when cupy/cupy#5348 is resolved\n- @unittest.skipIf(runtime.is_hip, 'HIP is not yet supported')\n def test_syncwarp_mask(self):\n @jit.rawkernel()\n def f(x, m):\n@@ -320,8 +316,6 @@ def f(x, y, size):\n f[5, 6](x, y, numpy.uint32(1024))\n assert bool((x == y).all())\n \n- # TODO(leofang): enable HIP when cupy/cupy#5348 is resolved\n- @unittest.skipIf(runtime.is_hip, 'HIP is not yet supported')\n # TODO(leofang): test float16 ('e') once cupy/cupy#5346 is resolved\n @testing.for_dtypes('iIlqfd' if runtime.is_hip else 'iIlLqQfd')\n def test_shfl(self, dtype):\n@@ -340,8 +334,6 @@ def f(a, b):\n f[1, 32](a, b)\n assert (b == a * cupy.ones((32,), dtype=dtype)).all()\n \n- # TODO(leofang): enable HIP when cupy/cupy#5348 is resolved\n- @unittest.skipIf(runtime.is_hip, 'HIP is not yet supported')\n def test_shfl_width(self):\n @jit.rawkernel()\n def f(a, b, w):\n@@ -357,8 +349,6 @@ def f(a, b, w):\n c[c % w != 0] = c[c % w == 0]\n assert (b == c).all()\n \n- # TODO(leofang): enable HIP when cupy/cupy#5348 is resolved\n- @unittest.skipIf(runtime.is_hip, 'HIP is not yet supported')\n # TODO(leofang): test float16 ('e') once cupy/cupy#5346 is resolved\n @testing.for_dtypes('iIlqfd' if runtime.is_hip else 'iIlLqQfd')\n def test_shfl_up(self, dtype):\n@@ -374,25 +364,24 @@ def f(a):\n expected = [i for i in range(N)] + [i for i in range(32-N)]\n assert(a == cupy.asarray(expected, dtype=dtype)).all()\n \n- # TODO(leofang): enable HIP when cupy/cupy#5348 is resolved\n- @unittest.skipIf(runtime.is_hip, 'HIP is not yet supported')\n # TODO(leofang): test float16 ('e') once cupy/cupy#5346 is resolved\n @testing.for_dtypes('iIlqfd' if runtime.is_hip else 'iIlLqQfd')\n def test_shfl_down(self, dtype):\n N = 5\n+ # __shfl_down() on HIP does not seem to have the same behavior...\n+ block = 64 if runtime.is_hip else 32\n \n @jit.rawkernel()\n def f(a):\n value = jit.shfl_down_sync(0xffffffff, a[jit.threadIdx.x], N)\n a[jit.threadIdx.x] = value\n \n- a = cupy.arange(32, dtype=dtype)\n- f[1, 32](a)\n- expected = [i for i in range(N, 32)] + [(32-N+i) for i in range(N)]\n+ a = cupy.arange(block, dtype=dtype)\n+ f[1, block](a)\n+ expected = [i for i in range(N, block)]\n+ expected += [(block-N+i) for i in range(N)]\n assert(a == cupy.asarray(expected, dtype=dtype)).all()\n \n- # TODO(leofang): enable HIP when cupy/cupy#5348 is resolved\n- @unittest.skipIf(runtime.is_hip, 'HIP is not yet supported')\n # TODO(leofang): test float16 ('e') once cupy/cupy#5346 is resolved\n @testing.for_dtypes('iIlqfd' if runtime.is_hip else 'iIlLqQfd')\n def test_shfl_xor(self, dtype):\n"}}},{"rowIdx":4682,"cells":{"in_source_id":{"kind":"string","value":"getsentry__sentry-python-464"},"issue":{"kind":"string","value":"logging breadcrumb collection time is incorrect\n\r\n\r\n\r\nI found the breadcrumbs timestamp converted to the local time zone\r\ndatetime.datetime.fromtimestamp(record.created)\r\n\r\n> ```python\r\n> # /sentry_sdk/integrations/logging.py:90\r\n> def _breadcrumb_from_record(record):\r\n> # type: (LogRecord) -> Dict[str, Any]\r\n> return {\r\n> \"ty\": \"log\",\r\n> \"level\": _logging_to_event_level(record.levelname),\r\n> \"category\": record.name,\r\n> \"message\": record.message,\r\n> \"timestamp\": datetime.datetime.fromtimestamp(record.created),\r\n> \"data\": _extra_from_record(record),\r\n> }\r\n> ```\n"},"before_files":{"kind":"list like","value":[{"content":"from __future__ import absolute_import\n\nimport logging\nimport datetime\n\nfrom sentry_sdk.hub import Hub\nfrom sentry_sdk.utils import (\n to_string,\n event_from_exception,\n current_stacktrace,\n capture_internal_exceptions,\n)\nfrom sentry_sdk.integrations import Integration\nfrom sentry_sdk._compat import iteritems\n\nfrom sentry_sdk._types import MYPY\n\nif MYPY:\n from logging import LogRecord\n from typing import Any\n from typing import Dict\n from typing import Optional\n\nDEFAULT_LEVEL = logging.INFO\nDEFAULT_EVENT_LEVEL = logging.ERROR\n\n_IGNORED_LOGGERS = set([\"sentry_sdk.errors\"])\n\n\ndef ignore_logger(name):\n # type: (str) -> None\n \"\"\"This disables recording (both in breadcrumbs and as events) calls to\n a logger of a specific name. Among other uses, many of our integrations\n use this to prevent their actions being recorded as breadcrumbs. Exposed\n to users as a way to quiet spammy loggers.\n \"\"\"\n _IGNORED_LOGGERS.add(name)\n\n\nclass LoggingIntegration(Integration):\n identifier = \"logging\"\n\n def __init__(self, level=DEFAULT_LEVEL, event_level=DEFAULT_EVENT_LEVEL):\n # type: (Optional[int], Optional[int]) -> None\n self._handler = None\n self._breadcrumb_handler = None\n\n if level is not None:\n self._breadcrumb_handler = BreadcrumbHandler(level=level)\n\n if event_level is not None:\n self._handler = EventHandler(level=event_level)\n\n def _handle_record(self, record):\n # type: (LogRecord) -> None\n if self._handler is not None and record.levelno >= self._handler.level:\n self._handler.handle(record)\n\n if (\n self._breadcrumb_handler is not None\n and record.levelno >= self._breadcrumb_handler.level\n ):\n self._breadcrumb_handler.handle(record)\n\n @staticmethod\n def setup_once():\n # type: () -> None\n old_callhandlers = logging.Logger.callHandlers # type: ignore\n\n def sentry_patched_callhandlers(self, record):\n # type: (Any, LogRecord) -> Any\n try:\n return old_callhandlers(self, record)\n finally:\n # This check is done twice, once also here before we even get\n # the integration. Otherwise we have a high chance of getting\n # into a recursion error when the integration is resolved\n # (this also is slower).\n if record.name not in _IGNORED_LOGGERS:\n integration = Hub.current.get_integration(LoggingIntegration)\n if integration is not None:\n integration._handle_record(record)\n\n logging.Logger.callHandlers = sentry_patched_callhandlers # type: ignore\n\n\ndef _can_record(record):\n # type: (LogRecord) -> bool\n return record.name not in _IGNORED_LOGGERS\n\n\ndef _breadcrumb_from_record(record):\n # type: (LogRecord) -> Dict[str, Any]\n return {\n \"ty\": \"log\",\n \"level\": _logging_to_event_level(record.levelname),\n \"category\": record.name,\n \"message\": record.message,\n \"timestamp\": datetime.datetime.fromtimestamp(record.created),\n \"data\": _extra_from_record(record),\n }\n\n\ndef _logging_to_event_level(levelname):\n # type: (str) -> str\n return {\"critical\": \"fatal\"}.get(levelname.lower(), levelname.lower())\n\n\nCOMMON_RECORD_ATTRS = frozenset(\n (\n \"args\",\n \"created\",\n \"exc_info\",\n \"exc_text\",\n \"filename\",\n \"funcName\",\n \"levelname\",\n \"levelno\",\n \"linenno\",\n \"lineno\",\n \"message\",\n \"module\",\n \"msecs\",\n \"msg\",\n \"name\",\n \"pathname\",\n \"process\",\n \"processName\",\n \"relativeCreated\",\n \"stack\",\n \"tags\",\n \"thread\",\n \"threadName\",\n )\n)\n\n\ndef _extra_from_record(record):\n # type: (LogRecord) -> Dict[str, None]\n return {\n k: v\n for k, v in iteritems(vars(record))\n if k not in COMMON_RECORD_ATTRS\n and (not isinstance(k, str) or not k.startswith(\"_\"))\n }\n\n\nclass EventHandler(logging.Handler, object):\n def emit(self, record):\n # type: (LogRecord) -> Any\n with capture_internal_exceptions():\n self.format(record)\n return self._emit(record)\n\n def _emit(self, record):\n # type: (LogRecord) -> None\n if not _can_record(record):\n return\n\n hub = Hub.current\n if hub.client is None:\n return\n\n client_options = hub.client.options\n\n # exc_info might be None or (None, None, None)\n if record.exc_info is not None and record.exc_info[0] is not None:\n event, hint = event_from_exception(\n record.exc_info,\n client_options=client_options,\n mechanism={\"type\": \"logging\", \"handled\": True},\n )\n elif record.exc_info and record.exc_info[0] is None:\n event = {}\n hint = {}\n with capture_internal_exceptions():\n event[\"threads\"] = {\n \"values\": [\n {\n \"stacktrace\": current_stacktrace(\n client_options[\"with_locals\"]\n ),\n \"crashed\": False,\n \"current\": True,\n }\n ]\n }\n else:\n event = {}\n hint = {}\n\n hint[\"log_record\"] = record\n\n event[\"level\"] = _logging_to_event_level(record.levelname)\n event[\"logger\"] = record.name\n event[\"logentry\"] = {\"message\": to_string(record.msg), \"params\": record.args}\n event[\"extra\"] = _extra_from_record(record)\n\n hub.capture_event(event, hint=hint)\n\n\n# Legacy name\nSentryHandler = EventHandler\n\n\nclass BreadcrumbHandler(logging.Handler, object):\n def emit(self, record):\n # type: (LogRecord) -> Any\n with capture_internal_exceptions():\n self.format(record)\n return self._emit(record)\n\n def _emit(self, record):\n # type: (LogRecord) -> None\n if not _can_record(record):\n return\n\n Hub.current.add_breadcrumb(\n _breadcrumb_from_record(record), hint={\"log_record\": record}\n )\n","path":"sentry_sdk/integrations/logging.py"}],"string":"[\n {\n \"content\": \"from __future__ import absolute_import\\n\\nimport logging\\nimport datetime\\n\\nfrom sentry_sdk.hub import Hub\\nfrom sentry_sdk.utils import (\\n to_string,\\n event_from_exception,\\n current_stacktrace,\\n capture_internal_exceptions,\\n)\\nfrom sentry_sdk.integrations import Integration\\nfrom sentry_sdk._compat import iteritems\\n\\nfrom sentry_sdk._types import MYPY\\n\\nif MYPY:\\n from logging import LogRecord\\n from typing import Any\\n from typing import Dict\\n from typing import Optional\\n\\nDEFAULT_LEVEL = logging.INFO\\nDEFAULT_EVENT_LEVEL = logging.ERROR\\n\\n_IGNORED_LOGGERS = set([\\\"sentry_sdk.errors\\\"])\\n\\n\\ndef ignore_logger(name):\\n # type: (str) -> None\\n \\\"\\\"\\\"This disables recording (both in breadcrumbs and as events) calls to\\n a logger of a specific name. Among other uses, many of our integrations\\n use this to prevent their actions being recorded as breadcrumbs. Exposed\\n to users as a way to quiet spammy loggers.\\n \\\"\\\"\\\"\\n _IGNORED_LOGGERS.add(name)\\n\\n\\nclass LoggingIntegration(Integration):\\n identifier = \\\"logging\\\"\\n\\n def __init__(self, level=DEFAULT_LEVEL, event_level=DEFAULT_EVENT_LEVEL):\\n # type: (Optional[int], Optional[int]) -> None\\n self._handler = None\\n self._breadcrumb_handler = None\\n\\n if level is not None:\\n self._breadcrumb_handler = BreadcrumbHandler(level=level)\\n\\n if event_level is not None:\\n self._handler = EventHandler(level=event_level)\\n\\n def _handle_record(self, record):\\n # type: (LogRecord) -> None\\n if self._handler is not None and record.levelno >= self._handler.level:\\n self._handler.handle(record)\\n\\n if (\\n self._breadcrumb_handler is not None\\n and record.levelno >= self._breadcrumb_handler.level\\n ):\\n self._breadcrumb_handler.handle(record)\\n\\n @staticmethod\\n def setup_once():\\n # type: () -> None\\n old_callhandlers = logging.Logger.callHandlers # type: ignore\\n\\n def sentry_patched_callhandlers(self, record):\\n # type: (Any, LogRecord) -> Any\\n try:\\n return old_callhandlers(self, record)\\n finally:\\n # This check is done twice, once also here before we even get\\n # the integration. Otherwise we have a high chance of getting\\n # into a recursion error when the integration is resolved\\n # (this also is slower).\\n if record.name not in _IGNORED_LOGGERS:\\n integration = Hub.current.get_integration(LoggingIntegration)\\n if integration is not None:\\n integration._handle_record(record)\\n\\n logging.Logger.callHandlers = sentry_patched_callhandlers # type: ignore\\n\\n\\ndef _can_record(record):\\n # type: (LogRecord) -> bool\\n return record.name not in _IGNORED_LOGGERS\\n\\n\\ndef _breadcrumb_from_record(record):\\n # type: (LogRecord) -> Dict[str, Any]\\n return {\\n \\\"ty\\\": \\\"log\\\",\\n \\\"level\\\": _logging_to_event_level(record.levelname),\\n \\\"category\\\": record.name,\\n \\\"message\\\": record.message,\\n \\\"timestamp\\\": datetime.datetime.fromtimestamp(record.created),\\n \\\"data\\\": _extra_from_record(record),\\n }\\n\\n\\ndef _logging_to_event_level(levelname):\\n # type: (str) -> str\\n return {\\\"critical\\\": \\\"fatal\\\"}.get(levelname.lower(), levelname.lower())\\n\\n\\nCOMMON_RECORD_ATTRS = frozenset(\\n (\\n \\\"args\\\",\\n \\\"created\\\",\\n \\\"exc_info\\\",\\n \\\"exc_text\\\",\\n \\\"filename\\\",\\n \\\"funcName\\\",\\n \\\"levelname\\\",\\n \\\"levelno\\\",\\n \\\"linenno\\\",\\n \\\"lineno\\\",\\n \\\"message\\\",\\n \\\"module\\\",\\n \\\"msecs\\\",\\n \\\"msg\\\",\\n \\\"name\\\",\\n \\\"pathname\\\",\\n \\\"process\\\",\\n \\\"processName\\\",\\n \\\"relativeCreated\\\",\\n \\\"stack\\\",\\n \\\"tags\\\",\\n \\\"thread\\\",\\n \\\"threadName\\\",\\n )\\n)\\n\\n\\ndef _extra_from_record(record):\\n # type: (LogRecord) -> Dict[str, None]\\n return {\\n k: v\\n for k, v in iteritems(vars(record))\\n if k not in COMMON_RECORD_ATTRS\\n and (not isinstance(k, str) or not k.startswith(\\\"_\\\"))\\n }\\n\\n\\nclass EventHandler(logging.Handler, object):\\n def emit(self, record):\\n # type: (LogRecord) -> Any\\n with capture_internal_exceptions():\\n self.format(record)\\n return self._emit(record)\\n\\n def _emit(self, record):\\n # type: (LogRecord) -> None\\n if not _can_record(record):\\n return\\n\\n hub = Hub.current\\n if hub.client is None:\\n return\\n\\n client_options = hub.client.options\\n\\n # exc_info might be None or (None, None, None)\\n if record.exc_info is not None and record.exc_info[0] is not None:\\n event, hint = event_from_exception(\\n record.exc_info,\\n client_options=client_options,\\n mechanism={\\\"type\\\": \\\"logging\\\", \\\"handled\\\": True},\\n )\\n elif record.exc_info and record.exc_info[0] is None:\\n event = {}\\n hint = {}\\n with capture_internal_exceptions():\\n event[\\\"threads\\\"] = {\\n \\\"values\\\": [\\n {\\n \\\"stacktrace\\\": current_stacktrace(\\n client_options[\\\"with_locals\\\"]\\n ),\\n \\\"crashed\\\": False,\\n \\\"current\\\": True,\\n }\\n ]\\n }\\n else:\\n event = {}\\n hint = {}\\n\\n hint[\\\"log_record\\\"] = record\\n\\n event[\\\"level\\\"] = _logging_to_event_level(record.levelname)\\n event[\\\"logger\\\"] = record.name\\n event[\\\"logentry\\\"] = {\\\"message\\\": to_string(record.msg), \\\"params\\\": record.args}\\n event[\\\"extra\\\"] = _extra_from_record(record)\\n\\n hub.capture_event(event, hint=hint)\\n\\n\\n# Legacy name\\nSentryHandler = EventHandler\\n\\n\\nclass BreadcrumbHandler(logging.Handler, object):\\n def emit(self, record):\\n # type: (LogRecord) -> Any\\n with capture_internal_exceptions():\\n self.format(record)\\n return self._emit(record)\\n\\n def _emit(self, record):\\n # type: (LogRecord) -> None\\n if not _can_record(record):\\n return\\n\\n Hub.current.add_breadcrumb(\\n _breadcrumb_from_record(record), hint={\\\"log_record\\\": record}\\n )\\n\",\n \"path\": \"sentry_sdk/integrations/logging.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"from __future__ import absolute_import\n\nimport logging\nimport datetime\n\nfrom sentry_sdk.hub import Hub\nfrom sentry_sdk.utils import (\n to_string,\n event_from_exception,\n current_stacktrace,\n capture_internal_exceptions,\n)\nfrom sentry_sdk.integrations import Integration\nfrom sentry_sdk._compat import iteritems\n\nfrom sentry_sdk._types import MYPY\n\nif MYPY:\n from logging import LogRecord\n from typing import Any\n from typing import Dict\n from typing import Optional\n\nDEFAULT_LEVEL = logging.INFO\nDEFAULT_EVENT_LEVEL = logging.ERROR\n\n_IGNORED_LOGGERS = set([\"sentry_sdk.errors\"])\n\n\ndef ignore_logger(name):\n # type: (str) -> None\n \"\"\"This disables recording (both in breadcrumbs and as events) calls to\n a logger of a specific name. Among other uses, many of our integrations\n use this to prevent their actions being recorded as breadcrumbs. Exposed\n to users as a way to quiet spammy loggers.\n \"\"\"\n _IGNORED_LOGGERS.add(name)\n\n\nclass LoggingIntegration(Integration):\n identifier = \"logging\"\n\n def __init__(self, level=DEFAULT_LEVEL, event_level=DEFAULT_EVENT_LEVEL):\n # type: (Optional[int], Optional[int]) -> None\n self._handler = None\n self._breadcrumb_handler = None\n\n if level is not None:\n self._breadcrumb_handler = BreadcrumbHandler(level=level)\n\n if event_level is not None:\n self._handler = EventHandler(level=event_level)\n\n def _handle_record(self, record):\n # type: (LogRecord) -> None\n if self._handler is not None and record.levelno >= self._handler.level:\n self._handler.handle(record)\n\n if (\n self._breadcrumb_handler is not None\n and record.levelno >= self._breadcrumb_handler.level\n ):\n self._breadcrumb_handler.handle(record)\n\n @staticmethod\n def setup_once():\n # type: () -> None\n old_callhandlers = logging.Logger.callHandlers # type: ignore\n\n def sentry_patched_callhandlers(self, record):\n # type: (Any, LogRecord) -> Any\n try:\n return old_callhandlers(self, record)\n finally:\n # This check is done twice, once also here before we even get\n # the integration. Otherwise we have a high chance of getting\n # into a recursion error when the integration is resolved\n # (this also is slower).\n if record.name not in _IGNORED_LOGGERS:\n integration = Hub.current.get_integration(LoggingIntegration)\n if integration is not None:\n integration._handle_record(record)\n\n logging.Logger.callHandlers = sentry_patched_callhandlers # type: ignore\n\n\ndef _can_record(record):\n # type: (LogRecord) -> bool\n return record.name not in _IGNORED_LOGGERS\n\n\ndef _breadcrumb_from_record(record):\n # type: (LogRecord) -> Dict[str, Any]\n return {\n \"ty\": \"log\",\n \"level\": _logging_to_event_level(record.levelname),\n \"category\": record.name,\n \"message\": record.message,\n \"timestamp\": datetime.datetime.utcfromtimestamp(record.created),\n \"data\": _extra_from_record(record),\n }\n\n\ndef _logging_to_event_level(levelname):\n # type: (str) -> str\n return {\"critical\": \"fatal\"}.get(levelname.lower(), levelname.lower())\n\n\nCOMMON_RECORD_ATTRS = frozenset(\n (\n \"args\",\n \"created\",\n \"exc_info\",\n \"exc_text\",\n \"filename\",\n \"funcName\",\n \"levelname\",\n \"levelno\",\n \"linenno\",\n \"lineno\",\n \"message\",\n \"module\",\n \"msecs\",\n \"msg\",\n \"name\",\n \"pathname\",\n \"process\",\n \"processName\",\n \"relativeCreated\",\n \"stack\",\n \"tags\",\n \"thread\",\n \"threadName\",\n )\n)\n\n\ndef _extra_from_record(record):\n # type: (LogRecord) -> Dict[str, None]\n return {\n k: v\n for k, v in iteritems(vars(record))\n if k not in COMMON_RECORD_ATTRS\n and (not isinstance(k, str) or not k.startswith(\"_\"))\n }\n\n\nclass EventHandler(logging.Handler, object):\n def emit(self, record):\n # type: (LogRecord) -> Any\n with capture_internal_exceptions():\n self.format(record)\n return self._emit(record)\n\n def _emit(self, record):\n # type: (LogRecord) -> None\n if not _can_record(record):\n return\n\n hub = Hub.current\n if hub.client is None:\n return\n\n client_options = hub.client.options\n\n # exc_info might be None or (None, None, None)\n if record.exc_info is not None and record.exc_info[0] is not None:\n event, hint = event_from_exception(\n record.exc_info,\n client_options=client_options,\n mechanism={\"type\": \"logging\", \"handled\": True},\n )\n elif record.exc_info and record.exc_info[0] is None:\n event = {}\n hint = {}\n with capture_internal_exceptions():\n event[\"threads\"] = {\n \"values\": [\n {\n \"stacktrace\": current_stacktrace(\n client_options[\"with_locals\"]\n ),\n \"crashed\": False,\n \"current\": True,\n }\n ]\n }\n else:\n event = {}\n hint = {}\n\n hint[\"log_record\"] = record\n\n event[\"level\"] = _logging_to_event_level(record.levelname)\n event[\"logger\"] = record.name\n event[\"logentry\"] = {\"message\": to_string(record.msg), \"params\": record.args}\n event[\"extra\"] = _extra_from_record(record)\n\n hub.capture_event(event, hint=hint)\n\n\n# Legacy name\nSentryHandler = EventHandler\n\n\nclass BreadcrumbHandler(logging.Handler, object):\n def emit(self, record):\n # type: (LogRecord) -> Any\n with capture_internal_exceptions():\n self.format(record)\n return self._emit(record)\n\n def _emit(self, record):\n # type: (LogRecord) -> None\n if not _can_record(record):\n return\n\n Hub.current.add_breadcrumb(\n _breadcrumb_from_record(record), hint={\"log_record\": record}\n )\n","path":"sentry_sdk/integrations/logging.py"}],"string":"[\n {\n \"content\": \"from __future__ import absolute_import\\n\\nimport logging\\nimport datetime\\n\\nfrom sentry_sdk.hub import Hub\\nfrom sentry_sdk.utils import (\\n to_string,\\n event_from_exception,\\n current_stacktrace,\\n capture_internal_exceptions,\\n)\\nfrom sentry_sdk.integrations import Integration\\nfrom sentry_sdk._compat import iteritems\\n\\nfrom sentry_sdk._types import MYPY\\n\\nif MYPY:\\n from logging import LogRecord\\n from typing import Any\\n from typing import Dict\\n from typing import Optional\\n\\nDEFAULT_LEVEL = logging.INFO\\nDEFAULT_EVENT_LEVEL = logging.ERROR\\n\\n_IGNORED_LOGGERS = set([\\\"sentry_sdk.errors\\\"])\\n\\n\\ndef ignore_logger(name):\\n # type: (str) -> None\\n \\\"\\\"\\\"This disables recording (both in breadcrumbs and as events) calls to\\n a logger of a specific name. Among other uses, many of our integrations\\n use this to prevent their actions being recorded as breadcrumbs. Exposed\\n to users as a way to quiet spammy loggers.\\n \\\"\\\"\\\"\\n _IGNORED_LOGGERS.add(name)\\n\\n\\nclass LoggingIntegration(Integration):\\n identifier = \\\"logging\\\"\\n\\n def __init__(self, level=DEFAULT_LEVEL, event_level=DEFAULT_EVENT_LEVEL):\\n # type: (Optional[int], Optional[int]) -> None\\n self._handler = None\\n self._breadcrumb_handler = None\\n\\n if level is not None:\\n self._breadcrumb_handler = BreadcrumbHandler(level=level)\\n\\n if event_level is not None:\\n self._handler = EventHandler(level=event_level)\\n\\n def _handle_record(self, record):\\n # type: (LogRecord) -> None\\n if self._handler is not None and record.levelno >= self._handler.level:\\n self._handler.handle(record)\\n\\n if (\\n self._breadcrumb_handler is not None\\n and record.levelno >= self._breadcrumb_handler.level\\n ):\\n self._breadcrumb_handler.handle(record)\\n\\n @staticmethod\\n def setup_once():\\n # type: () -> None\\n old_callhandlers = logging.Logger.callHandlers # type: ignore\\n\\n def sentry_patched_callhandlers(self, record):\\n # type: (Any, LogRecord) -> Any\\n try:\\n return old_callhandlers(self, record)\\n finally:\\n # This check is done twice, once also here before we even get\\n # the integration. Otherwise we have a high chance of getting\\n # into a recursion error when the integration is resolved\\n # (this also is slower).\\n if record.name not in _IGNORED_LOGGERS:\\n integration = Hub.current.get_integration(LoggingIntegration)\\n if integration is not None:\\n integration._handle_record(record)\\n\\n logging.Logger.callHandlers = sentry_patched_callhandlers # type: ignore\\n\\n\\ndef _can_record(record):\\n # type: (LogRecord) -> bool\\n return record.name not in _IGNORED_LOGGERS\\n\\n\\ndef _breadcrumb_from_record(record):\\n # type: (LogRecord) -> Dict[str, Any]\\n return {\\n \\\"ty\\\": \\\"log\\\",\\n \\\"level\\\": _logging_to_event_level(record.levelname),\\n \\\"category\\\": record.name,\\n \\\"message\\\": record.message,\\n \\\"timestamp\\\": datetime.datetime.utcfromtimestamp(record.created),\\n \\\"data\\\": _extra_from_record(record),\\n }\\n\\n\\ndef _logging_to_event_level(levelname):\\n # type: (str) -> str\\n return {\\\"critical\\\": \\\"fatal\\\"}.get(levelname.lower(), levelname.lower())\\n\\n\\nCOMMON_RECORD_ATTRS = frozenset(\\n (\\n \\\"args\\\",\\n \\\"created\\\",\\n \\\"exc_info\\\",\\n \\\"exc_text\\\",\\n \\\"filename\\\",\\n \\\"funcName\\\",\\n \\\"levelname\\\",\\n \\\"levelno\\\",\\n \\\"linenno\\\",\\n \\\"lineno\\\",\\n \\\"message\\\",\\n \\\"module\\\",\\n \\\"msecs\\\",\\n \\\"msg\\\",\\n \\\"name\\\",\\n \\\"pathname\\\",\\n \\\"process\\\",\\n \\\"processName\\\",\\n \\\"relativeCreated\\\",\\n \\\"stack\\\",\\n \\\"tags\\\",\\n \\\"thread\\\",\\n \\\"threadName\\\",\\n )\\n)\\n\\n\\ndef _extra_from_record(record):\\n # type: (LogRecord) -> Dict[str, None]\\n return {\\n k: v\\n for k, v in iteritems(vars(record))\\n if k not in COMMON_RECORD_ATTRS\\n and (not isinstance(k, str) or not k.startswith(\\\"_\\\"))\\n }\\n\\n\\nclass EventHandler(logging.Handler, object):\\n def emit(self, record):\\n # type: (LogRecord) -> Any\\n with capture_internal_exceptions():\\n self.format(record)\\n return self._emit(record)\\n\\n def _emit(self, record):\\n # type: (LogRecord) -> None\\n if not _can_record(record):\\n return\\n\\n hub = Hub.current\\n if hub.client is None:\\n return\\n\\n client_options = hub.client.options\\n\\n # exc_info might be None or (None, None, None)\\n if record.exc_info is not None and record.exc_info[0] is not None:\\n event, hint = event_from_exception(\\n record.exc_info,\\n client_options=client_options,\\n mechanism={\\\"type\\\": \\\"logging\\\", \\\"handled\\\": True},\\n )\\n elif record.exc_info and record.exc_info[0] is None:\\n event = {}\\n hint = {}\\n with capture_internal_exceptions():\\n event[\\\"threads\\\"] = {\\n \\\"values\\\": [\\n {\\n \\\"stacktrace\\\": current_stacktrace(\\n client_options[\\\"with_locals\\\"]\\n ),\\n \\\"crashed\\\": False,\\n \\\"current\\\": True,\\n }\\n ]\\n }\\n else:\\n event = {}\\n hint = {}\\n\\n hint[\\\"log_record\\\"] = record\\n\\n event[\\\"level\\\"] = _logging_to_event_level(record.levelname)\\n event[\\\"logger\\\"] = record.name\\n event[\\\"logentry\\\"] = {\\\"message\\\": to_string(record.msg), \\\"params\\\": record.args}\\n event[\\\"extra\\\"] = _extra_from_record(record)\\n\\n hub.capture_event(event, hint=hint)\\n\\n\\n# Legacy name\\nSentryHandler = EventHandler\\n\\n\\nclass BreadcrumbHandler(logging.Handler, object):\\n def emit(self, record):\\n # type: (LogRecord) -> Any\\n with capture_internal_exceptions():\\n self.format(record)\\n return self._emit(record)\\n\\n def _emit(self, record):\\n # type: (LogRecord) -> None\\n if not _can_record(record):\\n return\\n\\n Hub.current.add_breadcrumb(\\n _breadcrumb_from_record(record), hint={\\\"log_record\\\": record}\\n )\\n\",\n \"path\": \"sentry_sdk/integrations/logging.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/sentry_sdk/integrations/logging.py b/sentry_sdk/integrations/logging.py\nindex 512c3dada5..e0a1455313 100644\n--- a/sentry_sdk/integrations/logging.py\n+++ b/sentry_sdk/integrations/logging.py\n@@ -96,7 +96,7 @@ def _breadcrumb_from_record(record):\n \"level\": _logging_to_event_level(record.levelname),\n \"category\": record.name,\n \"message\": record.message,\n- \"timestamp\": datetime.datetime.fromtimestamp(record.created),\n+ \"timestamp\": datetime.datetime.utcfromtimestamp(record.created),\n \"data\": _extra_from_record(record),\n }\n \n"}}},{"rowIdx":4683,"cells":{"in_source_id":{"kind":"string","value":"cal-itp__benefits-1229"},"issue":{"kind":"string","value":"Investigate missing event properties\nIn #1057 we made some changes to the base `Event` type, to include an `eligibility_types` property on all events we send into Amplitude.\r\n\r\n## OAuth events\r\n\r\nLooking at the event reports over the last 14 days of production data, the [`started sign in` event](https://github.com/cal-itp/benefits/blob/dev/benefits/oauth/analytics.py#L16) is missing the `eligibility_types` property in 100% of recorded events. [See report here](https://data.amplitude.com/compiler/Benefits/events/main/latest/started%20sign%20in).\r\n\r\n## Eligibility events\r\n\r\nWe're also seeing unexpected behavior with the `eligibility` events for `courtesy_card`: the `eligiblity_types` property is coming through with the `event_properties`, but not with `user_properties`, leading to blanks/`(none)` when plotting the events on user-based charts. \r\n\r\nFor example, this [user checked `courtesy_card` eligibility](https://analytics.amplitude.com/compiler/project/304110/search/amplitude_id%3D555656738955?collapsed=true&sessionHandle=YXoogID_YXoogIG_IFfuPiL_BKPu_2b6a1cea-210a-8693-6f25-38c5de0f39c3&eventId=b505e207-9ca1-11ed-967a-9bb610a8bd25) and we can see the value in the raw `event_properties` output, but not `user_properties`:\r\n\r\n```json\r\n{\r\n \"amplitude_id\": 555656738955,\r\n \"app\": 304110,\r\n \"client_event_time\": \"2023-01-25 11:16:23.396000\",\r\n \"client_upload_time\": \"2023-01-25 11:16:23.506000\",\r\n \"data_type\": \"event\",\r\n \"display_name\": \"started eligibility\",\r\n \"event_id\": 664,\r\n \"event_properties\": {\r\n \"eligibility_types\": [\r\n \"courtesy_card\"\r\n ],\r\n \"eligibility_verifier\": \"MST Courtesy Card Eligibility Server Verifier\",\r\n \"path\": \"/eligibility/confirm\",\r\n \"transit_agency\": \"Monterey-Salinas Transit\"\r\n },\r\n \"event_time\": \"2023-01-25 11:16:23.396000\",\r\n \"event_type\": \"started eligibility\",\r\n \"language\": \"English\",\r\n \"library\": \"http/2.0\",\r\n \"server_received_time\": \"2023-01-25 11:16:23.506000\",\r\n \"server_upload_time\": \"2023-01-25 11:16:23.508000\",\r\n \"session_id\": 1674645209603,\r\n \"source_id\": null,\r\n \"start_version\": \"2023.01.1\",\r\n \"timeline_hidden\": false,\r\n \"user_creation_time\": \"2023-01-25 11:13:29.606000\",\r\n \"user_id\": \"35aabc7e-d98c-451d-95ec-e4033fcec987\",\r\n \"user_properties\": {\r\n \"eligibility_verifier\": \"MST Courtesy Card Eligibility Server Verifier\",\r\n \"referrer\": \"https://benefits.calitp.org/eligibility/confirm\",\r\n \"referring_domain\": \"benefits.calitp.org\",\r\n \"transit_agency\": \"Monterey-Salinas Transit\",\r\n \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36\"\r\n },\r\n \"uuid\": \"b505e207-9ca1-11ed-967a-9bb610a8bd25\",\r\n \"version_name\": \"2023.01.1\"\r\n}\r\n```\r\n\r\nAnd the resulting user chart shows categorizes this event as `(none)`:\r\n\r\n<img width=\"680\" alt=\"image\" src=\"https://user-images.githubusercontent.com/1783439/215842237-10a52ea7-5bad-4fa2-ad08-004e01d1f174.png\">\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"\"\"\"\nThe eligibility application: analytics implementation.\n\"\"\"\nfrom benefits.core import analytics as core\n\n\nclass EligibilityEvent(core.Event):\n \"\"\"Base analytics event for eligibility verification.\"\"\"\n\n def __init__(self, request, event_type, eligibility_types):\n super().__init__(request, event_type)\n # overwrite core.Event eligibility_types\n self.update_event_properties(eligibility_types=eligibility_types)\n\n\nclass SelectedVerifierEvent(EligibilityEvent):\n \"\"\"Analytics event representing the user selecting an eligibility verifier.\"\"\"\n\n def __init__(self, request, eligibility_types):\n super().__init__(request, \"selected eligibility verifier\", eligibility_types)\n\n\nclass StartedEligibilityEvent(EligibilityEvent):\n \"\"\"Analytics event representing the beginning of an eligibility verification check.\"\"\"\n\n def __init__(self, request, eligibility_types):\n super().__init__(request, \"started eligibility\", eligibility_types)\n\n\nclass ReturnedEligibilityEvent(EligibilityEvent):\n \"\"\"Analytics event representing the end of an eligibility verification check.\"\"\"\n\n def __init__(self, request, eligibility_types, status, error=None):\n super().__init__(request, \"returned eligibility\", eligibility_types)\n status = str(status).lower()\n if status in (\"error\", \"fail\", \"success\"):\n self.update_event_properties(status=status, error=error)\n if status == \"success\":\n self.update_user_properties(eligibility_types=eligibility_types)\n\n\ndef selected_verifier(request, eligibility_types):\n \"\"\"Send the \"selected eligibility verifier\" analytics event.\"\"\"\n core.send_event(SelectedVerifierEvent(request, eligibility_types))\n\n\ndef started_eligibility(request, eligibility_types):\n \"\"\"Send the \"started eligibility\" analytics event.\"\"\"\n core.send_event(StartedEligibilityEvent(request, eligibility_types))\n\n\ndef returned_error(request, eligibility_types, error):\n \"\"\"Send the \"returned eligibility\" analytics event with an error status.\"\"\"\n core.send_event(ReturnedEligibilityEvent(request, eligibility_types, status=\"error\", error=error))\n\n\ndef returned_fail(request, eligibility_types):\n \"\"\"Send the \"returned eligibility\" analytics event with a fail status.\"\"\"\n core.send_event(ReturnedEligibilityEvent(request, eligibility_types, status=\"fail\"))\n\n\ndef returned_success(request, eligibility_types):\n \"\"\"Send the \"returned eligibility\" analytics event with a success status.\"\"\"\n core.send_event(ReturnedEligibilityEvent(request, eligibility_types, status=\"success\"))\n","path":"benefits/eligibility/analytics.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"\\nThe eligibility application: analytics implementation.\\n\\\"\\\"\\\"\\nfrom benefits.core import analytics as core\\n\\n\\nclass EligibilityEvent(core.Event):\\n \\\"\\\"\\\"Base analytics event for eligibility verification.\\\"\\\"\\\"\\n\\n def __init__(self, request, event_type, eligibility_types):\\n super().__init__(request, event_type)\\n # overwrite core.Event eligibility_types\\n self.update_event_properties(eligibility_types=eligibility_types)\\n\\n\\nclass SelectedVerifierEvent(EligibilityEvent):\\n \\\"\\\"\\\"Analytics event representing the user selecting an eligibility verifier.\\\"\\\"\\\"\\n\\n def __init__(self, request, eligibility_types):\\n super().__init__(request, \\\"selected eligibility verifier\\\", eligibility_types)\\n\\n\\nclass StartedEligibilityEvent(EligibilityEvent):\\n \\\"\\\"\\\"Analytics event representing the beginning of an eligibility verification check.\\\"\\\"\\\"\\n\\n def __init__(self, request, eligibility_types):\\n super().__init__(request, \\\"started eligibility\\\", eligibility_types)\\n\\n\\nclass ReturnedEligibilityEvent(EligibilityEvent):\\n \\\"\\\"\\\"Analytics event representing the end of an eligibility verification check.\\\"\\\"\\\"\\n\\n def __init__(self, request, eligibility_types, status, error=None):\\n super().__init__(request, \\\"returned eligibility\\\", eligibility_types)\\n status = str(status).lower()\\n if status in (\\\"error\\\", \\\"fail\\\", \\\"success\\\"):\\n self.update_event_properties(status=status, error=error)\\n if status == \\\"success\\\":\\n self.update_user_properties(eligibility_types=eligibility_types)\\n\\n\\ndef selected_verifier(request, eligibility_types):\\n \\\"\\\"\\\"Send the \\\"selected eligibility verifier\\\" analytics event.\\\"\\\"\\\"\\n core.send_event(SelectedVerifierEvent(request, eligibility_types))\\n\\n\\ndef started_eligibility(request, eligibility_types):\\n \\\"\\\"\\\"Send the \\\"started eligibility\\\" analytics event.\\\"\\\"\\\"\\n core.send_event(StartedEligibilityEvent(request, eligibility_types))\\n\\n\\ndef returned_error(request, eligibility_types, error):\\n \\\"\\\"\\\"Send the \\\"returned eligibility\\\" analytics event with an error status.\\\"\\\"\\\"\\n core.send_event(ReturnedEligibilityEvent(request, eligibility_types, status=\\\"error\\\", error=error))\\n\\n\\ndef returned_fail(request, eligibility_types):\\n \\\"\\\"\\\"Send the \\\"returned eligibility\\\" analytics event with a fail status.\\\"\\\"\\\"\\n core.send_event(ReturnedEligibilityEvent(request, eligibility_types, status=\\\"fail\\\"))\\n\\n\\ndef returned_success(request, eligibility_types):\\n \\\"\\\"\\\"Send the \\\"returned eligibility\\\" analytics event with a success status.\\\"\\\"\\\"\\n core.send_event(ReturnedEligibilityEvent(request, eligibility_types, status=\\\"success\\\"))\\n\",\n \"path\": \"benefits/eligibility/analytics.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"\"\"\"\nThe eligibility application: analytics implementation.\n\"\"\"\nfrom benefits.core import analytics as core\n\n\nclass EligibilityEvent(core.Event):\n \"\"\"Base analytics event for eligibility verification.\"\"\"\n\n def __init__(self, request, event_type, eligibility_types):\n super().__init__(request, event_type)\n # overwrite core.Event eligibility_types\n self.update_event_properties(eligibility_types=eligibility_types)\n self.update_user_properties(eligibility_types=eligibility_types)\n\n\nclass SelectedVerifierEvent(EligibilityEvent):\n \"\"\"Analytics event representing the user selecting an eligibility verifier.\"\"\"\n\n def __init__(self, request, eligibility_types):\n super().__init__(request, \"selected eligibility verifier\", eligibility_types)\n\n\nclass StartedEligibilityEvent(EligibilityEvent):\n \"\"\"Analytics event representing the beginning of an eligibility verification check.\"\"\"\n\n def __init__(self, request, eligibility_types):\n super().__init__(request, \"started eligibility\", eligibility_types)\n\n\nclass ReturnedEligibilityEvent(EligibilityEvent):\n \"\"\"Analytics event representing the end of an eligibility verification check.\"\"\"\n\n def __init__(self, request, eligibility_types, status, error=None):\n super().__init__(request, \"returned eligibility\", eligibility_types)\n status = str(status).lower()\n if status in (\"error\", \"fail\", \"success\"):\n self.update_event_properties(status=status, error=error)\n if status == \"success\":\n self.update_user_properties(eligibility_types=eligibility_types)\n\n\ndef selected_verifier(request, eligibility_types):\n \"\"\"Send the \"selected eligibility verifier\" analytics event.\"\"\"\n core.send_event(SelectedVerifierEvent(request, eligibility_types))\n\n\ndef started_eligibility(request, eligibility_types):\n \"\"\"Send the \"started eligibility\" analytics event.\"\"\"\n core.send_event(StartedEligibilityEvent(request, eligibility_types))\n\n\ndef returned_error(request, eligibility_types, error):\n \"\"\"Send the \"returned eligibility\" analytics event with an error status.\"\"\"\n core.send_event(ReturnedEligibilityEvent(request, eligibility_types, status=\"error\", error=error))\n\n\ndef returned_fail(request, eligibility_types):\n \"\"\"Send the \"returned eligibility\" analytics event with a fail status.\"\"\"\n core.send_event(ReturnedEligibilityEvent(request, eligibility_types, status=\"fail\"))\n\n\ndef returned_success(request, eligibility_types):\n \"\"\"Send the \"returned eligibility\" analytics event with a success status.\"\"\"\n core.send_event(ReturnedEligibilityEvent(request, eligibility_types, status=\"success\"))\n","path":"benefits/eligibility/analytics.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"\\nThe eligibility application: analytics implementation.\\n\\\"\\\"\\\"\\nfrom benefits.core import analytics as core\\n\\n\\nclass EligibilityEvent(core.Event):\\n \\\"\\\"\\\"Base analytics event for eligibility verification.\\\"\\\"\\\"\\n\\n def __init__(self, request, event_type, eligibility_types):\\n super().__init__(request, event_type)\\n # overwrite core.Event eligibility_types\\n self.update_event_properties(eligibility_types=eligibility_types)\\n self.update_user_properties(eligibility_types=eligibility_types)\\n\\n\\nclass SelectedVerifierEvent(EligibilityEvent):\\n \\\"\\\"\\\"Analytics event representing the user selecting an eligibility verifier.\\\"\\\"\\\"\\n\\n def __init__(self, request, eligibility_types):\\n super().__init__(request, \\\"selected eligibility verifier\\\", eligibility_types)\\n\\n\\nclass StartedEligibilityEvent(EligibilityEvent):\\n \\\"\\\"\\\"Analytics event representing the beginning of an eligibility verification check.\\\"\\\"\\\"\\n\\n def __init__(self, request, eligibility_types):\\n super().__init__(request, \\\"started eligibility\\\", eligibility_types)\\n\\n\\nclass ReturnedEligibilityEvent(EligibilityEvent):\\n \\\"\\\"\\\"Analytics event representing the end of an eligibility verification check.\\\"\\\"\\\"\\n\\n def __init__(self, request, eligibility_types, status, error=None):\\n super().__init__(request, \\\"returned eligibility\\\", eligibility_types)\\n status = str(status).lower()\\n if status in (\\\"error\\\", \\\"fail\\\", \\\"success\\\"):\\n self.update_event_properties(status=status, error=error)\\n if status == \\\"success\\\":\\n self.update_user_properties(eligibility_types=eligibility_types)\\n\\n\\ndef selected_verifier(request, eligibility_types):\\n \\\"\\\"\\\"Send the \\\"selected eligibility verifier\\\" analytics event.\\\"\\\"\\\"\\n core.send_event(SelectedVerifierEvent(request, eligibility_types))\\n\\n\\ndef started_eligibility(request, eligibility_types):\\n \\\"\\\"\\\"Send the \\\"started eligibility\\\" analytics event.\\\"\\\"\\\"\\n core.send_event(StartedEligibilityEvent(request, eligibility_types))\\n\\n\\ndef returned_error(request, eligibility_types, error):\\n \\\"\\\"\\\"Send the \\\"returned eligibility\\\" analytics event with an error status.\\\"\\\"\\\"\\n core.send_event(ReturnedEligibilityEvent(request, eligibility_types, status=\\\"error\\\", error=error))\\n\\n\\ndef returned_fail(request, eligibility_types):\\n \\\"\\\"\\\"Send the \\\"returned eligibility\\\" analytics event with a fail status.\\\"\\\"\\\"\\n core.send_event(ReturnedEligibilityEvent(request, eligibility_types, status=\\\"fail\\\"))\\n\\n\\ndef returned_success(request, eligibility_types):\\n \\\"\\\"\\\"Send the \\\"returned eligibility\\\" analytics event with a success status.\\\"\\\"\\\"\\n core.send_event(ReturnedEligibilityEvent(request, eligibility_types, status=\\\"success\\\"))\\n\",\n \"path\": \"benefits/eligibility/analytics.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/benefits/eligibility/analytics.py b/benefits/eligibility/analytics.py\nindex e096c810cc..0dc03322da 100644\n--- a/benefits/eligibility/analytics.py\n+++ b/benefits/eligibility/analytics.py\n@@ -11,6 +11,7 @@ def __init__(self, request, event_type, eligibility_types):\n super().__init__(request, event_type)\n # overwrite core.Event eligibility_types\n self.update_event_properties(eligibility_types=eligibility_types)\n+ self.update_user_properties(eligibility_types=eligibility_types)\n \n \n class SelectedVerifierEvent(EligibilityEvent):\ndiff --git a/tests/pytest/eligibility/test_analytics.py b/tests/pytest/eligibility/test_analytics.py\nindex 62f93d45a4..18028a79d6 100644\n--- a/tests/pytest/eligibility/test_analytics.py\n+++ b/tests/pytest/eligibility/test_analytics.py\n@@ -1,10 +1,10 @@\n import pytest\n \n-from benefits.eligibility.analytics import EligibilityEvent, ReturnedEligibilityEvent\n+from benefits.eligibility.analytics import EligibilityEvent\n \n \n @pytest.mark.django_db\n-def test_EligibilityEvent_overwrites_event_eligibility_types(app_request, mocker):\n+def test_EligibilityEvent_overwrites_eligibility_types(app_request, mocker):\n key, type1, type2 = \"eligibility_types\", \"type1\", \"type2\"\n mocker.patch(\"benefits.core.analytics.session.eligibility\", return_value=[type1])\n mocker.patch(\"benefits.core.analytics.EligibilityType.get_names\", return_value=[type1])\n@@ -16,21 +16,7 @@ def test_EligibilityEvent_overwrites_event_eligibility_types(app_request, mocker\n assert type2 in event.event_properties[key]\n assert type1 not in event.event_properties[key]\n \n- # user_properties should not have been overwritten\n- assert key in event.user_properties\n- assert type1 in event.user_properties[key]\n- assert type2 not in event.user_properties[key]\n-\n-\n-@pytest.mark.django_db\n-def test_ReturnedEligibilityEvent_success_overwrites_user_eligibility_types(app_request, mocker):\n- key, type1, type2 = \"eligibility_types\", \"type1\", \"type2\"\n- mocker.patch(\"benefits.core.analytics.session.eligibility\", return_value=[type1])\n- mocker.patch(\"benefits.core.analytics.EligibilityType.get_names\", return_value=[type1])\n-\n- event = ReturnedEligibilityEvent(app_request, eligibility_types=[type2], status=\"success\")\n-\n # user_properties should have been overwritten\n assert key in event.user_properties\n- assert type1 not in event.user_properties[key]\n assert type2 in event.user_properties[key]\n+ assert type1 not in event.user_properties[key]\n"}}},{"rowIdx":4684,"cells":{"in_source_id":{"kind":"string","value":"RedHatInsights__insights-core-3043"},"issue":{"kind":"string","value":"The dmsetup parser is raising ValueError exceptions in production\nThe DmsetupStatus parser is throwing a large number of the exception ValueError('not enough values to unpack (expected 2, got 1)',) in production.\n"},"before_files":{"kind":"list like","value":[{"content":"\"\"\"\ndmsetup commands - Command ``dmsetup``\n======================================\n\nParsers for parsing and extracting data from output of commands related to\n``dmsetup``.\nParsers contained in this module are:\n\nDmsetupInfo - command ``dmsetup info -C``\n-----------------------------------------\n\nDmsetupStatus - command ``dmsetup status``\n------------------------------------------\n\n\"\"\"\nfrom collections import namedtuple\nfrom insights import parser, CommandParser\nfrom insights.parsers import parse_delimited_table\nfrom insights.parsers import ParseException\nfrom insights.specs import Specs\n\n\nSetupInfo = namedtuple('SetupInfo', [\n 'name', 'major', 'minor', 'open', 'segments', 'events',\n 'live_table', 'inactive_table', 'suspended', 'readonly', 'uuid']\n)\n\"\"\" Data structure to represent dmsetup information \"\"\"\n\nSetupStatus = namedtuple('SetupStatus', [\n 'device_name', 'start_sector', 'num_sectors', 'target_type',\n 'target_args', 'parsed_args']\n)\n\"\"\" Data structure to represent dmsetup status \"\"\"\n\n\n@parser(Specs.dmsetup_info)\nclass DmsetupInfo(CommandParser):\n \"\"\"\n ``dmsetup info -C`` command output\n\n Example input::\n\n Name Maj Min Stat Open Targ Event UUID\n VG00-tmp 253 8 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTax6lLmBji2ueSbX49gxcV76M29cmukQiw4\n VG00-home 253 3 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxCqXOnbGe2zjhX923dFiIdl1oi7mO9tXp\n VG00-var 253 6 L--w 1 2 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxicvyvt67113nTb8vMlGfgdEjDx0LKT2O\n VG00-swap 253 1 L--w 2 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTax3Ll2XhOYZkylx1CjOQi7G4yHgrIOsyqG\n VG00-root 253 0 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxKpnAKYhrYMYMNMwjegkW965bUgtJFTRY\n VG00-var_log_audit 253 5 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxwQ8R0XWJRm86QX3befq1cHRy47Von6ZW\n\n Example data structure produced::\n\n data = [\n {\n 'Stat': 'L--w',\n 'Name': 'VG00-tmp',\n 'Min': '8',\n 'Targ': '1',\n 'Maj': '253',\n 'Open': '1',\n 'Event': '0',\n 'UUID': 'LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTax6lLmBji2ueSbX49gxcV76M29cmukQiw4'\n },...\n ]\n\n Attributes:\n data (list): List of devices found, in order\n names (list): Device names, in order found\n uuids (list): UUID\n by_name (dict): Access to each device by devicename\n by_uuid (dict): Access to each device by uuid\n info (list): List of devices found, in order using SetupInfo structure\n\n Example:\n >>> len(setup_info)\n 6\n >>> setup_info.names[0]\n 'VG00-tmp'\n >>> setup_info[1]['Maj']\n '253'\n >>> setup_info[1]['Stat']\n 'L--w'\n >>> setup_info.info[-1].name\n 'VG00-var_log_audit'\n >>> setup_info.info[-1].major\n 253\n >>> setup_info.info[-1].live_table\n True\n >>> setup_info.info[-1].readonly\n False\n \"\"\"\n\n def parse_content(self, content):\n self.data = parse_delimited_table(content)\n\n self.names = [dm['Name'] for dm in self.data if 'Name' in dm]\n self.by_name = dict((dm['Name'], dm) for dm in self.data if 'Name' in dm)\n self.uuids = [dm['UUID'] for dm in self.data if 'UUID' in dm]\n self.by_uuid = dict((dm['UUID'], dm) for dm in self.data if 'UUID' in dm)\n self.info = []\n for dm in self.data:\n self.info.append(SetupInfo(\n name=dm.get('Name'),\n major=int(dm.get('Maj')) if 'Maj' in dm and dm.get('Maj').isdigit() else None,\n minor=int(dm.get('Min')) if 'Min' in dm and dm.get('Min').isdigit() else None,\n open=int(dm.get('Open')) if 'Open' in dm and dm.get('Open').isdigit() else None,\n segments=int(dm.get('Targ')) if 'Targ' in dm and dm.get('Targ').isdigit() else None,\n events=int(dm.get('Event')) if 'Event' in dm and dm.get('Event').isdigit() else None,\n live_table=dm.get('Stat', '----')[0] == 'L',\n inactive_table=dm.get('Stat', '----')[1] == 'I',\n suspended=dm.get('Stat', '----')[2] == 's',\n readonly=dm.get('Stat', '----')[3] == 'r',\n uuid=dm.get('UUID')\n ))\n\n def __len__(self):\n \"\"\"\n The length of the devices list\n \"\"\"\n return len(self.data)\n\n def __iter__(self):\n \"\"\"\n Iterate through the devices list\n \"\"\"\n for dm in self.data:\n yield dm\n\n def __getitem__(self, idx):\n \"\"\"\n Fetch a device by index in devices list\n \"\"\"\n return self.data[idx]\n\n\n@parser(Specs.dmsetup_status)\nclass DmsetupStatus(CommandParser, list):\n \"\"\"\n ``dmsetup status -C`` command output\n\n Example input::\n\n rootvg-tanlv: 0 6291456 linear\n rootvg-ssnap: 0 16384000 snapshot 1560768/5120000 6088\n rootvg-optvolapp: 0 8192000 snapshot-origin\n docker-253:10-1234567-0df13579: 0 20971520 thin 1922048 20971519\n docker-253:10-4254621-0496628a: 0 20971520 thin 1951744 20971519\n docker-253:10-4254621-d392682f: 0 20971520 thin 7106560 20971519\n rootvg-docker--pool: 0 129548288 thin-pool 1 20/49152 38/126512 - rw no_discard_passdown queue_if_no_space -\n rootvg-tmpvol: 0 2048000 linear\n rootvg-varvol: 0 18874368 snapshot Invalid\n rootvg-optvol: 0 8192000 snapshot 616408/5120000 2408\n rootvg-varvol-cow: 0 5120000 linear\n appsvg-lvapps_docker: 0 104857600 thin-pool 441 697/2048 20663/102400 - rw no_discard_passdown queue_if_no_space -\n\n Example data structure produced::\n\n [\n SetupStatus(\n device_name='rootvg-tanlv', start_sector='0',\n num_sectors='6291456', target_type='linear',\n target_args=None, parsed_args=None,\n ), ...\n ]\n\n Attributes:\n names (list): Device names, in order found\n by_name (dict): Access to each device by devicename\n unparseable_lines (list): Unparseable raw lines\n\n Example:\n >>> len(dmsetup_status)\n 12\n >>> dmsetup_status.names[0]\n 'rootvg-tanlv'\n >>> dmsetup_status[1].target_type\n 'snapshot'\n >>> dmsetup_status[1].start_sector\n '0'\n >>> len(dmsetup_status.by_name)\n 12\n >>> dmsetup_status[-1].parsed_args['used_metadata_blocks']\n '697'\n >>> dmsetup_status[-1].parsed_args['total_metadata_blocks']\n '2048'\n >>> dmsetup_status[-1].parsed_args['opts']\n ['rw', 'no_discard_passdown', 'queue_if_no_space', '-']\n \"\"\"\n\n def parse_content(self, content):\n self.unparseable_lines = []\n for line in content:\n _device_name, _device_info_str = line.rsplit(':', 1)\n device_name = _device_name.strip()\n device_info_spl = _device_info_str.strip().split(' ', 3)\n if len(device_info_spl) < 3:\n self.unparseable_lines.append(line)\n continue\n target_type = device_info_spl[2]\n target_args = device_info_spl[3] if len(device_info_spl) == 4 else None\n parsed_args = None\n if target_args:\n try:\n parsed_args = self._parse_target_args(target_type, target_args)\n except ParseException:\n self.unparseable_lines.append(line)\n self.append(SetupStatus(\n device_name=device_name,\n start_sector=device_info_spl[0],\n num_sectors=device_info_spl[1],\n target_type=target_type,\n target_args=target_args,\n parsed_args=parsed_args,\n ))\n\n @property\n def names(self):\n return [dm[0] for dm in self]\n\n @property\n def by_name(self):\n return dict((dm[0], dm) for dm in self)\n\n def _parse_target_args(self, target_type, target_args):\n pars_func_name = '_parse_target_args_' + target_type.replace('-', '_')\n pars_func = getattr(self, pars_func_name, None)\n return pars_func(target_args) if pars_func else None\n\n def _parse_target_args_thin_pool(self, target_args):\n \"\"\"\n Format:\n <transaction_id> <used_metadata_blocks>/<total_metadata_blocks>\n <used_data_blocks>/<total_data_blocks> <held_metadata_root>\n ro|rw|out_of_data_space [no_]discard_passdown [error|queue]_if_no_space\n needs_check|- metadata_low_watermark\n Refer to https://www.kernel.org/doc/Documentation/device-mapper/thin-provisioning.txt .\n \"\"\"\n args = target_args.split()\n if len(args) < 8 or '/' not in args[1] or '/' not in args[2]:\n raise ParseException(\"Invalid thin_pool target_args: {0}\".format(target_args))\n parsed_args = {}\n parsed_args['transaction_id'] = args[0]\n parsed_args['used_metadata_blocks'], parsed_args['total_metadata_blocks'] = args[1].split('/', 1)\n parsed_args['used_data_blocks'], parsed_args['total_data_blocks'] = args[2].split('/', 1)\n parsed_args['held_metadata_root'] = args[3]\n parsed_args['opts'] = args[4:8]\n parsed_args['metadata_low_watermark'] = args[8] if len(args) > 8 else None\n return parsed_args\n\n def _parse_target_args_thin(self, target_args):\n \"\"\"\n Format:\n <nr_mapped_sectors> <highest_mapped_sector>\n Refer to https://www.kernel.org/doc/Documentation/device-mapper/thin-provisioning.txt .\n \"\"\"\n args = target_args.split()\n if len(args) < 2:\n raise ParseException(\"Invalid thin target_args: {0}\".format(target_args))\n parsed_args = {}\n parsed_args['nr_mapped_sectors'] = args[0]\n parsed_args['highest_mapped_sector'] = args[1]\n return parsed_args\n\n def _parse_target_args_snapshot(self, target_args):\n \"\"\"\n Format:\n <sectors_allocated>/<total_sectors> <metadata_sectors>\n Refer to https://www.kernel.org/doc/Documentation/device-mapper/snapshot.txt .\n \"\"\"\n args = target_args.split()\n if len(args) < 2 or '/' not in args[0]:\n raise ParseException(\"Invalid snapshot target_args: {0}\".format(target_args))\n parsed_args = {}\n parsed_args['sectors_allocated'], parsed_args['total_sectors'] = args[0].split('/', 1)\n parsed_args['metadata_sectors'] = args[1]\n return parsed_args\n","path":"insights/parsers/dmsetup.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"\\ndmsetup commands - Command ``dmsetup``\\n======================================\\n\\nParsers for parsing and extracting data from output of commands related to\\n``dmsetup``.\\nParsers contained in this module are:\\n\\nDmsetupInfo - command ``dmsetup info -C``\\n-----------------------------------------\\n\\nDmsetupStatus - command ``dmsetup status``\\n------------------------------------------\\n\\n\\\"\\\"\\\"\\nfrom collections import namedtuple\\nfrom insights import parser, CommandParser\\nfrom insights.parsers import parse_delimited_table\\nfrom insights.parsers import ParseException\\nfrom insights.specs import Specs\\n\\n\\nSetupInfo = namedtuple('SetupInfo', [\\n 'name', 'major', 'minor', 'open', 'segments', 'events',\\n 'live_table', 'inactive_table', 'suspended', 'readonly', 'uuid']\\n)\\n\\\"\\\"\\\" Data structure to represent dmsetup information \\\"\\\"\\\"\\n\\nSetupStatus = namedtuple('SetupStatus', [\\n 'device_name', 'start_sector', 'num_sectors', 'target_type',\\n 'target_args', 'parsed_args']\\n)\\n\\\"\\\"\\\" Data structure to represent dmsetup status \\\"\\\"\\\"\\n\\n\\n@parser(Specs.dmsetup_info)\\nclass DmsetupInfo(CommandParser):\\n \\\"\\\"\\\"\\n ``dmsetup info -C`` command output\\n\\n Example input::\\n\\n Name Maj Min Stat Open Targ Event UUID\\n VG00-tmp 253 8 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTax6lLmBji2ueSbX49gxcV76M29cmukQiw4\\n VG00-home 253 3 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxCqXOnbGe2zjhX923dFiIdl1oi7mO9tXp\\n VG00-var 253 6 L--w 1 2 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxicvyvt67113nTb8vMlGfgdEjDx0LKT2O\\n VG00-swap 253 1 L--w 2 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTax3Ll2XhOYZkylx1CjOQi7G4yHgrIOsyqG\\n VG00-root 253 0 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxKpnAKYhrYMYMNMwjegkW965bUgtJFTRY\\n VG00-var_log_audit 253 5 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxwQ8R0XWJRm86QX3befq1cHRy47Von6ZW\\n\\n Example data structure produced::\\n\\n data = [\\n {\\n 'Stat': 'L--w',\\n 'Name': 'VG00-tmp',\\n 'Min': '8',\\n 'Targ': '1',\\n 'Maj': '253',\\n 'Open': '1',\\n 'Event': '0',\\n 'UUID': 'LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTax6lLmBji2ueSbX49gxcV76M29cmukQiw4'\\n },...\\n ]\\n\\n Attributes:\\n data (list): List of devices found, in order\\n names (list): Device names, in order found\\n uuids (list): UUID\\n by_name (dict): Access to each device by devicename\\n by_uuid (dict): Access to each device by uuid\\n info (list): List of devices found, in order using SetupInfo structure\\n\\n Example:\\n >>> len(setup_info)\\n 6\\n >>> setup_info.names[0]\\n 'VG00-tmp'\\n >>> setup_info[1]['Maj']\\n '253'\\n >>> setup_info[1]['Stat']\\n 'L--w'\\n >>> setup_info.info[-1].name\\n 'VG00-var_log_audit'\\n >>> setup_info.info[-1].major\\n 253\\n >>> setup_info.info[-1].live_table\\n True\\n >>> setup_info.info[-1].readonly\\n False\\n \\\"\\\"\\\"\\n\\n def parse_content(self, content):\\n self.data = parse_delimited_table(content)\\n\\n self.names = [dm['Name'] for dm in self.data if 'Name' in dm]\\n self.by_name = dict((dm['Name'], dm) for dm in self.data if 'Name' in dm)\\n self.uuids = [dm['UUID'] for dm in self.data if 'UUID' in dm]\\n self.by_uuid = dict((dm['UUID'], dm) for dm in self.data if 'UUID' in dm)\\n self.info = []\\n for dm in self.data:\\n self.info.append(SetupInfo(\\n name=dm.get('Name'),\\n major=int(dm.get('Maj')) if 'Maj' in dm and dm.get('Maj').isdigit() else None,\\n minor=int(dm.get('Min')) if 'Min' in dm and dm.get('Min').isdigit() else None,\\n open=int(dm.get('Open')) if 'Open' in dm and dm.get('Open').isdigit() else None,\\n segments=int(dm.get('Targ')) if 'Targ' in dm and dm.get('Targ').isdigit() else None,\\n events=int(dm.get('Event')) if 'Event' in dm and dm.get('Event').isdigit() else None,\\n live_table=dm.get('Stat', '----')[0] == 'L',\\n inactive_table=dm.get('Stat', '----')[1] == 'I',\\n suspended=dm.get('Stat', '----')[2] == 's',\\n readonly=dm.get('Stat', '----')[3] == 'r',\\n uuid=dm.get('UUID')\\n ))\\n\\n def __len__(self):\\n \\\"\\\"\\\"\\n The length of the devices list\\n \\\"\\\"\\\"\\n return len(self.data)\\n\\n def __iter__(self):\\n \\\"\\\"\\\"\\n Iterate through the devices list\\n \\\"\\\"\\\"\\n for dm in self.data:\\n yield dm\\n\\n def __getitem__(self, idx):\\n \\\"\\\"\\\"\\n Fetch a device by index in devices list\\n \\\"\\\"\\\"\\n return self.data[idx]\\n\\n\\n@parser(Specs.dmsetup_status)\\nclass DmsetupStatus(CommandParser, list):\\n \\\"\\\"\\\"\\n ``dmsetup status -C`` command output\\n\\n Example input::\\n\\n rootvg-tanlv: 0 6291456 linear\\n rootvg-ssnap: 0 16384000 snapshot 1560768/5120000 6088\\n rootvg-optvolapp: 0 8192000 snapshot-origin\\n docker-253:10-1234567-0df13579: 0 20971520 thin 1922048 20971519\\n docker-253:10-4254621-0496628a: 0 20971520 thin 1951744 20971519\\n docker-253:10-4254621-d392682f: 0 20971520 thin 7106560 20971519\\n rootvg-docker--pool: 0 129548288 thin-pool 1 20/49152 38/126512 - rw no_discard_passdown queue_if_no_space -\\n rootvg-tmpvol: 0 2048000 linear\\n rootvg-varvol: 0 18874368 snapshot Invalid\\n rootvg-optvol: 0 8192000 snapshot 616408/5120000 2408\\n rootvg-varvol-cow: 0 5120000 linear\\n appsvg-lvapps_docker: 0 104857600 thin-pool 441 697/2048 20663/102400 - rw no_discard_passdown queue_if_no_space -\\n\\n Example data structure produced::\\n\\n [\\n SetupStatus(\\n device_name='rootvg-tanlv', start_sector='0',\\n num_sectors='6291456', target_type='linear',\\n target_args=None, parsed_args=None,\\n ), ...\\n ]\\n\\n Attributes:\\n names (list): Device names, in order found\\n by_name (dict): Access to each device by devicename\\n unparseable_lines (list): Unparseable raw lines\\n\\n Example:\\n >>> len(dmsetup_status)\\n 12\\n >>> dmsetup_status.names[0]\\n 'rootvg-tanlv'\\n >>> dmsetup_status[1].target_type\\n 'snapshot'\\n >>> dmsetup_status[1].start_sector\\n '0'\\n >>> len(dmsetup_status.by_name)\\n 12\\n >>> dmsetup_status[-1].parsed_args['used_metadata_blocks']\\n '697'\\n >>> dmsetup_status[-1].parsed_args['total_metadata_blocks']\\n '2048'\\n >>> dmsetup_status[-1].parsed_args['opts']\\n ['rw', 'no_discard_passdown', 'queue_if_no_space', '-']\\n \\\"\\\"\\\"\\n\\n def parse_content(self, content):\\n self.unparseable_lines = []\\n for line in content:\\n _device_name, _device_info_str = line.rsplit(':', 1)\\n device_name = _device_name.strip()\\n device_info_spl = _device_info_str.strip().split(' ', 3)\\n if len(device_info_spl) < 3:\\n self.unparseable_lines.append(line)\\n continue\\n target_type = device_info_spl[2]\\n target_args = device_info_spl[3] if len(device_info_spl) == 4 else None\\n parsed_args = None\\n if target_args:\\n try:\\n parsed_args = self._parse_target_args(target_type, target_args)\\n except ParseException:\\n self.unparseable_lines.append(line)\\n self.append(SetupStatus(\\n device_name=device_name,\\n start_sector=device_info_spl[0],\\n num_sectors=device_info_spl[1],\\n target_type=target_type,\\n target_args=target_args,\\n parsed_args=parsed_args,\\n ))\\n\\n @property\\n def names(self):\\n return [dm[0] for dm in self]\\n\\n @property\\n def by_name(self):\\n return dict((dm[0], dm) for dm in self)\\n\\n def _parse_target_args(self, target_type, target_args):\\n pars_func_name = '_parse_target_args_' + target_type.replace('-', '_')\\n pars_func = getattr(self, pars_func_name, None)\\n return pars_func(target_args) if pars_func else None\\n\\n def _parse_target_args_thin_pool(self, target_args):\\n \\\"\\\"\\\"\\n Format:\\n <transaction_id> <used_metadata_blocks>/<total_metadata_blocks>\\n <used_data_blocks>/<total_data_blocks> <held_metadata_root>\\n ro|rw|out_of_data_space [no_]discard_passdown [error|queue]_if_no_space\\n needs_check|- metadata_low_watermark\\n Refer to https://www.kernel.org/doc/Documentation/device-mapper/thin-provisioning.txt .\\n \\\"\\\"\\\"\\n args = target_args.split()\\n if len(args) < 8 or '/' not in args[1] or '/' not in args[2]:\\n raise ParseException(\\\"Invalid thin_pool target_args: {0}\\\".format(target_args))\\n parsed_args = {}\\n parsed_args['transaction_id'] = args[0]\\n parsed_args['used_metadata_blocks'], parsed_args['total_metadata_blocks'] = args[1].split('/', 1)\\n parsed_args['used_data_blocks'], parsed_args['total_data_blocks'] = args[2].split('/', 1)\\n parsed_args['held_metadata_root'] = args[3]\\n parsed_args['opts'] = args[4:8]\\n parsed_args['metadata_low_watermark'] = args[8] if len(args) > 8 else None\\n return parsed_args\\n\\n def _parse_target_args_thin(self, target_args):\\n \\\"\\\"\\\"\\n Format:\\n <nr_mapped_sectors> <highest_mapped_sector>\\n Refer to https://www.kernel.org/doc/Documentation/device-mapper/thin-provisioning.txt .\\n \\\"\\\"\\\"\\n args = target_args.split()\\n if len(args) < 2:\\n raise ParseException(\\\"Invalid thin target_args: {0}\\\".format(target_args))\\n parsed_args = {}\\n parsed_args['nr_mapped_sectors'] = args[0]\\n parsed_args['highest_mapped_sector'] = args[1]\\n return parsed_args\\n\\n def _parse_target_args_snapshot(self, target_args):\\n \\\"\\\"\\\"\\n Format:\\n <sectors_allocated>/<total_sectors> <metadata_sectors>\\n Refer to https://www.kernel.org/doc/Documentation/device-mapper/snapshot.txt .\\n \\\"\\\"\\\"\\n args = target_args.split()\\n if len(args) < 2 or '/' not in args[0]:\\n raise ParseException(\\\"Invalid snapshot target_args: {0}\\\".format(target_args))\\n parsed_args = {}\\n parsed_args['sectors_allocated'], parsed_args['total_sectors'] = args[0].split('/', 1)\\n parsed_args['metadata_sectors'] = args[1]\\n return parsed_args\\n\",\n \"path\": \"insights/parsers/dmsetup.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"\"\"\"\ndmsetup commands - Command ``dmsetup``\n======================================\n\nParsers for parsing and extracting data from output of commands related to\n``dmsetup``.\nParsers contained in this module are:\n\nDmsetupInfo - command ``dmsetup info -C``\n-----------------------------------------\n\nDmsetupStatus - command ``dmsetup status``\n------------------------------------------\n\n\"\"\"\nfrom collections import namedtuple\nfrom insights import parser, CommandParser\nfrom insights.parsers import parse_delimited_table\nfrom insights.parsers import ParseException\nfrom insights.specs import Specs\n\n\nSetupInfo = namedtuple('SetupInfo', [\n 'name', 'major', 'minor', 'open', 'segments', 'events',\n 'live_table', 'inactive_table', 'suspended', 'readonly', 'uuid']\n)\n\"\"\" Data structure to represent dmsetup information \"\"\"\n\nSetupStatus = namedtuple('SetupStatus', [\n 'device_name', 'start_sector', 'num_sectors', 'target_type',\n 'target_args', 'parsed_args']\n)\n\"\"\" Data structure to represent dmsetup status \"\"\"\n\n\n@parser(Specs.dmsetup_info)\nclass DmsetupInfo(CommandParser):\n \"\"\"\n ``dmsetup info -C`` command output\n\n Example input::\n\n Name Maj Min Stat Open Targ Event UUID\n VG00-tmp 253 8 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTax6lLmBji2ueSbX49gxcV76M29cmukQiw4\n VG00-home 253 3 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxCqXOnbGe2zjhX923dFiIdl1oi7mO9tXp\n VG00-var 253 6 L--w 1 2 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxicvyvt67113nTb8vMlGfgdEjDx0LKT2O\n VG00-swap 253 1 L--w 2 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTax3Ll2XhOYZkylx1CjOQi7G4yHgrIOsyqG\n VG00-root 253 0 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxKpnAKYhrYMYMNMwjegkW965bUgtJFTRY\n VG00-var_log_audit 253 5 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxwQ8R0XWJRm86QX3befq1cHRy47Von6ZW\n\n Example data structure produced::\n\n data = [\n {\n 'Stat': 'L--w',\n 'Name': 'VG00-tmp',\n 'Min': '8',\n 'Targ': '1',\n 'Maj': '253',\n 'Open': '1',\n 'Event': '0',\n 'UUID': 'LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTax6lLmBji2ueSbX49gxcV76M29cmukQiw4'\n },...\n ]\n\n Attributes:\n data (list): List of devices found, in order\n names (list): Device names, in order found\n uuids (list): UUID\n by_name (dict): Access to each device by devicename\n by_uuid (dict): Access to each device by uuid\n info (list): List of devices found, in order using SetupInfo structure\n\n Example:\n >>> len(setup_info)\n 6\n >>> setup_info.names[0]\n 'VG00-tmp'\n >>> setup_info[1]['Maj']\n '253'\n >>> setup_info[1]['Stat']\n 'L--w'\n >>> setup_info.info[-1].name\n 'VG00-var_log_audit'\n >>> setup_info.info[-1].major\n 253\n >>> setup_info.info[-1].live_table\n True\n >>> setup_info.info[-1].readonly\n False\n \"\"\"\n\n def parse_content(self, content):\n self.data = parse_delimited_table(content)\n\n self.names = [dm['Name'] for dm in self.data if 'Name' in dm]\n self.by_name = dict((dm['Name'], dm) for dm in self.data if 'Name' in dm)\n self.uuids = [dm['UUID'] for dm in self.data if 'UUID' in dm]\n self.by_uuid = dict((dm['UUID'], dm) for dm in self.data if 'UUID' in dm)\n self.info = []\n for dm in self.data:\n self.info.append(SetupInfo(\n name=dm.get('Name'),\n major=int(dm.get('Maj')) if 'Maj' in dm and dm.get('Maj').isdigit() else None,\n minor=int(dm.get('Min')) if 'Min' in dm and dm.get('Min').isdigit() else None,\n open=int(dm.get('Open')) if 'Open' in dm and dm.get('Open').isdigit() else None,\n segments=int(dm.get('Targ')) if 'Targ' in dm and dm.get('Targ').isdigit() else None,\n events=int(dm.get('Event')) if 'Event' in dm and dm.get('Event').isdigit() else None,\n live_table=dm.get('Stat', '----')[0] == 'L',\n inactive_table=dm.get('Stat', '----')[1] == 'I',\n suspended=dm.get('Stat', '----')[2] == 's',\n readonly=dm.get('Stat', '----')[3] == 'r',\n uuid=dm.get('UUID')\n ))\n\n def __len__(self):\n \"\"\"\n The length of the devices list\n \"\"\"\n return len(self.data)\n\n def __iter__(self):\n \"\"\"\n Iterate through the devices list\n \"\"\"\n for dm in self.data:\n yield dm\n\n def __getitem__(self, idx):\n \"\"\"\n Fetch a device by index in devices list\n \"\"\"\n return self.data[idx]\n\n\n@parser(Specs.dmsetup_status)\nclass DmsetupStatus(CommandParser, list):\n \"\"\"\n ``dmsetup status -C`` command output\n\n Example input::\n\n rootvg-tanlv: 0 6291456 linear\n rootvg-ssnap: 0 16384000 snapshot 1560768/5120000 6088\n rootvg-optvolapp: 0 8192000 snapshot-origin\n docker-253:10-1234567-0df13579: 0 20971520 thin 1922048 20971519\n docker-253:10-4254621-0496628a: 0 20971520 thin 1951744 20971519\n docker-253:10-4254621-d392682f: 0 20971520 thin 7106560 20971519\n rootvg-docker--pool: 0 129548288 thin-pool 1 20/49152 38/126512 - rw no_discard_passdown queue_if_no_space -\n rootvg-tmpvol: 0 2048000 linear\n rootvg-varvol: 0 18874368 snapshot Invalid\n rootvg-optvol: 0 8192000 snapshot 616408/5120000 2408\n rootvg-varvol-cow: 0 5120000 linear\n appsvg-lvapps_docker: 0 104857600 thin-pool 441 697/2048 20663/102400 - rw no_discard_passdown queue_if_no_space -\n\n Example data structure produced::\n\n [\n SetupStatus(\n device_name='rootvg-tanlv', start_sector='0',\n num_sectors='6291456', target_type='linear',\n target_args=None, parsed_args=None,\n ), ...\n ]\n\n Attributes:\n names (list): Device names, in order found\n by_name (dict): Access to each device by devicename\n unparseable_lines (list): Unparseable raw lines\n\n Example:\n >>> len(dmsetup_status)\n 12\n >>> dmsetup_status.names[0]\n 'rootvg-tanlv'\n >>> dmsetup_status[1].target_type\n 'snapshot'\n >>> dmsetup_status[1].start_sector\n '0'\n >>> len(dmsetup_status.by_name)\n 12\n >>> dmsetup_status[-1].parsed_args['used_metadata_blocks']\n '697'\n >>> dmsetup_status[-1].parsed_args['total_metadata_blocks']\n '2048'\n >>> dmsetup_status[-1].parsed_args['opts']\n ['rw', 'no_discard_passdown', 'queue_if_no_space', '-']\n \"\"\"\n\n def parse_content(self, content):\n self.unparseable_lines = []\n if content[0].lower() == \"no devices found\":\n return\n\n for line in content:\n _device_name, _device_info_str = line.rsplit(':', 1)\n device_name = _device_name.strip()\n device_info_spl = _device_info_str.strip().split(' ', 3)\n if len(device_info_spl) < 3:\n self.unparseable_lines.append(line)\n continue\n target_type = device_info_spl[2]\n target_args = device_info_spl[3] if len(device_info_spl) == 4 else None\n parsed_args = None\n if target_args:\n try:\n parsed_args = self._parse_target_args(target_type, target_args)\n except ParseException:\n self.unparseable_lines.append(line)\n self.append(SetupStatus(\n device_name=device_name,\n start_sector=device_info_spl[0],\n num_sectors=device_info_spl[1],\n target_type=target_type,\n target_args=target_args,\n parsed_args=parsed_args,\n ))\n\n @property\n def names(self):\n return [dm[0] for dm in self]\n\n @property\n def by_name(self):\n return dict((dm[0], dm) for dm in self)\n\n def _parse_target_args(self, target_type, target_args):\n pars_func_name = '_parse_target_args_' + target_type.replace('-', '_')\n pars_func = getattr(self, pars_func_name, None)\n return pars_func(target_args) if pars_func else None\n\n def _parse_target_args_thin_pool(self, target_args):\n \"\"\"\n Format:\n <transaction_id> <used_metadata_blocks>/<total_metadata_blocks>\n <used_data_blocks>/<total_data_blocks> <held_metadata_root>\n ro|rw|out_of_data_space [no_]discard_passdown [error|queue]_if_no_space\n needs_check|- metadata_low_watermark\n Refer to https://www.kernel.org/doc/Documentation/device-mapper/thin-provisioning.txt .\n \"\"\"\n args = target_args.split()\n if len(args) < 8 or '/' not in args[1] or '/' not in args[2]:\n raise ParseException(\"Invalid thin_pool target_args: {0}\".format(target_args))\n parsed_args = {}\n parsed_args['transaction_id'] = args[0]\n parsed_args['used_metadata_blocks'], parsed_args['total_metadata_blocks'] = args[1].split('/', 1)\n parsed_args['used_data_blocks'], parsed_args['total_data_blocks'] = args[2].split('/', 1)\n parsed_args['held_metadata_root'] = args[3]\n parsed_args['opts'] = args[4:8]\n parsed_args['metadata_low_watermark'] = args[8] if len(args) > 8 else None\n return parsed_args\n\n def _parse_target_args_thin(self, target_args):\n \"\"\"\n Format:\n <nr_mapped_sectors> <highest_mapped_sector>\n Refer to https://www.kernel.org/doc/Documentation/device-mapper/thin-provisioning.txt .\n \"\"\"\n args = target_args.split()\n if len(args) < 2:\n raise ParseException(\"Invalid thin target_args: {0}\".format(target_args))\n parsed_args = {}\n parsed_args['nr_mapped_sectors'] = args[0]\n parsed_args['highest_mapped_sector'] = args[1]\n return parsed_args\n\n def _parse_target_args_snapshot(self, target_args):\n \"\"\"\n Format:\n <sectors_allocated>/<total_sectors> <metadata_sectors>\n Refer to https://www.kernel.org/doc/Documentation/device-mapper/snapshot.txt .\n \"\"\"\n args = target_args.split()\n if len(args) < 2 or '/' not in args[0]:\n raise ParseException(\"Invalid snapshot target_args: {0}\".format(target_args))\n parsed_args = {}\n parsed_args['sectors_allocated'], parsed_args['total_sectors'] = args[0].split('/', 1)\n parsed_args['metadata_sectors'] = args[1]\n return parsed_args\n","path":"insights/parsers/dmsetup.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"\\ndmsetup commands - Command ``dmsetup``\\n======================================\\n\\nParsers for parsing and extracting data from output of commands related to\\n``dmsetup``.\\nParsers contained in this module are:\\n\\nDmsetupInfo - command ``dmsetup info -C``\\n-----------------------------------------\\n\\nDmsetupStatus - command ``dmsetup status``\\n------------------------------------------\\n\\n\\\"\\\"\\\"\\nfrom collections import namedtuple\\nfrom insights import parser, CommandParser\\nfrom insights.parsers import parse_delimited_table\\nfrom insights.parsers import ParseException\\nfrom insights.specs import Specs\\n\\n\\nSetupInfo = namedtuple('SetupInfo', [\\n 'name', 'major', 'minor', 'open', 'segments', 'events',\\n 'live_table', 'inactive_table', 'suspended', 'readonly', 'uuid']\\n)\\n\\\"\\\"\\\" Data structure to represent dmsetup information \\\"\\\"\\\"\\n\\nSetupStatus = namedtuple('SetupStatus', [\\n 'device_name', 'start_sector', 'num_sectors', 'target_type',\\n 'target_args', 'parsed_args']\\n)\\n\\\"\\\"\\\" Data structure to represent dmsetup status \\\"\\\"\\\"\\n\\n\\n@parser(Specs.dmsetup_info)\\nclass DmsetupInfo(CommandParser):\\n \\\"\\\"\\\"\\n ``dmsetup info -C`` command output\\n\\n Example input::\\n\\n Name Maj Min Stat Open Targ Event UUID\\n VG00-tmp 253 8 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTax6lLmBji2ueSbX49gxcV76M29cmukQiw4\\n VG00-home 253 3 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxCqXOnbGe2zjhX923dFiIdl1oi7mO9tXp\\n VG00-var 253 6 L--w 1 2 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxicvyvt67113nTb8vMlGfgdEjDx0LKT2O\\n VG00-swap 253 1 L--w 2 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTax3Ll2XhOYZkylx1CjOQi7G4yHgrIOsyqG\\n VG00-root 253 0 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxKpnAKYhrYMYMNMwjegkW965bUgtJFTRY\\n VG00-var_log_audit 253 5 L--w 1 1 0 LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTaxwQ8R0XWJRm86QX3befq1cHRy47Von6ZW\\n\\n Example data structure produced::\\n\\n data = [\\n {\\n 'Stat': 'L--w',\\n 'Name': 'VG00-tmp',\\n 'Min': '8',\\n 'Targ': '1',\\n 'Maj': '253',\\n 'Open': '1',\\n 'Event': '0',\\n 'UUID': 'LVM-gy9uAwD7LuTIApplr2sogbOx5iS0FTax6lLmBji2ueSbX49gxcV76M29cmukQiw4'\\n },...\\n ]\\n\\n Attributes:\\n data (list): List of devices found, in order\\n names (list): Device names, in order found\\n uuids (list): UUID\\n by_name (dict): Access to each device by devicename\\n by_uuid (dict): Access to each device by uuid\\n info (list): List of devices found, in order using SetupInfo structure\\n\\n Example:\\n >>> len(setup_info)\\n 6\\n >>> setup_info.names[0]\\n 'VG00-tmp'\\n >>> setup_info[1]['Maj']\\n '253'\\n >>> setup_info[1]['Stat']\\n 'L--w'\\n >>> setup_info.info[-1].name\\n 'VG00-var_log_audit'\\n >>> setup_info.info[-1].major\\n 253\\n >>> setup_info.info[-1].live_table\\n True\\n >>> setup_info.info[-1].readonly\\n False\\n \\\"\\\"\\\"\\n\\n def parse_content(self, content):\\n self.data = parse_delimited_table(content)\\n\\n self.names = [dm['Name'] for dm in self.data if 'Name' in dm]\\n self.by_name = dict((dm['Name'], dm) for dm in self.data if 'Name' in dm)\\n self.uuids = [dm['UUID'] for dm in self.data if 'UUID' in dm]\\n self.by_uuid = dict((dm['UUID'], dm) for dm in self.data if 'UUID' in dm)\\n self.info = []\\n for dm in self.data:\\n self.info.append(SetupInfo(\\n name=dm.get('Name'),\\n major=int(dm.get('Maj')) if 'Maj' in dm and dm.get('Maj').isdigit() else None,\\n minor=int(dm.get('Min')) if 'Min' in dm and dm.get('Min').isdigit() else None,\\n open=int(dm.get('Open')) if 'Open' in dm and dm.get('Open').isdigit() else None,\\n segments=int(dm.get('Targ')) if 'Targ' in dm and dm.get('Targ').isdigit() else None,\\n events=int(dm.get('Event')) if 'Event' in dm and dm.get('Event').isdigit() else None,\\n live_table=dm.get('Stat', '----')[0] == 'L',\\n inactive_table=dm.get('Stat', '----')[1] == 'I',\\n suspended=dm.get('Stat', '----')[2] == 's',\\n readonly=dm.get('Stat', '----')[3] == 'r',\\n uuid=dm.get('UUID')\\n ))\\n\\n def __len__(self):\\n \\\"\\\"\\\"\\n The length of the devices list\\n \\\"\\\"\\\"\\n return len(self.data)\\n\\n def __iter__(self):\\n \\\"\\\"\\\"\\n Iterate through the devices list\\n \\\"\\\"\\\"\\n for dm in self.data:\\n yield dm\\n\\n def __getitem__(self, idx):\\n \\\"\\\"\\\"\\n Fetch a device by index in devices list\\n \\\"\\\"\\\"\\n return self.data[idx]\\n\\n\\n@parser(Specs.dmsetup_status)\\nclass DmsetupStatus(CommandParser, list):\\n \\\"\\\"\\\"\\n ``dmsetup status -C`` command output\\n\\n Example input::\\n\\n rootvg-tanlv: 0 6291456 linear\\n rootvg-ssnap: 0 16384000 snapshot 1560768/5120000 6088\\n rootvg-optvolapp: 0 8192000 snapshot-origin\\n docker-253:10-1234567-0df13579: 0 20971520 thin 1922048 20971519\\n docker-253:10-4254621-0496628a: 0 20971520 thin 1951744 20971519\\n docker-253:10-4254621-d392682f: 0 20971520 thin 7106560 20971519\\n rootvg-docker--pool: 0 129548288 thin-pool 1 20/49152 38/126512 - rw no_discard_passdown queue_if_no_space -\\n rootvg-tmpvol: 0 2048000 linear\\n rootvg-varvol: 0 18874368 snapshot Invalid\\n rootvg-optvol: 0 8192000 snapshot 616408/5120000 2408\\n rootvg-varvol-cow: 0 5120000 linear\\n appsvg-lvapps_docker: 0 104857600 thin-pool 441 697/2048 20663/102400 - rw no_discard_passdown queue_if_no_space -\\n\\n Example data structure produced::\\n\\n [\\n SetupStatus(\\n device_name='rootvg-tanlv', start_sector='0',\\n num_sectors='6291456', target_type='linear',\\n target_args=None, parsed_args=None,\\n ), ...\\n ]\\n\\n Attributes:\\n names (list): Device names, in order found\\n by_name (dict): Access to each device by devicename\\n unparseable_lines (list): Unparseable raw lines\\n\\n Example:\\n >>> len(dmsetup_status)\\n 12\\n >>> dmsetup_status.names[0]\\n 'rootvg-tanlv'\\n >>> dmsetup_status[1].target_type\\n 'snapshot'\\n >>> dmsetup_status[1].start_sector\\n '0'\\n >>> len(dmsetup_status.by_name)\\n 12\\n >>> dmsetup_status[-1].parsed_args['used_metadata_blocks']\\n '697'\\n >>> dmsetup_status[-1].parsed_args['total_metadata_blocks']\\n '2048'\\n >>> dmsetup_status[-1].parsed_args['opts']\\n ['rw', 'no_discard_passdown', 'queue_if_no_space', '-']\\n \\\"\\\"\\\"\\n\\n def parse_content(self, content):\\n self.unparseable_lines = []\\n if content[0].lower() == \\\"no devices found\\\":\\n return\\n\\n for line in content:\\n _device_name, _device_info_str = line.rsplit(':', 1)\\n device_name = _device_name.strip()\\n device_info_spl = _device_info_str.strip().split(' ', 3)\\n if len(device_info_spl) < 3:\\n self.unparseable_lines.append(line)\\n continue\\n target_type = device_info_spl[2]\\n target_args = device_info_spl[3] if len(device_info_spl) == 4 else None\\n parsed_args = None\\n if target_args:\\n try:\\n parsed_args = self._parse_target_args(target_type, target_args)\\n except ParseException:\\n self.unparseable_lines.append(line)\\n self.append(SetupStatus(\\n device_name=device_name,\\n start_sector=device_info_spl[0],\\n num_sectors=device_info_spl[1],\\n target_type=target_type,\\n target_args=target_args,\\n parsed_args=parsed_args,\\n ))\\n\\n @property\\n def names(self):\\n return [dm[0] for dm in self]\\n\\n @property\\n def by_name(self):\\n return dict((dm[0], dm) for dm in self)\\n\\n def _parse_target_args(self, target_type, target_args):\\n pars_func_name = '_parse_target_args_' + target_type.replace('-', '_')\\n pars_func = getattr(self, pars_func_name, None)\\n return pars_func(target_args) if pars_func else None\\n\\n def _parse_target_args_thin_pool(self, target_args):\\n \\\"\\\"\\\"\\n Format:\\n <transaction_id> <used_metadata_blocks>/<total_metadata_blocks>\\n <used_data_blocks>/<total_data_blocks> <held_metadata_root>\\n ro|rw|out_of_data_space [no_]discard_passdown [error|queue]_if_no_space\\n needs_check|- metadata_low_watermark\\n Refer to https://www.kernel.org/doc/Documentation/device-mapper/thin-provisioning.txt .\\n \\\"\\\"\\\"\\n args = target_args.split()\\n if len(args) < 8 or '/' not in args[1] or '/' not in args[2]:\\n raise ParseException(\\\"Invalid thin_pool target_args: {0}\\\".format(target_args))\\n parsed_args = {}\\n parsed_args['transaction_id'] = args[0]\\n parsed_args['used_metadata_blocks'], parsed_args['total_metadata_blocks'] = args[1].split('/', 1)\\n parsed_args['used_data_blocks'], parsed_args['total_data_blocks'] = args[2].split('/', 1)\\n parsed_args['held_metadata_root'] = args[3]\\n parsed_args['opts'] = args[4:8]\\n parsed_args['metadata_low_watermark'] = args[8] if len(args) > 8 else None\\n return parsed_args\\n\\n def _parse_target_args_thin(self, target_args):\\n \\\"\\\"\\\"\\n Format:\\n <nr_mapped_sectors> <highest_mapped_sector>\\n Refer to https://www.kernel.org/doc/Documentation/device-mapper/thin-provisioning.txt .\\n \\\"\\\"\\\"\\n args = target_args.split()\\n if len(args) < 2:\\n raise ParseException(\\\"Invalid thin target_args: {0}\\\".format(target_args))\\n parsed_args = {}\\n parsed_args['nr_mapped_sectors'] = args[0]\\n parsed_args['highest_mapped_sector'] = args[1]\\n return parsed_args\\n\\n def _parse_target_args_snapshot(self, target_args):\\n \\\"\\\"\\\"\\n Format:\\n <sectors_allocated>/<total_sectors> <metadata_sectors>\\n Refer to https://www.kernel.org/doc/Documentation/device-mapper/snapshot.txt .\\n \\\"\\\"\\\"\\n args = target_args.split()\\n if len(args) < 2 or '/' not in args[0]:\\n raise ParseException(\\\"Invalid snapshot target_args: {0}\\\".format(target_args))\\n parsed_args = {}\\n parsed_args['sectors_allocated'], parsed_args['total_sectors'] = args[0].split('/', 1)\\n parsed_args['metadata_sectors'] = args[1]\\n return parsed_args\\n\",\n \"path\": \"insights/parsers/dmsetup.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/insights/parsers/dmsetup.py b/insights/parsers/dmsetup.py\nindex ba693bef2f..ae77e6da97 100644\n--- a/insights/parsers/dmsetup.py\n+++ b/insights/parsers/dmsetup.py\n@@ -189,6 +189,9 @@ class DmsetupStatus(CommandParser, list):\n \n def parse_content(self, content):\n self.unparseable_lines = []\n+ if content[0].lower() == \"no devices found\":\n+ return\n+\n for line in content:\n _device_name, _device_info_str = line.rsplit(':', 1)\n device_name = _device_name.strip()\ndiff --git a/insights/parsers/tests/test_dmsetup.py b/insights/parsers/tests/test_dmsetup.py\nindex 9a027967e6..634336449b 100644\n--- a/insights/parsers/tests/test_dmsetup.py\n+++ b/insights/parsers/tests/test_dmsetup.py\n@@ -105,6 +105,10 @@ def test_dmsetup_setupinfo():\n docker-253:10-1234567-0df13579: 0 20971520 thin 1922048\n \"\"\".strip()\n \n+DMSETUP_STATUS_3 = \"\"\"\n+No devices found\n+\"\"\".strip()\n+\n \n def test_dmsetup_status():\n r = DmsetupStatus(context_wrap(DMSETUP_STATUS_1))\n@@ -165,6 +169,10 @@ def test_dmsetup_status():\n 'rootvg-docker--pool: 0 129548288 thin-pool 1 20/49152 38/126512 - rw no_discard_passdown queue_if_no_space',\n 'docker-253:10-1234567-0df13579: 0 20971520 thin 1922048']\n \n+ r = DmsetupStatus(context_wrap(DMSETUP_STATUS_3))\n+ assert len(r) == 0\n+ assert r.unparseable_lines == []\n+\n \n DMSETUP_EXAMPLES = \"\"\"\n Name Maj Min Stat Open Targ Event UUID\n"}}},{"rowIdx":4685,"cells":{"in_source_id":{"kind":"string","value":"googleapis__google-cloud-python-5899"},"issue":{"kind":"string","value":"Default max_bytes in pubsub seems wrong\nhttps://github.com/GoogleCloudPlatform/google-cloud-python/blob/005ddd11770f8953643dac9b64a037524da2f49e/pubsub/google/cloud/pubsub_v1/types.py#L43\r\n\r\nIn my code I'm seeing this:\r\n```\r\ngoogle.api_core.exceptions.InvalidArgument: 400 The value for 10159812 is too large. You passed request_size in the request, but the maximum value is 10000000.\r\n```\r\n\r\nBased on the error coming out of the pubsub, I think this default max size is wrong.\n"},"before_files":{"kind":"list like","value":[{"content":"# Copyright 2017, Google LLC All rights reserved.\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\nfrom __future__ import absolute_import\nimport collections\nimport sys\n\nfrom google.api import http_pb2\nfrom google.iam.v1 import iam_policy_pb2\nfrom google.iam.v1 import policy_pb2\nfrom google.iam.v1.logging import audit_data_pb2\nfrom google.protobuf import descriptor_pb2\nfrom google.protobuf import duration_pb2\nfrom google.protobuf import empty_pb2\nfrom google.protobuf import field_mask_pb2\nfrom google.protobuf import timestamp_pb2\n\nfrom google.api_core.protobuf_helpers import get_messages\nfrom google.cloud.pubsub_v1.proto import pubsub_pb2\n\n\n# Define the default values for batching.\n#\n# This class is used when creating a publisher or subscriber client, and\n# these settings can be altered to tweak Pub/Sub behavior.\n# The defaults should be fine for most use cases.\nBatchSettings = collections.namedtuple(\n 'BatchSettings',\n ['max_bytes', 'max_latency', 'max_messages'],\n)\nBatchSettings.__new__.__defaults__ = (\n 1024 * 1024 * 10, # max_bytes: 10 MB\n 0.05, # max_latency: 0.05 seconds\n 1000, # max_messages: 1,000\n)\n\n# Define the type class and default values for flow control settings.\n#\n# This class is used when creating a publisher or subscriber client, and\n# these settings can be altered to tweak Pub/Sub behavior.\n# The defaults should be fine for most use cases.\nFlowControl = collections.namedtuple(\n 'FlowControl',\n ['max_bytes', 'max_messages', 'resume_threshold', 'max_requests',\n 'max_request_batch_size', 'max_request_batch_latency',\n 'max_lease_duration'],\n)\nFlowControl.__new__.__defaults__ = (\n 100 * 1024 * 1024, # max_bytes: 100mb\n 100, # max_messages: 100\n 0.8, # resume_threshold: 80%\n 100, # max_requests: 100\n 100, # max_request_batch_size: 100\n 0.01, # max_request_batch_latency: 0.01s\n 2 * 60 * 60, # max_lease_duration: 2 hours.\n)\n\n\n_shared_modules = [\n http_pb2,\n iam_policy_pb2,\n policy_pb2,\n audit_data_pb2,\n descriptor_pb2,\n duration_pb2,\n empty_pb2,\n field_mask_pb2,\n timestamp_pb2,\n]\n\n_local_modules = [\n pubsub_pb2,\n]\n\n\nnames = ['BatchSettings', 'FlowControl']\n\n\nfor module in _shared_modules:\n for name, message in get_messages(module).items():\n setattr(sys.modules[__name__], name, message)\n names.append(name)\n\nfor module in _local_modules:\n for name, message in get_messages(module).items():\n message.__module__ = 'google.cloud.pubsub_v1.types'\n setattr(sys.modules[__name__], name, message)\n names.append(name)\n\n\n__all__ = tuple(sorted(names))\n","path":"pubsub/google/cloud/pubsub_v1/types.py"}],"string":"[\n {\n \"content\": \"# Copyright 2017, Google LLC All rights reserved.\\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\\nfrom __future__ import absolute_import\\nimport collections\\nimport sys\\n\\nfrom google.api import http_pb2\\nfrom google.iam.v1 import iam_policy_pb2\\nfrom google.iam.v1 import policy_pb2\\nfrom google.iam.v1.logging import audit_data_pb2\\nfrom google.protobuf import descriptor_pb2\\nfrom google.protobuf import duration_pb2\\nfrom google.protobuf import empty_pb2\\nfrom google.protobuf import field_mask_pb2\\nfrom google.protobuf import timestamp_pb2\\n\\nfrom google.api_core.protobuf_helpers import get_messages\\nfrom google.cloud.pubsub_v1.proto import pubsub_pb2\\n\\n\\n# Define the default values for batching.\\n#\\n# This class is used when creating a publisher or subscriber client, and\\n# these settings can be altered to tweak Pub/Sub behavior.\\n# The defaults should be fine for most use cases.\\nBatchSettings = collections.namedtuple(\\n 'BatchSettings',\\n ['max_bytes', 'max_latency', 'max_messages'],\\n)\\nBatchSettings.__new__.__defaults__ = (\\n 1024 * 1024 * 10, # max_bytes: 10 MB\\n 0.05, # max_latency: 0.05 seconds\\n 1000, # max_messages: 1,000\\n)\\n\\n# Define the type class and default values for flow control settings.\\n#\\n# This class is used when creating a publisher or subscriber client, and\\n# these settings can be altered to tweak Pub/Sub behavior.\\n# The defaults should be fine for most use cases.\\nFlowControl = collections.namedtuple(\\n 'FlowControl',\\n ['max_bytes', 'max_messages', 'resume_threshold', 'max_requests',\\n 'max_request_batch_size', 'max_request_batch_latency',\\n 'max_lease_duration'],\\n)\\nFlowControl.__new__.__defaults__ = (\\n 100 * 1024 * 1024, # max_bytes: 100mb\\n 100, # max_messages: 100\\n 0.8, # resume_threshold: 80%\\n 100, # max_requests: 100\\n 100, # max_request_batch_size: 100\\n 0.01, # max_request_batch_latency: 0.01s\\n 2 * 60 * 60, # max_lease_duration: 2 hours.\\n)\\n\\n\\n_shared_modules = [\\n http_pb2,\\n iam_policy_pb2,\\n policy_pb2,\\n audit_data_pb2,\\n descriptor_pb2,\\n duration_pb2,\\n empty_pb2,\\n field_mask_pb2,\\n timestamp_pb2,\\n]\\n\\n_local_modules = [\\n pubsub_pb2,\\n]\\n\\n\\nnames = ['BatchSettings', 'FlowControl']\\n\\n\\nfor module in _shared_modules:\\n for name, message in get_messages(module).items():\\n setattr(sys.modules[__name__], name, message)\\n names.append(name)\\n\\nfor module in _local_modules:\\n for name, message in get_messages(module).items():\\n message.__module__ = 'google.cloud.pubsub_v1.types'\\n setattr(sys.modules[__name__], name, message)\\n names.append(name)\\n\\n\\n__all__ = tuple(sorted(names))\\n\",\n \"path\": \"pubsub/google/cloud/pubsub_v1/types.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# Copyright 2017, Google LLC All rights reserved.\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\nfrom __future__ import absolute_import\nimport collections\nimport sys\n\nfrom google.api import http_pb2\nfrom google.iam.v1 import iam_policy_pb2\nfrom google.iam.v1 import policy_pb2\nfrom google.iam.v1.logging import audit_data_pb2\nfrom google.protobuf import descriptor_pb2\nfrom google.protobuf import duration_pb2\nfrom google.protobuf import empty_pb2\nfrom google.protobuf import field_mask_pb2\nfrom google.protobuf import timestamp_pb2\n\nfrom google.api_core.protobuf_helpers import get_messages\nfrom google.cloud.pubsub_v1.proto import pubsub_pb2\n\n\n# Define the default values for batching.\n#\n# This class is used when creating a publisher or subscriber client, and\n# these settings can be altered to tweak Pub/Sub behavior.\n# The defaults should be fine for most use cases.\nBatchSettings = collections.namedtuple(\n 'BatchSettings',\n ['max_bytes', 'max_latency', 'max_messages'],\n)\nBatchSettings.__new__.__defaults__ = (\n 1000 * 1000 * 10, # max_bytes: documented \"10 MB\", enforced 10000000\n 0.05, # max_latency: 0.05 seconds\n 1000, # max_messages: 1,000\n)\n\n# Define the type class and default values for flow control settings.\n#\n# This class is used when creating a publisher or subscriber client, and\n# these settings can be altered to tweak Pub/Sub behavior.\n# The defaults should be fine for most use cases.\nFlowControl = collections.namedtuple(\n 'FlowControl',\n ['max_bytes', 'max_messages', 'resume_threshold', 'max_requests',\n 'max_request_batch_size', 'max_request_batch_latency',\n 'max_lease_duration'],\n)\nFlowControl.__new__.__defaults__ = (\n 100 * 1024 * 1024, # max_bytes: 100mb\n 100, # max_messages: 100\n 0.8, # resume_threshold: 80%\n 100, # max_requests: 100\n 100, # max_request_batch_size: 100\n 0.01, # max_request_batch_latency: 0.01s\n 2 * 60 * 60, # max_lease_duration: 2 hours.\n)\n\n\n_shared_modules = [\n http_pb2,\n iam_policy_pb2,\n policy_pb2,\n audit_data_pb2,\n descriptor_pb2,\n duration_pb2,\n empty_pb2,\n field_mask_pb2,\n timestamp_pb2,\n]\n\n_local_modules = [\n pubsub_pb2,\n]\n\n\nnames = ['BatchSettings', 'FlowControl']\n\n\nfor module in _shared_modules:\n for name, message in get_messages(module).items():\n setattr(sys.modules[__name__], name, message)\n names.append(name)\n\nfor module in _local_modules:\n for name, message in get_messages(module).items():\n message.__module__ = 'google.cloud.pubsub_v1.types'\n setattr(sys.modules[__name__], name, message)\n names.append(name)\n\n\n__all__ = tuple(sorted(names))\n","path":"pubsub/google/cloud/pubsub_v1/types.py"}],"string":"[\n {\n \"content\": \"# Copyright 2017, Google LLC All rights reserved.\\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\\nfrom __future__ import absolute_import\\nimport collections\\nimport sys\\n\\nfrom google.api import http_pb2\\nfrom google.iam.v1 import iam_policy_pb2\\nfrom google.iam.v1 import policy_pb2\\nfrom google.iam.v1.logging import audit_data_pb2\\nfrom google.protobuf import descriptor_pb2\\nfrom google.protobuf import duration_pb2\\nfrom google.protobuf import empty_pb2\\nfrom google.protobuf import field_mask_pb2\\nfrom google.protobuf import timestamp_pb2\\n\\nfrom google.api_core.protobuf_helpers import get_messages\\nfrom google.cloud.pubsub_v1.proto import pubsub_pb2\\n\\n\\n# Define the default values for batching.\\n#\\n# This class is used when creating a publisher or subscriber client, and\\n# these settings can be altered to tweak Pub/Sub behavior.\\n# The defaults should be fine for most use cases.\\nBatchSettings = collections.namedtuple(\\n 'BatchSettings',\\n ['max_bytes', 'max_latency', 'max_messages'],\\n)\\nBatchSettings.__new__.__defaults__ = (\\n 1000 * 1000 * 10, # max_bytes: documented \\\"10 MB\\\", enforced 10000000\\n 0.05, # max_latency: 0.05 seconds\\n 1000, # max_messages: 1,000\\n)\\n\\n# Define the type class and default values for flow control settings.\\n#\\n# This class is used when creating a publisher or subscriber client, and\\n# these settings can be altered to tweak Pub/Sub behavior.\\n# The defaults should be fine for most use cases.\\nFlowControl = collections.namedtuple(\\n 'FlowControl',\\n ['max_bytes', 'max_messages', 'resume_threshold', 'max_requests',\\n 'max_request_batch_size', 'max_request_batch_latency',\\n 'max_lease_duration'],\\n)\\nFlowControl.__new__.__defaults__ = (\\n 100 * 1024 * 1024, # max_bytes: 100mb\\n 100, # max_messages: 100\\n 0.8, # resume_threshold: 80%\\n 100, # max_requests: 100\\n 100, # max_request_batch_size: 100\\n 0.01, # max_request_batch_latency: 0.01s\\n 2 * 60 * 60, # max_lease_duration: 2 hours.\\n)\\n\\n\\n_shared_modules = [\\n http_pb2,\\n iam_policy_pb2,\\n policy_pb2,\\n audit_data_pb2,\\n descriptor_pb2,\\n duration_pb2,\\n empty_pb2,\\n field_mask_pb2,\\n timestamp_pb2,\\n]\\n\\n_local_modules = [\\n pubsub_pb2,\\n]\\n\\n\\nnames = ['BatchSettings', 'FlowControl']\\n\\n\\nfor module in _shared_modules:\\n for name, message in get_messages(module).items():\\n setattr(sys.modules[__name__], name, message)\\n names.append(name)\\n\\nfor module in _local_modules:\\n for name, message in get_messages(module).items():\\n message.__module__ = 'google.cloud.pubsub_v1.types'\\n setattr(sys.modules[__name__], name, message)\\n names.append(name)\\n\\n\\n__all__ = tuple(sorted(names))\\n\",\n \"path\": \"pubsub/google/cloud/pubsub_v1/types.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/pubsub/google/cloud/pubsub_v1/types.py b/pubsub/google/cloud/pubsub_v1/types.py\nindex 1ac99a96534b..1f5ca92174e2 100644\n--- a/pubsub/google/cloud/pubsub_v1/types.py\n+++ b/pubsub/google/cloud/pubsub_v1/types.py\n@@ -40,7 +40,7 @@\n ['max_bytes', 'max_latency', 'max_messages'],\n )\n BatchSettings.__new__.__defaults__ = (\n- 1024 * 1024 * 10, # max_bytes: 10 MB\n+ 1000 * 1000 * 10, # max_bytes: documented \"10 MB\", enforced 10000000\n 0.05, # max_latency: 0.05 seconds\n 1000, # max_messages: 1,000\n )\ndiff --git a/pubsub/tests/unit/pubsub_v1/publisher/test_publisher_client.py b/pubsub/tests/unit/pubsub_v1/publisher/test_publisher_client.py\nindex 1c0ab91a03d4..9b15e6d4777d 100644\n--- a/pubsub/tests/unit/pubsub_v1/publisher/test_publisher_client.py\n+++ b/pubsub/tests/unit/pubsub_v1/publisher/test_publisher_client.py\n@@ -31,7 +31,7 @@ def test_init():\n # A plain client should have an `api` (the underlying GAPIC) and a\n # batch settings object, which should have the defaults.\n assert isinstance(client.api, publisher_client.PublisherClient)\n- assert client.batch_settings.max_bytes == 10 * (2 ** 20)\n+ assert client.batch_settings.max_bytes == 10 * 1000 * 1000\n assert client.batch_settings.max_latency == 0.05\n assert client.batch_settings.max_messages == 1000\n \n"}}},{"rowIdx":4686,"cells":{"in_source_id":{"kind":"string","value":"oppia__oppia-11852"},"issue":{"kind":"string","value":"FetchIssuesHandler should respond with a JSON object instead of an array\n`FetchIssuesHandler` ([link](https://github.com/oppia/oppia/blob/84c00daefcda8174bf312e11106c31940b96fd4a/core/controllers/editor.py#L526)) currently responds to GET requests with a JSON array. This conflicts with HTTP best practices, and should be changed to respond with a JSON object instead.\r\n\r\nThe fix itself is straightforward. We should change the return value from:\r\n```python\r\nself.render_json(exp_issues_dict['unresolved_issues'])\r\n```\r\nto:\r\n```python\r\nself.render_json(exp_issues_dict)\r\n```\r\n\r\nWe will need to update the corresponding `PlaythroughIssuesBackendApiService` ([link](https://github.com/oppia/oppia/blob/84c00daefcda8174bf312e11106c31940b96fd4a/core/templates/services/playthrough-issues-backend-api.service.ts#L33)) and unit tests accordingly as well.\n"},"before_files":{"kind":"list like","value":[{"content":"# coding: utf-8\n\n# Copyright 2014 The Oppia Authors. All Rights Reserved.\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\"\"\"Controllers for the editor view.\"\"\"\n\nfrom __future__ import absolute_import # pylint: disable=import-only-modules\nfrom __future__ import unicode_literals # pylint: disable=import-only-modules\n\nimport datetime\nimport logging\n\nfrom constants import constants\nfrom core.controllers import acl_decorators\nfrom core.controllers import base\nfrom core.domain import email_manager\nfrom core.domain import exp_domain\nfrom core.domain import exp_fetchers\nfrom core.domain import exp_services\nfrom core.domain import fs_domain\nfrom core.domain import fs_services\nfrom core.domain import image_validation_services\nfrom core.domain import question_services\nfrom core.domain import rights_manager\nfrom core.domain import search_services\nfrom core.domain import state_domain\nfrom core.domain import stats_domain\nfrom core.domain import stats_services\nfrom core.domain import user_services\nimport feconf\nimport utils\n\n\ndef _require_valid_version(version_from_payload, exploration_version):\n \"\"\"Check that the payload version matches the given exploration version.\"\"\"\n if version_from_payload is None:\n raise base.BaseHandler.InvalidInputException(\n 'Invalid POST request: a version must be specified.')\n\n if version_from_payload != exploration_version:\n raise base.BaseHandler.InvalidInputException(\n 'Trying to update version %s of exploration from version %s, '\n 'which is too old. Please reload the page and try again.'\n % (exploration_version, version_from_payload))\n\n\nclass EditorHandler(base.BaseHandler):\n \"\"\"Base class for all handlers for the editor page.\"\"\"\n\n pass\n\n\nclass ExplorationPage(EditorHandler):\n \"\"\"The editor page for a single exploration.\"\"\"\n\n @acl_decorators.can_play_exploration\n def get(self, unused_exploration_id):\n \"\"\"Handles GET requests.\"\"\"\n\n self.render_template('exploration-editor-page.mainpage.html')\n\n\nclass ExplorationHandler(EditorHandler):\n \"\"\"Page with editor data for a single exploration.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_play_exploration\n def get(self, exploration_id):\n \"\"\"Gets the data for the exploration overview page.\"\"\"\n # 'apply_draft' and 'v'(version) are optional parameters because the\n # exploration history tab also uses this handler, and these parameters\n # are not used by that tab.\n version = self.request.get('v', default_value=None)\n apply_draft = self.request.get('apply_draft', default_value=False)\n\n user_settings = user_services.get_user_settings(self.user_id)\n has_seen_editor_tutorial = False\n has_seen_translation_tutorial = False\n if user_settings is not None:\n if user_settings.last_started_state_editor_tutorial:\n has_seen_editor_tutorial = True\n if user_settings.last_started_state_translation_tutorial:\n has_seen_translation_tutorial = True\n\n try:\n exploration_data = exp_services.get_user_exploration_data(\n self.user_id, exploration_id, apply_draft=apply_draft,\n version=version)\n exploration_data['show_state_editor_tutorial_on_load'] = (\n self.user_id and not has_seen_editor_tutorial)\n exploration_data['show_state_translation_tutorial_on_load'] = (\n self.user_id and not has_seen_translation_tutorial)\n exploration_data['exploration_is_linked_to_story'] = bool(\n exp_services.get_story_id_linked_to_exploration(exploration_id))\n except:\n raise self.PageNotFoundException\n\n self.values.update(exploration_data)\n self.render_json(self.values)\n\n @acl_decorators.can_save_exploration\n def put(self, exploration_id):\n \"\"\"Updates properties of the given exploration.\"\"\"\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\n version = self.payload.get('version')\n _require_valid_version(version, exploration.version)\n\n commit_message = self.payload.get('commit_message')\n\n if (commit_message is not None and\n len(commit_message) > constants.MAX_COMMIT_MESSAGE_LENGTH):\n raise self.InvalidInputException(\n 'Commit messages must be at most %s characters long.'\n % constants.MAX_COMMIT_MESSAGE_LENGTH)\n\n change_list_dict = self.payload.get('change_list')\n\n try:\n change_list = [\n exp_domain.ExplorationChange(change)\n for change in change_list_dict\n ]\n except utils.ValidationError as e:\n raise self.InvalidInputException(e)\n\n exploration_rights = rights_manager.get_exploration_rights(\n exploration_id)\n can_edit = rights_manager.check_can_edit_activity(\n self.user, exploration_rights)\n can_voiceover = rights_manager.check_can_voiceover_activity(\n self.user, exploration_rights)\n\n try:\n if can_edit:\n exp_services.update_exploration(\n self.user_id, exploration_id, change_list, commit_message)\n elif can_voiceover:\n exp_services.update_exploration(\n self.user_id, exploration_id, change_list, commit_message,\n is_by_voice_artist=True)\n except utils.ValidationError as e:\n raise self.InvalidInputException(e)\n\n exploration_data = exp_services.get_user_exploration_data(\n self.user_id, exploration_id)\n\n self.values.update(exploration_data)\n self.render_json(self.values)\n\n @acl_decorators.can_delete_exploration\n def delete(self, exploration_id):\n \"\"\"Deletes the given exploration.\"\"\"\n\n log_debug_string = '(%s) %s tried to delete exploration %s' % (\n self.role, self.user_id, exploration_id)\n logging.debug(log_debug_string)\n\n is_exploration_cloned = rights_manager.is_exploration_cloned(\n exploration_id)\n exp_services.delete_exploration(\n self.user_id, exploration_id, force_deletion=is_exploration_cloned)\n\n log_info_string = '(%s) %s deleted exploration %s' % (\n self.role, self.user_id, exploration_id)\n logging.info(log_info_string)\n self.render_json(self.values)\n\n\nclass UserExplorationPermissionsHandler(EditorHandler):\n \"\"\"Handles user permissions for a particular exploration.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_play_exploration\n def get(self, exploration_id):\n \"\"\"Gets the user permissions for an exploration.\"\"\"\n exploration_rights = rights_manager.get_exploration_rights(\n exploration_id)\n self.values.update({\n 'can_delete': rights_manager.check_can_delete_activity(\n self.user, exploration_rights),\n 'can_edit': rights_manager.check_can_edit_activity(\n self.user, exploration_rights),\n 'can_modify_roles': (\n rights_manager.check_can_modify_activity_roles(\n self.user, exploration_rights)),\n 'can_publish': rights_manager.check_can_publish_activity(\n self.user, exploration_rights),\n 'can_release_ownership': (\n rights_manager.check_can_release_ownership(\n self.user, exploration_rights)),\n 'can_voiceover': (\n rights_manager.check_can_voiceover_activity(\n self.user, exploration_rights)),\n 'can_unpublish': rights_manager.check_can_unpublish_activity(\n self.user, exploration_rights),\n })\n self.render_json(self.values)\n\n\nclass ExplorationRightsHandler(EditorHandler):\n \"\"\"Handles management of exploration editing rights.\"\"\"\n\n @acl_decorators.can_modify_exploration_roles\n def put(self, exploration_id):\n \"\"\"Updates the editing rights for the given exploration.\"\"\"\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\n version = self.payload.get('version')\n _require_valid_version(version, exploration.version)\n\n make_community_owned = self.payload.get('make_community_owned')\n new_member_username = self.payload.get('new_member_username')\n new_member_role = self.payload.get('new_member_role')\n viewable_if_private = self.payload.get('viewable_if_private')\n\n if new_member_username:\n new_member_id = user_services.get_user_id_from_username(\n new_member_username)\n if new_member_id is None:\n raise self.InvalidInputException(\n 'Sorry, we could not find the specified user.')\n\n rights_manager.assign_role_for_exploration(\n self.user, exploration_id, new_member_id, new_member_role)\n email_manager.send_role_notification_email(\n self.user_id, new_member_id, new_member_role, exploration_id,\n exploration.title)\n\n elif make_community_owned:\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\n try:\n exploration.validate(strict=True)\n except utils.ValidationError as e:\n raise self.InvalidInputException(e)\n\n rights_manager.release_ownership_of_exploration(\n self.user, exploration_id)\n\n elif viewable_if_private is not None:\n rights_manager.set_private_viewability_of_exploration(\n self.user, exploration_id, viewable_if_private)\n\n else:\n raise self.InvalidInputException(\n 'No change was made to this exploration.')\n\n self.render_json({\n 'rights': rights_manager.get_exploration_rights(\n exploration_id).to_dict()\n })\n\n\nclass ExplorationStatusHandler(EditorHandler):\n \"\"\"Handles publishing of an exploration.\"\"\"\n\n def _publish_exploration(self, exploration_id):\n \"\"\"Publish an exploration.\n\n Args:\n exploration_id: str. Id of the exploration.\n\n Raises:\n InvalidInputException. Given exploration is invalid.\n \"\"\"\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\n try:\n exploration.validate(strict=True)\n except utils.ValidationError as e:\n raise self.InvalidInputException(e)\n\n exp_services.publish_exploration_and_update_user_profiles(\n self.user, exploration_id)\n exp_services.index_explorations_given_ids([exploration_id])\n\n @acl_decorators.can_publish_exploration\n def put(self, exploration_id):\n make_public = self.payload.get('make_public')\n\n if make_public is not None:\n self._publish_exploration(exploration_id)\n\n self.render_json({\n 'rights': rights_manager.get_exploration_rights(\n exploration_id).to_dict()\n })\n\n\nclass ExplorationModeratorRightsHandler(EditorHandler):\n \"\"\"Handles management of exploration rights by moderators.\"\"\"\n\n @acl_decorators.can_access_moderator_page\n def put(self, exploration_id):\n \"\"\"Unpublishes the given exploration, and sends an email to all its\n owners.\n \"\"\"\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\n email_body = self.payload.get('email_body')\n version = self.payload.get('version')\n _require_valid_version(version, exploration.version)\n\n # If moderator emails can be sent, check that all the prerequisites are\n # satisfied, otherwise do nothing.\n if feconf.REQUIRE_EMAIL_ON_MODERATOR_ACTION:\n if not email_body:\n raise self.InvalidInputException(\n 'Moderator actions should include an email to the '\n 'recipient.')\n email_manager.require_moderator_email_prereqs_are_satisfied()\n\n # Unpublish exploration.\n rights_manager.unpublish_exploration(self.user, exploration_id)\n search_services.delete_explorations_from_search_index([exploration_id])\n exp_rights = rights_manager.get_exploration_rights(exploration_id)\n\n # If moderator emails can be sent, send an email to the all owners of\n # the exploration notifying them of the change.\n if feconf.REQUIRE_EMAIL_ON_MODERATOR_ACTION:\n for owner_id in exp_rights.owner_ids:\n email_manager.send_moderator_action_email(\n self.user_id, owner_id, 'unpublish_exploration',\n exploration.title, email_body)\n\n self.render_json({\n 'rights': exp_rights.to_dict(),\n })\n\n\nclass UserExplorationEmailsHandler(EditorHandler):\n \"\"\"Handles management of user email notification preferences for this\n exploration.\n \"\"\"\n\n @acl_decorators.can_edit_exploration\n def put(self, exploration_id):\n \"\"\"Updates the email notification preferences for the given exploration.\n\n Args:\n exploration_id: str. The exploration id.\n\n Raises:\n InvalidInputException. Invalid message type.\n \"\"\"\n\n mute = self.payload.get('mute')\n message_type = self.payload.get('message_type')\n\n if message_type == feconf.MESSAGE_TYPE_FEEDBACK:\n user_services.set_email_preferences_for_exploration(\n self.user_id, exploration_id, mute_feedback_notifications=mute)\n elif message_type == feconf.MESSAGE_TYPE_SUGGESTION:\n user_services.set_email_preferences_for_exploration(\n self.user_id, exploration_id,\n mute_suggestion_notifications=mute)\n else:\n raise self.InvalidInputException(\n 'Invalid message type.')\n\n exploration_email_preferences = (\n user_services.get_email_preferences_for_exploration(\n self.user_id, exploration_id))\n self.render_json({\n 'email_preferences': exploration_email_preferences.to_dict()\n })\n\n\nclass ExplorationFileDownloader(EditorHandler):\n \"\"\"Downloads an exploration as a zip file, or dict of YAML strings\n representing states.\n \"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_DOWNLOADABLE\n\n @acl_decorators.can_download_exploration\n def get(self, exploration_id):\n \"\"\"Handles GET requests.\"\"\"\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\n\n version_str = self.request.get('v', default_value=exploration.version)\n output_format = self.request.get('output_format', default_value='zip')\n\n try:\n version = int(version_str)\n except ValueError:\n version = exploration.version\n\n # If the title of the exploration has changed, we use the new title.\n if not exploration.title:\n init_filename = 'oppia-unpublished_exploration-v%s.zip' % version\n else:\n init_filename = 'oppia-%s-v%s.zip' % (\n exploration.title.replace(' ', ''), version)\n filename = utils.to_ascii(init_filename).decode('utf-8')\n\n if output_format == feconf.OUTPUT_FORMAT_ZIP:\n self.render_downloadable_file(\n exp_services.export_to_zip_file(\n exploration_id, version=version),\n filename, 'text/plain')\n elif output_format == feconf.OUTPUT_FORMAT_JSON:\n self.render_json(exp_services.export_states_to_yaml(\n exploration_id, version=version))\n else:\n raise self.InvalidInputException(\n 'Unrecognized output format %s' % output_format)\n\n\nclass StateYamlHandler(EditorHandler):\n \"\"\"Given a representation of a state, converts it to a YAML string.\n\n Note that this handler is stateless; it does not make use of the storage\n layer.\n \"\"\"\n\n @acl_decorators.can_play_exploration\n def post(self, unused_exploration_id):\n \"\"\"Handles POST requests.\"\"\"\n state_dict = self.payload.get('state_dict')\n width = self.payload.get('width')\n\n if not width or not state_dict:\n raise self.PageNotFoundException\n\n self.render_json({\n 'yaml': state_domain.State.convert_state_dict_to_yaml(\n state_dict, width),\n })\n\n\nclass ExplorationSnapshotsHandler(EditorHandler):\n \"\"\"Returns the exploration snapshot history.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_play_exploration\n def get(self, exploration_id):\n \"\"\"Handles GET requests.\"\"\"\n\n snapshots = exp_services.get_exploration_snapshots_metadata(\n exploration_id)\n\n # Patch `snapshots` to use the editor's display name.\n snapshots_committer_ids = [\n snapshot['committer_id'] for snapshot in snapshots]\n committer_usernames = user_services.get_usernames(\n snapshots_committer_ids)\n for index, snapshot in enumerate(snapshots):\n snapshot['committer_id'] = committer_usernames[index]\n\n self.render_json({\n 'snapshots': snapshots,\n })\n\n\nclass ExplorationRevertHandler(EditorHandler):\n \"\"\"Reverts an exploration to an older version.\"\"\"\n\n @acl_decorators.can_edit_exploration\n def post(self, exploration_id):\n \"\"\"Handles POST requests.\"\"\"\n current_version = self.payload.get('current_version')\n revert_to_version = self.payload.get('revert_to_version')\n\n if not isinstance(revert_to_version, int):\n raise self.InvalidInputException(\n 'Expected an integer version to revert to; received %s.' %\n revert_to_version)\n if not isinstance(current_version, int):\n raise self.InvalidInputException(\n 'Expected an integer current version; received %s.' %\n current_version)\n\n if revert_to_version < 1 or revert_to_version >= current_version:\n raise self.InvalidInputException(\n 'Cannot revert to version %s from version %s.' %\n (revert_to_version, current_version))\n\n exp_services.discard_draft(exploration_id, self.user_id)\n exp_services.revert_exploration(\n self.user_id, exploration_id, current_version, revert_to_version)\n self.render_json({})\n\n\nclass ExplorationStatisticsHandler(EditorHandler):\n \"\"\"Returns statistics for an exploration. This is the handler for the new\n statistics framework.\n \"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_view_exploration_stats\n def get(self, exploration_id):\n \"\"\"Handles GET requests.\"\"\"\n current_exploration = exp_fetchers.get_exploration_by_id(\n exploration_id)\n\n self.render_json(stats_services.get_exploration_stats(\n exploration_id, current_exploration.version).to_frontend_dict())\n\n\nclass StateInteractionStatsHandler(EditorHandler):\n \"\"\"Returns detailed learner answer statistics for a state.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_view_exploration_stats\n def get(self, exploration_id, escaped_state_name):\n \"\"\"Handles GET requests.\"\"\"\n current_exploration = exp_fetchers.get_exploration_by_id(\n exploration_id)\n\n state_name = utils.unescape_encoded_uri_component(escaped_state_name)\n if state_name not in current_exploration.states:\n logging.error('Could not find state: %s' % state_name)\n logging.error('Available states: %s' % (\n list(current_exploration.states.keys())))\n raise self.PageNotFoundException\n\n self.render_json({\n 'visualizations_info': stats_services.get_visualizations_info(\n current_exploration.id, state_name,\n current_exploration.states[state_name].interaction.id),\n })\n\n\nclass FetchIssuesHandler(EditorHandler):\n \"\"\"Handler used for retrieving the list of unresolved issues in an\n exploration. This removes the invalid issues and returns the remaining\n unresolved ones.\n \"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_view_exploration_stats\n def get(self, exp_id):\n \"\"\"Handles GET requests.\"\"\"\n exp_version = self.request.get('exp_version')\n exp_issues = stats_services.get_exp_issues(exp_id, exp_version)\n if exp_issues is None:\n raise self.PageNotFoundException(\n 'Invalid version %s for exploration ID %s'\n % (exp_version, exp_id))\n unresolved_issues = []\n for issue in exp_issues.unresolved_issues:\n if issue.is_valid:\n unresolved_issues.append(issue)\n exp_issues.unresolved_issues = unresolved_issues\n exp_issues_dict = exp_issues.to_dict()\n self.render_json(exp_issues_dict['unresolved_issues'])\n\n\nclass FetchPlaythroughHandler(EditorHandler):\n \"\"\"Handler used for retrieving a playthrough.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_view_exploration_stats\n def get(self, unused_exploration_id, playthrough_id):\n \"\"\"Handles GET requests.\"\"\"\n playthrough = stats_services.get_playthrough_by_id(playthrough_id)\n if playthrough is None:\n raise self.PageNotFoundException(\n 'Invalid playthrough ID %s' % (playthrough_id))\n self.render_json(playthrough.to_dict())\n\n\nclass ResolveIssueHandler(EditorHandler):\n \"\"\"Handler used for resolving an issue. Currently, when an issue is\n resolved, the issue is removed from the unresolved issues list in the\n ExplorationIssuesModel instance, and all corresponding playthrough\n instances are deleted.\n \"\"\"\n\n @acl_decorators.can_edit_exploration\n def post(self, exp_id):\n \"\"\"Handles POST requests.\"\"\"\n exp_issue_dict = self.payload.get('exp_issue_dict')\n try:\n stats_domain.ExplorationIssue.from_dict(exp_issue_dict)\n except utils.ValidationError as e:\n raise self.PageNotFoundException(e)\n\n exp_version = self.payload.get('exp_version')\n\n exp_issues = stats_services.get_exp_issues(exp_id, exp_version)\n if exp_issues is None:\n raise self.PageNotFoundException(\n 'Invalid exploration ID %s' % (exp_id))\n\n # Check that the passed in issue actually exists in the exploration\n # issues instance.\n issue_to_remove = None\n for issue in exp_issues.unresolved_issues:\n if issue.to_dict() == exp_issue_dict:\n issue_to_remove = issue\n break\n\n if not issue_to_remove:\n raise self.PageNotFoundException(\n 'Exploration issue does not exist in the list of issues for '\n 'the exploration with ID %s' % exp_id)\n\n # Remove the issue from the unresolved issues list.\n exp_issues.unresolved_issues.remove(issue_to_remove)\n\n # Update the exploration issues instance and delete the playthrough\n # instances.\n stats_services.delete_playthroughs_multi(\n issue_to_remove.playthrough_ids)\n stats_services.save_exp_issues_model(exp_issues)\n\n self.render_json({})\n\n\nclass ImageUploadHandler(EditorHandler):\n \"\"\"Handles image uploads.\"\"\"\n\n # The string to prefix to the filename (before tacking the whole thing on\n # to the end of 'assets/').\n _FILENAME_PREFIX = 'image'\n _decorator = None\n\n @acl_decorators.can_edit_entity\n def post(self, entity_type, entity_id):\n \"\"\"Saves an image uploaded by a content creator.\"\"\"\n\n raw = self.request.get('image')\n filename = self.payload.get('filename')\n filename_prefix = self.payload.get('filename_prefix')\n if filename_prefix is None:\n filename_prefix = self._FILENAME_PREFIX\n\n try:\n file_format = image_validation_services.validate_image_and_filename(\n raw, filename)\n except utils.ValidationError as e:\n raise self.InvalidInputException(e)\n\n file_system_class = fs_services.get_entity_file_system_class()\n fs = fs_domain.AbstractFileSystem(file_system_class(\n entity_type, entity_id))\n filepath = '%s/%s' % (filename_prefix, filename)\n\n if fs.isfile(filepath):\n raise self.InvalidInputException(\n 'A file with the name %s already exists. Please choose a '\n 'different name.' % filename)\n image_is_compressible = (\n file_format in feconf.COMPRESSIBLE_IMAGE_FORMATS)\n fs_services.save_original_and_compressed_versions_of_image(\n filename, entity_type, entity_id, raw, filename_prefix,\n image_is_compressible)\n\n self.render_json({'filename': filename})\n\n\nclass StartedTutorialEventHandler(EditorHandler):\n \"\"\"Records that this user has started the state editor tutorial.\"\"\"\n\n @acl_decorators.can_play_exploration\n def post(self, unused_exploration_id):\n \"\"\"Handles GET requests.\"\"\"\n user_services.record_user_started_state_editor_tutorial(self.user_id)\n self.render_json({})\n\n\nclass EditorAutosaveHandler(ExplorationHandler):\n \"\"\"Handles requests from the editor for draft autosave.\"\"\"\n\n @acl_decorators.can_save_exploration\n def put(self, exploration_id):\n \"\"\"Handles PUT requests for draft updation.\"\"\"\n # Raise an Exception if the draft change list fails non-strict\n # validation.\n try:\n change_list_dict = self.payload.get('change_list')\n change_list = [\n exp_domain.ExplorationChange(change)\n for change in change_list_dict]\n except utils.ValidationError as e:\n # We leave any pre-existing draft changes in the datastore.\n raise self.InvalidInputException(e)\n\n version = self.payload.get('version')\n exploration_rights = rights_manager.get_exploration_rights(\n exploration_id)\n can_edit = rights_manager.check_can_edit_activity(\n self.user, exploration_rights)\n can_voiceover = rights_manager.check_can_voiceover_activity(\n self.user, exploration_rights)\n\n try:\n if can_edit:\n exp_services.create_or_update_draft(\n exploration_id, self.user_id, change_list, version,\n datetime.datetime.utcnow())\n elif can_voiceover:\n exp_services.create_or_update_draft(\n exploration_id, self.user_id, change_list, version,\n datetime.datetime.utcnow(), is_by_voice_artist=True)\n except utils.ValidationError as e:\n # We leave any pre-existing draft changes in the datastore.\n raise self.InvalidInputException(e)\n\n exp_user_data = exp_services.get_user_exploration_data(\n self.user_id, exploration_id)\n # If the draft_change_list_id is False, have the user discard the draft\n # changes. We save the draft to the datastore even if the version is\n # invalid, so that it is available for recovery later.\n self.render_json({\n 'draft_change_list_id': exp_user_data['draft_change_list_id'],\n 'is_version_of_draft_valid': exp_services.is_version_of_draft_valid(\n exploration_id, version)})\n\n @acl_decorators.can_save_exploration\n def post(self, exploration_id):\n \"\"\"Handles POST request for discarding draft changes.\"\"\"\n exp_services.discard_draft(exploration_id, self.user_id)\n self.render_json({})\n\n\nclass StateAnswerStatisticsHandler(EditorHandler):\n \"\"\"Returns basic learner answer statistics for a state.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_view_exploration_stats\n def get(self, exploration_id):\n \"\"\"Handles GET requests.\"\"\"\n current_exploration = exp_fetchers.get_exploration_by_id(exploration_id)\n\n top_state_answers = stats_services.get_top_state_answer_stats_multi(\n exploration_id, current_exploration.states)\n top_state_interaction_ids = {\n state_name: current_exploration.states[state_name].interaction.id\n for state_name in top_state_answers\n }\n self.render_json({\n 'answers': top_state_answers,\n 'interaction_ids': top_state_interaction_ids,\n })\n\n\nclass TopUnresolvedAnswersHandler(EditorHandler):\n \"\"\"Returns a list of top N unresolved answers.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_edit_exploration\n def get(self, exploration_id):\n \"\"\"Handles GET requests for unresolved answers.\"\"\"\n state_name = self.request.get('state_name')\n if not state_name:\n raise self.PageNotFoundException\n\n unresolved_answers_with_frequency = (\n stats_services.get_top_state_unresolved_answers(\n exploration_id, state_name))\n\n self.render_json({\n 'unresolved_answers': unresolved_answers_with_frequency\n })\n\n\nclass LearnerAnswerInfoHandler(EditorHandler):\n \"\"\"Handles the learner answer info for an exploration state.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_play_entity\n def get(self, entity_type, entity_id):\n \"\"\"Handles the GET requests for learner answer info for an\n exploration state.\n \"\"\"\n if not constants.ENABLE_SOLICIT_ANSWER_DETAILS_FEATURE:\n raise self.PageNotFoundException\n\n learner_answer_info_data = []\n\n if entity_type == feconf.ENTITY_TYPE_EXPLORATION:\n exp = exp_fetchers.get_exploration_by_id(entity_id)\n for state_name in exp.states:\n state_reference = (\n stats_services.get_state_reference_for_exploration(\n entity_id, state_name))\n learner_answer_details = (\n stats_services.get_learner_answer_details(\n feconf.ENTITY_TYPE_EXPLORATION, state_reference))\n if learner_answer_details is not None:\n learner_answer_info_data.append({\n 'state_name': state_name,\n 'interaction_id': learner_answer_details.interaction_id,\n 'customization_args': exp.states[state_name].interaction\n .to_dict()['customization_args'],\n 'learner_answer_info_dicts': [\n learner_answer_info.to_dict() for\n learner_answer_info in\n learner_answer_details.learner_answer_info_list]\n })\n elif entity_type == feconf.ENTITY_TYPE_QUESTION:\n question = question_services.get_question_by_id(entity_id)\n state_reference = stats_services.get_state_reference_for_question(\n entity_id)\n learner_answer_details = stats_services.get_learner_answer_details(\n feconf.ENTITY_TYPE_QUESTION, state_reference)\n if learner_answer_details is not None:\n learner_answer_info_dicts = [\n learner_answer_info.to_dict() for learner_answer_info in\n learner_answer_details.learner_answer_info_list]\n learner_answer_info_data = {\n 'interaction_id': learner_answer_details.interaction_id,\n 'customization_args': question.question_state_data.interaction\n .to_dict()['customization_args'],\n 'learner_answer_info_dicts': learner_answer_info_dicts\n }\n\n self.render_json({\n 'learner_answer_info_data': learner_answer_info_data\n })\n\n @acl_decorators.can_edit_entity\n def delete(self, entity_type, entity_id):\n \"\"\"Deletes the learner answer info by the given id.\"\"\"\n\n if not constants.ENABLE_SOLICIT_ANSWER_DETAILS_FEATURE:\n raise self.PageNotFoundException\n\n if entity_type == feconf.ENTITY_TYPE_EXPLORATION:\n state_name = self.request.get('state_name')\n if not state_name:\n raise self.InvalidInputException\n state_reference = (\n stats_services.get_state_reference_for_exploration(\n entity_id, state_name))\n elif entity_type == feconf.ENTITY_TYPE_QUESTION:\n state_reference = (\n stats_services.get_state_reference_for_question(\n entity_id))\n learner_answer_info_id = self.request.get('learner_answer_info_id')\n if not learner_answer_info_id:\n raise self.PageNotFoundException\n stats_services.delete_learner_answer_info(\n entity_type, state_reference, learner_answer_info_id)\n self.render_json({})\n","path":"core/controllers/editor.py"}],"string":"[\n {\n \"content\": \"# coding: utf-8\\n\\n# Copyright 2014 The Oppia Authors. All Rights Reserved.\\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\\\"\\\"\\\"Controllers for the editor view.\\\"\\\"\\\"\\n\\nfrom __future__ import absolute_import # pylint: disable=import-only-modules\\nfrom __future__ import unicode_literals # pylint: disable=import-only-modules\\n\\nimport datetime\\nimport logging\\n\\nfrom constants import constants\\nfrom core.controllers import acl_decorators\\nfrom core.controllers import base\\nfrom core.domain import email_manager\\nfrom core.domain import exp_domain\\nfrom core.domain import exp_fetchers\\nfrom core.domain import exp_services\\nfrom core.domain import fs_domain\\nfrom core.domain import fs_services\\nfrom core.domain import image_validation_services\\nfrom core.domain import question_services\\nfrom core.domain import rights_manager\\nfrom core.domain import search_services\\nfrom core.domain import state_domain\\nfrom core.domain import stats_domain\\nfrom core.domain import stats_services\\nfrom core.domain import user_services\\nimport feconf\\nimport utils\\n\\n\\ndef _require_valid_version(version_from_payload, exploration_version):\\n \\\"\\\"\\\"Check that the payload version matches the given exploration version.\\\"\\\"\\\"\\n if version_from_payload is None:\\n raise base.BaseHandler.InvalidInputException(\\n 'Invalid POST request: a version must be specified.')\\n\\n if version_from_payload != exploration_version:\\n raise base.BaseHandler.InvalidInputException(\\n 'Trying to update version %s of exploration from version %s, '\\n 'which is too old. Please reload the page and try again.'\\n % (exploration_version, version_from_payload))\\n\\n\\nclass EditorHandler(base.BaseHandler):\\n \\\"\\\"\\\"Base class for all handlers for the editor page.\\\"\\\"\\\"\\n\\n pass\\n\\n\\nclass ExplorationPage(EditorHandler):\\n \\\"\\\"\\\"The editor page for a single exploration.\\\"\\\"\\\"\\n\\n @acl_decorators.can_play_exploration\\n def get(self, unused_exploration_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n\\n self.render_template('exploration-editor-page.mainpage.html')\\n\\n\\nclass ExplorationHandler(EditorHandler):\\n \\\"\\\"\\\"Page with editor data for a single exploration.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_play_exploration\\n def get(self, exploration_id):\\n \\\"\\\"\\\"Gets the data for the exploration overview page.\\\"\\\"\\\"\\n # 'apply_draft' and 'v'(version) are optional parameters because the\\n # exploration history tab also uses this handler, and these parameters\\n # are not used by that tab.\\n version = self.request.get('v', default_value=None)\\n apply_draft = self.request.get('apply_draft', default_value=False)\\n\\n user_settings = user_services.get_user_settings(self.user_id)\\n has_seen_editor_tutorial = False\\n has_seen_translation_tutorial = False\\n if user_settings is not None:\\n if user_settings.last_started_state_editor_tutorial:\\n has_seen_editor_tutorial = True\\n if user_settings.last_started_state_translation_tutorial:\\n has_seen_translation_tutorial = True\\n\\n try:\\n exploration_data = exp_services.get_user_exploration_data(\\n self.user_id, exploration_id, apply_draft=apply_draft,\\n version=version)\\n exploration_data['show_state_editor_tutorial_on_load'] = (\\n self.user_id and not has_seen_editor_tutorial)\\n exploration_data['show_state_translation_tutorial_on_load'] = (\\n self.user_id and not has_seen_translation_tutorial)\\n exploration_data['exploration_is_linked_to_story'] = bool(\\n exp_services.get_story_id_linked_to_exploration(exploration_id))\\n except:\\n raise self.PageNotFoundException\\n\\n self.values.update(exploration_data)\\n self.render_json(self.values)\\n\\n @acl_decorators.can_save_exploration\\n def put(self, exploration_id):\\n \\\"\\\"\\\"Updates properties of the given exploration.\\\"\\\"\\\"\\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\\n version = self.payload.get('version')\\n _require_valid_version(version, exploration.version)\\n\\n commit_message = self.payload.get('commit_message')\\n\\n if (commit_message is not None and\\n len(commit_message) > constants.MAX_COMMIT_MESSAGE_LENGTH):\\n raise self.InvalidInputException(\\n 'Commit messages must be at most %s characters long.'\\n % constants.MAX_COMMIT_MESSAGE_LENGTH)\\n\\n change_list_dict = self.payload.get('change_list')\\n\\n try:\\n change_list = [\\n exp_domain.ExplorationChange(change)\\n for change in change_list_dict\\n ]\\n except utils.ValidationError as e:\\n raise self.InvalidInputException(e)\\n\\n exploration_rights = rights_manager.get_exploration_rights(\\n exploration_id)\\n can_edit = rights_manager.check_can_edit_activity(\\n self.user, exploration_rights)\\n can_voiceover = rights_manager.check_can_voiceover_activity(\\n self.user, exploration_rights)\\n\\n try:\\n if can_edit:\\n exp_services.update_exploration(\\n self.user_id, exploration_id, change_list, commit_message)\\n elif can_voiceover:\\n exp_services.update_exploration(\\n self.user_id, exploration_id, change_list, commit_message,\\n is_by_voice_artist=True)\\n except utils.ValidationError as e:\\n raise self.InvalidInputException(e)\\n\\n exploration_data = exp_services.get_user_exploration_data(\\n self.user_id, exploration_id)\\n\\n self.values.update(exploration_data)\\n self.render_json(self.values)\\n\\n @acl_decorators.can_delete_exploration\\n def delete(self, exploration_id):\\n \\\"\\\"\\\"Deletes the given exploration.\\\"\\\"\\\"\\n\\n log_debug_string = '(%s) %s tried to delete exploration %s' % (\\n self.role, self.user_id, exploration_id)\\n logging.debug(log_debug_string)\\n\\n is_exploration_cloned = rights_manager.is_exploration_cloned(\\n exploration_id)\\n exp_services.delete_exploration(\\n self.user_id, exploration_id, force_deletion=is_exploration_cloned)\\n\\n log_info_string = '(%s) %s deleted exploration %s' % (\\n self.role, self.user_id, exploration_id)\\n logging.info(log_info_string)\\n self.render_json(self.values)\\n\\n\\nclass UserExplorationPermissionsHandler(EditorHandler):\\n \\\"\\\"\\\"Handles user permissions for a particular exploration.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_play_exploration\\n def get(self, exploration_id):\\n \\\"\\\"\\\"Gets the user permissions for an exploration.\\\"\\\"\\\"\\n exploration_rights = rights_manager.get_exploration_rights(\\n exploration_id)\\n self.values.update({\\n 'can_delete': rights_manager.check_can_delete_activity(\\n self.user, exploration_rights),\\n 'can_edit': rights_manager.check_can_edit_activity(\\n self.user, exploration_rights),\\n 'can_modify_roles': (\\n rights_manager.check_can_modify_activity_roles(\\n self.user, exploration_rights)),\\n 'can_publish': rights_manager.check_can_publish_activity(\\n self.user, exploration_rights),\\n 'can_release_ownership': (\\n rights_manager.check_can_release_ownership(\\n self.user, exploration_rights)),\\n 'can_voiceover': (\\n rights_manager.check_can_voiceover_activity(\\n self.user, exploration_rights)),\\n 'can_unpublish': rights_manager.check_can_unpublish_activity(\\n self.user, exploration_rights),\\n })\\n self.render_json(self.values)\\n\\n\\nclass ExplorationRightsHandler(EditorHandler):\\n \\\"\\\"\\\"Handles management of exploration editing rights.\\\"\\\"\\\"\\n\\n @acl_decorators.can_modify_exploration_roles\\n def put(self, exploration_id):\\n \\\"\\\"\\\"Updates the editing rights for the given exploration.\\\"\\\"\\\"\\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\\n version = self.payload.get('version')\\n _require_valid_version(version, exploration.version)\\n\\n make_community_owned = self.payload.get('make_community_owned')\\n new_member_username = self.payload.get('new_member_username')\\n new_member_role = self.payload.get('new_member_role')\\n viewable_if_private = self.payload.get('viewable_if_private')\\n\\n if new_member_username:\\n new_member_id = user_services.get_user_id_from_username(\\n new_member_username)\\n if new_member_id is None:\\n raise self.InvalidInputException(\\n 'Sorry, we could not find the specified user.')\\n\\n rights_manager.assign_role_for_exploration(\\n self.user, exploration_id, new_member_id, new_member_role)\\n email_manager.send_role_notification_email(\\n self.user_id, new_member_id, new_member_role, exploration_id,\\n exploration.title)\\n\\n elif make_community_owned:\\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\\n try:\\n exploration.validate(strict=True)\\n except utils.ValidationError as e:\\n raise self.InvalidInputException(e)\\n\\n rights_manager.release_ownership_of_exploration(\\n self.user, exploration_id)\\n\\n elif viewable_if_private is not None:\\n rights_manager.set_private_viewability_of_exploration(\\n self.user, exploration_id, viewable_if_private)\\n\\n else:\\n raise self.InvalidInputException(\\n 'No change was made to this exploration.')\\n\\n self.render_json({\\n 'rights': rights_manager.get_exploration_rights(\\n exploration_id).to_dict()\\n })\\n\\n\\nclass ExplorationStatusHandler(EditorHandler):\\n \\\"\\\"\\\"Handles publishing of an exploration.\\\"\\\"\\\"\\n\\n def _publish_exploration(self, exploration_id):\\n \\\"\\\"\\\"Publish an exploration.\\n\\n Args:\\n exploration_id: str. Id of the exploration.\\n\\n Raises:\\n InvalidInputException. Given exploration is invalid.\\n \\\"\\\"\\\"\\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\\n try:\\n exploration.validate(strict=True)\\n except utils.ValidationError as e:\\n raise self.InvalidInputException(e)\\n\\n exp_services.publish_exploration_and_update_user_profiles(\\n self.user, exploration_id)\\n exp_services.index_explorations_given_ids([exploration_id])\\n\\n @acl_decorators.can_publish_exploration\\n def put(self, exploration_id):\\n make_public = self.payload.get('make_public')\\n\\n if make_public is not None:\\n self._publish_exploration(exploration_id)\\n\\n self.render_json({\\n 'rights': rights_manager.get_exploration_rights(\\n exploration_id).to_dict()\\n })\\n\\n\\nclass ExplorationModeratorRightsHandler(EditorHandler):\\n \\\"\\\"\\\"Handles management of exploration rights by moderators.\\\"\\\"\\\"\\n\\n @acl_decorators.can_access_moderator_page\\n def put(self, exploration_id):\\n \\\"\\\"\\\"Unpublishes the given exploration, and sends an email to all its\\n owners.\\n \\\"\\\"\\\"\\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\\n email_body = self.payload.get('email_body')\\n version = self.payload.get('version')\\n _require_valid_version(version, exploration.version)\\n\\n # If moderator emails can be sent, check that all the prerequisites are\\n # satisfied, otherwise do nothing.\\n if feconf.REQUIRE_EMAIL_ON_MODERATOR_ACTION:\\n if not email_body:\\n raise self.InvalidInputException(\\n 'Moderator actions should include an email to the '\\n 'recipient.')\\n email_manager.require_moderator_email_prereqs_are_satisfied()\\n\\n # Unpublish exploration.\\n rights_manager.unpublish_exploration(self.user, exploration_id)\\n search_services.delete_explorations_from_search_index([exploration_id])\\n exp_rights = rights_manager.get_exploration_rights(exploration_id)\\n\\n # If moderator emails can be sent, send an email to the all owners of\\n # the exploration notifying them of the change.\\n if feconf.REQUIRE_EMAIL_ON_MODERATOR_ACTION:\\n for owner_id in exp_rights.owner_ids:\\n email_manager.send_moderator_action_email(\\n self.user_id, owner_id, 'unpublish_exploration',\\n exploration.title, email_body)\\n\\n self.render_json({\\n 'rights': exp_rights.to_dict(),\\n })\\n\\n\\nclass UserExplorationEmailsHandler(EditorHandler):\\n \\\"\\\"\\\"Handles management of user email notification preferences for this\\n exploration.\\n \\\"\\\"\\\"\\n\\n @acl_decorators.can_edit_exploration\\n def put(self, exploration_id):\\n \\\"\\\"\\\"Updates the email notification preferences for the given exploration.\\n\\n Args:\\n exploration_id: str. The exploration id.\\n\\n Raises:\\n InvalidInputException. Invalid message type.\\n \\\"\\\"\\\"\\n\\n mute = self.payload.get('mute')\\n message_type = self.payload.get('message_type')\\n\\n if message_type == feconf.MESSAGE_TYPE_FEEDBACK:\\n user_services.set_email_preferences_for_exploration(\\n self.user_id, exploration_id, mute_feedback_notifications=mute)\\n elif message_type == feconf.MESSAGE_TYPE_SUGGESTION:\\n user_services.set_email_preferences_for_exploration(\\n self.user_id, exploration_id,\\n mute_suggestion_notifications=mute)\\n else:\\n raise self.InvalidInputException(\\n 'Invalid message type.')\\n\\n exploration_email_preferences = (\\n user_services.get_email_preferences_for_exploration(\\n self.user_id, exploration_id))\\n self.render_json({\\n 'email_preferences': exploration_email_preferences.to_dict()\\n })\\n\\n\\nclass ExplorationFileDownloader(EditorHandler):\\n \\\"\\\"\\\"Downloads an exploration as a zip file, or dict of YAML strings\\n representing states.\\n \\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_DOWNLOADABLE\\n\\n @acl_decorators.can_download_exploration\\n def get(self, exploration_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\\n\\n version_str = self.request.get('v', default_value=exploration.version)\\n output_format = self.request.get('output_format', default_value='zip')\\n\\n try:\\n version = int(version_str)\\n except ValueError:\\n version = exploration.version\\n\\n # If the title of the exploration has changed, we use the new title.\\n if not exploration.title:\\n init_filename = 'oppia-unpublished_exploration-v%s.zip' % version\\n else:\\n init_filename = 'oppia-%s-v%s.zip' % (\\n exploration.title.replace(' ', ''), version)\\n filename = utils.to_ascii(init_filename).decode('utf-8')\\n\\n if output_format == feconf.OUTPUT_FORMAT_ZIP:\\n self.render_downloadable_file(\\n exp_services.export_to_zip_file(\\n exploration_id, version=version),\\n filename, 'text/plain')\\n elif output_format == feconf.OUTPUT_FORMAT_JSON:\\n self.render_json(exp_services.export_states_to_yaml(\\n exploration_id, version=version))\\n else:\\n raise self.InvalidInputException(\\n 'Unrecognized output format %s' % output_format)\\n\\n\\nclass StateYamlHandler(EditorHandler):\\n \\\"\\\"\\\"Given a representation of a state, converts it to a YAML string.\\n\\n Note that this handler is stateless; it does not make use of the storage\\n layer.\\n \\\"\\\"\\\"\\n\\n @acl_decorators.can_play_exploration\\n def post(self, unused_exploration_id):\\n \\\"\\\"\\\"Handles POST requests.\\\"\\\"\\\"\\n state_dict = self.payload.get('state_dict')\\n width = self.payload.get('width')\\n\\n if not width or not state_dict:\\n raise self.PageNotFoundException\\n\\n self.render_json({\\n 'yaml': state_domain.State.convert_state_dict_to_yaml(\\n state_dict, width),\\n })\\n\\n\\nclass ExplorationSnapshotsHandler(EditorHandler):\\n \\\"\\\"\\\"Returns the exploration snapshot history.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_play_exploration\\n def get(self, exploration_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n\\n snapshots = exp_services.get_exploration_snapshots_metadata(\\n exploration_id)\\n\\n # Patch `snapshots` to use the editor's display name.\\n snapshots_committer_ids = [\\n snapshot['committer_id'] for snapshot in snapshots]\\n committer_usernames = user_services.get_usernames(\\n snapshots_committer_ids)\\n for index, snapshot in enumerate(snapshots):\\n snapshot['committer_id'] = committer_usernames[index]\\n\\n self.render_json({\\n 'snapshots': snapshots,\\n })\\n\\n\\nclass ExplorationRevertHandler(EditorHandler):\\n \\\"\\\"\\\"Reverts an exploration to an older version.\\\"\\\"\\\"\\n\\n @acl_decorators.can_edit_exploration\\n def post(self, exploration_id):\\n \\\"\\\"\\\"Handles POST requests.\\\"\\\"\\\"\\n current_version = self.payload.get('current_version')\\n revert_to_version = self.payload.get('revert_to_version')\\n\\n if not isinstance(revert_to_version, int):\\n raise self.InvalidInputException(\\n 'Expected an integer version to revert to; received %s.' %\\n revert_to_version)\\n if not isinstance(current_version, int):\\n raise self.InvalidInputException(\\n 'Expected an integer current version; received %s.' %\\n current_version)\\n\\n if revert_to_version < 1 or revert_to_version >= current_version:\\n raise self.InvalidInputException(\\n 'Cannot revert to version %s from version %s.' %\\n (revert_to_version, current_version))\\n\\n exp_services.discard_draft(exploration_id, self.user_id)\\n exp_services.revert_exploration(\\n self.user_id, exploration_id, current_version, revert_to_version)\\n self.render_json({})\\n\\n\\nclass ExplorationStatisticsHandler(EditorHandler):\\n \\\"\\\"\\\"Returns statistics for an exploration. This is the handler for the new\\n statistics framework.\\n \\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_view_exploration_stats\\n def get(self, exploration_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n current_exploration = exp_fetchers.get_exploration_by_id(\\n exploration_id)\\n\\n self.render_json(stats_services.get_exploration_stats(\\n exploration_id, current_exploration.version).to_frontend_dict())\\n\\n\\nclass StateInteractionStatsHandler(EditorHandler):\\n \\\"\\\"\\\"Returns detailed learner answer statistics for a state.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_view_exploration_stats\\n def get(self, exploration_id, escaped_state_name):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n current_exploration = exp_fetchers.get_exploration_by_id(\\n exploration_id)\\n\\n state_name = utils.unescape_encoded_uri_component(escaped_state_name)\\n if state_name not in current_exploration.states:\\n logging.error('Could not find state: %s' % state_name)\\n logging.error('Available states: %s' % (\\n list(current_exploration.states.keys())))\\n raise self.PageNotFoundException\\n\\n self.render_json({\\n 'visualizations_info': stats_services.get_visualizations_info(\\n current_exploration.id, state_name,\\n current_exploration.states[state_name].interaction.id),\\n })\\n\\n\\nclass FetchIssuesHandler(EditorHandler):\\n \\\"\\\"\\\"Handler used for retrieving the list of unresolved issues in an\\n exploration. This removes the invalid issues and returns the remaining\\n unresolved ones.\\n \\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_view_exploration_stats\\n def get(self, exp_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n exp_version = self.request.get('exp_version')\\n exp_issues = stats_services.get_exp_issues(exp_id, exp_version)\\n if exp_issues is None:\\n raise self.PageNotFoundException(\\n 'Invalid version %s for exploration ID %s'\\n % (exp_version, exp_id))\\n unresolved_issues = []\\n for issue in exp_issues.unresolved_issues:\\n if issue.is_valid:\\n unresolved_issues.append(issue)\\n exp_issues.unresolved_issues = unresolved_issues\\n exp_issues_dict = exp_issues.to_dict()\\n self.render_json(exp_issues_dict['unresolved_issues'])\\n\\n\\nclass FetchPlaythroughHandler(EditorHandler):\\n \\\"\\\"\\\"Handler used for retrieving a playthrough.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_view_exploration_stats\\n def get(self, unused_exploration_id, playthrough_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n playthrough = stats_services.get_playthrough_by_id(playthrough_id)\\n if playthrough is None:\\n raise self.PageNotFoundException(\\n 'Invalid playthrough ID %s' % (playthrough_id))\\n self.render_json(playthrough.to_dict())\\n\\n\\nclass ResolveIssueHandler(EditorHandler):\\n \\\"\\\"\\\"Handler used for resolving an issue. Currently, when an issue is\\n resolved, the issue is removed from the unresolved issues list in the\\n ExplorationIssuesModel instance, and all corresponding playthrough\\n instances are deleted.\\n \\\"\\\"\\\"\\n\\n @acl_decorators.can_edit_exploration\\n def post(self, exp_id):\\n \\\"\\\"\\\"Handles POST requests.\\\"\\\"\\\"\\n exp_issue_dict = self.payload.get('exp_issue_dict')\\n try:\\n stats_domain.ExplorationIssue.from_dict(exp_issue_dict)\\n except utils.ValidationError as e:\\n raise self.PageNotFoundException(e)\\n\\n exp_version = self.payload.get('exp_version')\\n\\n exp_issues = stats_services.get_exp_issues(exp_id, exp_version)\\n if exp_issues is None:\\n raise self.PageNotFoundException(\\n 'Invalid exploration ID %s' % (exp_id))\\n\\n # Check that the passed in issue actually exists in the exploration\\n # issues instance.\\n issue_to_remove = None\\n for issue in exp_issues.unresolved_issues:\\n if issue.to_dict() == exp_issue_dict:\\n issue_to_remove = issue\\n break\\n\\n if not issue_to_remove:\\n raise self.PageNotFoundException(\\n 'Exploration issue does not exist in the list of issues for '\\n 'the exploration with ID %s' % exp_id)\\n\\n # Remove the issue from the unresolved issues list.\\n exp_issues.unresolved_issues.remove(issue_to_remove)\\n\\n # Update the exploration issues instance and delete the playthrough\\n # instances.\\n stats_services.delete_playthroughs_multi(\\n issue_to_remove.playthrough_ids)\\n stats_services.save_exp_issues_model(exp_issues)\\n\\n self.render_json({})\\n\\n\\nclass ImageUploadHandler(EditorHandler):\\n \\\"\\\"\\\"Handles image uploads.\\\"\\\"\\\"\\n\\n # The string to prefix to the filename (before tacking the whole thing on\\n # to the end of 'assets/').\\n _FILENAME_PREFIX = 'image'\\n _decorator = None\\n\\n @acl_decorators.can_edit_entity\\n def post(self, entity_type, entity_id):\\n \\\"\\\"\\\"Saves an image uploaded by a content creator.\\\"\\\"\\\"\\n\\n raw = self.request.get('image')\\n filename = self.payload.get('filename')\\n filename_prefix = self.payload.get('filename_prefix')\\n if filename_prefix is None:\\n filename_prefix = self._FILENAME_PREFIX\\n\\n try:\\n file_format = image_validation_services.validate_image_and_filename(\\n raw, filename)\\n except utils.ValidationError as e:\\n raise self.InvalidInputException(e)\\n\\n file_system_class = fs_services.get_entity_file_system_class()\\n fs = fs_domain.AbstractFileSystem(file_system_class(\\n entity_type, entity_id))\\n filepath = '%s/%s' % (filename_prefix, filename)\\n\\n if fs.isfile(filepath):\\n raise self.InvalidInputException(\\n 'A file with the name %s already exists. Please choose a '\\n 'different name.' % filename)\\n image_is_compressible = (\\n file_format in feconf.COMPRESSIBLE_IMAGE_FORMATS)\\n fs_services.save_original_and_compressed_versions_of_image(\\n filename, entity_type, entity_id, raw, filename_prefix,\\n image_is_compressible)\\n\\n self.render_json({'filename': filename})\\n\\n\\nclass StartedTutorialEventHandler(EditorHandler):\\n \\\"\\\"\\\"Records that this user has started the state editor tutorial.\\\"\\\"\\\"\\n\\n @acl_decorators.can_play_exploration\\n def post(self, unused_exploration_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n user_services.record_user_started_state_editor_tutorial(self.user_id)\\n self.render_json({})\\n\\n\\nclass EditorAutosaveHandler(ExplorationHandler):\\n \\\"\\\"\\\"Handles requests from the editor for draft autosave.\\\"\\\"\\\"\\n\\n @acl_decorators.can_save_exploration\\n def put(self, exploration_id):\\n \\\"\\\"\\\"Handles PUT requests for draft updation.\\\"\\\"\\\"\\n # Raise an Exception if the draft change list fails non-strict\\n # validation.\\n try:\\n change_list_dict = self.payload.get('change_list')\\n change_list = [\\n exp_domain.ExplorationChange(change)\\n for change in change_list_dict]\\n except utils.ValidationError as e:\\n # We leave any pre-existing draft changes in the datastore.\\n raise self.InvalidInputException(e)\\n\\n version = self.payload.get('version')\\n exploration_rights = rights_manager.get_exploration_rights(\\n exploration_id)\\n can_edit = rights_manager.check_can_edit_activity(\\n self.user, exploration_rights)\\n can_voiceover = rights_manager.check_can_voiceover_activity(\\n self.user, exploration_rights)\\n\\n try:\\n if can_edit:\\n exp_services.create_or_update_draft(\\n exploration_id, self.user_id, change_list, version,\\n datetime.datetime.utcnow())\\n elif can_voiceover:\\n exp_services.create_or_update_draft(\\n exploration_id, self.user_id, change_list, version,\\n datetime.datetime.utcnow(), is_by_voice_artist=True)\\n except utils.ValidationError as e:\\n # We leave any pre-existing draft changes in the datastore.\\n raise self.InvalidInputException(e)\\n\\n exp_user_data = exp_services.get_user_exploration_data(\\n self.user_id, exploration_id)\\n # If the draft_change_list_id is False, have the user discard the draft\\n # changes. We save the draft to the datastore even if the version is\\n # invalid, so that it is available for recovery later.\\n self.render_json({\\n 'draft_change_list_id': exp_user_data['draft_change_list_id'],\\n 'is_version_of_draft_valid': exp_services.is_version_of_draft_valid(\\n exploration_id, version)})\\n\\n @acl_decorators.can_save_exploration\\n def post(self, exploration_id):\\n \\\"\\\"\\\"Handles POST request for discarding draft changes.\\\"\\\"\\\"\\n exp_services.discard_draft(exploration_id, self.user_id)\\n self.render_json({})\\n\\n\\nclass StateAnswerStatisticsHandler(EditorHandler):\\n \\\"\\\"\\\"Returns basic learner answer statistics for a state.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_view_exploration_stats\\n def get(self, exploration_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n current_exploration = exp_fetchers.get_exploration_by_id(exploration_id)\\n\\n top_state_answers = stats_services.get_top_state_answer_stats_multi(\\n exploration_id, current_exploration.states)\\n top_state_interaction_ids = {\\n state_name: current_exploration.states[state_name].interaction.id\\n for state_name in top_state_answers\\n }\\n self.render_json({\\n 'answers': top_state_answers,\\n 'interaction_ids': top_state_interaction_ids,\\n })\\n\\n\\nclass TopUnresolvedAnswersHandler(EditorHandler):\\n \\\"\\\"\\\"Returns a list of top N unresolved answers.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_edit_exploration\\n def get(self, exploration_id):\\n \\\"\\\"\\\"Handles GET requests for unresolved answers.\\\"\\\"\\\"\\n state_name = self.request.get('state_name')\\n if not state_name:\\n raise self.PageNotFoundException\\n\\n unresolved_answers_with_frequency = (\\n stats_services.get_top_state_unresolved_answers(\\n exploration_id, state_name))\\n\\n self.render_json({\\n 'unresolved_answers': unresolved_answers_with_frequency\\n })\\n\\n\\nclass LearnerAnswerInfoHandler(EditorHandler):\\n \\\"\\\"\\\"Handles the learner answer info for an exploration state.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_play_entity\\n def get(self, entity_type, entity_id):\\n \\\"\\\"\\\"Handles the GET requests for learner answer info for an\\n exploration state.\\n \\\"\\\"\\\"\\n if not constants.ENABLE_SOLICIT_ANSWER_DETAILS_FEATURE:\\n raise self.PageNotFoundException\\n\\n learner_answer_info_data = []\\n\\n if entity_type == feconf.ENTITY_TYPE_EXPLORATION:\\n exp = exp_fetchers.get_exploration_by_id(entity_id)\\n for state_name in exp.states:\\n state_reference = (\\n stats_services.get_state_reference_for_exploration(\\n entity_id, state_name))\\n learner_answer_details = (\\n stats_services.get_learner_answer_details(\\n feconf.ENTITY_TYPE_EXPLORATION, state_reference))\\n if learner_answer_details is not None:\\n learner_answer_info_data.append({\\n 'state_name': state_name,\\n 'interaction_id': learner_answer_details.interaction_id,\\n 'customization_args': exp.states[state_name].interaction\\n .to_dict()['customization_args'],\\n 'learner_answer_info_dicts': [\\n learner_answer_info.to_dict() for\\n learner_answer_info in\\n learner_answer_details.learner_answer_info_list]\\n })\\n elif entity_type == feconf.ENTITY_TYPE_QUESTION:\\n question = question_services.get_question_by_id(entity_id)\\n state_reference = stats_services.get_state_reference_for_question(\\n entity_id)\\n learner_answer_details = stats_services.get_learner_answer_details(\\n feconf.ENTITY_TYPE_QUESTION, state_reference)\\n if learner_answer_details is not None:\\n learner_answer_info_dicts = [\\n learner_answer_info.to_dict() for learner_answer_info in\\n learner_answer_details.learner_answer_info_list]\\n learner_answer_info_data = {\\n 'interaction_id': learner_answer_details.interaction_id,\\n 'customization_args': question.question_state_data.interaction\\n .to_dict()['customization_args'],\\n 'learner_answer_info_dicts': learner_answer_info_dicts\\n }\\n\\n self.render_json({\\n 'learner_answer_info_data': learner_answer_info_data\\n })\\n\\n @acl_decorators.can_edit_entity\\n def delete(self, entity_type, entity_id):\\n \\\"\\\"\\\"Deletes the learner answer info by the given id.\\\"\\\"\\\"\\n\\n if not constants.ENABLE_SOLICIT_ANSWER_DETAILS_FEATURE:\\n raise self.PageNotFoundException\\n\\n if entity_type == feconf.ENTITY_TYPE_EXPLORATION:\\n state_name = self.request.get('state_name')\\n if not state_name:\\n raise self.InvalidInputException\\n state_reference = (\\n stats_services.get_state_reference_for_exploration(\\n entity_id, state_name))\\n elif entity_type == feconf.ENTITY_TYPE_QUESTION:\\n state_reference = (\\n stats_services.get_state_reference_for_question(\\n entity_id))\\n learner_answer_info_id = self.request.get('learner_answer_info_id')\\n if not learner_answer_info_id:\\n raise self.PageNotFoundException\\n stats_services.delete_learner_answer_info(\\n entity_type, state_reference, learner_answer_info_id)\\n self.render_json({})\\n\",\n \"path\": \"core/controllers/editor.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# coding: utf-8\n\n# Copyright 2014 The Oppia Authors. All Rights Reserved.\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\"\"\"Controllers for the editor view.\"\"\"\n\nfrom __future__ import absolute_import # pylint: disable=import-only-modules\nfrom __future__ import unicode_literals # pylint: disable=import-only-modules\n\nimport datetime\nimport logging\n\nfrom constants import constants\nfrom core.controllers import acl_decorators\nfrom core.controllers import base\nfrom core.domain import email_manager\nfrom core.domain import exp_domain\nfrom core.domain import exp_fetchers\nfrom core.domain import exp_services\nfrom core.domain import fs_domain\nfrom core.domain import fs_services\nfrom core.domain import image_validation_services\nfrom core.domain import question_services\nfrom core.domain import rights_manager\nfrom core.domain import search_services\nfrom core.domain import state_domain\nfrom core.domain import stats_domain\nfrom core.domain import stats_services\nfrom core.domain import user_services\nimport feconf\nimport utils\n\n\ndef _require_valid_version(version_from_payload, exploration_version):\n \"\"\"Check that the payload version matches the given exploration version.\"\"\"\n if version_from_payload is None:\n raise base.BaseHandler.InvalidInputException(\n 'Invalid POST request: a version must be specified.')\n\n if version_from_payload != exploration_version:\n raise base.BaseHandler.InvalidInputException(\n 'Trying to update version %s of exploration from version %s, '\n 'which is too old. Please reload the page and try again.'\n % (exploration_version, version_from_payload))\n\n\nclass EditorHandler(base.BaseHandler):\n \"\"\"Base class for all handlers for the editor page.\"\"\"\n\n pass\n\n\nclass ExplorationPage(EditorHandler):\n \"\"\"The editor page for a single exploration.\"\"\"\n\n @acl_decorators.can_play_exploration\n def get(self, unused_exploration_id):\n \"\"\"Handles GET requests.\"\"\"\n\n self.render_template('exploration-editor-page.mainpage.html')\n\n\nclass ExplorationHandler(EditorHandler):\n \"\"\"Page with editor data for a single exploration.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_play_exploration\n def get(self, exploration_id):\n \"\"\"Gets the data for the exploration overview page.\"\"\"\n # 'apply_draft' and 'v'(version) are optional parameters because the\n # exploration history tab also uses this handler, and these parameters\n # are not used by that tab.\n version = self.request.get('v', default_value=None)\n apply_draft = self.request.get('apply_draft', default_value=False)\n\n user_settings = user_services.get_user_settings(self.user_id)\n has_seen_editor_tutorial = False\n has_seen_translation_tutorial = False\n if user_settings is not None:\n if user_settings.last_started_state_editor_tutorial:\n has_seen_editor_tutorial = True\n if user_settings.last_started_state_translation_tutorial:\n has_seen_translation_tutorial = True\n\n try:\n exploration_data = exp_services.get_user_exploration_data(\n self.user_id, exploration_id, apply_draft=apply_draft,\n version=version)\n exploration_data['show_state_editor_tutorial_on_load'] = (\n self.user_id and not has_seen_editor_tutorial)\n exploration_data['show_state_translation_tutorial_on_load'] = (\n self.user_id and not has_seen_translation_tutorial)\n exploration_data['exploration_is_linked_to_story'] = bool(\n exp_services.get_story_id_linked_to_exploration(exploration_id))\n except:\n raise self.PageNotFoundException\n\n self.values.update(exploration_data)\n self.render_json(self.values)\n\n @acl_decorators.can_save_exploration\n def put(self, exploration_id):\n \"\"\"Updates properties of the given exploration.\"\"\"\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\n version = self.payload.get('version')\n _require_valid_version(version, exploration.version)\n\n commit_message = self.payload.get('commit_message')\n\n if (commit_message is not None and\n len(commit_message) > constants.MAX_COMMIT_MESSAGE_LENGTH):\n raise self.InvalidInputException(\n 'Commit messages must be at most %s characters long.'\n % constants.MAX_COMMIT_MESSAGE_LENGTH)\n\n change_list_dict = self.payload.get('change_list')\n\n try:\n change_list = [\n exp_domain.ExplorationChange(change)\n for change in change_list_dict\n ]\n except utils.ValidationError as e:\n raise self.InvalidInputException(e)\n\n exploration_rights = rights_manager.get_exploration_rights(\n exploration_id)\n can_edit = rights_manager.check_can_edit_activity(\n self.user, exploration_rights)\n can_voiceover = rights_manager.check_can_voiceover_activity(\n self.user, exploration_rights)\n\n try:\n if can_edit:\n exp_services.update_exploration(\n self.user_id, exploration_id, change_list, commit_message)\n elif can_voiceover:\n exp_services.update_exploration(\n self.user_id, exploration_id, change_list, commit_message,\n is_by_voice_artist=True)\n except utils.ValidationError as e:\n raise self.InvalidInputException(e)\n\n exploration_data = exp_services.get_user_exploration_data(\n self.user_id, exploration_id)\n\n self.values.update(exploration_data)\n self.render_json(self.values)\n\n @acl_decorators.can_delete_exploration\n def delete(self, exploration_id):\n \"\"\"Deletes the given exploration.\"\"\"\n\n log_debug_string = '(%s) %s tried to delete exploration %s' % (\n self.role, self.user_id, exploration_id)\n logging.debug(log_debug_string)\n\n is_exploration_cloned = rights_manager.is_exploration_cloned(\n exploration_id)\n exp_services.delete_exploration(\n self.user_id, exploration_id, force_deletion=is_exploration_cloned)\n\n log_info_string = '(%s) %s deleted exploration %s' % (\n self.role, self.user_id, exploration_id)\n logging.info(log_info_string)\n self.render_json(self.values)\n\n\nclass UserExplorationPermissionsHandler(EditorHandler):\n \"\"\"Handles user permissions for a particular exploration.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_play_exploration\n def get(self, exploration_id):\n \"\"\"Gets the user permissions for an exploration.\"\"\"\n exploration_rights = rights_manager.get_exploration_rights(\n exploration_id)\n self.values.update({\n 'can_delete': rights_manager.check_can_delete_activity(\n self.user, exploration_rights),\n 'can_edit': rights_manager.check_can_edit_activity(\n self.user, exploration_rights),\n 'can_modify_roles': (\n rights_manager.check_can_modify_activity_roles(\n self.user, exploration_rights)),\n 'can_publish': rights_manager.check_can_publish_activity(\n self.user, exploration_rights),\n 'can_release_ownership': (\n rights_manager.check_can_release_ownership(\n self.user, exploration_rights)),\n 'can_voiceover': (\n rights_manager.check_can_voiceover_activity(\n self.user, exploration_rights)),\n 'can_unpublish': rights_manager.check_can_unpublish_activity(\n self.user, exploration_rights),\n })\n self.render_json(self.values)\n\n\nclass ExplorationRightsHandler(EditorHandler):\n \"\"\"Handles management of exploration editing rights.\"\"\"\n\n @acl_decorators.can_modify_exploration_roles\n def put(self, exploration_id):\n \"\"\"Updates the editing rights for the given exploration.\"\"\"\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\n version = self.payload.get('version')\n _require_valid_version(version, exploration.version)\n\n make_community_owned = self.payload.get('make_community_owned')\n new_member_username = self.payload.get('new_member_username')\n new_member_role = self.payload.get('new_member_role')\n viewable_if_private = self.payload.get('viewable_if_private')\n\n if new_member_username:\n new_member_id = user_services.get_user_id_from_username(\n new_member_username)\n if new_member_id is None:\n raise self.InvalidInputException(\n 'Sorry, we could not find the specified user.')\n\n rights_manager.assign_role_for_exploration(\n self.user, exploration_id, new_member_id, new_member_role)\n email_manager.send_role_notification_email(\n self.user_id, new_member_id, new_member_role, exploration_id,\n exploration.title)\n\n elif make_community_owned:\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\n try:\n exploration.validate(strict=True)\n except utils.ValidationError as e:\n raise self.InvalidInputException(e)\n\n rights_manager.release_ownership_of_exploration(\n self.user, exploration_id)\n\n elif viewable_if_private is not None:\n rights_manager.set_private_viewability_of_exploration(\n self.user, exploration_id, viewable_if_private)\n\n else:\n raise self.InvalidInputException(\n 'No change was made to this exploration.')\n\n self.render_json({\n 'rights': rights_manager.get_exploration_rights(\n exploration_id).to_dict()\n })\n\n\nclass ExplorationStatusHandler(EditorHandler):\n \"\"\"Handles publishing of an exploration.\"\"\"\n\n def _publish_exploration(self, exploration_id):\n \"\"\"Publish an exploration.\n\n Args:\n exploration_id: str. Id of the exploration.\n\n Raises:\n InvalidInputException. Given exploration is invalid.\n \"\"\"\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\n try:\n exploration.validate(strict=True)\n except utils.ValidationError as e:\n raise self.InvalidInputException(e)\n\n exp_services.publish_exploration_and_update_user_profiles(\n self.user, exploration_id)\n exp_services.index_explorations_given_ids([exploration_id])\n\n @acl_decorators.can_publish_exploration\n def put(self, exploration_id):\n make_public = self.payload.get('make_public')\n\n if make_public is not None:\n self._publish_exploration(exploration_id)\n\n self.render_json({\n 'rights': rights_manager.get_exploration_rights(\n exploration_id).to_dict()\n })\n\n\nclass ExplorationModeratorRightsHandler(EditorHandler):\n \"\"\"Handles management of exploration rights by moderators.\"\"\"\n\n @acl_decorators.can_access_moderator_page\n def put(self, exploration_id):\n \"\"\"Unpublishes the given exploration, and sends an email to all its\n owners.\n \"\"\"\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\n email_body = self.payload.get('email_body')\n version = self.payload.get('version')\n _require_valid_version(version, exploration.version)\n\n # If moderator emails can be sent, check that all the prerequisites are\n # satisfied, otherwise do nothing.\n if feconf.REQUIRE_EMAIL_ON_MODERATOR_ACTION:\n if not email_body:\n raise self.InvalidInputException(\n 'Moderator actions should include an email to the '\n 'recipient.')\n email_manager.require_moderator_email_prereqs_are_satisfied()\n\n # Unpublish exploration.\n rights_manager.unpublish_exploration(self.user, exploration_id)\n search_services.delete_explorations_from_search_index([exploration_id])\n exp_rights = rights_manager.get_exploration_rights(exploration_id)\n\n # If moderator emails can be sent, send an email to the all owners of\n # the exploration notifying them of the change.\n if feconf.REQUIRE_EMAIL_ON_MODERATOR_ACTION:\n for owner_id in exp_rights.owner_ids:\n email_manager.send_moderator_action_email(\n self.user_id, owner_id, 'unpublish_exploration',\n exploration.title, email_body)\n\n self.render_json({\n 'rights': exp_rights.to_dict(),\n })\n\n\nclass UserExplorationEmailsHandler(EditorHandler):\n \"\"\"Handles management of user email notification preferences for this\n exploration.\n \"\"\"\n\n @acl_decorators.can_edit_exploration\n def put(self, exploration_id):\n \"\"\"Updates the email notification preferences for the given exploration.\n\n Args:\n exploration_id: str. The exploration id.\n\n Raises:\n InvalidInputException. Invalid message type.\n \"\"\"\n\n mute = self.payload.get('mute')\n message_type = self.payload.get('message_type')\n\n if message_type == feconf.MESSAGE_TYPE_FEEDBACK:\n user_services.set_email_preferences_for_exploration(\n self.user_id, exploration_id, mute_feedback_notifications=mute)\n elif message_type == feconf.MESSAGE_TYPE_SUGGESTION:\n user_services.set_email_preferences_for_exploration(\n self.user_id, exploration_id,\n mute_suggestion_notifications=mute)\n else:\n raise self.InvalidInputException(\n 'Invalid message type.')\n\n exploration_email_preferences = (\n user_services.get_email_preferences_for_exploration(\n self.user_id, exploration_id))\n self.render_json({\n 'email_preferences': exploration_email_preferences.to_dict()\n })\n\n\nclass ExplorationFileDownloader(EditorHandler):\n \"\"\"Downloads an exploration as a zip file, or dict of YAML strings\n representing states.\n \"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_DOWNLOADABLE\n\n @acl_decorators.can_download_exploration\n def get(self, exploration_id):\n \"\"\"Handles GET requests.\"\"\"\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\n\n version_str = self.request.get('v', default_value=exploration.version)\n output_format = self.request.get('output_format', default_value='zip')\n\n try:\n version = int(version_str)\n except ValueError:\n version = exploration.version\n\n # If the title of the exploration has changed, we use the new title.\n if not exploration.title:\n init_filename = 'oppia-unpublished_exploration-v%s.zip' % version\n else:\n init_filename = 'oppia-%s-v%s.zip' % (\n exploration.title.replace(' ', ''), version)\n filename = utils.to_ascii(init_filename).decode('utf-8')\n\n if output_format == feconf.OUTPUT_FORMAT_ZIP:\n self.render_downloadable_file(\n exp_services.export_to_zip_file(\n exploration_id, version=version),\n filename, 'text/plain')\n elif output_format == feconf.OUTPUT_FORMAT_JSON:\n self.render_json(exp_services.export_states_to_yaml(\n exploration_id, version=version))\n else:\n raise self.InvalidInputException(\n 'Unrecognized output format %s' % output_format)\n\n\nclass StateYamlHandler(EditorHandler):\n \"\"\"Given a representation of a state, converts it to a YAML string.\n\n Note that this handler is stateless; it does not make use of the storage\n layer.\n \"\"\"\n\n @acl_decorators.can_play_exploration\n def post(self, unused_exploration_id):\n \"\"\"Handles POST requests.\"\"\"\n state_dict = self.payload.get('state_dict')\n width = self.payload.get('width')\n\n if not width or not state_dict:\n raise self.PageNotFoundException\n\n self.render_json({\n 'yaml': state_domain.State.convert_state_dict_to_yaml(\n state_dict, width),\n })\n\n\nclass ExplorationSnapshotsHandler(EditorHandler):\n \"\"\"Returns the exploration snapshot history.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_play_exploration\n def get(self, exploration_id):\n \"\"\"Handles GET requests.\"\"\"\n\n snapshots = exp_services.get_exploration_snapshots_metadata(\n exploration_id)\n\n # Patch `snapshots` to use the editor's display name.\n snapshots_committer_ids = [\n snapshot['committer_id'] for snapshot in snapshots]\n committer_usernames = user_services.get_usernames(\n snapshots_committer_ids)\n for index, snapshot in enumerate(snapshots):\n snapshot['committer_id'] = committer_usernames[index]\n\n self.render_json({\n 'snapshots': snapshots,\n })\n\n\nclass ExplorationRevertHandler(EditorHandler):\n \"\"\"Reverts an exploration to an older version.\"\"\"\n\n @acl_decorators.can_edit_exploration\n def post(self, exploration_id):\n \"\"\"Handles POST requests.\"\"\"\n current_version = self.payload.get('current_version')\n revert_to_version = self.payload.get('revert_to_version')\n\n if not isinstance(revert_to_version, int):\n raise self.InvalidInputException(\n 'Expected an integer version to revert to; received %s.' %\n revert_to_version)\n if not isinstance(current_version, int):\n raise self.InvalidInputException(\n 'Expected an integer current version; received %s.' %\n current_version)\n\n if revert_to_version < 1 or revert_to_version >= current_version:\n raise self.InvalidInputException(\n 'Cannot revert to version %s from version %s.' %\n (revert_to_version, current_version))\n\n exp_services.discard_draft(exploration_id, self.user_id)\n exp_services.revert_exploration(\n self.user_id, exploration_id, current_version, revert_to_version)\n self.render_json({})\n\n\nclass ExplorationStatisticsHandler(EditorHandler):\n \"\"\"Returns statistics for an exploration. This is the handler for the new\n statistics framework.\n \"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_view_exploration_stats\n def get(self, exploration_id):\n \"\"\"Handles GET requests.\"\"\"\n current_exploration = exp_fetchers.get_exploration_by_id(\n exploration_id)\n\n self.render_json(stats_services.get_exploration_stats(\n exploration_id, current_exploration.version).to_frontend_dict())\n\n\nclass StateInteractionStatsHandler(EditorHandler):\n \"\"\"Returns detailed learner answer statistics for a state.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_view_exploration_stats\n def get(self, exploration_id, escaped_state_name):\n \"\"\"Handles GET requests.\"\"\"\n current_exploration = exp_fetchers.get_exploration_by_id(\n exploration_id)\n\n state_name = utils.unescape_encoded_uri_component(escaped_state_name)\n if state_name not in current_exploration.states:\n logging.error('Could not find state: %s' % state_name)\n logging.error('Available states: %s' % (\n list(current_exploration.states.keys())))\n raise self.PageNotFoundException\n\n self.render_json({\n 'visualizations_info': stats_services.get_visualizations_info(\n current_exploration.id, state_name,\n current_exploration.states[state_name].interaction.id),\n })\n\n\nclass FetchIssuesHandler(EditorHandler):\n \"\"\"Handler used for retrieving the list of unresolved issues in an\n exploration. This removes the invalid issues and returns the remaining\n unresolved ones.\n \"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_view_exploration_stats\n def get(self, exp_id):\n \"\"\"Handles GET requests.\"\"\"\n exp_version = self.request.get('exp_version')\n exp_issues = stats_services.get_exp_issues(exp_id, exp_version)\n if exp_issues is None:\n raise self.PageNotFoundException(\n 'Invalid version %s for exploration ID %s'\n % (exp_version, exp_id))\n unresolved_issues = []\n for issue in exp_issues.unresolved_issues:\n if issue.is_valid:\n unresolved_issues.append(issue)\n exp_issues.unresolved_issues = unresolved_issues\n exp_issues_dict = exp_issues.to_dict()\n self.render_json(exp_issues_dict)\n\n\nclass FetchPlaythroughHandler(EditorHandler):\n \"\"\"Handler used for retrieving a playthrough.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_view_exploration_stats\n def get(self, unused_exploration_id, playthrough_id):\n \"\"\"Handles GET requests.\"\"\"\n playthrough = stats_services.get_playthrough_by_id(playthrough_id)\n if playthrough is None:\n raise self.PageNotFoundException(\n 'Invalid playthrough ID %s' % (playthrough_id))\n self.render_json(playthrough.to_dict())\n\n\nclass ResolveIssueHandler(EditorHandler):\n \"\"\"Handler used for resolving an issue. Currently, when an issue is\n resolved, the issue is removed from the unresolved issues list in the\n ExplorationIssuesModel instance, and all corresponding playthrough\n instances are deleted.\n \"\"\"\n\n @acl_decorators.can_edit_exploration\n def post(self, exp_id):\n \"\"\"Handles POST requests.\"\"\"\n exp_issue_dict = self.payload.get('exp_issue_dict')\n try:\n stats_domain.ExplorationIssue.from_dict(exp_issue_dict)\n except utils.ValidationError as e:\n raise self.PageNotFoundException(e)\n\n exp_version = self.payload.get('exp_version')\n\n exp_issues = stats_services.get_exp_issues(exp_id, exp_version)\n if exp_issues is None:\n raise self.PageNotFoundException(\n 'Invalid exploration ID %s' % (exp_id))\n\n # Check that the passed in issue actually exists in the exploration\n # issues instance.\n issue_to_remove = None\n for issue in exp_issues.unresolved_issues:\n if issue.to_dict() == exp_issue_dict:\n issue_to_remove = issue\n break\n\n if not issue_to_remove:\n raise self.PageNotFoundException(\n 'Exploration issue does not exist in the list of issues for '\n 'the exploration with ID %s' % exp_id)\n\n # Remove the issue from the unresolved issues list.\n exp_issues.unresolved_issues.remove(issue_to_remove)\n\n # Update the exploration issues instance and delete the playthrough\n # instances.\n stats_services.delete_playthroughs_multi(\n issue_to_remove.playthrough_ids)\n stats_services.save_exp_issues_model(exp_issues)\n\n self.render_json({})\n\n\nclass ImageUploadHandler(EditorHandler):\n \"\"\"Handles image uploads.\"\"\"\n\n # The string to prefix to the filename (before tacking the whole thing on\n # to the end of 'assets/').\n _FILENAME_PREFIX = 'image'\n _decorator = None\n\n @acl_decorators.can_edit_entity\n def post(self, entity_type, entity_id):\n \"\"\"Saves an image uploaded by a content creator.\"\"\"\n\n raw = self.request.get('image')\n filename = self.payload.get('filename')\n filename_prefix = self.payload.get('filename_prefix')\n if filename_prefix is None:\n filename_prefix = self._FILENAME_PREFIX\n\n try:\n file_format = image_validation_services.validate_image_and_filename(\n raw, filename)\n except utils.ValidationError as e:\n raise self.InvalidInputException(e)\n\n file_system_class = fs_services.get_entity_file_system_class()\n fs = fs_domain.AbstractFileSystem(file_system_class(\n entity_type, entity_id))\n filepath = '%s/%s' % (filename_prefix, filename)\n\n if fs.isfile(filepath):\n raise self.InvalidInputException(\n 'A file with the name %s already exists. Please choose a '\n 'different name.' % filename)\n image_is_compressible = (\n file_format in feconf.COMPRESSIBLE_IMAGE_FORMATS)\n fs_services.save_original_and_compressed_versions_of_image(\n filename, entity_type, entity_id, raw, filename_prefix,\n image_is_compressible)\n\n self.render_json({'filename': filename})\n\n\nclass StartedTutorialEventHandler(EditorHandler):\n \"\"\"Records that this user has started the state editor tutorial.\"\"\"\n\n @acl_decorators.can_play_exploration\n def post(self, unused_exploration_id):\n \"\"\"Handles GET requests.\"\"\"\n user_services.record_user_started_state_editor_tutorial(self.user_id)\n self.render_json({})\n\n\nclass EditorAutosaveHandler(ExplorationHandler):\n \"\"\"Handles requests from the editor for draft autosave.\"\"\"\n\n @acl_decorators.can_save_exploration\n def put(self, exploration_id):\n \"\"\"Handles PUT requests for draft updation.\"\"\"\n # Raise an Exception if the draft change list fails non-strict\n # validation.\n try:\n change_list_dict = self.payload.get('change_list')\n change_list = [\n exp_domain.ExplorationChange(change)\n for change in change_list_dict]\n except utils.ValidationError as e:\n # We leave any pre-existing draft changes in the datastore.\n raise self.InvalidInputException(e)\n\n version = self.payload.get('version')\n exploration_rights = rights_manager.get_exploration_rights(\n exploration_id)\n can_edit = rights_manager.check_can_edit_activity(\n self.user, exploration_rights)\n can_voiceover = rights_manager.check_can_voiceover_activity(\n self.user, exploration_rights)\n\n try:\n if can_edit:\n exp_services.create_or_update_draft(\n exploration_id, self.user_id, change_list, version,\n datetime.datetime.utcnow())\n elif can_voiceover:\n exp_services.create_or_update_draft(\n exploration_id, self.user_id, change_list, version,\n datetime.datetime.utcnow(), is_by_voice_artist=True)\n except utils.ValidationError as e:\n # We leave any pre-existing draft changes in the datastore.\n raise self.InvalidInputException(e)\n\n exp_user_data = exp_services.get_user_exploration_data(\n self.user_id, exploration_id)\n # If the draft_change_list_id is False, have the user discard the draft\n # changes. We save the draft to the datastore even if the version is\n # invalid, so that it is available for recovery later.\n self.render_json({\n 'draft_change_list_id': exp_user_data['draft_change_list_id'],\n 'is_version_of_draft_valid': exp_services.is_version_of_draft_valid(\n exploration_id, version)})\n\n @acl_decorators.can_save_exploration\n def post(self, exploration_id):\n \"\"\"Handles POST request for discarding draft changes.\"\"\"\n exp_services.discard_draft(exploration_id, self.user_id)\n self.render_json({})\n\n\nclass StateAnswerStatisticsHandler(EditorHandler):\n \"\"\"Returns basic learner answer statistics for a state.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_view_exploration_stats\n def get(self, exploration_id):\n \"\"\"Handles GET requests.\"\"\"\n current_exploration = exp_fetchers.get_exploration_by_id(exploration_id)\n\n top_state_answers = stats_services.get_top_state_answer_stats_multi(\n exploration_id, current_exploration.states)\n top_state_interaction_ids = {\n state_name: current_exploration.states[state_name].interaction.id\n for state_name in top_state_answers\n }\n self.render_json({\n 'answers': top_state_answers,\n 'interaction_ids': top_state_interaction_ids,\n })\n\n\nclass TopUnresolvedAnswersHandler(EditorHandler):\n \"\"\"Returns a list of top N unresolved answers.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_edit_exploration\n def get(self, exploration_id):\n \"\"\"Handles GET requests for unresolved answers.\"\"\"\n state_name = self.request.get('state_name')\n if not state_name:\n raise self.PageNotFoundException\n\n unresolved_answers_with_frequency = (\n stats_services.get_top_state_unresolved_answers(\n exploration_id, state_name))\n\n self.render_json({\n 'unresolved_answers': unresolved_answers_with_frequency\n })\n\n\nclass LearnerAnswerInfoHandler(EditorHandler):\n \"\"\"Handles the learner answer info for an exploration state.\"\"\"\n\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\n\n @acl_decorators.can_play_entity\n def get(self, entity_type, entity_id):\n \"\"\"Handles the GET requests for learner answer info for an\n exploration state.\n \"\"\"\n if not constants.ENABLE_SOLICIT_ANSWER_DETAILS_FEATURE:\n raise self.PageNotFoundException\n\n learner_answer_info_data = []\n\n if entity_type == feconf.ENTITY_TYPE_EXPLORATION:\n exp = exp_fetchers.get_exploration_by_id(entity_id)\n for state_name in exp.states:\n state_reference = (\n stats_services.get_state_reference_for_exploration(\n entity_id, state_name))\n learner_answer_details = (\n stats_services.get_learner_answer_details(\n feconf.ENTITY_TYPE_EXPLORATION, state_reference))\n if learner_answer_details is not None:\n learner_answer_info_data.append({\n 'state_name': state_name,\n 'interaction_id': learner_answer_details.interaction_id,\n 'customization_args': exp.states[state_name].interaction\n .to_dict()['customization_args'],\n 'learner_answer_info_dicts': [\n learner_answer_info.to_dict() for\n learner_answer_info in\n learner_answer_details.learner_answer_info_list]\n })\n elif entity_type == feconf.ENTITY_TYPE_QUESTION:\n question = question_services.get_question_by_id(entity_id)\n state_reference = stats_services.get_state_reference_for_question(\n entity_id)\n learner_answer_details = stats_services.get_learner_answer_details(\n feconf.ENTITY_TYPE_QUESTION, state_reference)\n if learner_answer_details is not None:\n learner_answer_info_dicts = [\n learner_answer_info.to_dict() for learner_answer_info in\n learner_answer_details.learner_answer_info_list]\n learner_answer_info_data = {\n 'interaction_id': learner_answer_details.interaction_id,\n 'customization_args': question.question_state_data.interaction\n .to_dict()['customization_args'],\n 'learner_answer_info_dicts': learner_answer_info_dicts\n }\n\n self.render_json({\n 'learner_answer_info_data': learner_answer_info_data\n })\n\n @acl_decorators.can_edit_entity\n def delete(self, entity_type, entity_id):\n \"\"\"Deletes the learner answer info by the given id.\"\"\"\n\n if not constants.ENABLE_SOLICIT_ANSWER_DETAILS_FEATURE:\n raise self.PageNotFoundException\n\n if entity_type == feconf.ENTITY_TYPE_EXPLORATION:\n state_name = self.request.get('state_name')\n if not state_name:\n raise self.InvalidInputException\n state_reference = (\n stats_services.get_state_reference_for_exploration(\n entity_id, state_name))\n elif entity_type == feconf.ENTITY_TYPE_QUESTION:\n state_reference = (\n stats_services.get_state_reference_for_question(\n entity_id))\n learner_answer_info_id = self.request.get('learner_answer_info_id')\n if not learner_answer_info_id:\n raise self.PageNotFoundException\n stats_services.delete_learner_answer_info(\n entity_type, state_reference, learner_answer_info_id)\n self.render_json({})\n","path":"core/controllers/editor.py"}],"string":"[\n {\n \"content\": \"# coding: utf-8\\n\\n# Copyright 2014 The Oppia Authors. All Rights Reserved.\\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\\\"\\\"\\\"Controllers for the editor view.\\\"\\\"\\\"\\n\\nfrom __future__ import absolute_import # pylint: disable=import-only-modules\\nfrom __future__ import unicode_literals # pylint: disable=import-only-modules\\n\\nimport datetime\\nimport logging\\n\\nfrom constants import constants\\nfrom core.controllers import acl_decorators\\nfrom core.controllers import base\\nfrom core.domain import email_manager\\nfrom core.domain import exp_domain\\nfrom core.domain import exp_fetchers\\nfrom core.domain import exp_services\\nfrom core.domain import fs_domain\\nfrom core.domain import fs_services\\nfrom core.domain import image_validation_services\\nfrom core.domain import question_services\\nfrom core.domain import rights_manager\\nfrom core.domain import search_services\\nfrom core.domain import state_domain\\nfrom core.domain import stats_domain\\nfrom core.domain import stats_services\\nfrom core.domain import user_services\\nimport feconf\\nimport utils\\n\\n\\ndef _require_valid_version(version_from_payload, exploration_version):\\n \\\"\\\"\\\"Check that the payload version matches the given exploration version.\\\"\\\"\\\"\\n if version_from_payload is None:\\n raise base.BaseHandler.InvalidInputException(\\n 'Invalid POST request: a version must be specified.')\\n\\n if version_from_payload != exploration_version:\\n raise base.BaseHandler.InvalidInputException(\\n 'Trying to update version %s of exploration from version %s, '\\n 'which is too old. Please reload the page and try again.'\\n % (exploration_version, version_from_payload))\\n\\n\\nclass EditorHandler(base.BaseHandler):\\n \\\"\\\"\\\"Base class for all handlers for the editor page.\\\"\\\"\\\"\\n\\n pass\\n\\n\\nclass ExplorationPage(EditorHandler):\\n \\\"\\\"\\\"The editor page for a single exploration.\\\"\\\"\\\"\\n\\n @acl_decorators.can_play_exploration\\n def get(self, unused_exploration_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n\\n self.render_template('exploration-editor-page.mainpage.html')\\n\\n\\nclass ExplorationHandler(EditorHandler):\\n \\\"\\\"\\\"Page with editor data for a single exploration.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_play_exploration\\n def get(self, exploration_id):\\n \\\"\\\"\\\"Gets the data for the exploration overview page.\\\"\\\"\\\"\\n # 'apply_draft' and 'v'(version) are optional parameters because the\\n # exploration history tab also uses this handler, and these parameters\\n # are not used by that tab.\\n version = self.request.get('v', default_value=None)\\n apply_draft = self.request.get('apply_draft', default_value=False)\\n\\n user_settings = user_services.get_user_settings(self.user_id)\\n has_seen_editor_tutorial = False\\n has_seen_translation_tutorial = False\\n if user_settings is not None:\\n if user_settings.last_started_state_editor_tutorial:\\n has_seen_editor_tutorial = True\\n if user_settings.last_started_state_translation_tutorial:\\n has_seen_translation_tutorial = True\\n\\n try:\\n exploration_data = exp_services.get_user_exploration_data(\\n self.user_id, exploration_id, apply_draft=apply_draft,\\n version=version)\\n exploration_data['show_state_editor_tutorial_on_load'] = (\\n self.user_id and not has_seen_editor_tutorial)\\n exploration_data['show_state_translation_tutorial_on_load'] = (\\n self.user_id and not has_seen_translation_tutorial)\\n exploration_data['exploration_is_linked_to_story'] = bool(\\n exp_services.get_story_id_linked_to_exploration(exploration_id))\\n except:\\n raise self.PageNotFoundException\\n\\n self.values.update(exploration_data)\\n self.render_json(self.values)\\n\\n @acl_decorators.can_save_exploration\\n def put(self, exploration_id):\\n \\\"\\\"\\\"Updates properties of the given exploration.\\\"\\\"\\\"\\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\\n version = self.payload.get('version')\\n _require_valid_version(version, exploration.version)\\n\\n commit_message = self.payload.get('commit_message')\\n\\n if (commit_message is not None and\\n len(commit_message) > constants.MAX_COMMIT_MESSAGE_LENGTH):\\n raise self.InvalidInputException(\\n 'Commit messages must be at most %s characters long.'\\n % constants.MAX_COMMIT_MESSAGE_LENGTH)\\n\\n change_list_dict = self.payload.get('change_list')\\n\\n try:\\n change_list = [\\n exp_domain.ExplorationChange(change)\\n for change in change_list_dict\\n ]\\n except utils.ValidationError as e:\\n raise self.InvalidInputException(e)\\n\\n exploration_rights = rights_manager.get_exploration_rights(\\n exploration_id)\\n can_edit = rights_manager.check_can_edit_activity(\\n self.user, exploration_rights)\\n can_voiceover = rights_manager.check_can_voiceover_activity(\\n self.user, exploration_rights)\\n\\n try:\\n if can_edit:\\n exp_services.update_exploration(\\n self.user_id, exploration_id, change_list, commit_message)\\n elif can_voiceover:\\n exp_services.update_exploration(\\n self.user_id, exploration_id, change_list, commit_message,\\n is_by_voice_artist=True)\\n except utils.ValidationError as e:\\n raise self.InvalidInputException(e)\\n\\n exploration_data = exp_services.get_user_exploration_data(\\n self.user_id, exploration_id)\\n\\n self.values.update(exploration_data)\\n self.render_json(self.values)\\n\\n @acl_decorators.can_delete_exploration\\n def delete(self, exploration_id):\\n \\\"\\\"\\\"Deletes the given exploration.\\\"\\\"\\\"\\n\\n log_debug_string = '(%s) %s tried to delete exploration %s' % (\\n self.role, self.user_id, exploration_id)\\n logging.debug(log_debug_string)\\n\\n is_exploration_cloned = rights_manager.is_exploration_cloned(\\n exploration_id)\\n exp_services.delete_exploration(\\n self.user_id, exploration_id, force_deletion=is_exploration_cloned)\\n\\n log_info_string = '(%s) %s deleted exploration %s' % (\\n self.role, self.user_id, exploration_id)\\n logging.info(log_info_string)\\n self.render_json(self.values)\\n\\n\\nclass UserExplorationPermissionsHandler(EditorHandler):\\n \\\"\\\"\\\"Handles user permissions for a particular exploration.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_play_exploration\\n def get(self, exploration_id):\\n \\\"\\\"\\\"Gets the user permissions for an exploration.\\\"\\\"\\\"\\n exploration_rights = rights_manager.get_exploration_rights(\\n exploration_id)\\n self.values.update({\\n 'can_delete': rights_manager.check_can_delete_activity(\\n self.user, exploration_rights),\\n 'can_edit': rights_manager.check_can_edit_activity(\\n self.user, exploration_rights),\\n 'can_modify_roles': (\\n rights_manager.check_can_modify_activity_roles(\\n self.user, exploration_rights)),\\n 'can_publish': rights_manager.check_can_publish_activity(\\n self.user, exploration_rights),\\n 'can_release_ownership': (\\n rights_manager.check_can_release_ownership(\\n self.user, exploration_rights)),\\n 'can_voiceover': (\\n rights_manager.check_can_voiceover_activity(\\n self.user, exploration_rights)),\\n 'can_unpublish': rights_manager.check_can_unpublish_activity(\\n self.user, exploration_rights),\\n })\\n self.render_json(self.values)\\n\\n\\nclass ExplorationRightsHandler(EditorHandler):\\n \\\"\\\"\\\"Handles management of exploration editing rights.\\\"\\\"\\\"\\n\\n @acl_decorators.can_modify_exploration_roles\\n def put(self, exploration_id):\\n \\\"\\\"\\\"Updates the editing rights for the given exploration.\\\"\\\"\\\"\\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\\n version = self.payload.get('version')\\n _require_valid_version(version, exploration.version)\\n\\n make_community_owned = self.payload.get('make_community_owned')\\n new_member_username = self.payload.get('new_member_username')\\n new_member_role = self.payload.get('new_member_role')\\n viewable_if_private = self.payload.get('viewable_if_private')\\n\\n if new_member_username:\\n new_member_id = user_services.get_user_id_from_username(\\n new_member_username)\\n if new_member_id is None:\\n raise self.InvalidInputException(\\n 'Sorry, we could not find the specified user.')\\n\\n rights_manager.assign_role_for_exploration(\\n self.user, exploration_id, new_member_id, new_member_role)\\n email_manager.send_role_notification_email(\\n self.user_id, new_member_id, new_member_role, exploration_id,\\n exploration.title)\\n\\n elif make_community_owned:\\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\\n try:\\n exploration.validate(strict=True)\\n except utils.ValidationError as e:\\n raise self.InvalidInputException(e)\\n\\n rights_manager.release_ownership_of_exploration(\\n self.user, exploration_id)\\n\\n elif viewable_if_private is not None:\\n rights_manager.set_private_viewability_of_exploration(\\n self.user, exploration_id, viewable_if_private)\\n\\n else:\\n raise self.InvalidInputException(\\n 'No change was made to this exploration.')\\n\\n self.render_json({\\n 'rights': rights_manager.get_exploration_rights(\\n exploration_id).to_dict()\\n })\\n\\n\\nclass ExplorationStatusHandler(EditorHandler):\\n \\\"\\\"\\\"Handles publishing of an exploration.\\\"\\\"\\\"\\n\\n def _publish_exploration(self, exploration_id):\\n \\\"\\\"\\\"Publish an exploration.\\n\\n Args:\\n exploration_id: str. Id of the exploration.\\n\\n Raises:\\n InvalidInputException. Given exploration is invalid.\\n \\\"\\\"\\\"\\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\\n try:\\n exploration.validate(strict=True)\\n except utils.ValidationError as e:\\n raise self.InvalidInputException(e)\\n\\n exp_services.publish_exploration_and_update_user_profiles(\\n self.user, exploration_id)\\n exp_services.index_explorations_given_ids([exploration_id])\\n\\n @acl_decorators.can_publish_exploration\\n def put(self, exploration_id):\\n make_public = self.payload.get('make_public')\\n\\n if make_public is not None:\\n self._publish_exploration(exploration_id)\\n\\n self.render_json({\\n 'rights': rights_manager.get_exploration_rights(\\n exploration_id).to_dict()\\n })\\n\\n\\nclass ExplorationModeratorRightsHandler(EditorHandler):\\n \\\"\\\"\\\"Handles management of exploration rights by moderators.\\\"\\\"\\\"\\n\\n @acl_decorators.can_access_moderator_page\\n def put(self, exploration_id):\\n \\\"\\\"\\\"Unpublishes the given exploration, and sends an email to all its\\n owners.\\n \\\"\\\"\\\"\\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\\n email_body = self.payload.get('email_body')\\n version = self.payload.get('version')\\n _require_valid_version(version, exploration.version)\\n\\n # If moderator emails can be sent, check that all the prerequisites are\\n # satisfied, otherwise do nothing.\\n if feconf.REQUIRE_EMAIL_ON_MODERATOR_ACTION:\\n if not email_body:\\n raise self.InvalidInputException(\\n 'Moderator actions should include an email to the '\\n 'recipient.')\\n email_manager.require_moderator_email_prereqs_are_satisfied()\\n\\n # Unpublish exploration.\\n rights_manager.unpublish_exploration(self.user, exploration_id)\\n search_services.delete_explorations_from_search_index([exploration_id])\\n exp_rights = rights_manager.get_exploration_rights(exploration_id)\\n\\n # If moderator emails can be sent, send an email to the all owners of\\n # the exploration notifying them of the change.\\n if feconf.REQUIRE_EMAIL_ON_MODERATOR_ACTION:\\n for owner_id in exp_rights.owner_ids:\\n email_manager.send_moderator_action_email(\\n self.user_id, owner_id, 'unpublish_exploration',\\n exploration.title, email_body)\\n\\n self.render_json({\\n 'rights': exp_rights.to_dict(),\\n })\\n\\n\\nclass UserExplorationEmailsHandler(EditorHandler):\\n \\\"\\\"\\\"Handles management of user email notification preferences for this\\n exploration.\\n \\\"\\\"\\\"\\n\\n @acl_decorators.can_edit_exploration\\n def put(self, exploration_id):\\n \\\"\\\"\\\"Updates the email notification preferences for the given exploration.\\n\\n Args:\\n exploration_id: str. The exploration id.\\n\\n Raises:\\n InvalidInputException. Invalid message type.\\n \\\"\\\"\\\"\\n\\n mute = self.payload.get('mute')\\n message_type = self.payload.get('message_type')\\n\\n if message_type == feconf.MESSAGE_TYPE_FEEDBACK:\\n user_services.set_email_preferences_for_exploration(\\n self.user_id, exploration_id, mute_feedback_notifications=mute)\\n elif message_type == feconf.MESSAGE_TYPE_SUGGESTION:\\n user_services.set_email_preferences_for_exploration(\\n self.user_id, exploration_id,\\n mute_suggestion_notifications=mute)\\n else:\\n raise self.InvalidInputException(\\n 'Invalid message type.')\\n\\n exploration_email_preferences = (\\n user_services.get_email_preferences_for_exploration(\\n self.user_id, exploration_id))\\n self.render_json({\\n 'email_preferences': exploration_email_preferences.to_dict()\\n })\\n\\n\\nclass ExplorationFileDownloader(EditorHandler):\\n \\\"\\\"\\\"Downloads an exploration as a zip file, or dict of YAML strings\\n representing states.\\n \\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_DOWNLOADABLE\\n\\n @acl_decorators.can_download_exploration\\n def get(self, exploration_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n exploration = exp_fetchers.get_exploration_by_id(exploration_id)\\n\\n version_str = self.request.get('v', default_value=exploration.version)\\n output_format = self.request.get('output_format', default_value='zip')\\n\\n try:\\n version = int(version_str)\\n except ValueError:\\n version = exploration.version\\n\\n # If the title of the exploration has changed, we use the new title.\\n if not exploration.title:\\n init_filename = 'oppia-unpublished_exploration-v%s.zip' % version\\n else:\\n init_filename = 'oppia-%s-v%s.zip' % (\\n exploration.title.replace(' ', ''), version)\\n filename = utils.to_ascii(init_filename).decode('utf-8')\\n\\n if output_format == feconf.OUTPUT_FORMAT_ZIP:\\n self.render_downloadable_file(\\n exp_services.export_to_zip_file(\\n exploration_id, version=version),\\n filename, 'text/plain')\\n elif output_format == feconf.OUTPUT_FORMAT_JSON:\\n self.render_json(exp_services.export_states_to_yaml(\\n exploration_id, version=version))\\n else:\\n raise self.InvalidInputException(\\n 'Unrecognized output format %s' % output_format)\\n\\n\\nclass StateYamlHandler(EditorHandler):\\n \\\"\\\"\\\"Given a representation of a state, converts it to a YAML string.\\n\\n Note that this handler is stateless; it does not make use of the storage\\n layer.\\n \\\"\\\"\\\"\\n\\n @acl_decorators.can_play_exploration\\n def post(self, unused_exploration_id):\\n \\\"\\\"\\\"Handles POST requests.\\\"\\\"\\\"\\n state_dict = self.payload.get('state_dict')\\n width = self.payload.get('width')\\n\\n if not width or not state_dict:\\n raise self.PageNotFoundException\\n\\n self.render_json({\\n 'yaml': state_domain.State.convert_state_dict_to_yaml(\\n state_dict, width),\\n })\\n\\n\\nclass ExplorationSnapshotsHandler(EditorHandler):\\n \\\"\\\"\\\"Returns the exploration snapshot history.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_play_exploration\\n def get(self, exploration_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n\\n snapshots = exp_services.get_exploration_snapshots_metadata(\\n exploration_id)\\n\\n # Patch `snapshots` to use the editor's display name.\\n snapshots_committer_ids = [\\n snapshot['committer_id'] for snapshot in snapshots]\\n committer_usernames = user_services.get_usernames(\\n snapshots_committer_ids)\\n for index, snapshot in enumerate(snapshots):\\n snapshot['committer_id'] = committer_usernames[index]\\n\\n self.render_json({\\n 'snapshots': snapshots,\\n })\\n\\n\\nclass ExplorationRevertHandler(EditorHandler):\\n \\\"\\\"\\\"Reverts an exploration to an older version.\\\"\\\"\\\"\\n\\n @acl_decorators.can_edit_exploration\\n def post(self, exploration_id):\\n \\\"\\\"\\\"Handles POST requests.\\\"\\\"\\\"\\n current_version = self.payload.get('current_version')\\n revert_to_version = self.payload.get('revert_to_version')\\n\\n if not isinstance(revert_to_version, int):\\n raise self.InvalidInputException(\\n 'Expected an integer version to revert to; received %s.' %\\n revert_to_version)\\n if not isinstance(current_version, int):\\n raise self.InvalidInputException(\\n 'Expected an integer current version; received %s.' %\\n current_version)\\n\\n if revert_to_version < 1 or revert_to_version >= current_version:\\n raise self.InvalidInputException(\\n 'Cannot revert to version %s from version %s.' %\\n (revert_to_version, current_version))\\n\\n exp_services.discard_draft(exploration_id, self.user_id)\\n exp_services.revert_exploration(\\n self.user_id, exploration_id, current_version, revert_to_version)\\n self.render_json({})\\n\\n\\nclass ExplorationStatisticsHandler(EditorHandler):\\n \\\"\\\"\\\"Returns statistics for an exploration. This is the handler for the new\\n statistics framework.\\n \\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_view_exploration_stats\\n def get(self, exploration_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n current_exploration = exp_fetchers.get_exploration_by_id(\\n exploration_id)\\n\\n self.render_json(stats_services.get_exploration_stats(\\n exploration_id, current_exploration.version).to_frontend_dict())\\n\\n\\nclass StateInteractionStatsHandler(EditorHandler):\\n \\\"\\\"\\\"Returns detailed learner answer statistics for a state.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_view_exploration_stats\\n def get(self, exploration_id, escaped_state_name):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n current_exploration = exp_fetchers.get_exploration_by_id(\\n exploration_id)\\n\\n state_name = utils.unescape_encoded_uri_component(escaped_state_name)\\n if state_name not in current_exploration.states:\\n logging.error('Could not find state: %s' % state_name)\\n logging.error('Available states: %s' % (\\n list(current_exploration.states.keys())))\\n raise self.PageNotFoundException\\n\\n self.render_json({\\n 'visualizations_info': stats_services.get_visualizations_info(\\n current_exploration.id, state_name,\\n current_exploration.states[state_name].interaction.id),\\n })\\n\\n\\nclass FetchIssuesHandler(EditorHandler):\\n \\\"\\\"\\\"Handler used for retrieving the list of unresolved issues in an\\n exploration. This removes the invalid issues and returns the remaining\\n unresolved ones.\\n \\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_view_exploration_stats\\n def get(self, exp_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n exp_version = self.request.get('exp_version')\\n exp_issues = stats_services.get_exp_issues(exp_id, exp_version)\\n if exp_issues is None:\\n raise self.PageNotFoundException(\\n 'Invalid version %s for exploration ID %s'\\n % (exp_version, exp_id))\\n unresolved_issues = []\\n for issue in exp_issues.unresolved_issues:\\n if issue.is_valid:\\n unresolved_issues.append(issue)\\n exp_issues.unresolved_issues = unresolved_issues\\n exp_issues_dict = exp_issues.to_dict()\\n self.render_json(exp_issues_dict)\\n\\n\\nclass FetchPlaythroughHandler(EditorHandler):\\n \\\"\\\"\\\"Handler used for retrieving a playthrough.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_view_exploration_stats\\n def get(self, unused_exploration_id, playthrough_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n playthrough = stats_services.get_playthrough_by_id(playthrough_id)\\n if playthrough is None:\\n raise self.PageNotFoundException(\\n 'Invalid playthrough ID %s' % (playthrough_id))\\n self.render_json(playthrough.to_dict())\\n\\n\\nclass ResolveIssueHandler(EditorHandler):\\n \\\"\\\"\\\"Handler used for resolving an issue. Currently, when an issue is\\n resolved, the issue is removed from the unresolved issues list in the\\n ExplorationIssuesModel instance, and all corresponding playthrough\\n instances are deleted.\\n \\\"\\\"\\\"\\n\\n @acl_decorators.can_edit_exploration\\n def post(self, exp_id):\\n \\\"\\\"\\\"Handles POST requests.\\\"\\\"\\\"\\n exp_issue_dict = self.payload.get('exp_issue_dict')\\n try:\\n stats_domain.ExplorationIssue.from_dict(exp_issue_dict)\\n except utils.ValidationError as e:\\n raise self.PageNotFoundException(e)\\n\\n exp_version = self.payload.get('exp_version')\\n\\n exp_issues = stats_services.get_exp_issues(exp_id, exp_version)\\n if exp_issues is None:\\n raise self.PageNotFoundException(\\n 'Invalid exploration ID %s' % (exp_id))\\n\\n # Check that the passed in issue actually exists in the exploration\\n # issues instance.\\n issue_to_remove = None\\n for issue in exp_issues.unresolved_issues:\\n if issue.to_dict() == exp_issue_dict:\\n issue_to_remove = issue\\n break\\n\\n if not issue_to_remove:\\n raise self.PageNotFoundException(\\n 'Exploration issue does not exist in the list of issues for '\\n 'the exploration with ID %s' % exp_id)\\n\\n # Remove the issue from the unresolved issues list.\\n exp_issues.unresolved_issues.remove(issue_to_remove)\\n\\n # Update the exploration issues instance and delete the playthrough\\n # instances.\\n stats_services.delete_playthroughs_multi(\\n issue_to_remove.playthrough_ids)\\n stats_services.save_exp_issues_model(exp_issues)\\n\\n self.render_json({})\\n\\n\\nclass ImageUploadHandler(EditorHandler):\\n \\\"\\\"\\\"Handles image uploads.\\\"\\\"\\\"\\n\\n # The string to prefix to the filename (before tacking the whole thing on\\n # to the end of 'assets/').\\n _FILENAME_PREFIX = 'image'\\n _decorator = None\\n\\n @acl_decorators.can_edit_entity\\n def post(self, entity_type, entity_id):\\n \\\"\\\"\\\"Saves an image uploaded by a content creator.\\\"\\\"\\\"\\n\\n raw = self.request.get('image')\\n filename = self.payload.get('filename')\\n filename_prefix = self.payload.get('filename_prefix')\\n if filename_prefix is None:\\n filename_prefix = self._FILENAME_PREFIX\\n\\n try:\\n file_format = image_validation_services.validate_image_and_filename(\\n raw, filename)\\n except utils.ValidationError as e:\\n raise self.InvalidInputException(e)\\n\\n file_system_class = fs_services.get_entity_file_system_class()\\n fs = fs_domain.AbstractFileSystem(file_system_class(\\n entity_type, entity_id))\\n filepath = '%s/%s' % (filename_prefix, filename)\\n\\n if fs.isfile(filepath):\\n raise self.InvalidInputException(\\n 'A file with the name %s already exists. Please choose a '\\n 'different name.' % filename)\\n image_is_compressible = (\\n file_format in feconf.COMPRESSIBLE_IMAGE_FORMATS)\\n fs_services.save_original_and_compressed_versions_of_image(\\n filename, entity_type, entity_id, raw, filename_prefix,\\n image_is_compressible)\\n\\n self.render_json({'filename': filename})\\n\\n\\nclass StartedTutorialEventHandler(EditorHandler):\\n \\\"\\\"\\\"Records that this user has started the state editor tutorial.\\\"\\\"\\\"\\n\\n @acl_decorators.can_play_exploration\\n def post(self, unused_exploration_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n user_services.record_user_started_state_editor_tutorial(self.user_id)\\n self.render_json({})\\n\\n\\nclass EditorAutosaveHandler(ExplorationHandler):\\n \\\"\\\"\\\"Handles requests from the editor for draft autosave.\\\"\\\"\\\"\\n\\n @acl_decorators.can_save_exploration\\n def put(self, exploration_id):\\n \\\"\\\"\\\"Handles PUT requests for draft updation.\\\"\\\"\\\"\\n # Raise an Exception if the draft change list fails non-strict\\n # validation.\\n try:\\n change_list_dict = self.payload.get('change_list')\\n change_list = [\\n exp_domain.ExplorationChange(change)\\n for change in change_list_dict]\\n except utils.ValidationError as e:\\n # We leave any pre-existing draft changes in the datastore.\\n raise self.InvalidInputException(e)\\n\\n version = self.payload.get('version')\\n exploration_rights = rights_manager.get_exploration_rights(\\n exploration_id)\\n can_edit = rights_manager.check_can_edit_activity(\\n self.user, exploration_rights)\\n can_voiceover = rights_manager.check_can_voiceover_activity(\\n self.user, exploration_rights)\\n\\n try:\\n if can_edit:\\n exp_services.create_or_update_draft(\\n exploration_id, self.user_id, change_list, version,\\n datetime.datetime.utcnow())\\n elif can_voiceover:\\n exp_services.create_or_update_draft(\\n exploration_id, self.user_id, change_list, version,\\n datetime.datetime.utcnow(), is_by_voice_artist=True)\\n except utils.ValidationError as e:\\n # We leave any pre-existing draft changes in the datastore.\\n raise self.InvalidInputException(e)\\n\\n exp_user_data = exp_services.get_user_exploration_data(\\n self.user_id, exploration_id)\\n # If the draft_change_list_id is False, have the user discard the draft\\n # changes. We save the draft to the datastore even if the version is\\n # invalid, so that it is available for recovery later.\\n self.render_json({\\n 'draft_change_list_id': exp_user_data['draft_change_list_id'],\\n 'is_version_of_draft_valid': exp_services.is_version_of_draft_valid(\\n exploration_id, version)})\\n\\n @acl_decorators.can_save_exploration\\n def post(self, exploration_id):\\n \\\"\\\"\\\"Handles POST request for discarding draft changes.\\\"\\\"\\\"\\n exp_services.discard_draft(exploration_id, self.user_id)\\n self.render_json({})\\n\\n\\nclass StateAnswerStatisticsHandler(EditorHandler):\\n \\\"\\\"\\\"Returns basic learner answer statistics for a state.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_view_exploration_stats\\n def get(self, exploration_id):\\n \\\"\\\"\\\"Handles GET requests.\\\"\\\"\\\"\\n current_exploration = exp_fetchers.get_exploration_by_id(exploration_id)\\n\\n top_state_answers = stats_services.get_top_state_answer_stats_multi(\\n exploration_id, current_exploration.states)\\n top_state_interaction_ids = {\\n state_name: current_exploration.states[state_name].interaction.id\\n for state_name in top_state_answers\\n }\\n self.render_json({\\n 'answers': top_state_answers,\\n 'interaction_ids': top_state_interaction_ids,\\n })\\n\\n\\nclass TopUnresolvedAnswersHandler(EditorHandler):\\n \\\"\\\"\\\"Returns a list of top N unresolved answers.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_edit_exploration\\n def get(self, exploration_id):\\n \\\"\\\"\\\"Handles GET requests for unresolved answers.\\\"\\\"\\\"\\n state_name = self.request.get('state_name')\\n if not state_name:\\n raise self.PageNotFoundException\\n\\n unresolved_answers_with_frequency = (\\n stats_services.get_top_state_unresolved_answers(\\n exploration_id, state_name))\\n\\n self.render_json({\\n 'unresolved_answers': unresolved_answers_with_frequency\\n })\\n\\n\\nclass LearnerAnswerInfoHandler(EditorHandler):\\n \\\"\\\"\\\"Handles the learner answer info for an exploration state.\\\"\\\"\\\"\\n\\n GET_HANDLER_ERROR_RETURN_TYPE = feconf.HANDLER_TYPE_JSON\\n\\n @acl_decorators.can_play_entity\\n def get(self, entity_type, entity_id):\\n \\\"\\\"\\\"Handles the GET requests for learner answer info for an\\n exploration state.\\n \\\"\\\"\\\"\\n if not constants.ENABLE_SOLICIT_ANSWER_DETAILS_FEATURE:\\n raise self.PageNotFoundException\\n\\n learner_answer_info_data = []\\n\\n if entity_type == feconf.ENTITY_TYPE_EXPLORATION:\\n exp = exp_fetchers.get_exploration_by_id(entity_id)\\n for state_name in exp.states:\\n state_reference = (\\n stats_services.get_state_reference_for_exploration(\\n entity_id, state_name))\\n learner_answer_details = (\\n stats_services.get_learner_answer_details(\\n feconf.ENTITY_TYPE_EXPLORATION, state_reference))\\n if learner_answer_details is not None:\\n learner_answer_info_data.append({\\n 'state_name': state_name,\\n 'interaction_id': learner_answer_details.interaction_id,\\n 'customization_args': exp.states[state_name].interaction\\n .to_dict()['customization_args'],\\n 'learner_answer_info_dicts': [\\n learner_answer_info.to_dict() for\\n learner_answer_info in\\n learner_answer_details.learner_answer_info_list]\\n })\\n elif entity_type == feconf.ENTITY_TYPE_QUESTION:\\n question = question_services.get_question_by_id(entity_id)\\n state_reference = stats_services.get_state_reference_for_question(\\n entity_id)\\n learner_answer_details = stats_services.get_learner_answer_details(\\n feconf.ENTITY_TYPE_QUESTION, state_reference)\\n if learner_answer_details is not None:\\n learner_answer_info_dicts = [\\n learner_answer_info.to_dict() for learner_answer_info in\\n learner_answer_details.learner_answer_info_list]\\n learner_answer_info_data = {\\n 'interaction_id': learner_answer_details.interaction_id,\\n 'customization_args': question.question_state_data.interaction\\n .to_dict()['customization_args'],\\n 'learner_answer_info_dicts': learner_answer_info_dicts\\n }\\n\\n self.render_json({\\n 'learner_answer_info_data': learner_answer_info_data\\n })\\n\\n @acl_decorators.can_edit_entity\\n def delete(self, entity_type, entity_id):\\n \\\"\\\"\\\"Deletes the learner answer info by the given id.\\\"\\\"\\\"\\n\\n if not constants.ENABLE_SOLICIT_ANSWER_DETAILS_FEATURE:\\n raise self.PageNotFoundException\\n\\n if entity_type == feconf.ENTITY_TYPE_EXPLORATION:\\n state_name = self.request.get('state_name')\\n if not state_name:\\n raise self.InvalidInputException\\n state_reference = (\\n stats_services.get_state_reference_for_exploration(\\n entity_id, state_name))\\n elif entity_type == feconf.ENTITY_TYPE_QUESTION:\\n state_reference = (\\n stats_services.get_state_reference_for_question(\\n entity_id))\\n learner_answer_info_id = self.request.get('learner_answer_info_id')\\n if not learner_answer_info_id:\\n raise self.PageNotFoundException\\n stats_services.delete_learner_answer_info(\\n entity_type, state_reference, learner_answer_info_id)\\n self.render_json({})\\n\",\n \"path\": \"core/controllers/editor.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/core/controllers/editor.py b/core/controllers/editor.py\nindex bbc6b763b8f9b..6cbcba1316ac6 100644\n--- a/core/controllers/editor.py\n+++ b/core/controllers/editor.py\n@@ -558,7 +558,7 @@ def get(self, exp_id):\n unresolved_issues.append(issue)\n exp_issues.unresolved_issues = unresolved_issues\n exp_issues_dict = exp_issues.to_dict()\n- self.render_json(exp_issues_dict['unresolved_issues'])\n+ self.render_json(exp_issues_dict)\n \n \n class FetchPlaythroughHandler(EditorHandler):\ndiff --git a/core/controllers/editor_test.py b/core/controllers/editor_test.py\nindex 3b410fc12f2a4..f7e6aafa9a218 100644\n--- a/core/controllers/editor_test.py\n+++ b/core/controllers/editor_test.py\n@@ -2114,10 +2114,12 @@ def test_fetch_issues_handler(self):\n response = self.get_json(\n '/issuesdatahandler/%s' % self.EXP_ID,\n params={'exp_version': 1})\n- self.assertEqual(len(response), 2)\n- self.assertEqual(response[0]['issue_type'], 'EarlyQuit')\n+ self.assertEqual(len(response['unresolved_issues']), 2)\n self.assertEqual(\n- response[1]['issue_type'], 'MultipleIncorrectSubmissions')\n+ response['unresolved_issues'][0]['issue_type'], 'EarlyQuit')\n+ self.assertEqual(\n+ response['unresolved_issues'][1]['issue_type'],\n+ 'MultipleIncorrectSubmissions')\n \n def test_invalid_issues_are_not_retrieved(self):\n \"\"\"Test that invalid issues are not retrieved.\"\"\"\n@@ -2130,8 +2132,9 @@ def test_invalid_issues_are_not_retrieved(self):\n response = self.get_json(\n '/issuesdatahandler/%s' % self.EXP_ID,\n params={'exp_version': 1})\n- self.assertEqual(len(response), 1)\n- self.assertEqual(response[0]['issue_type'], 'EarlyQuit')\n+ self.assertEqual(len(response['unresolved_issues']), 1)\n+ self.assertEqual(\n+ response['unresolved_issues'][0]['issue_type'], 'EarlyQuit')\n \n def test_fetch_playthrough_handler(self):\n \"\"\"Test that the playthrough gets fetched correctly.\"\"\"\ndiff --git a/core/templates/services/playthrough-issues-backend-api.service.spec.ts b/core/templates/services/playthrough-issues-backend-api.service.spec.ts\nindex 6d0d28ea5ca61..22097bbf37ec5 100644\n--- a/core/templates/services/playthrough-issues-backend-api.service.spec.ts\n+++ b/core/templates/services/playthrough-issues-backend-api.service.spec.ts\n@@ -66,7 +66,7 @@ describe('PlaythroughIssuesBackendApiService', () => {\n let req = httpTestingController.expectOne(\n '/issuesdatahandler/7?exp_version=1');\n expect(req.request.method).toEqual('GET');\n- req.flush(backendIssues);\n+ req.flush({unresolved_issues: backendIssues});\n flushMicrotasks();\n \n expect(successHandler).toHaveBeenCalledWith(\n@@ -110,7 +110,7 @@ describe('PlaythroughIssuesBackendApiService', () => {\n let req = httpTestingController.expectOne(\n '/issuesdatahandler/7?exp_version=1');\n expect(req.request.method).toEqual('GET');\n- req.flush(backendIssues);\n+ req.flush({unresolved_issues: backendIssues});\n flushMicrotasks();\n \n expect(successHandler).toHaveBeenCalledWith(\n@@ -199,7 +199,7 @@ describe('PlaythroughIssuesBackendApiService', () => {\n let req = httpTestingController.expectOne(\n '/issuesdatahandler/7?exp_version=1');\n expect(req.request.method).toEqual('GET');\n- req.flush(backendIssues);\n+ req.flush({unresolved_issues: backendIssues});\n flushMicrotasks();\n \n req = httpTestingController.expectOne(\n@@ -228,7 +228,7 @@ describe('PlaythroughIssuesBackendApiService', () => {\n let req = httpTestingController.expectOne(\n '/issuesdatahandler/7?exp_version=1');\n expect(req.request.method).toEqual('GET');\n- req.flush(backendIssues);\n+ req.flush({unresolved_issues: backendIssues});\n flushMicrotasks();\n \n req = httpTestingController.expectOne(\ndiff --git a/core/templates/services/playthrough-issues-backend-api.service.ts b/core/templates/services/playthrough-issues-backend-api.service.ts\nindex 415d7a152437a..e6186621e0260 100644\n--- a/core/templates/services/playthrough-issues-backend-api.service.ts\n+++ b/core/templates/services/playthrough-issues-backend-api.service.ts\n@@ -20,6 +20,10 @@ import { downgradeInjectable } from '@angular/upgrade/static';\n import { HttpClient } from '@angular/common/http';\n import { Injectable } from '@angular/core';\n \n+export interface FetchIssuesResponseBackendDict {\n+ 'unresolved_issues': PlaythroughIssueBackendDict[],\n+}\n+\n import {\n PlaythroughIssueBackendDict,\n PlaythroughIssue,\n@@ -46,11 +50,11 @@ export class PlaythroughIssuesBackendApiService {\n }\n \n return new Promise((resolve, reject) => {\n- this.httpClient.get<PlaythroughIssueBackendDict[]>(\n+ this.httpClient.get<FetchIssuesResponseBackendDict>(\n this.getFetchIssuesUrl(explorationId), {\n params: { exp_version: explorationVersion.toString() }}).toPromise()\n .then(response => {\n- resolve(this.cachedIssues = response.map(\n+ resolve(this.cachedIssues = response.unresolved_issues.map(\n this.playthroughIssueObjectFactory.createFromBackendDict));\n }, errorResponse => {\n reject(errorResponse.error.error);\n"}}},{"rowIdx":4687,"cells":{"in_source_id":{"kind":"string","value":"akvo__akvo-rsr-1622"},"issue":{"kind":"string","value":"Small user interface enhancements\nSee https://github.com/akvo/akvo-product-design/issues/104\n## Test plan\n1. \"Update list\" on directory pages should display \"Search\"\n2. On the project page, in the financial overview part, no cents should be displayed and the total amount funded should be displayed (only visible when donations are activated)\n3. On the project full data report page the alignments should be 'fixed', Target group should be visible (when filled in), 'Current situation' is renamed to 'Situation at the start of the project', and the \"other\" labels in budget items should have the actual label filled in.\n4. The financial page is revamped, with a better order of columns (budget on the left, funding in the middle, and summary of those two on the right)\n5. One enter in a project update should also display an enter on the project update page (previously this only happened with two enters)\n6. On My Projects in MyRSR, the \"Update\" button should never be too small so that it only displays part of the word (e.g. \"Upd...\")\n\n"},"before_files":{"kind":"list like","value":[{"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\nimport json\n\nfrom sorl.thumbnail import get_thumbnail\nfrom django.contrib.auth.decorators import login_required\nfrom django.core.exceptions import PermissionDenied\nfrom django.http import Http404, HttpResponse\nfrom django.shortcuts import get_object_or_404, redirect, render\nfrom lxml import etree\n\nfrom ..forms import ProjectUpdateForm\nfrom ..filters import remove_empty_querydict_items, ProjectFilter\nfrom ..models import Invoice, Project, ProjectUpdate\nfrom ...utils import pagination, filter_query_string\nfrom ...iati.iati_export import IatiXML\nfrom .utils import apply_keywords, org_projects\n\n\n###############################################################################\n# Project directory\n###############################################################################\n\n\ndef _all_projects():\n \"\"\"Return all active projects.\"\"\"\n return Project.objects.published().select_related(\n 'publishingstatus__status',\n 'sync_owner',\n 'primary_location',\n 'primary_location__country'\n 'locations',\n 'partnerships',\n 'partnerships__organisation',\n 'sectors',\n 'partners',\n ).order_by('-id')\n\n\ndef _page_projects(page):\n \"\"\"Dig out the list of projects to use.\n\n First get a list based on page settings (orgs or all projects). Then apply\n keywords filtering / exclusion.\n \"\"\"\n projects = org_projects(page.organisation) if page.partner_projects else _all_projects()\n return apply_keywords(page, projects)\n\n\ndef _project_directory_coll(request):\n \"\"\"Dig out and pass correct projects to the view.\"\"\"\n page = request.rsr_page\n if not page:\n return _all_projects()\n return _page_projects(page)\n\n\ndef directory(request):\n \"\"\"The project list view.\"\"\"\n\n qs = remove_empty_querydict_items(request.GET)\n\n # Set show_filters to \"in\" if any filter is selected\n show_filters = \"in\" # To simplify template use bootstrap class\n available_filters = ['location', 'status', 'organisation', 'sector', 'sort_by']\n if frozenset(qs.keys()).isdisjoint(available_filters):\n show_filters = \"\"\n\n # Prepare sorting\n available_sorting = ['last_modified_at', '-last_modified_at', 'title',\n '-title', 'budget', '-budget', ]\n sort_by = request.GET.get('sort_by', '-last_modified_at')\n sorting = sort_by if sort_by in available_sorting else '-last_modified_at'\n\n # Yank project collection\n all_projects = _project_directory_coll(request)\n f = ProjectFilter(qs, queryset=all_projects)\n sorted_projects = f.qs.distinct().order_by(sorting)\n\n # Build page\n page = request.GET.get('page')\n page, paginator, page_range = pagination(page, sorted_projects, 10)\n\n # Get the current org filter for typeahead\n org_filter = request.GET.get('organisation', '')\n\n # Get projects to be displayed on the map\n map_projects = all_projects if request.rsr_page and request.rsr_page.all_maps else page\n\n context = {\n 'project_count': sorted_projects.count(),\n 'filter': f,\n 'page': page,\n 'page_range': page_range,\n 'paginator': paginator,\n 'show_filters': show_filters,\n 'q': filter_query_string(qs),\n 'sorting': sorting,\n 'current_org': org_filter,\n 'map_projects': map_projects,\n }\n return render(request, 'project_directory.html', context)\n\n\n###############################################################################\n# Project main\n###############################################################################\n\n\ndef _get_accordion_data(project):\n accordion_data = dict()\n accordion_data['background'] = project.background\n accordion_data['current_status'] = project.current_status\n accordion_data['project_plan'] = project.project_plan\n accordion_data['target_group'] = project.target_group\n accordion_data['sustainability'] = project.sustainability\n accordion_data['goals_overview'] = project.goals_overview\n if project.results.all():\n results_data = []\n for result in project.results.all():\n result_data = dict()\n result_data['id'] = str(result.pk)\n result_data['title'] = result.title\n indicators_data = []\n for indicator in result.indicators.all():\n for period in indicator.periods.all():\n indicator_data = dict()\n indicator_data['id'] = str(period.pk)\n indicator_data['title'] = indicator.title\n if period.period_start:\n indicator_data['period_start'] = period.period_start.strftime(\"%d-%m-%Y\")\n if period.period_end:\n indicator_data['period_end'] = period.period_end.strftime(\"%d-%m-%Y\")\n indicator_data['target_value'] = period.target_value\n indicator_data['actual_value'] = period.actual_value\n indicators_data.append(indicator_data)\n if not indicator.periods.all():\n indicator_data = dict()\n indicator_data['id'] = str(indicator.pk)\n indicator_data['title'] = indicator.title\n indicators_data.append(indicator_data)\n result_data['indicators'] = indicators_data\n results_data.append(result_data)\n accordion_data['results'] = results_data\n return accordion_data\n\n\ndef _get_timeline_data(project):\n timeline_data = {'timeline': {'type': 'default'}}\n timeline_dates = []\n\n # Project start and end dates\n # TODO: fix when no planned start date\n date_start = (project.date_start_actual, 'Start', 'actual') if project.date_start_actual else \\\n (project.date_start_planned, 'Start', 'planned')\n date_end = (project.date_end_actual, 'End', 'actual') if project.date_end_actual else \\\n (project.date_end_planned, 'End', 'planned') if project.date_end_planned else None\n\n for date in (date_start, date_end):\n if date:\n headline = date[1] + \" date of project\"\n if not date[2] == 'actual':\n headline += \" (planned)\"\n timeline_dates.append({\n 'startDate': ','.join((str(date[0].year), str(date[0].month), str(date[0].day))),\n 'headline': headline,\n })\n\n # Project updates\n for update in project.updates_desc():\n date = update.last_modified_at\n timeline_dates.append({\n 'startDate': ','.join((str(date.year), str(date.month), str(date.day))),\n 'headline': 'Project update added',\n 'text': '<a href=\"' + update.get_absolute_url() + '\">' + update.title + '</a>',\n 'asset': {\n 'thumbnail': update.photo.url if update.photo else None,\n 'media': update.photo.url if update.photo else None,\n }\n })\n\n # Donations\n for donation in Invoice.objects.filter(project=project):\n date = donation.time\n timeline_dates.append({\n 'startDate': ','.join((str(date.year), str(date.month), str(date.day))),\n 'headline': 'Donation added',\n 'text': 'by ' + donation.name if donation.name else 'Anonymous',\n })\n\n timeline_data['timeline']['date'] = timeline_dates\n\n return timeline_data\n\n\ndef _get_carousel_data(project):\n photos = []\n if project.current_image:\n try:\n im = get_thumbnail(project.current_image, '750x400', quality=99)\n photos.append({\n \"url\": im.url,\n \"caption\": project.current_image_caption,\n \"credit\": project.current_image_credit,\n \"original_url\": project.current_image.url,\n })\n except IOError:\n pass\n for update in project.updates_desc():\n if len(photos) > 9:\n break\n if update.photo:\n try:\n im = get_thumbnail(update.photo, '750x400', quality=99)\n photos.append({\n \"url\": im.url,\n \"caption\": update.photo_caption,\n \"credit\": update.photo_credit,\n \"original_url\": update.photo.url,\n })\n except IOError:\n continue\n return {\"photos\": photos}\n\n\ndef _get_hierarchy_row(max_rows, projects):\n \"\"\"Return a column for the project hierarchy with a division.\n\n E.g. with a max_rows of 4 and one project, it will return [False,\n <Project>, False, False].\n \"\"\"\n project_count = projects.count()\n if max_rows == project_count:\n return [project for project in projects]\n empty_begin = (max_rows - project_count) / 2\n empty_end = (max_rows - project_count) / 2 + ((max_rows - project_count) % 2)\n rows = []\n for row in range(empty_begin):\n rows.append(False)\n for project in projects:\n rows.append(project)\n for row in range(empty_end):\n rows.append(False)\n return rows\n\n\ndef _get_hierarchy_grid(project):\n parents = project.parents()\n siblings = project.siblings()\n children = project.children()\n\n # Create the lay-out of the grid\n max_rows = max(parents.count(), siblings.count() + 1, children.count())\n parent_rows = _get_hierarchy_row(max_rows, parents)\n siblings_rows = _get_hierarchy_row(max_rows - 1, siblings)\n siblings_rows.insert((max_rows - 1) / 2, 'project')\n children_rows = _get_hierarchy_row(max_rows, children)\n\n grid = []\n project_added = False\n for row in range(max_rows):\n grid.append([])\n grid[row].append([parent_rows[row], 'parent']) if parent_rows[row] else grid[row].append(None)\n if siblings_rows[row] == 'project':\n grid[row].append([project, 'project'])\n project_added = True\n elif not project_added:\n grid[row].append([siblings_rows[row], 'sibling-top']) if siblings_rows[row] else grid[row].append(None)\n else:\n grid[row].append([siblings_rows[row], 'sibling-bottom']) if siblings_rows[row] else grid[row].append(None)\n grid[row].append([children_rows[row], 'child']) if children_rows[row] else grid[row].append(None)\n\n return grid\n\n\ndef _get_project_partners(project):\n partners = {}\n for partner in project.all_partners():\n partners[partner] = partner.has_partner_types(project)\n return partners\n\n\ndef main(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n\n # Non-editors are not allowed to view unpublished projects\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\n raise PermissionDenied\n\n carousel_data = _get_carousel_data(project)\n updates = project.project_updates.all().order_by('-created_at')[:5]\n accordion_data = _get_accordion_data(project)\n # timeline_data = _get_timeline_data(project)\n\n reporting_org = project.reporting_org()\n reporting_org_info = (reporting_org, reporting_org.has_partner_types(project))\n partners = _get_project_partners(project)\n\n context = {\n 'accordion_data': json.dumps(accordion_data),\n 'carousel_data': json.dumps(carousel_data),\n 'project': project,\n # 'timeline_data': json.dumps(timeline_data),\n 'updates': updates,\n 'reporting_org': reporting_org_info,\n 'partners': partners,\n }\n\n return render(request, 'project_main.html', context)\n\n\n###############################################################################\n# Project hierarchy\n###############################################################################\n\n\ndef hierarchy(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n\n # Non-editors are not allowed to view unpublished projects\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\n raise PermissionDenied\n\n if not project.has_relations():\n raise Http404\n\n hierarchy_grid = _get_hierarchy_grid(project)\n\n context = {\n 'project': project,\n 'hierarchy_grid': hierarchy_grid,\n }\n\n return render(request, 'project_hierarchy.html', context)\n\n\n###############################################################################\n# Project report\n###############################################################################\n\n\ndef report(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n\n # Non-editors are not allowed to view unpublished projects\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\n raise PermissionDenied\n\n context = {\n 'project': project,\n }\n\n return render(request, 'project_report.html', context)\n\n###############################################################################\n# Project IATI file\n###############################################################################\n\n\ndef iati(request, project_id):\n \"\"\"Generate the IATI file on-the-fly and return the XML.\"\"\"\n iati_activities = IatiXML(Project.objects.filter(pk=project_id)).iati_activities\n xml_data = etree.tostring(etree.ElementTree(iati_activities))\n return HttpResponse(xml_data, content_type=\"text/xml\")\n\n\n###############################################################################\n# Project widgets\n###############################################################################\n\n\ndef widgets(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n selected_widget = request.GET.get('widget', None)\n\n # Non-editors are not allowed to view unpublished projects\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\n raise PermissionDenied\n\n context = {\n 'project': project,\n 'style': 'darkBG',\n }\n\n if selected_widget in ['narrow', 'cobranded', 'small', 'map', 'list']:\n context['widget'] = selected_widget\n context['domain_url'] = 'http://' + request.META['HTTP_HOST']\n return render(request, 'project_widgets2.html', context)\n\n else:\n return render(request, 'project_widgets.html', context)\n\n\n@login_required()\ndef set_update(request, project_id, edit_mode=False, form_class=ProjectUpdateForm, update_id=None):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, id=project_id)\n\n # Non-editors are not allowed to view unpublished projects\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\n raise PermissionDenied\n\n # Check if user is allowed to place updates for this project\n allow_update = False\n if request.user.has_perm('rsr.post_updates', project):\n allow_update = True\n\n updates = project.updates_desc()[:5]\n update = None\n\n if update_id is not None:\n edit_mode = True\n update = get_object_or_404(ProjectUpdate, id=update_id)\n if not request.user == update.user:\n request.error_message = u'You can only edit your own updates.'\n raise PermissionDenied\n\n if update.edit_window_has_expired():\n request.error_message = u'You cannot edit this update anymore, the 30 minutes time limit has passed.'\n raise PermissionDenied\n\n if request.method == 'POST':\n updateform = form_class(request.POST, request.FILES, instance=update)\n if updateform.is_valid():\n update = updateform.save(project=project, user=request.user)\n return redirect(update.get_absolute_url())\n else:\n updateform = form_class(instance=update)\n\n context = {\n 'project': project,\n 'updates': updates,\n 'update': update,\n 'updateform': updateform,\n 'edit_mode': edit_mode,\n 'allow_update': allow_update\n }\n\n return render(request, 'update_add.html', context)\n\n\ndef search(request):\n \"\"\".\"\"\"\n context = {'projects': Project.objects.published()}\n return render(request, 'project_search.html', context)\n\ndef partners(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n partners = _get_project_partners(project)\n context = {\n 'project': project,\n 'partners': partners\n }\n return render(request, 'project_partners.html', context)\n\n\ndef finance(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n context = {\n 'project': project\n }\n return render(request, 'project_finance.html', context)\n\n\ndef donations_disabled(project):\n \"\"\".\"\"\"\n return not project.donate_button\n\n\ndef can_accept_donations(project):\n \"\"\".\"\"\"\n if project in Project.objects.active() and project.funds_needed > 0:\n return True\n else:\n return False\n\n\ndef donate(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n\n if not project.accepts_donations():\n raise Http404\n\n context = {\n 'project': project\n }\n return render(request, 'project_donate.html', context)\n","path":"akvo/rsr/views/project.py"}],"string":"[\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\\nimport json\\n\\nfrom sorl.thumbnail import get_thumbnail\\nfrom django.contrib.auth.decorators import login_required\\nfrom django.core.exceptions import PermissionDenied\\nfrom django.http import Http404, HttpResponse\\nfrom django.shortcuts import get_object_or_404, redirect, render\\nfrom lxml import etree\\n\\nfrom ..forms import ProjectUpdateForm\\nfrom ..filters import remove_empty_querydict_items, ProjectFilter\\nfrom ..models import Invoice, Project, ProjectUpdate\\nfrom ...utils import pagination, filter_query_string\\nfrom ...iati.iati_export import IatiXML\\nfrom .utils import apply_keywords, org_projects\\n\\n\\n###############################################################################\\n# Project directory\\n###############################################################################\\n\\n\\ndef _all_projects():\\n \\\"\\\"\\\"Return all active projects.\\\"\\\"\\\"\\n return Project.objects.published().select_related(\\n 'publishingstatus__status',\\n 'sync_owner',\\n 'primary_location',\\n 'primary_location__country'\\n 'locations',\\n 'partnerships',\\n 'partnerships__organisation',\\n 'sectors',\\n 'partners',\\n ).order_by('-id')\\n\\n\\ndef _page_projects(page):\\n \\\"\\\"\\\"Dig out the list of projects to use.\\n\\n First get a list based on page settings (orgs or all projects). Then apply\\n keywords filtering / exclusion.\\n \\\"\\\"\\\"\\n projects = org_projects(page.organisation) if page.partner_projects else _all_projects()\\n return apply_keywords(page, projects)\\n\\n\\ndef _project_directory_coll(request):\\n \\\"\\\"\\\"Dig out and pass correct projects to the view.\\\"\\\"\\\"\\n page = request.rsr_page\\n if not page:\\n return _all_projects()\\n return _page_projects(page)\\n\\n\\ndef directory(request):\\n \\\"\\\"\\\"The project list view.\\\"\\\"\\\"\\n\\n qs = remove_empty_querydict_items(request.GET)\\n\\n # Set show_filters to \\\"in\\\" if any filter is selected\\n show_filters = \\\"in\\\" # To simplify template use bootstrap class\\n available_filters = ['location', 'status', 'organisation', 'sector', 'sort_by']\\n if frozenset(qs.keys()).isdisjoint(available_filters):\\n show_filters = \\\"\\\"\\n\\n # Prepare sorting\\n available_sorting = ['last_modified_at', '-last_modified_at', 'title',\\n '-title', 'budget', '-budget', ]\\n sort_by = request.GET.get('sort_by', '-last_modified_at')\\n sorting = sort_by if sort_by in available_sorting else '-last_modified_at'\\n\\n # Yank project collection\\n all_projects = _project_directory_coll(request)\\n f = ProjectFilter(qs, queryset=all_projects)\\n sorted_projects = f.qs.distinct().order_by(sorting)\\n\\n # Build page\\n page = request.GET.get('page')\\n page, paginator, page_range = pagination(page, sorted_projects, 10)\\n\\n # Get the current org filter for typeahead\\n org_filter = request.GET.get('organisation', '')\\n\\n # Get projects to be displayed on the map\\n map_projects = all_projects if request.rsr_page and request.rsr_page.all_maps else page\\n\\n context = {\\n 'project_count': sorted_projects.count(),\\n 'filter': f,\\n 'page': page,\\n 'page_range': page_range,\\n 'paginator': paginator,\\n 'show_filters': show_filters,\\n 'q': filter_query_string(qs),\\n 'sorting': sorting,\\n 'current_org': org_filter,\\n 'map_projects': map_projects,\\n }\\n return render(request, 'project_directory.html', context)\\n\\n\\n###############################################################################\\n# Project main\\n###############################################################################\\n\\n\\ndef _get_accordion_data(project):\\n accordion_data = dict()\\n accordion_data['background'] = project.background\\n accordion_data['current_status'] = project.current_status\\n accordion_data['project_plan'] = project.project_plan\\n accordion_data['target_group'] = project.target_group\\n accordion_data['sustainability'] = project.sustainability\\n accordion_data['goals_overview'] = project.goals_overview\\n if project.results.all():\\n results_data = []\\n for result in project.results.all():\\n result_data = dict()\\n result_data['id'] = str(result.pk)\\n result_data['title'] = result.title\\n indicators_data = []\\n for indicator in result.indicators.all():\\n for period in indicator.periods.all():\\n indicator_data = dict()\\n indicator_data['id'] = str(period.pk)\\n indicator_data['title'] = indicator.title\\n if period.period_start:\\n indicator_data['period_start'] = period.period_start.strftime(\\\"%d-%m-%Y\\\")\\n if period.period_end:\\n indicator_data['period_end'] = period.period_end.strftime(\\\"%d-%m-%Y\\\")\\n indicator_data['target_value'] = period.target_value\\n indicator_data['actual_value'] = period.actual_value\\n indicators_data.append(indicator_data)\\n if not indicator.periods.all():\\n indicator_data = dict()\\n indicator_data['id'] = str(indicator.pk)\\n indicator_data['title'] = indicator.title\\n indicators_data.append(indicator_data)\\n result_data['indicators'] = indicators_data\\n results_data.append(result_data)\\n accordion_data['results'] = results_data\\n return accordion_data\\n\\n\\ndef _get_timeline_data(project):\\n timeline_data = {'timeline': {'type': 'default'}}\\n timeline_dates = []\\n\\n # Project start and end dates\\n # TODO: fix when no planned start date\\n date_start = (project.date_start_actual, 'Start', 'actual') if project.date_start_actual else \\\\\\n (project.date_start_planned, 'Start', 'planned')\\n date_end = (project.date_end_actual, 'End', 'actual') if project.date_end_actual else \\\\\\n (project.date_end_planned, 'End', 'planned') if project.date_end_planned else None\\n\\n for date in (date_start, date_end):\\n if date:\\n headline = date[1] + \\\" date of project\\\"\\n if not date[2] == 'actual':\\n headline += \\\" (planned)\\\"\\n timeline_dates.append({\\n 'startDate': ','.join((str(date[0].year), str(date[0].month), str(date[0].day))),\\n 'headline': headline,\\n })\\n\\n # Project updates\\n for update in project.updates_desc():\\n date = update.last_modified_at\\n timeline_dates.append({\\n 'startDate': ','.join((str(date.year), str(date.month), str(date.day))),\\n 'headline': 'Project update added',\\n 'text': '<a href=\\\"' + update.get_absolute_url() + '\\\">' + update.title + '</a>',\\n 'asset': {\\n 'thumbnail': update.photo.url if update.photo else None,\\n 'media': update.photo.url if update.photo else None,\\n }\\n })\\n\\n # Donations\\n for donation in Invoice.objects.filter(project=project):\\n date = donation.time\\n timeline_dates.append({\\n 'startDate': ','.join((str(date.year), str(date.month), str(date.day))),\\n 'headline': 'Donation added',\\n 'text': 'by ' + donation.name if donation.name else 'Anonymous',\\n })\\n\\n timeline_data['timeline']['date'] = timeline_dates\\n\\n return timeline_data\\n\\n\\ndef _get_carousel_data(project):\\n photos = []\\n if project.current_image:\\n try:\\n im = get_thumbnail(project.current_image, '750x400', quality=99)\\n photos.append({\\n \\\"url\\\": im.url,\\n \\\"caption\\\": project.current_image_caption,\\n \\\"credit\\\": project.current_image_credit,\\n \\\"original_url\\\": project.current_image.url,\\n })\\n except IOError:\\n pass\\n for update in project.updates_desc():\\n if len(photos) > 9:\\n break\\n if update.photo:\\n try:\\n im = get_thumbnail(update.photo, '750x400', quality=99)\\n photos.append({\\n \\\"url\\\": im.url,\\n \\\"caption\\\": update.photo_caption,\\n \\\"credit\\\": update.photo_credit,\\n \\\"original_url\\\": update.photo.url,\\n })\\n except IOError:\\n continue\\n return {\\\"photos\\\": photos}\\n\\n\\ndef _get_hierarchy_row(max_rows, projects):\\n \\\"\\\"\\\"Return a column for the project hierarchy with a division.\\n\\n E.g. with a max_rows of 4 and one project, it will return [False,\\n <Project>, False, False].\\n \\\"\\\"\\\"\\n project_count = projects.count()\\n if max_rows == project_count:\\n return [project for project in projects]\\n empty_begin = (max_rows - project_count) / 2\\n empty_end = (max_rows - project_count) / 2 + ((max_rows - project_count) % 2)\\n rows = []\\n for row in range(empty_begin):\\n rows.append(False)\\n for project in projects:\\n rows.append(project)\\n for row in range(empty_end):\\n rows.append(False)\\n return rows\\n\\n\\ndef _get_hierarchy_grid(project):\\n parents = project.parents()\\n siblings = project.siblings()\\n children = project.children()\\n\\n # Create the lay-out of the grid\\n max_rows = max(parents.count(), siblings.count() + 1, children.count())\\n parent_rows = _get_hierarchy_row(max_rows, parents)\\n siblings_rows = _get_hierarchy_row(max_rows - 1, siblings)\\n siblings_rows.insert((max_rows - 1) / 2, 'project')\\n children_rows = _get_hierarchy_row(max_rows, children)\\n\\n grid = []\\n project_added = False\\n for row in range(max_rows):\\n grid.append([])\\n grid[row].append([parent_rows[row], 'parent']) if parent_rows[row] else grid[row].append(None)\\n if siblings_rows[row] == 'project':\\n grid[row].append([project, 'project'])\\n project_added = True\\n elif not project_added:\\n grid[row].append([siblings_rows[row], 'sibling-top']) if siblings_rows[row] else grid[row].append(None)\\n else:\\n grid[row].append([siblings_rows[row], 'sibling-bottom']) if siblings_rows[row] else grid[row].append(None)\\n grid[row].append([children_rows[row], 'child']) if children_rows[row] else grid[row].append(None)\\n\\n return grid\\n\\n\\ndef _get_project_partners(project):\\n partners = {}\\n for partner in project.all_partners():\\n partners[partner] = partner.has_partner_types(project)\\n return partners\\n\\n\\ndef main(request, project_id):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, pk=project_id)\\n\\n # Non-editors are not allowed to view unpublished projects\\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\\n raise PermissionDenied\\n\\n carousel_data = _get_carousel_data(project)\\n updates = project.project_updates.all().order_by('-created_at')[:5]\\n accordion_data = _get_accordion_data(project)\\n # timeline_data = _get_timeline_data(project)\\n\\n reporting_org = project.reporting_org()\\n reporting_org_info = (reporting_org, reporting_org.has_partner_types(project))\\n partners = _get_project_partners(project)\\n\\n context = {\\n 'accordion_data': json.dumps(accordion_data),\\n 'carousel_data': json.dumps(carousel_data),\\n 'project': project,\\n # 'timeline_data': json.dumps(timeline_data),\\n 'updates': updates,\\n 'reporting_org': reporting_org_info,\\n 'partners': partners,\\n }\\n\\n return render(request, 'project_main.html', context)\\n\\n\\n###############################################################################\\n# Project hierarchy\\n###############################################################################\\n\\n\\ndef hierarchy(request, project_id):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, pk=project_id)\\n\\n # Non-editors are not allowed to view unpublished projects\\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\\n raise PermissionDenied\\n\\n if not project.has_relations():\\n raise Http404\\n\\n hierarchy_grid = _get_hierarchy_grid(project)\\n\\n context = {\\n 'project': project,\\n 'hierarchy_grid': hierarchy_grid,\\n }\\n\\n return render(request, 'project_hierarchy.html', context)\\n\\n\\n###############################################################################\\n# Project report\\n###############################################################################\\n\\n\\ndef report(request, project_id):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, pk=project_id)\\n\\n # Non-editors are not allowed to view unpublished projects\\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\\n raise PermissionDenied\\n\\n context = {\\n 'project': project,\\n }\\n\\n return render(request, 'project_report.html', context)\\n\\n###############################################################################\\n# Project IATI file\\n###############################################################################\\n\\n\\ndef iati(request, project_id):\\n \\\"\\\"\\\"Generate the IATI file on-the-fly and return the XML.\\\"\\\"\\\"\\n iati_activities = IatiXML(Project.objects.filter(pk=project_id)).iati_activities\\n xml_data = etree.tostring(etree.ElementTree(iati_activities))\\n return HttpResponse(xml_data, content_type=\\\"text/xml\\\")\\n\\n\\n###############################################################################\\n# Project widgets\\n###############################################################################\\n\\n\\ndef widgets(request, project_id):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, pk=project_id)\\n selected_widget = request.GET.get('widget', None)\\n\\n # Non-editors are not allowed to view unpublished projects\\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\\n raise PermissionDenied\\n\\n context = {\\n 'project': project,\\n 'style': 'darkBG',\\n }\\n\\n if selected_widget in ['narrow', 'cobranded', 'small', 'map', 'list']:\\n context['widget'] = selected_widget\\n context['domain_url'] = 'http://' + request.META['HTTP_HOST']\\n return render(request, 'project_widgets2.html', context)\\n\\n else:\\n return render(request, 'project_widgets.html', context)\\n\\n\\n@login_required()\\ndef set_update(request, project_id, edit_mode=False, form_class=ProjectUpdateForm, update_id=None):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, id=project_id)\\n\\n # Non-editors are not allowed to view unpublished projects\\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\\n raise PermissionDenied\\n\\n # Check if user is allowed to place updates for this project\\n allow_update = False\\n if request.user.has_perm('rsr.post_updates', project):\\n allow_update = True\\n\\n updates = project.updates_desc()[:5]\\n update = None\\n\\n if update_id is not None:\\n edit_mode = True\\n update = get_object_or_404(ProjectUpdate, id=update_id)\\n if not request.user == update.user:\\n request.error_message = u'You can only edit your own updates.'\\n raise PermissionDenied\\n\\n if update.edit_window_has_expired():\\n request.error_message = u'You cannot edit this update anymore, the 30 minutes time limit has passed.'\\n raise PermissionDenied\\n\\n if request.method == 'POST':\\n updateform = form_class(request.POST, request.FILES, instance=update)\\n if updateform.is_valid():\\n update = updateform.save(project=project, user=request.user)\\n return redirect(update.get_absolute_url())\\n else:\\n updateform = form_class(instance=update)\\n\\n context = {\\n 'project': project,\\n 'updates': updates,\\n 'update': update,\\n 'updateform': updateform,\\n 'edit_mode': edit_mode,\\n 'allow_update': allow_update\\n }\\n\\n return render(request, 'update_add.html', context)\\n\\n\\ndef search(request):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n context = {'projects': Project.objects.published()}\\n return render(request, 'project_search.html', context)\\n\\ndef partners(request, project_id):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, pk=project_id)\\n partners = _get_project_partners(project)\\n context = {\\n 'project': project,\\n 'partners': partners\\n }\\n return render(request, 'project_partners.html', context)\\n\\n\\ndef finance(request, project_id):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, pk=project_id)\\n context = {\\n 'project': project\\n }\\n return render(request, 'project_finance.html', context)\\n\\n\\ndef donations_disabled(project):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n return not project.donate_button\\n\\n\\ndef can_accept_donations(project):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n if project in Project.objects.active() and project.funds_needed > 0:\\n return True\\n else:\\n return False\\n\\n\\ndef donate(request, project_id):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, pk=project_id)\\n\\n if not project.accepts_donations():\\n raise Http404\\n\\n context = {\\n 'project': project\\n }\\n return render(request, 'project_donate.html', context)\\n\",\n \"path\": \"akvo/rsr/views/project.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"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\nimport json\n\nfrom sorl.thumbnail import get_thumbnail\nfrom django.contrib.auth.decorators import login_required\nfrom django.core.exceptions import PermissionDenied\nfrom django.http import Http404, HttpResponse\nfrom django.shortcuts import get_object_or_404, redirect, render\nfrom lxml import etree\n\nfrom ..forms import ProjectUpdateForm\nfrom ..filters import remove_empty_querydict_items, ProjectFilter\nfrom ..models import Invoice, Project, ProjectUpdate\nfrom ...utils import pagination, filter_query_string\nfrom ...iati.iati_export import IatiXML\nfrom .utils import apply_keywords, org_projects\n\n\n###############################################################################\n# Project directory\n###############################################################################\n\n\ndef _all_projects():\n \"\"\"Return all active projects.\"\"\"\n return Project.objects.published().select_related(\n 'publishingstatus__status',\n 'sync_owner',\n 'primary_location',\n 'primary_location__country'\n 'locations',\n 'partnerships',\n 'partnerships__organisation',\n 'sectors',\n 'partners',\n ).order_by('-id')\n\n\ndef _page_projects(page):\n \"\"\"Dig out the list of projects to use.\n\n First get a list based on page settings (orgs or all projects). Then apply\n keywords filtering / exclusion.\n \"\"\"\n projects = org_projects(page.organisation) if page.partner_projects else _all_projects()\n return apply_keywords(page, projects)\n\n\ndef _project_directory_coll(request):\n \"\"\"Dig out and pass correct projects to the view.\"\"\"\n page = request.rsr_page\n if not page:\n return _all_projects()\n return _page_projects(page)\n\n\ndef directory(request):\n \"\"\"The project list view.\"\"\"\n\n qs = remove_empty_querydict_items(request.GET)\n\n # Set show_filters to \"in\" if any filter is selected\n show_filters = \"in\" # To simplify template use bootstrap class\n available_filters = ['location', 'status', 'organisation', 'sector', 'sort_by']\n if frozenset(qs.keys()).isdisjoint(available_filters):\n show_filters = \"\"\n\n # Prepare sorting\n available_sorting = ['last_modified_at', '-last_modified_at', 'title',\n '-title', 'budget', '-budget', ]\n sort_by = request.GET.get('sort_by', '-last_modified_at')\n sorting = sort_by if sort_by in available_sorting else '-last_modified_at'\n\n # Yank project collection\n all_projects = _project_directory_coll(request)\n f = ProjectFilter(qs, queryset=all_projects)\n sorted_projects = f.qs.distinct().order_by(sorting)\n\n # Build page\n page = request.GET.get('page')\n page, paginator, page_range = pagination(page, sorted_projects, 10)\n\n # Get the current org filter for typeahead\n org_filter = request.GET.get('organisation', '')\n\n # Get projects to be displayed on the map\n map_projects = all_projects if request.rsr_page and request.rsr_page.all_maps else page\n\n context = {\n 'project_count': sorted_projects.count(),\n 'filter': f,\n 'page': page,\n 'page_range': page_range,\n 'paginator': paginator,\n 'show_filters': show_filters,\n 'q': filter_query_string(qs),\n 'sorting': sorting,\n 'current_org': org_filter,\n 'map_projects': map_projects,\n }\n return render(request, 'project_directory.html', context)\n\n\n###############################################################################\n# Project main\n###############################################################################\n\n\ndef _get_accordion_data(project):\n accordion_data = dict()\n accordion_data['background'] = project.background\n accordion_data['current_status'] = project.current_status\n accordion_data['project_plan'] = project.project_plan\n accordion_data['target_group'] = project.target_group\n accordion_data['sustainability'] = project.sustainability\n accordion_data['goals_overview'] = project.goals_overview\n if project.results.all():\n results_data = []\n for result in project.results.all():\n result_data = dict()\n result_data['id'] = str(result.pk)\n result_data['title'] = result.title\n indicators_data = []\n for indicator in result.indicators.all():\n for period in indicator.periods.all():\n indicator_data = dict()\n indicator_data['id'] = str(period.pk)\n indicator_data['title'] = indicator.title\n if period.period_start:\n indicator_data['period_start'] = period.period_start.strftime(\"%d-%m-%Y\")\n if period.period_end:\n indicator_data['period_end'] = period.period_end.strftime(\"%d-%m-%Y\")\n indicator_data['target_value'] = period.target_value\n indicator_data['actual_value'] = period.actual_value\n indicators_data.append(indicator_data)\n if not indicator.periods.all():\n indicator_data = dict()\n indicator_data['id'] = str(indicator.pk)\n indicator_data['title'] = indicator.title\n indicators_data.append(indicator_data)\n result_data['indicators'] = indicators_data\n results_data.append(result_data)\n accordion_data['results'] = results_data\n return accordion_data\n\n\ndef _get_timeline_data(project):\n timeline_data = {'timeline': {'type': 'default'}}\n timeline_dates = []\n\n # Project start and end dates\n # TODO: fix when no planned start date\n date_start = (project.date_start_actual, 'Start', 'actual') if project.date_start_actual else \\\n (project.date_start_planned, 'Start', 'planned')\n date_end = (project.date_end_actual, 'End', 'actual') if project.date_end_actual else \\\n (project.date_end_planned, 'End', 'planned') if project.date_end_planned else None\n\n for date in (date_start, date_end):\n if date:\n headline = date[1] + \" date of project\"\n if not date[2] == 'actual':\n headline += \" (planned)\"\n timeline_dates.append({\n 'startDate': ','.join((str(date[0].year), str(date[0].month), str(date[0].day))),\n 'headline': headline,\n })\n\n # Project updates\n for update in project.updates_desc():\n date = update.last_modified_at\n timeline_dates.append({\n 'startDate': ','.join((str(date.year), str(date.month), str(date.day))),\n 'headline': 'Project update added',\n 'text': '<a href=\"' + update.get_absolute_url() + '\">' + update.title + '</a>',\n 'asset': {\n 'thumbnail': update.photo.url if update.photo else None,\n 'media': update.photo.url if update.photo else None,\n }\n })\n\n # Donations\n for donation in Invoice.objects.filter(project=project):\n date = donation.time\n timeline_dates.append({\n 'startDate': ','.join((str(date.year), str(date.month), str(date.day))),\n 'headline': 'Donation added',\n 'text': 'by ' + donation.name if donation.name else 'Anonymous',\n })\n\n timeline_data['timeline']['date'] = timeline_dates\n\n return timeline_data\n\n\ndef _get_carousel_data(project):\n photos = []\n if project.current_image:\n try:\n im = get_thumbnail(project.current_image, '750x400', quality=99)\n photos.append({\n \"url\": im.url,\n \"caption\": project.current_image_caption,\n \"credit\": project.current_image_credit,\n \"original_url\": project.current_image.url,\n })\n except IOError:\n pass\n for update in project.updates_desc():\n if len(photos) > 9:\n break\n if update.photo:\n try:\n im = get_thumbnail(update.photo, '750x400', quality=99)\n photos.append({\n \"url\": im.url,\n \"caption\": update.photo_caption,\n \"credit\": update.photo_credit,\n \"original_url\": update.photo.url,\n })\n except IOError:\n continue\n return {\"photos\": photos}\n\n\ndef _get_hierarchy_row(max_rows, projects):\n \"\"\"Return a column for the project hierarchy with a division.\n\n E.g. with a max_rows of 4 and one project, it will return [False,\n <Project>, False, False].\n \"\"\"\n project_count = projects.count()\n if max_rows == project_count:\n return [project for project in projects]\n empty_begin = (max_rows - project_count) / 2\n empty_end = (max_rows - project_count) / 2 + ((max_rows - project_count) % 2)\n rows = []\n for row in range(empty_begin):\n rows.append(False)\n for project in projects:\n rows.append(project)\n for row in range(empty_end):\n rows.append(False)\n return rows\n\n\ndef _get_hierarchy_grid(project):\n parents = project.parents()\n siblings = project.siblings()\n children = project.children()\n\n # Create the lay-out of the grid\n max_rows = max(parents.count(), siblings.count() + 1, children.count())\n parent_rows = _get_hierarchy_row(max_rows, parents)\n siblings_rows = _get_hierarchy_row(max_rows - 1, siblings)\n siblings_rows.insert((max_rows - 1) / 2, 'project')\n children_rows = _get_hierarchy_row(max_rows, children)\n\n grid = []\n project_added = False\n for row in range(max_rows):\n grid.append([])\n grid[row].append([parent_rows[row], 'parent']) if parent_rows[row] else grid[row].append(None)\n if siblings_rows[row] == 'project':\n grid[row].append([project, 'project'])\n project_added = True\n elif not project_added:\n grid[row].append([siblings_rows[row], 'sibling-top']) if siblings_rows[row] else grid[row].append(None)\n else:\n grid[row].append([siblings_rows[row], 'sibling-bottom']) if siblings_rows[row] else grid[row].append(None)\n grid[row].append([children_rows[row], 'child']) if children_rows[row] else grid[row].append(None)\n\n return grid\n\n\ndef _get_project_partners(project):\n partners = {}\n for partner in project.all_partners():\n partners[partner] = partner.has_partner_types(project)\n return partners\n\n\ndef main(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n\n # Non-editors are not allowed to view unpublished projects\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\n raise PermissionDenied\n\n carousel_data = _get_carousel_data(project)\n updates = project.project_updates.all().order_by('-created_at')[:5]\n accordion_data = _get_accordion_data(project)\n # timeline_data = _get_timeline_data(project)\n\n reporting_org = project.reporting_org()\n reporting_org_info = (reporting_org, reporting_org.has_partner_types(project))\n partners = _get_project_partners(project)\n\n context = {\n 'accordion_data': json.dumps(accordion_data),\n 'carousel_data': json.dumps(carousel_data),\n 'project': project,\n # 'timeline_data': json.dumps(timeline_data),\n 'updates': updates,\n 'reporting_org': reporting_org_info,\n 'partners': partners,\n }\n\n return render(request, 'project_main.html', context)\n\n\n###############################################################################\n# Project hierarchy\n###############################################################################\n\n\ndef hierarchy(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n\n # Non-editors are not allowed to view unpublished projects\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\n raise PermissionDenied\n\n if not project.has_relations():\n raise Http404\n\n hierarchy_grid = _get_hierarchy_grid(project)\n\n context = {\n 'project': project,\n 'hierarchy_grid': hierarchy_grid,\n }\n\n return render(request, 'project_hierarchy.html', context)\n\n\n###############################################################################\n# Project report\n###############################################################################\n\n\ndef report(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n\n # Non-editors are not allowed to view unpublished projects\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\n raise PermissionDenied\n\n context = {\n 'project': project,\n }\n\n return render(request, 'project_report.html', context)\n\n###############################################################################\n# Project IATI file\n###############################################################################\n\n\ndef iati(request, project_id):\n \"\"\"Generate the IATI file on-the-fly and return the XML.\"\"\"\n iati_activities = IatiXML(Project.objects.filter(pk=project_id)).iati_activities\n xml_data = etree.tostring(etree.ElementTree(iati_activities))\n return HttpResponse(xml_data, content_type=\"text/xml\")\n\n\n###############################################################################\n# Project widgets\n###############################################################################\n\n\ndef widgets(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n selected_widget = request.GET.get('widget', None)\n\n # Non-editors are not allowed to view unpublished projects\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\n raise PermissionDenied\n\n context = {\n 'project': project,\n 'style': 'darkBG',\n }\n\n if selected_widget in ['narrow', 'cobranded', 'small', 'map', 'list']:\n context['widget'] = selected_widget\n context['domain_url'] = 'http://' + request.META['HTTP_HOST']\n return render(request, 'project_widgets2.html', context)\n\n else:\n return render(request, 'project_widgets.html', context)\n\n\n@login_required()\ndef set_update(request, project_id, edit_mode=False, form_class=ProjectUpdateForm, update_id=None):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, id=project_id)\n\n # Non-editors are not allowed to view unpublished projects\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\n raise PermissionDenied\n\n # Check if user is allowed to place updates for this project\n allow_update = False\n if request.user.has_perm('rsr.post_updates', project):\n allow_update = True\n\n updates = project.updates_desc()[:5]\n update = None\n\n if update_id is not None:\n edit_mode = True\n update = get_object_or_404(ProjectUpdate, id=update_id)\n if not request.user == update.user:\n request.error_message = u'You can only edit your own updates.'\n raise PermissionDenied\n\n if update.edit_window_has_expired():\n request.error_message = u'You cannot edit this update anymore, the 30 minutes time limit has passed.'\n raise PermissionDenied\n\n if request.method == 'POST':\n updateform = form_class(request.POST, request.FILES, instance=update)\n if updateform.is_valid():\n update = updateform.save(project=project, user=request.user)\n return redirect(update.get_absolute_url())\n else:\n updateform = form_class(instance=update)\n\n context = {\n 'project': project,\n 'updates': updates,\n 'update': update,\n 'updateform': updateform,\n 'edit_mode': edit_mode,\n 'allow_update': allow_update\n }\n\n return render(request, 'update_add.html', context)\n\n\ndef search(request):\n \"\"\".\"\"\"\n context = {'projects': Project.objects.published()}\n return render(request, 'project_search.html', context)\n\ndef partners(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n partners = _get_project_partners(project)\n context = {\n 'project': project,\n 'partners': partners\n }\n return render(request, 'project_partners.html', context)\n\n\ndef finance(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n pledged = project.get_pledged()\n context = {\n 'project': project,\n 'pledged': pledged,\n }\n return render(request, 'project_finance.html', context)\n\n\ndef donations_disabled(project):\n \"\"\".\"\"\"\n return not project.donate_button\n\n\ndef can_accept_donations(project):\n \"\"\".\"\"\"\n if project in Project.objects.active() and project.funds_needed > 0:\n return True\n else:\n return False\n\n\ndef donate(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n\n if not project.accepts_donations():\n raise Http404\n\n context = {\n 'project': project\n }\n return render(request, 'project_donate.html', context)\n","path":"akvo/rsr/views/project.py"}],"string":"[\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\\nimport json\\n\\nfrom sorl.thumbnail import get_thumbnail\\nfrom django.contrib.auth.decorators import login_required\\nfrom django.core.exceptions import PermissionDenied\\nfrom django.http import Http404, HttpResponse\\nfrom django.shortcuts import get_object_or_404, redirect, render\\nfrom lxml import etree\\n\\nfrom ..forms import ProjectUpdateForm\\nfrom ..filters import remove_empty_querydict_items, ProjectFilter\\nfrom ..models import Invoice, Project, ProjectUpdate\\nfrom ...utils import pagination, filter_query_string\\nfrom ...iati.iati_export import IatiXML\\nfrom .utils import apply_keywords, org_projects\\n\\n\\n###############################################################################\\n# Project directory\\n###############################################################################\\n\\n\\ndef _all_projects():\\n \\\"\\\"\\\"Return all active projects.\\\"\\\"\\\"\\n return Project.objects.published().select_related(\\n 'publishingstatus__status',\\n 'sync_owner',\\n 'primary_location',\\n 'primary_location__country'\\n 'locations',\\n 'partnerships',\\n 'partnerships__organisation',\\n 'sectors',\\n 'partners',\\n ).order_by('-id')\\n\\n\\ndef _page_projects(page):\\n \\\"\\\"\\\"Dig out the list of projects to use.\\n\\n First get a list based on page settings (orgs or all projects). Then apply\\n keywords filtering / exclusion.\\n \\\"\\\"\\\"\\n projects = org_projects(page.organisation) if page.partner_projects else _all_projects()\\n return apply_keywords(page, projects)\\n\\n\\ndef _project_directory_coll(request):\\n \\\"\\\"\\\"Dig out and pass correct projects to the view.\\\"\\\"\\\"\\n page = request.rsr_page\\n if not page:\\n return _all_projects()\\n return _page_projects(page)\\n\\n\\ndef directory(request):\\n \\\"\\\"\\\"The project list view.\\\"\\\"\\\"\\n\\n qs = remove_empty_querydict_items(request.GET)\\n\\n # Set show_filters to \\\"in\\\" if any filter is selected\\n show_filters = \\\"in\\\" # To simplify template use bootstrap class\\n available_filters = ['location', 'status', 'organisation', 'sector', 'sort_by']\\n if frozenset(qs.keys()).isdisjoint(available_filters):\\n show_filters = \\\"\\\"\\n\\n # Prepare sorting\\n available_sorting = ['last_modified_at', '-last_modified_at', 'title',\\n '-title', 'budget', '-budget', ]\\n sort_by = request.GET.get('sort_by', '-last_modified_at')\\n sorting = sort_by if sort_by in available_sorting else '-last_modified_at'\\n\\n # Yank project collection\\n all_projects = _project_directory_coll(request)\\n f = ProjectFilter(qs, queryset=all_projects)\\n sorted_projects = f.qs.distinct().order_by(sorting)\\n\\n # Build page\\n page = request.GET.get('page')\\n page, paginator, page_range = pagination(page, sorted_projects, 10)\\n\\n # Get the current org filter for typeahead\\n org_filter = request.GET.get('organisation', '')\\n\\n # Get projects to be displayed on the map\\n map_projects = all_projects if request.rsr_page and request.rsr_page.all_maps else page\\n\\n context = {\\n 'project_count': sorted_projects.count(),\\n 'filter': f,\\n 'page': page,\\n 'page_range': page_range,\\n 'paginator': paginator,\\n 'show_filters': show_filters,\\n 'q': filter_query_string(qs),\\n 'sorting': sorting,\\n 'current_org': org_filter,\\n 'map_projects': map_projects,\\n }\\n return render(request, 'project_directory.html', context)\\n\\n\\n###############################################################################\\n# Project main\\n###############################################################################\\n\\n\\ndef _get_accordion_data(project):\\n accordion_data = dict()\\n accordion_data['background'] = project.background\\n accordion_data['current_status'] = project.current_status\\n accordion_data['project_plan'] = project.project_plan\\n accordion_data['target_group'] = project.target_group\\n accordion_data['sustainability'] = project.sustainability\\n accordion_data['goals_overview'] = project.goals_overview\\n if project.results.all():\\n results_data = []\\n for result in project.results.all():\\n result_data = dict()\\n result_data['id'] = str(result.pk)\\n result_data['title'] = result.title\\n indicators_data = []\\n for indicator in result.indicators.all():\\n for period in indicator.periods.all():\\n indicator_data = dict()\\n indicator_data['id'] = str(period.pk)\\n indicator_data['title'] = indicator.title\\n if period.period_start:\\n indicator_data['period_start'] = period.period_start.strftime(\\\"%d-%m-%Y\\\")\\n if period.period_end:\\n indicator_data['period_end'] = period.period_end.strftime(\\\"%d-%m-%Y\\\")\\n indicator_data['target_value'] = period.target_value\\n indicator_data['actual_value'] = period.actual_value\\n indicators_data.append(indicator_data)\\n if not indicator.periods.all():\\n indicator_data = dict()\\n indicator_data['id'] = str(indicator.pk)\\n indicator_data['title'] = indicator.title\\n indicators_data.append(indicator_data)\\n result_data['indicators'] = indicators_data\\n results_data.append(result_data)\\n accordion_data['results'] = results_data\\n return accordion_data\\n\\n\\ndef _get_timeline_data(project):\\n timeline_data = {'timeline': {'type': 'default'}}\\n timeline_dates = []\\n\\n # Project start and end dates\\n # TODO: fix when no planned start date\\n date_start = (project.date_start_actual, 'Start', 'actual') if project.date_start_actual else \\\\\\n (project.date_start_planned, 'Start', 'planned')\\n date_end = (project.date_end_actual, 'End', 'actual') if project.date_end_actual else \\\\\\n (project.date_end_planned, 'End', 'planned') if project.date_end_planned else None\\n\\n for date in (date_start, date_end):\\n if date:\\n headline = date[1] + \\\" date of project\\\"\\n if not date[2] == 'actual':\\n headline += \\\" (planned)\\\"\\n timeline_dates.append({\\n 'startDate': ','.join((str(date[0].year), str(date[0].month), str(date[0].day))),\\n 'headline': headline,\\n })\\n\\n # Project updates\\n for update in project.updates_desc():\\n date = update.last_modified_at\\n timeline_dates.append({\\n 'startDate': ','.join((str(date.year), str(date.month), str(date.day))),\\n 'headline': 'Project update added',\\n 'text': '<a href=\\\"' + update.get_absolute_url() + '\\\">' + update.title + '</a>',\\n 'asset': {\\n 'thumbnail': update.photo.url if update.photo else None,\\n 'media': update.photo.url if update.photo else None,\\n }\\n })\\n\\n # Donations\\n for donation in Invoice.objects.filter(project=project):\\n date = donation.time\\n timeline_dates.append({\\n 'startDate': ','.join((str(date.year), str(date.month), str(date.day))),\\n 'headline': 'Donation added',\\n 'text': 'by ' + donation.name if donation.name else 'Anonymous',\\n })\\n\\n timeline_data['timeline']['date'] = timeline_dates\\n\\n return timeline_data\\n\\n\\ndef _get_carousel_data(project):\\n photos = []\\n if project.current_image:\\n try:\\n im = get_thumbnail(project.current_image, '750x400', quality=99)\\n photos.append({\\n \\\"url\\\": im.url,\\n \\\"caption\\\": project.current_image_caption,\\n \\\"credit\\\": project.current_image_credit,\\n \\\"original_url\\\": project.current_image.url,\\n })\\n except IOError:\\n pass\\n for update in project.updates_desc():\\n if len(photos) > 9:\\n break\\n if update.photo:\\n try:\\n im = get_thumbnail(update.photo, '750x400', quality=99)\\n photos.append({\\n \\\"url\\\": im.url,\\n \\\"caption\\\": update.photo_caption,\\n \\\"credit\\\": update.photo_credit,\\n \\\"original_url\\\": update.photo.url,\\n })\\n except IOError:\\n continue\\n return {\\\"photos\\\": photos}\\n\\n\\ndef _get_hierarchy_row(max_rows, projects):\\n \\\"\\\"\\\"Return a column for the project hierarchy with a division.\\n\\n E.g. with a max_rows of 4 and one project, it will return [False,\\n <Project>, False, False].\\n \\\"\\\"\\\"\\n project_count = projects.count()\\n if max_rows == project_count:\\n return [project for project in projects]\\n empty_begin = (max_rows - project_count) / 2\\n empty_end = (max_rows - project_count) / 2 + ((max_rows - project_count) % 2)\\n rows = []\\n for row in range(empty_begin):\\n rows.append(False)\\n for project in projects:\\n rows.append(project)\\n for row in range(empty_end):\\n rows.append(False)\\n return rows\\n\\n\\ndef _get_hierarchy_grid(project):\\n parents = project.parents()\\n siblings = project.siblings()\\n children = project.children()\\n\\n # Create the lay-out of the grid\\n max_rows = max(parents.count(), siblings.count() + 1, children.count())\\n parent_rows = _get_hierarchy_row(max_rows, parents)\\n siblings_rows = _get_hierarchy_row(max_rows - 1, siblings)\\n siblings_rows.insert((max_rows - 1) / 2, 'project')\\n children_rows = _get_hierarchy_row(max_rows, children)\\n\\n grid = []\\n project_added = False\\n for row in range(max_rows):\\n grid.append([])\\n grid[row].append([parent_rows[row], 'parent']) if parent_rows[row] else grid[row].append(None)\\n if siblings_rows[row] == 'project':\\n grid[row].append([project, 'project'])\\n project_added = True\\n elif not project_added:\\n grid[row].append([siblings_rows[row], 'sibling-top']) if siblings_rows[row] else grid[row].append(None)\\n else:\\n grid[row].append([siblings_rows[row], 'sibling-bottom']) if siblings_rows[row] else grid[row].append(None)\\n grid[row].append([children_rows[row], 'child']) if children_rows[row] else grid[row].append(None)\\n\\n return grid\\n\\n\\ndef _get_project_partners(project):\\n partners = {}\\n for partner in project.all_partners():\\n partners[partner] = partner.has_partner_types(project)\\n return partners\\n\\n\\ndef main(request, project_id):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, pk=project_id)\\n\\n # Non-editors are not allowed to view unpublished projects\\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\\n raise PermissionDenied\\n\\n carousel_data = _get_carousel_data(project)\\n updates = project.project_updates.all().order_by('-created_at')[:5]\\n accordion_data = _get_accordion_data(project)\\n # timeline_data = _get_timeline_data(project)\\n\\n reporting_org = project.reporting_org()\\n reporting_org_info = (reporting_org, reporting_org.has_partner_types(project))\\n partners = _get_project_partners(project)\\n\\n context = {\\n 'accordion_data': json.dumps(accordion_data),\\n 'carousel_data': json.dumps(carousel_data),\\n 'project': project,\\n # 'timeline_data': json.dumps(timeline_data),\\n 'updates': updates,\\n 'reporting_org': reporting_org_info,\\n 'partners': partners,\\n }\\n\\n return render(request, 'project_main.html', context)\\n\\n\\n###############################################################################\\n# Project hierarchy\\n###############################################################################\\n\\n\\ndef hierarchy(request, project_id):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, pk=project_id)\\n\\n # Non-editors are not allowed to view unpublished projects\\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\\n raise PermissionDenied\\n\\n if not project.has_relations():\\n raise Http404\\n\\n hierarchy_grid = _get_hierarchy_grid(project)\\n\\n context = {\\n 'project': project,\\n 'hierarchy_grid': hierarchy_grid,\\n }\\n\\n return render(request, 'project_hierarchy.html', context)\\n\\n\\n###############################################################################\\n# Project report\\n###############################################################################\\n\\n\\ndef report(request, project_id):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, pk=project_id)\\n\\n # Non-editors are not allowed to view unpublished projects\\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\\n raise PermissionDenied\\n\\n context = {\\n 'project': project,\\n }\\n\\n return render(request, 'project_report.html', context)\\n\\n###############################################################################\\n# Project IATI file\\n###############################################################################\\n\\n\\ndef iati(request, project_id):\\n \\\"\\\"\\\"Generate the IATI file on-the-fly and return the XML.\\\"\\\"\\\"\\n iati_activities = IatiXML(Project.objects.filter(pk=project_id)).iati_activities\\n xml_data = etree.tostring(etree.ElementTree(iati_activities))\\n return HttpResponse(xml_data, content_type=\\\"text/xml\\\")\\n\\n\\n###############################################################################\\n# Project widgets\\n###############################################################################\\n\\n\\ndef widgets(request, project_id):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, pk=project_id)\\n selected_widget = request.GET.get('widget', None)\\n\\n # Non-editors are not allowed to view unpublished projects\\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\\n raise PermissionDenied\\n\\n context = {\\n 'project': project,\\n 'style': 'darkBG',\\n }\\n\\n if selected_widget in ['narrow', 'cobranded', 'small', 'map', 'list']:\\n context['widget'] = selected_widget\\n context['domain_url'] = 'http://' + request.META['HTTP_HOST']\\n return render(request, 'project_widgets2.html', context)\\n\\n else:\\n return render(request, 'project_widgets.html', context)\\n\\n\\n@login_required()\\ndef set_update(request, project_id, edit_mode=False, form_class=ProjectUpdateForm, update_id=None):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, id=project_id)\\n\\n # Non-editors are not allowed to view unpublished projects\\n if not project.is_published() and not request.user.has_perm('rsr.change_project', project):\\n raise PermissionDenied\\n\\n # Check if user is allowed to place updates for this project\\n allow_update = False\\n if request.user.has_perm('rsr.post_updates', project):\\n allow_update = True\\n\\n updates = project.updates_desc()[:5]\\n update = None\\n\\n if update_id is not None:\\n edit_mode = True\\n update = get_object_or_404(ProjectUpdate, id=update_id)\\n if not request.user == update.user:\\n request.error_message = u'You can only edit your own updates.'\\n raise PermissionDenied\\n\\n if update.edit_window_has_expired():\\n request.error_message = u'You cannot edit this update anymore, the 30 minutes time limit has passed.'\\n raise PermissionDenied\\n\\n if request.method == 'POST':\\n updateform = form_class(request.POST, request.FILES, instance=update)\\n if updateform.is_valid():\\n update = updateform.save(project=project, user=request.user)\\n return redirect(update.get_absolute_url())\\n else:\\n updateform = form_class(instance=update)\\n\\n context = {\\n 'project': project,\\n 'updates': updates,\\n 'update': update,\\n 'updateform': updateform,\\n 'edit_mode': edit_mode,\\n 'allow_update': allow_update\\n }\\n\\n return render(request, 'update_add.html', context)\\n\\n\\ndef search(request):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n context = {'projects': Project.objects.published()}\\n return render(request, 'project_search.html', context)\\n\\ndef partners(request, project_id):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, pk=project_id)\\n partners = _get_project_partners(project)\\n context = {\\n 'project': project,\\n 'partners': partners\\n }\\n return render(request, 'project_partners.html', context)\\n\\n\\ndef finance(request, project_id):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, pk=project_id)\\n pledged = project.get_pledged()\\n context = {\\n 'project': project,\\n 'pledged': pledged,\\n }\\n return render(request, 'project_finance.html', context)\\n\\n\\ndef donations_disabled(project):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n return not project.donate_button\\n\\n\\ndef can_accept_donations(project):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n if project in Project.objects.active() and project.funds_needed > 0:\\n return True\\n else:\\n return False\\n\\n\\ndef donate(request, project_id):\\n \\\"\\\"\\\".\\\"\\\"\\\"\\n project = get_object_or_404(Project, pk=project_id)\\n\\n if not project.accepts_donations():\\n raise Http404\\n\\n context = {\\n 'project': project\\n }\\n return render(request, 'project_donate.html', context)\\n\",\n \"path\": \"akvo/rsr/views/project.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/akvo/rsr/static/styles-src/main.css b/akvo/rsr/static/styles-src/main.css\nindex 13790a3d7a..8d3b279cb2 100755\n--- a/akvo/rsr/static/styles-src/main.css\n+++ b/akvo/rsr/static/styles-src/main.css\n@@ -533,6 +533,14 @@ nav.navbar-fixed-top {\n background: rgba(32, 32, 36, 0.1) !important; }\n .myProjectList tbody tr.isPublished {\n background: white !important; }\n+@media only screen and (min-width: 1200px) {\n+ .myProjectList div.twoColumns.clearfix {\n+ min-width: 170px; } }\n+.myProjectList div.twoColumns.clearfix > a {\n+ min-width: 70px; }\n+\n+div.paginationWrap {\n+ clear: both; }\n \n #profile .usrAvatar {\n background-color: rgba(32, 32, 36, 0);\n@@ -1489,6 +1497,10 @@ div.textBlock {\n margin-bottom: 1em; } }\n \n /* Financial details page */\n+section.projectFinancial .currentFunders dl > dd {\n+ text-align: right; }\n+section.projectFinancial .donationBreak {\n+ display: none; }\n @media only screen and (max-width: 768px) {\n section.projectFinancial {\n width: 95%;\n@@ -1500,7 +1512,14 @@ div.textBlock {\n @media only screen and (max-width: 992px) {\n @media only screen and (min-width: 768px) {\n section.projectFinancial .dl-horizontal dt {\n- width: initial; } } }\n+ width: initial; }\n+ section.projectFinancial .donationBreak {\n+ display: initial;\n+ clear: both; }\n+ section.projectFinancial .currentFunders dd.donation {\n+ float: right; }\n+ section.projectFinancial .currentFunders dt.donation {\n+ clear: both; } } }\n \n /* Project Partners details page */\n section.projectPartners .title {\n@@ -1556,6 +1575,28 @@ section.projectPartners .row {\n dd.currencyAmount {\n margin-left: auto; }\n \n+/* Project report page */\n+@media only screen and (max-width: 768px) {\n+ .projectReport {\n+ max-width: 95%;\n+ margin-left: auto;\n+ margin-right: auto; } }\n+@media only screen and (min-width: 992px) {\n+ .projectReport table {\n+ table-layout: fixed; }\n+ .projectReport table th {\n+ word-break: break-word; }\n+ @media only screen and (max-width: 1200px) {\n+ .projectReport table th {\n+ width: 90px; } }\n+ @media only screen and (min-width: 1200px) {\n+ .projectReport table th {\n+ width: 120px; } } }\n+\n+/* Project update page */\n+.updateText {\n+ white-space: pre-line; }\n+\n /* Cookie */\n #cookie-law {\n position: fixed;\ndiff --git a/akvo/rsr/static/styles-src/main.scss b/akvo/rsr/static/styles-src/main.scss\nindex 1d1a94fc39..dd55cdcf30 100755\n--- a/akvo/rsr/static/styles-src/main.scss\n+++ b/akvo/rsr/static/styles-src/main.scss\n@@ -480,7 +480,7 @@ nav.navbar-fixed-top {\n .navbar-collapse {\n &.in {\n /* Allow language dropdown menu to extend the height of the nav container.\n- Otherwise, we get a scrollbar in the nav area on small screens */ \n+ Otherwise, we get a scrollbar in the nav area on small screens */\n @include responsive(small-max-screens) {\n overflow-y: initial;\n }\n@@ -596,6 +596,18 @@ nav.navbar-fixed-top {\n }\n }\n }\n+ div.twoColumns.clearfix {\n+ @media only screen and (min-width: $width-large) {\n+ min-width: 170px;\n+ }\n+ > a {\n+ min-width: 70px;\n+ }\n+ }\n+}\n+\n+div.paginationWrap {\n+ clear: both;\n }\n \n #profile {\n@@ -1848,6 +1860,16 @@ div.textBlock {\n /* Financial details page */\n \n section.projectFinancial {\n+ .currentFunders {\n+ dl {\n+ > dd {\n+ text-align: right;\n+ }\n+ }\n+ }\n+ .donationBreak {\n+ display: none;\n+ }\n @include responsive(small-max-screens) {\n width: 95%;\n max-width: 450px;\n@@ -1867,6 +1889,22 @@ section.projectFinancial {\n width: initial;\n }\n }\n+ .donationBreak {\n+ display: initial;\n+ clear: both;\n+ }\n+ .currentFunders {\n+ dd {\n+ &.donation {\n+ float: right;\n+ }\n+ }\n+ dt {\n+ &.donation {\n+ clear: both;\n+ }\n+ }\n+ }\n }\n }\n }\n@@ -1948,6 +1986,37 @@ dd {\n }\n }\n \n+/* Project report page */\n+\n+.projectReport {\n+ @include responsive(small-max-screens) {\n+ max-width: 95%;\n+ margin-left: auto;\n+ margin-right: auto;\n+ }\n+\n+ @media only screen and (min-width: $width-medium) {\n+ table {\n+ table-layout: fixed;\n+ th {\n+ @media only screen and (max-width: $width-large) {\n+ width: 90px;\n+ }\n+ @media only screen and (min-width: $width-large) {\n+ width: 120px;\n+ }\n+ word-break: break-word;\n+ }\n+ }\n+ }\n+}\n+\n+/* Project update page */\n+\n+.updateText {\n+ white-space: pre-line;\n+}\n+\n /* Cookie */\n \n #cookie-law {\ndiff --git a/akvo/rsr/views/project.py b/akvo/rsr/views/project.py\nindex f25da9e7ba..4c047e614a 100644\n--- a/akvo/rsr/views/project.py\n+++ b/akvo/rsr/views/project.py\n@@ -469,8 +469,10 @@ def partners(request, project_id):\n def finance(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n+ pledged = project.get_pledged()\n context = {\n- 'project': project\n+ 'project': project,\n+ 'pledged': pledged,\n }\n return render(request, 'project_finance.html', context)\n \ndiff --git a/akvo/templates/myrsr/my_iati.html b/akvo/templates/myrsr/my_iati.html\nindex 4c6c931b8e..38b2ee0ccc 100644\n--- a/akvo/templates/myrsr/my_iati.html\n+++ b/akvo/templates/myrsr/my_iati.html\n@@ -25,7 +25,7 @@ <h3>{% trans \"My IATI\" %}{% if selected_org %} {% trans \"for\" %} {{selected_org.\n {% trans 'When the IATI file is generated, it will be shown in the overview on the right.' %}\n </div>\n {% endif %}\n- {% trans 'On this page it is possible to export an IATI file of the projects of your organisation or view previously exported files. ' %}\n+ {% trans 'IATI stands for International Aid Transparency Initiative, which is a global reporting standard that makes it possible to compare and compile data sets from different projects and organisations. On this page it is possible to export an IATI file of the projects of your organisation or view previously exported files.' %}\n {% if not selected_org %}\n {% trans 'Since your account is connected to multiple organisations, please select an organisation first.' %}\n <p>\ndiff --git a/akvo/templates/organisation_directory.html b/akvo/templates/organisation_directory.html\nindex 46ca1c5508..3c65a02164 100644\n--- a/akvo/templates/organisation_directory.html\n+++ b/akvo/templates/organisation_directory.html\n@@ -17,7 +17,7 @@\n <div class=\"input-group\">\n {% bootstrap_field filter.form.name field_class='search-query' show_label=False %}\n <span class=\"input-group-btn\">\n- <button class=\"btn btn-primary\" type=\"submit\">{% trans \"Update list\" %} ›</button>\n+ <button class=\"btn btn-primary\" type=\"submit\">{% trans \"Search\" %} ›</button>\n </span>\n </div>\n <a class=\"btn showFilters menu-toggle\"><i class=\"fa fa-toggle-off\"></i> {% trans 'Advanced filters' %}</a>\ndiff --git a/akvo/templates/project_directory.html b/akvo/templates/project_directory.html\nindex c8e355ce88..67e5296e71 100644\n--- a/akvo/templates/project_directory.html\n+++ b/akvo/templates/project_directory.html\n@@ -15,7 +15,7 @@\n <div class=\"input-group\">\n {% bootstrap_field filter.form.title field_class='search-query' show_label=False %}\n <span class=\"input-group-btn\">\n- <button class=\"btn btn-primary\" type=\"submit\">{% trans \"Update list\" %} ›</button>\n+ <button class=\"btn btn-primary\" type=\"submit\">{% trans \"Search\" %} ›</button>\n </span>\n </div>\n <a class=\"btn showFilters menu-toggle\"><i class=\"fa fa-toggle-off\"></i> {% trans 'Advanced filters' %}</a>\ndiff --git a/akvo/templates/project_finance.html b/akvo/templates/project_finance.html\nindex 4ff480781d..4d8906d8a8 100644\n--- a/akvo/templates/project_finance.html\n+++ b/akvo/templates/project_finance.html\n@@ -11,58 +11,64 @@\n \t <div class=\"container\">\n \t \t<div class=\"row verticalPadding\">\n <div class=\"col-sm-4\">\n- <h4 class=\"\">{% trans \"Project financial details\" %}:</h4>\n+ <h4 class=\"\">{% trans \"Project budget\" %}:</h4>\n <dl class=\"dl-horizontal\">\n {% for budget_item in project.budget_items.all %}\n {% if 'other' in budget_item.label.label and budget_item.other_extra %}\n- <dt>{{budget_item.other_extra}}:</dt><dd class=\"currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{budget_item.amount|floatformat:2|intcomma}}</dd>\n+ <dt>{{budget_item.other_extra}}:</dt><dd class=\"currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{budget_item.amount|floatformat:0|intcomma}}</dd>\n {% else %}\n- <dt>{{budget_item.label.label}}:</dt><dd class=\"currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{budget_item.amount|floatformat:2|intcomma}}</dd>\n+ <dt>{{budget_item.label.label}}:</dt><dd class=\"currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{budget_item.amount|floatformat:0|intcomma}}</dd>\n {% endif %}\n {% endfor %}\n- <dt class=\"totalFinance\">{% trans \"Total\" %}:</dt><dd class=\"totalFinance currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{project.budget|floatformat:2|intcomma}}</dd>\n+ <dt class=\"totalFinance\">{% trans \"Total\" %}:</dt><dd class=\"totalFinance currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{project.budget|floatformat:0|intcomma}}</dd>\n </dl>\n </div>\n- <div class=\"col-sm-4\">\n- <h4 class=\"\">{% trans \"Project funding\" %}:</h4>\n- <dl class=\"dl-horizontal\">\n- <dt>{% trans \"Budget\" %}:</dt><dd class=\"currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{project.budget|floatformat:2|intcomma}}</dd>\n- <dt>{% trans \"Funded\" %}:</dt><dd class=\"currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{project.funds|floatformat:2|intcomma}}</dd>\n- <dt class=\"totalFinance\">{% trans \"Funds needed\" %}:</dt><dd class=\"totalFinance currencyAmount\"><span class=\"currency\"> {{project.get_currency_display}}</span>{{project.funds_needed|floatformat:2|intcomma}}</dd>\n- </dl>\n- </div>\n- <div class=\"col-sm-4\">\n+ <div class=\"col-sm-4 currentFunders\">\n <h4 class=\"\">{% trans \"Current funders\" %}:</h4>\n {% for partnership in project.funding_partnerships %}\n <dl class=\"dl-horizontal\">\n <dt><a href=\"{% url 'organisation-main' partnership.organisation.pk %}\">{% img partnership.organisation 80 60 partnership.organisation.name %}</a></dt>\n <dd>\n- <a href=\"{% url 'organisation-main' partnership.organisation.pk %}\">{{partnership.organisation}}</a>\n- {% if partnership.funding_amount %}\n- <br><span class=\"currency\">{{project.get_currency_display}}</span>{{partnership.funding_amount|floatformat:2|intcomma}}\n- {% endif %}\n+ <a href=\"{% url 'organisation-main' partnership.organisation.pk %}\">{{partnership.organisation}}</a>{% if partnership.funding_amount %}<br><span class=\"currency\">{{project.get_currency_display}}</span>{{partnership.funding_amount|floatformat:0|intcomma}}{% endif %}\n </dd>\n+ {% if pledged %}\n+ <dt class=\"totalFinance\">{% trans \"Total\" %}:</dt><dd class=\"totalFinance currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{pledged|floatformat:0|intcomma}}</dd>\n+ {% endif %}\n </dl>\n {% endfor %}\n <h4>{% trans \"Donations\" %}:</h4>\n <dl class=\"dl-horizontal\">\n {% for donation in project.all_donations %}\n- <dt>{% if donation.is_anonymous %}{% trans \"Anonymous\" %}{% else %}{{donation.name}}{% endif %}:</dt><dd class=\"currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{donation.amount_received|floatformat:2|intcomma}}</dd>\n+ <dt class=\"donation\">{% if donation.is_anonymous %}{% trans \"Anonymous\" %}{% else %}{{donation.name}}{% endif %}:</dt><br class=\"donationBreak\"><dd class=\"currencyAmount donation\"><span class=\"currency\"> ({% trans \"excl. fee\" %}: {{project.get_currency_display}}</span>{{donation.donation_fee|floatformat:0|intcomma}}) <span class=\"currency\">{{project.get_currency_display}}</span>{{donation.amount_received|floatformat:0|intcomma}}</dd>\n {% empty %}\n <dt>{% trans \"No donations\" %}</dt><dd></dd>\n {% endfor %}\n {% if project.all_donations %}\n- <dt class=\"totalFinance\">{% trans \"Total\" %}:</dt><dd class=\"totalFinance currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{project.all_donations_amount_received|floatformat:2|intcomma}}</dd>\n+ <dt class=\"totalFinance\">{% trans \"Total\" %}:</dt><dd class=\"totalFinance currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{project.all_donations_amount_received|floatformat:0|intcomma}}</dd>\n {% endif %}\n </dl>\n </div>\n+ <div class=\"col-sm-4\">\n+ <h4 class=\"\">{% trans \"Project funding\" %}:</h4>\n+ <dl class=\"dl-horizontal\">\n+ <dt>{% trans \"Current funders\" %}:</dt><dd class=\"currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{% if pledged %}{{pledged|floatformat:0|intcomma}}{% else %}0{% endif %}</dd>\n+ <dt>{% trans \"Donations\" %}:</dt><dd class=\"currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{% if project.all_donations_amount_received %}{{project.all_donations_amount_received|floatformat:0|intcomma}}{% else %}0{% endif %}</dd>\n+ <hr>\n+ <dt>{% trans \"Total funded\" %}:</dt><dd class=\"currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{project.funds|floatformat:0|intcomma}}</dd>\n+ <dt>{% trans \"Project budget\" %}:</dt><dd class=\"currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{project.budget|floatformat:0|intcomma}}</dd> \n+ <dt class=\"totalFinance\">{% trans \"Funds needed\" %}:</dt>\n+ <dd class=\"totalFinance currencyAmount\">\n+ <span class=\"currency\"> {{project.get_currency_display}}</span>{% if project.funds_needed >= 0 %}{{project.funds_needed|floatformat:0|intcomma}}{% else %}0{% endif %}\n+ </dd>\n+ </dl>\n+ </div> \n \t\t\t</div>\n \t\t\t<div class=\"row verticalPadding\">\n \t \t\t<h4 class=\"\">{% trans \"Project transactions\" %}:</h4>\n {% if project.transactions.all %}\n <dl class=\"dl-horizontal\">\n {% for transaction in project.transactions.all %}\n- <dt>{% if transaction.description %}{{transaction.description}}{% else %}{{transaction.iati_transaction_type}}{% endif %}:</dt><dd class=\"currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{transaction.value|floatformat:2|intcomma}}</dd>\n+ <dt>{% if transaction.description %}{{transaction.description}}{% else %}{{transaction.iati_transaction_type}}{% endif %}:</dt><dd class=\"currencyAmount\"><span class=\"currency\">{{project.get_currency_display}}</span>{{transaction.value|floatformat:0|intcomma}}</dd>\n {% endfor %}\n </dl>\n {% else %}\ndiff --git a/akvo/templates/project_main.html b/akvo/templates/project_main.html\nindex c694cde2ff..2c4de9260d 100644\n--- a/akvo/templates/project_main.html\n+++ b/akvo/templates/project_main.html\n@@ -1,6 +1,6 @@\n {% extends \"base.html\" %}\n {% load compressed i18n rsr_utils %}\n-{% load rsr_filters %}\n+{% load rsr_filters humanize %}\n {% block title %}{{project.title}}{% endblock title%}\n {% block head_js %}\n <link rel=\"stylesheet\" type=\"text/css\" href=\"http://cdn.knightlab.com/libs/timeline/latest/css/timeline.css\">\n@@ -71,7 +71,8 @@\n {% if project.accepts_donations %}\n <li class=\"donateSection text-center topMargin\">\n <dl class=\"dl-horizontal\">\n- <dt class=\"totalBudgetLabel\">{% trans 'Budget Needed' %}:</dt><dd class=\"currencyAmount\">{{project.get_currency_display}}{{project.funds_needed}}</dd>\n+ <dt class=\"totalBudgetLabel\">{% trans 'Total Budget' %}:</dt><dd class=\"currencyAmount\">{{project.get_currency_display}}{{project.budget|floatformat|intcomma}}</dd> \n+ <dt class=\"totalBudgetLabel\">{% trans 'Funds Needed' %}:</dt><dd class=\"currencyAmount\">{{project.get_currency_display}}{{project.funds_needed|floatformat|intcomma}}</dd>\n </dl>\n <a href=\"{% url 'project-donate' project.id %}\" class=\"btn btn-primary donateButton\">{% trans \"Donate\" %}</a>\n </li>\n@@ -137,12 +138,12 @@ <h4 class=\"detailedInfo\">{% trans 'Latest project updates' %}</h4>\n \"actual_text\": \"{% trans 'actual' %}\",\n \"target_text\": \"{% trans 'target' %}\",\n \"background_text\": \"{% trans 'Background' %}\",\n- \"current_situation_text\": \"{% trans 'Current situation' %}\",\n+ \"current_situation_text\": \"{% trans 'Situation at start of project' %}\",\n \"goals_overview_text\": \"{% trans 'Goals overview' %}\",\n \"project_plan_text\": \"{% trans 'Project plan' %}\",\n \"sustainability_text\": \"{% trans 'Sustainability' %}\",\n \"target_group_text\": \"{% trans 'Target group' %}\",\n- \"results_text\": \"{% trans 'Results' %}\"\n+ \"results_text\": \"{% trans 'Results and indicators' %}\"\n }\n </script>\n \ndiff --git a/akvo/templates/project_report.html b/akvo/templates/project_report.html\nindex 624c802ee2..ce16b123d5 100644\n--- a/akvo/templates/project_report.html\n+++ b/akvo/templates/project_report.html\n@@ -5,7 +5,7 @@\n {% block title %}{{project.title}} - {% trans \"Report\" %}{% endblock %}\n \n {% block maincontent %}\n-<article class=\"touch-navbar project-container\">\n+<article class=\"touch-navbar project-container projectReport\">\n {% include \"partials/project_header.html\" %}\n <div class=\"container\">\n <div class=\"row\">\n@@ -118,7 +118,7 @@ <h4>{% trans \"Descriptions\" %}</h4>\n <td>{{project.background}}</td>\n </tr>\n <tr>\n- <th scope=\"row\">{% trans \"Current Situation\" %}</th>\n+ <th scope=\"row\">{% trans \"Situation at start of project\" %}</th>\n <td>{{project.current_status}}</td>\n </tr>\n <tr>\n@@ -291,7 +291,11 @@ <h4>{% trans \"Product Budget Items\" %}</h4>\n <tbody>\n {% for budget_item in project.budget_items.all %}\n <tr>\n- <td>{{budget_item.label}}</td>\n+ {% if 'other' in budget_item.label.label and budget_item.other_extra %}\n+ <td>{{budget_item.other_extra}}</td>\n+ {% else %}\n+ <td>{{budget_item.label}}</td>\n+ {% endif %}\n <td>{{budget_item.iati_type}}</td>\n <td>{{budget_item.amount}}</td>\n <td>{{budget_item.iati_currency}}</td>\n@@ -491,7 +495,7 @@ <h4>{% trans \"Indicators\" %}</h4>\n \n <h4>{% trans \"Reporting Organisation\" %}</h4>\n {% with reporting_org=project.reporting_org %}\n- <table class=\"table table-striped table-bordered table-responsive\">\n+ <table class=\"table table-striped table-bordered table-responsive reportingOrganisation\">\n <tbody>\n <tr>\n <th scope=\"row\">{% trans \"Name\" %}</th>\n@@ -515,7 +519,7 @@ <h4>{% trans \"Reporting Organisation\" %}</h4>\n \n <h4>{% trans \"Participating Organisations\" %}</h4>\n {% for partner, info in project.partners_info.items %}\n- <table class=\"table table-striped table-bordered table-responsive\">\n+ <table class=\"table table-striped table-bordered table-responsive participatingOrganisations\">\n <tbody>\n <tr>\n <th scope=\"row\">{% trans \"Name\" %}</th>\n@@ -623,5 +627,6 @@ <h4>{% trans \"Additional Details\" %}</h4>\n \n </div>\n </div>\n+{% include \"partials/project_footer.html\" %}\n </article>\n {% endblock %}\ndiff --git a/akvo/templates/update_directory.html b/akvo/templates/update_directory.html\nindex 0cc32956b8..0c39dc2bd3 100644\n--- a/akvo/templates/update_directory.html\n+++ b/akvo/templates/update_directory.html\n@@ -16,7 +16,7 @@\n <div class=\"input-group\">\n {% bootstrap_field filter.form.title field_class='search-query' show_label=False %}\n <span class=\"input-group-btn\">\n- <button class=\"btn btn-primary\" type=\"submit\">{% trans \"Update list\" %} ›</button>\n+ <button class=\"btn btn-primary\" type=\"submit\">{% trans \"Search\" %} ›</button>\n </span>\n </div>\n <a class=\"btn showFilters menu-toggle\"><i class=\"fa fa-toggle-off\"></i> {% trans 'Advanced filters' %}</a>\ndiff --git a/akvo/templates/update_main.html b/akvo/templates/update_main.html\nindex 9d74a08528..3fc0224c04 100644\n--- a/akvo/templates/update_main.html\n+++ b/akvo/templates/update_main.html\n@@ -52,7 +52,7 @@ <h6>\"{{ update.photo_caption }}\"{% if update.photo_credit %}</h6>{% endif %}\n \n \n {% autoescape off %}\n- <p class=\"topMargin\">{{ update.text|force_escape|urlize|apply_markup:\"markdown\" }}</p>\n+ <div class=\"updateText topMargin\">{{ update.text|force_escape|urlize|apply_markup:\"markdown\" }}</div>\n {% endautoescape %}\n </div>\n </div>\n"}}},{"rowIdx":4688,"cells":{"in_source_id":{"kind":"string","value":"iterative__dvc-4156"},"issue":{"kind":"string","value":"DVC status fails after using add -R\nHey :)\r\n\r\nI have a folder of files I added with \r\n$$ dvc add -R raw_data\r\n\r\nThen I've imported the folder in other git repo using\r\n$$ dvc import -o data --rev raw-v1 https://...@bitbucket.org/.../raw_data_reg.git raw_data\r\n\r\nThen when execute dvc status I get an error message\r\n\r\n```\r\n$$ dvc status -v\r\n\r\n2020-06-29 13:54:52,056 DEBUG: fetched: [(3,)] \r\n2020-06-29 13:54:52,059 DEBUG: Creating external repo https://...@bitbucket.org/.../raw_data_reg.git@43fb50fb519d58415bba4903b480f44811fefec1\r\n2020-06-29 13:54:52,059 DEBUG: erepo: git clone https://...@bitbucket.org/.../raw_data_reg.git to a temporary dir\r\nCloning |0.00 [00:00, ?obj/s]Password for 'https://...@bitbucket.org':\r\n2020-06-29 13:54:58,709 DEBUG: fetched: [(17,)] \r\n2020-06-29 13:54:58,728 ERROR: failed to obtain data status - get_hash() takes 2 positional arguments but 3 were given\r\n------------------------------------------------------------\r\nTraceback (most recent call last):\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/dvc/dependency/repo.py\", line 57, in _get_checksum\r\n return repo.find_out_by_relpath(self.def_path).info[\"md5\"]\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/dvc/repo/__init__.py\", line 566, in find_out_by_relpath\r\n (out,) = self.find_outs_by_path(path)\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/dvc/repo/__init__.py\", line 560, in find_outs_by_path\r\n raise OutputNotFoundError(path, self)\r\ndvc.exceptions.OutputNotFoundError: Unable to find DVC-file with output '../../../tmp/tmpq5w4msxhdvc-clone/raw_data'\r\n\r\nDuring handling of the above exception, another exception occurred:\r\n\r\nTraceback (most recent call last):\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/dvc/command/status.py\", line 51, in run\r\n recursive=self.args.recursive,\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/dvc/repo/__init__.py\", line 35, in wrapper\r\n ret = f(repo, *args, **kwargs)\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/dvc/repo/status.py\", line 146, in status\r\n self, targets, with_deps=with_deps, recursive=recursive\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/dvc/repo/status.py\", line 37, in _local_status\r\n return _joint_status(stages)\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/dvc/repo/status.py\", line 23, in _joint_status\r\n status.update(stage.status(check_updates=True))\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/funcy/decorators.py\", line 39, in wrapper\r\n return deco(call, *dargs, **dkwargs)\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/dvc/stage/decorators.py\", line 35, in rwlocked\r\n return call()\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/funcy/decorators.py\", line 60, in __call__\r\n return self._func(*self._args, **self._kwargs)\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/dvc/stage/__init__.py\", line 469, in status\r\n self._status_deps(ret)\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/dvc/stage/__init__.py\", line 485, in _status_deps\r\n deps_status = self._status(self.deps)\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/dvc/stage/__init__.py\", line 480, in _status\r\n ret.update(entry.status())\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/dvc/dependency/repo.py\", line 71, in status\r\n current_checksum = self._get_checksum(locked=True)\r\n File \"/home/moshe/.local/lib/python3.6/site-packages/dvc/dependency/repo.py\", line 67, in _get_checksum\r\n return self.repo.cache.local.get_hash(path, tree)\r\nTypeError: get_hash() takes 2 positional arguments but 3 were given\r\n------------------------------------------------------------\r\n\r\n$$ dvc version\r\nDVC version: 1.0.1\r\nPython version: 3.6.9\r\nPlatform: Linux-5.3.0-61-generic-x86_64-with-Ubuntu-18.04-bionic\r\nBinary: False\r\nPackage: pip\r\nSupported remotes: azure, gdrive, gs, hdfs, http, https, s3, ssh, oss\r\nCache: reflink - not supported, hardlink - supported, symlink - supported\r\nFilesystem type (cache directory): ('ext4', '/dev/sda1')\r\nRepo: dvc, git\r\nFilesystem type (workspace): ('ext4', '/dev/sda1')\r\n```\r\n\r\nDo you know what could be the problem?\r\nThanks.\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"import os\n\nfrom voluptuous import Required\n\nfrom dvc.exceptions import OutputNotFoundError\nfrom dvc.path_info import PathInfo\n\nfrom .local import LocalDependency\n\n\nclass RepoDependency(LocalDependency):\n PARAM_REPO = \"repo\"\n PARAM_URL = \"url\"\n PARAM_REV = \"rev\"\n PARAM_REV_LOCK = \"rev_lock\"\n\n REPO_SCHEMA = {\n PARAM_REPO: {\n Required(PARAM_URL): str,\n PARAM_REV: str,\n PARAM_REV_LOCK: str,\n }\n }\n\n def __init__(self, def_repo, stage, *args, **kwargs):\n self.def_repo = def_repo\n super().__init__(stage, *args, **kwargs)\n\n def _parse_path(self, remote, path):\n return None\n\n @property\n def is_in_repo(self):\n return False\n\n @property\n def repo_pair(self):\n d = self.def_repo\n rev = d.get(self.PARAM_REV_LOCK) or d.get(self.PARAM_REV)\n return d[self.PARAM_URL], rev\n\n def __str__(self):\n return \"{} ({})\".format(self.def_path, self.def_repo[self.PARAM_URL])\n\n def _make_repo(self, *, locked=True):\n from dvc.external_repo import external_repo\n\n d = self.def_repo\n rev = (d.get(\"rev_lock\") if locked else None) or d.get(\"rev\")\n return external_repo(d[\"url\"], rev=rev)\n\n def _get_checksum(self, locked=True):\n from dvc.repo.tree import RepoTree\n\n with self._make_repo(locked=locked) as repo:\n try:\n return repo.find_out_by_relpath(self.def_path).info[\"md5\"]\n except OutputNotFoundError:\n path = PathInfo(os.path.join(repo.root_dir, self.def_path))\n\n # we want stream but not fetch, so DVC out directories are\n # walked, but dir contents is not fetched\n tree = RepoTree(repo, stream=True)\n\n # We are polluting our repo cache with some dir listing here\n if tree.isdir(path):\n return self.repo.cache.local.get_hash(path, tree)\n return tree.get_file_hash(path)\n\n def status(self):\n current_checksum = self._get_checksum(locked=True)\n updated_checksum = self._get_checksum(locked=False)\n\n if current_checksum != updated_checksum:\n return {str(self): \"update available\"}\n\n return {}\n\n def save(self):\n pass\n\n def dumpd(self):\n return {self.PARAM_PATH: self.def_path, self.PARAM_REPO: self.def_repo}\n\n def download(self, to):\n with self._make_repo() as repo:\n if self.def_repo.get(self.PARAM_REV_LOCK) is None:\n self.def_repo[self.PARAM_REV_LOCK] = repo.get_rev()\n\n cache = self.repo.cache.local\n with repo.use_cache(cache):\n _, _, cache_infos = repo.fetch_external([self.def_path])\n cache.checkout(to.path_info, cache_infos[0])\n\n def update(self, rev=None):\n if rev:\n self.def_repo[self.PARAM_REV] = rev\n\n with self._make_repo(locked=False) as repo:\n self.def_repo[self.PARAM_REV_LOCK] = repo.get_rev()\n","path":"dvc/dependency/repo.py"}],"string":"[\n {\n \"content\": \"import os\\n\\nfrom voluptuous import Required\\n\\nfrom dvc.exceptions import OutputNotFoundError\\nfrom dvc.path_info import PathInfo\\n\\nfrom .local import LocalDependency\\n\\n\\nclass RepoDependency(LocalDependency):\\n PARAM_REPO = \\\"repo\\\"\\n PARAM_URL = \\\"url\\\"\\n PARAM_REV = \\\"rev\\\"\\n PARAM_REV_LOCK = \\\"rev_lock\\\"\\n\\n REPO_SCHEMA = {\\n PARAM_REPO: {\\n Required(PARAM_URL): str,\\n PARAM_REV: str,\\n PARAM_REV_LOCK: str,\\n }\\n }\\n\\n def __init__(self, def_repo, stage, *args, **kwargs):\\n self.def_repo = def_repo\\n super().__init__(stage, *args, **kwargs)\\n\\n def _parse_path(self, remote, path):\\n return None\\n\\n @property\\n def is_in_repo(self):\\n return False\\n\\n @property\\n def repo_pair(self):\\n d = self.def_repo\\n rev = d.get(self.PARAM_REV_LOCK) or d.get(self.PARAM_REV)\\n return d[self.PARAM_URL], rev\\n\\n def __str__(self):\\n return \\\"{} ({})\\\".format(self.def_path, self.def_repo[self.PARAM_URL])\\n\\n def _make_repo(self, *, locked=True):\\n from dvc.external_repo import external_repo\\n\\n d = self.def_repo\\n rev = (d.get(\\\"rev_lock\\\") if locked else None) or d.get(\\\"rev\\\")\\n return external_repo(d[\\\"url\\\"], rev=rev)\\n\\n def _get_checksum(self, locked=True):\\n from dvc.repo.tree import RepoTree\\n\\n with self._make_repo(locked=locked) as repo:\\n try:\\n return repo.find_out_by_relpath(self.def_path).info[\\\"md5\\\"]\\n except OutputNotFoundError:\\n path = PathInfo(os.path.join(repo.root_dir, self.def_path))\\n\\n # we want stream but not fetch, so DVC out directories are\\n # walked, but dir contents is not fetched\\n tree = RepoTree(repo, stream=True)\\n\\n # We are polluting our repo cache with some dir listing here\\n if tree.isdir(path):\\n return self.repo.cache.local.get_hash(path, tree)\\n return tree.get_file_hash(path)\\n\\n def status(self):\\n current_checksum = self._get_checksum(locked=True)\\n updated_checksum = self._get_checksum(locked=False)\\n\\n if current_checksum != updated_checksum:\\n return {str(self): \\\"update available\\\"}\\n\\n return {}\\n\\n def save(self):\\n pass\\n\\n def dumpd(self):\\n return {self.PARAM_PATH: self.def_path, self.PARAM_REPO: self.def_repo}\\n\\n def download(self, to):\\n with self._make_repo() as repo:\\n if self.def_repo.get(self.PARAM_REV_LOCK) is None:\\n self.def_repo[self.PARAM_REV_LOCK] = repo.get_rev()\\n\\n cache = self.repo.cache.local\\n with repo.use_cache(cache):\\n _, _, cache_infos = repo.fetch_external([self.def_path])\\n cache.checkout(to.path_info, cache_infos[0])\\n\\n def update(self, rev=None):\\n if rev:\\n self.def_repo[self.PARAM_REV] = rev\\n\\n with self._make_repo(locked=False) as repo:\\n self.def_repo[self.PARAM_REV_LOCK] = repo.get_rev()\\n\",\n \"path\": \"dvc/dependency/repo.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import os\n\nfrom voluptuous import Required\n\nfrom dvc.exceptions import OutputNotFoundError\nfrom dvc.path_info import PathInfo\n\nfrom .local import LocalDependency\n\n\nclass RepoDependency(LocalDependency):\n PARAM_REPO = \"repo\"\n PARAM_URL = \"url\"\n PARAM_REV = \"rev\"\n PARAM_REV_LOCK = \"rev_lock\"\n\n REPO_SCHEMA = {\n PARAM_REPO: {\n Required(PARAM_URL): str,\n PARAM_REV: str,\n PARAM_REV_LOCK: str,\n }\n }\n\n def __init__(self, def_repo, stage, *args, **kwargs):\n self.def_repo = def_repo\n super().__init__(stage, *args, **kwargs)\n\n def _parse_path(self, remote, path):\n return None\n\n @property\n def is_in_repo(self):\n return False\n\n @property\n def repo_pair(self):\n d = self.def_repo\n rev = d.get(self.PARAM_REV_LOCK) or d.get(self.PARAM_REV)\n return d[self.PARAM_URL], rev\n\n def __str__(self):\n return \"{} ({})\".format(self.def_path, self.def_repo[self.PARAM_URL])\n\n def _make_repo(self, *, locked=True):\n from dvc.external_repo import external_repo\n\n d = self.def_repo\n rev = (d.get(\"rev_lock\") if locked else None) or d.get(\"rev\")\n return external_repo(d[\"url\"], rev=rev)\n\n def _get_checksum(self, locked=True):\n from dvc.repo.tree import RepoTree\n\n with self._make_repo(locked=locked) as repo:\n try:\n return repo.find_out_by_relpath(self.def_path).info[\"md5\"]\n except OutputNotFoundError:\n path = PathInfo(os.path.join(repo.root_dir, self.def_path))\n\n # we want stream but not fetch, so DVC out directories are\n # walked, but dir contents is not fetched\n tree = RepoTree(repo, stream=True)\n\n # We are polluting our repo cache with some dir listing here\n if tree.isdir(path):\n return self.repo.cache.local.get_hash(path, tree=tree)\n return tree.get_file_hash(path)\n\n def status(self):\n current_checksum = self._get_checksum(locked=True)\n updated_checksum = self._get_checksum(locked=False)\n\n if current_checksum != updated_checksum:\n return {str(self): \"update available\"}\n\n return {}\n\n def save(self):\n pass\n\n def dumpd(self):\n return {self.PARAM_PATH: self.def_path, self.PARAM_REPO: self.def_repo}\n\n def download(self, to):\n with self._make_repo() as repo:\n if self.def_repo.get(self.PARAM_REV_LOCK) is None:\n self.def_repo[self.PARAM_REV_LOCK] = repo.get_rev()\n\n cache = self.repo.cache.local\n with repo.use_cache(cache):\n _, _, cache_infos = repo.fetch_external([self.def_path])\n cache.checkout(to.path_info, cache_infos[0])\n\n def update(self, rev=None):\n if rev:\n self.def_repo[self.PARAM_REV] = rev\n\n with self._make_repo(locked=False) as repo:\n self.def_repo[self.PARAM_REV_LOCK] = repo.get_rev()\n","path":"dvc/dependency/repo.py"}],"string":"[\n {\n \"content\": \"import os\\n\\nfrom voluptuous import Required\\n\\nfrom dvc.exceptions import OutputNotFoundError\\nfrom dvc.path_info import PathInfo\\n\\nfrom .local import LocalDependency\\n\\n\\nclass RepoDependency(LocalDependency):\\n PARAM_REPO = \\\"repo\\\"\\n PARAM_URL = \\\"url\\\"\\n PARAM_REV = \\\"rev\\\"\\n PARAM_REV_LOCK = \\\"rev_lock\\\"\\n\\n REPO_SCHEMA = {\\n PARAM_REPO: {\\n Required(PARAM_URL): str,\\n PARAM_REV: str,\\n PARAM_REV_LOCK: str,\\n }\\n }\\n\\n def __init__(self, def_repo, stage, *args, **kwargs):\\n self.def_repo = def_repo\\n super().__init__(stage, *args, **kwargs)\\n\\n def _parse_path(self, remote, path):\\n return None\\n\\n @property\\n def is_in_repo(self):\\n return False\\n\\n @property\\n def repo_pair(self):\\n d = self.def_repo\\n rev = d.get(self.PARAM_REV_LOCK) or d.get(self.PARAM_REV)\\n return d[self.PARAM_URL], rev\\n\\n def __str__(self):\\n return \\\"{} ({})\\\".format(self.def_path, self.def_repo[self.PARAM_URL])\\n\\n def _make_repo(self, *, locked=True):\\n from dvc.external_repo import external_repo\\n\\n d = self.def_repo\\n rev = (d.get(\\\"rev_lock\\\") if locked else None) or d.get(\\\"rev\\\")\\n return external_repo(d[\\\"url\\\"], rev=rev)\\n\\n def _get_checksum(self, locked=True):\\n from dvc.repo.tree import RepoTree\\n\\n with self._make_repo(locked=locked) as repo:\\n try:\\n return repo.find_out_by_relpath(self.def_path).info[\\\"md5\\\"]\\n except OutputNotFoundError:\\n path = PathInfo(os.path.join(repo.root_dir, self.def_path))\\n\\n # we want stream but not fetch, so DVC out directories are\\n # walked, but dir contents is not fetched\\n tree = RepoTree(repo, stream=True)\\n\\n # We are polluting our repo cache with some dir listing here\\n if tree.isdir(path):\\n return self.repo.cache.local.get_hash(path, tree=tree)\\n return tree.get_file_hash(path)\\n\\n def status(self):\\n current_checksum = self._get_checksum(locked=True)\\n updated_checksum = self._get_checksum(locked=False)\\n\\n if current_checksum != updated_checksum:\\n return {str(self): \\\"update available\\\"}\\n\\n return {}\\n\\n def save(self):\\n pass\\n\\n def dumpd(self):\\n return {self.PARAM_PATH: self.def_path, self.PARAM_REPO: self.def_repo}\\n\\n def download(self, to):\\n with self._make_repo() as repo:\\n if self.def_repo.get(self.PARAM_REV_LOCK) is None:\\n self.def_repo[self.PARAM_REV_LOCK] = repo.get_rev()\\n\\n cache = self.repo.cache.local\\n with repo.use_cache(cache):\\n _, _, cache_infos = repo.fetch_external([self.def_path])\\n cache.checkout(to.path_info, cache_infos[0])\\n\\n def update(self, rev=None):\\n if rev:\\n self.def_repo[self.PARAM_REV] = rev\\n\\n with self._make_repo(locked=False) as repo:\\n self.def_repo[self.PARAM_REV_LOCK] = repo.get_rev()\\n\",\n \"path\": \"dvc/dependency/repo.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/dvc/dependency/repo.py b/dvc/dependency/repo.py\nindex 8566c080b9..3ae2a77dfb 100644\n--- a/dvc/dependency/repo.py\n+++ b/dvc/dependency/repo.py\n@@ -64,7 +64,7 @@ def _get_checksum(self, locked=True):\n \n # We are polluting our repo cache with some dir listing here\n if tree.isdir(path):\n- return self.repo.cache.local.get_hash(path, tree)\n+ return self.repo.cache.local.get_hash(path, tree=tree)\n return tree.get_file_hash(path)\n \n def status(self):\ndiff --git a/tests/dir_helpers.py b/tests/dir_helpers.py\nindex 4395a2a022..02ae154fd6 100644\n--- a/tests/dir_helpers.py\n+++ b/tests/dir_helpers.py\n@@ -221,6 +221,17 @@ def branch(self, name, new=False):\n finally:\n self.scm.checkout(old)\n \n+ def read_text(self, *args, **kwargs): # pylint: disable=signature-differs\n+ # NOTE: on windows we'll get PermissionError instead of\n+ # IsADirectoryError when we try to `open` a directory, so we can't\n+ # rely on exception flow control\n+ if self.is_dir():\n+ return {\n+ path.name: path.read_text(*args, **kwargs)\n+ for path in self.iterdir()\n+ }\n+ return super().read_text(*args, **kwargs)\n+\n \n def _coerce_filenames(filenames):\n if isinstance(filenames, (str, bytes, pathlib.PurePath)):\ndiff --git a/tests/func/test_get.py b/tests/func/test_get.py\nindex ccb8160bfc..72736f8077 100644\n--- a/tests/func/test_get.py\n+++ b/tests/func/test_get.py\n@@ -10,7 +10,6 @@\n from dvc.repo.get import GetDVCFileError\n from dvc.system import System\n from dvc.utils.fs import makedirs\n-from tests.utils import trees_equal\n \n \n def test_get_repo_file(tmp_dir, erepo_dir):\n@@ -29,8 +28,7 @@ def test_get_repo_dir(tmp_dir, erepo_dir):\n \n Repo.get(os.fspath(erepo_dir), \"dir\", \"dir_imported\")\n \n- assert os.path.isdir(\"dir_imported\")\n- trees_equal(erepo_dir / \"dir\", \"dir_imported\")\n+ assert (tmp_dir / \"dir_imported\").read_text() == {\"file\": \"contents\"}\n \n \n @pytest.mark.parametrize(\n@@ -44,7 +42,6 @@ def test_get_git_file(tmp_dir, erepo):\n \n Repo.get(os.fspath(erepo), src, dst)\n \n- assert (tmp_dir / dst).is_file()\n assert (tmp_dir / dst).read_text() == \"hello\"\n \n \n@@ -61,8 +58,7 @@ def test_get_git_dir(tmp_dir, erepo):\n \n Repo.get(os.fspath(erepo), src, dst)\n \n- assert (tmp_dir / dst).is_dir()\n- trees_equal(erepo / src, tmp_dir / dst)\n+ assert (tmp_dir / dst).read_text() == {\"dir\": {\"file.txt\": \"hello\"}}\n \n \n def test_cache_type_is_properly_overridden(tmp_dir, erepo_dir):\ndiff --git a/tests/func/test_import.py b/tests/func/test_import.py\nindex b97d9ca102..d1f6b5e59c 100644\n--- a/tests/func/test_import.py\n+++ b/tests/func/test_import.py\n@@ -11,7 +11,6 @@\n from dvc.exceptions import DownloadError, PathMissingError\n from dvc.system import System\n from dvc.utils.fs import makedirs, remove\n-from tests.utils import trees_equal\n \n \n def test_import(tmp_dir, scm, dvc, erepo_dir):\n@@ -73,8 +72,7 @@ def test_import_git_dir(tmp_dir, scm, dvc, git_dir, src_is_dvc):\n \n stage = dvc.imp(os.fspath(git_dir), \"src\", \"dst\")\n \n- assert (tmp_dir / \"dst\").is_dir()\n- trees_equal(git_dir / \"src\", tmp_dir / \"dst\")\n+ assert (tmp_dir / \"dst\").read_text() == {\"file.txt\": \"hello\"}\n assert tmp_dir.scm.repo.git.check_ignore(os.fspath(tmp_dir / \"dst\"))\n assert stage.deps[0].def_repo == {\n \"url\": os.fspath(git_dir),\n@@ -88,8 +86,7 @@ def test_import_dir(tmp_dir, scm, dvc, erepo_dir):\n \n stage = dvc.imp(os.fspath(erepo_dir), \"dir\", \"dir_imported\")\n \n- assert os.path.isdir(\"dir_imported\")\n- trees_equal(erepo_dir / \"dir\", \"dir_imported\")\n+ assert (tmp_dir / \"dir_imported\").read_text() == {\"foo\": \"foo content\"}\n assert scm.repo.git.check_ignore(\"dir_imported\")\n assert stage.deps[0].def_repo == {\n \"url\": os.fspath(erepo_dir),\n@@ -222,8 +219,7 @@ def test_pull_imported_directory_stage(tmp_dir, dvc, erepo_dir):\n \n dvc.pull([\"dir_imported.dvc\"])\n \n- assert os.path.isdir(\"dir_imported\")\n- trees_equal(erepo_dir / \"dir\", \"dir_imported\")\n+ assert (tmp_dir / \"dir_imported\").read_text() == {\"foo\": \"foo content\"}\n \n \n def test_download_error_pulling_imported_stage(tmp_dir, dvc, erepo_dir):\ndiff --git a/tests/func/test_update.py b/tests/func/test_update.py\nindex b5bc9d14ed..ec49eaf641 100644\n--- a/tests/func/test_update.py\n+++ b/tests/func/test_update.py\n@@ -10,26 +10,69 @@ def test_update_import(tmp_dir, dvc, erepo_dir, cached):\n gen = erepo_dir.dvc_gen if cached else erepo_dir.scm_gen\n \n with erepo_dir.branch(\"branch\", new=True), erepo_dir.chdir():\n- gen(\"version\", \"branch\", \"add version file\")\n+ gen(\n+ {\n+ \"version\": \"branch\",\n+ \"dir\": {\"version\": \"branch\", \"subdir\": {\"file\": \"file\"}},\n+ },\n+ commit=\"add version file\",\n+ )\n old_rev = erepo_dir.scm.get_rev()\n \n stage = dvc.imp(os.fspath(erepo_dir), \"version\", \"version\", rev=\"branch\")\n+ dir_stage = dvc.imp(os.fspath(erepo_dir), \"dir\", \"dir\", rev=\"branch\")\n+ assert dvc.status() == {}\n \n assert (tmp_dir / \"version\").read_text() == \"branch\"\n+ assert (tmp_dir / \"dir\").read_text() == {\n+ \"version\": \"branch\",\n+ \"subdir\": {\"file\": \"file\"},\n+ }\n assert stage.deps[0].def_repo[\"rev_lock\"] == old_rev\n+ assert dir_stage.deps[0].def_repo[\"rev_lock\"] == old_rev\n \n # Update version file\n with erepo_dir.branch(\"branch\", new=False), erepo_dir.chdir():\n- gen(\"version\", \"updated\", \"update version content\")\n+ gen(\n+ {\n+ \"version\": \"updated\",\n+ \"dir\": {\"version\": \"updated\", \"subdir\": {\"file\": \"file\"}},\n+ },\n+ commit=\"update version content\",\n+ )\n new_rev = erepo_dir.scm.get_rev()\n \n assert old_rev != new_rev\n \n- dvc.update([stage.path])\n+ assert dvc.status() == {\n+ \"dir.dvc\": [\n+ {\n+ \"changed deps\": {\n+ f\"dir ({os.fspath(erepo_dir)})\": \"update available\"\n+ }\n+ }\n+ ],\n+ \"version.dvc\": [\n+ {\n+ \"changed deps\": {\n+ f\"version ({os.fspath(erepo_dir)})\": \"update available\"\n+ }\n+ }\n+ ],\n+ }\n+\n+ (stage,) = dvc.update(stage.path)\n+ (dir_stage,) = dvc.update(dir_stage.path)\n+ assert dvc.status() == {}\n+\n assert (tmp_dir / \"version\").read_text() == \"updated\"\n+ assert (tmp_dir / \"dir\").read_text() == {\n+ \"version\": \"updated\",\n+ \"subdir\": {\"file\": \"file\"},\n+ }\n \n- stage = Dvcfile(dvc, stage.path).stage\n assert stage.deps[0].def_repo[\"rev_lock\"] == new_rev\n+ assert dir_stage.deps[0].def_repo[\"rev_lock\"] == new_rev\n \n \n def test_update_import_after_remote_updates_to_dvc(tmp_dir, dvc, erepo_dir):\ndiff --git a/tests/utils/__init__.py b/tests/utils/__init__.py\nindex 060315e956..91f63c6fb4 100644\n--- a/tests/utils/__init__.py\n+++ b/tests/utils/__init__.py\n@@ -1,6 +1,5 @@\n import os\n from contextlib import contextmanager\n-from filecmp import dircmp\n \n from dvc.scm import Git\n \n@@ -20,15 +19,5 @@ def cd(newdir):\n os.chdir(prevdir)\n \n \n-def trees_equal(dir_path_1, dir_path_2):\n-\n- comparison = dircmp(dir_path_1, dir_path_2)\n-\n- assert set(comparison.left_only) == set(comparison.right_only) == set()\n-\n- for d in comparison.common_dirs:\n- trees_equal(os.path.join(dir_path_1, d), os.path.join(dir_path_2, d))\n-\n-\n def to_posixpath(path):\n return path.replace(\"\\\\\", \"/\")\n"}}},{"rowIdx":4689,"cells":{"in_source_id":{"kind":"string","value":"pytorch__pytorch-2084"},"issue":{"kind":"string","value":"Negative dimension behaviour in torch.stack\nSupport for using a negative dimension in `torch.stack` currently works as follows:\r\n\r\n```python\r\nif dim < 0:\r\n dim += sequence[0].dim()\r\n```\r\n\r\nThis is not consistent with the behaviour of `torch.unsqueeze`, which uses `dim += input.dim() + 1`. The unsqueeze behaviour is better since it is possible to use negative indexing to insert a new dimension as the last dimension.\r\n\r\n## Example\r\n\r\n`torch.stack` with `dim=-1` adds a new dimension in the second-to-last position. This is confusing. It is not possible to use negative indexing to add a dimension in the last position (ie can't achieve a 3x2 result).\r\n\r\n```python\r\n>>> a = torch.Tensor([1, 2, 3])\r\n>>> b = torch.Tensor([4, 5, 6])\r\n>>> torch.stack([a, b], -1)\r\n\r\n 1 2 3\r\n 4 5 6\r\n[torch.FloatTensor of size 2x3]\r\n```\r\n\r\nContrast this to using `torch.unsqueeze` and `torch.cat` with `dim=-1`, which adds a new dimension in the last position:\r\n\r\n```python\r\n>>> a = torch.Tensor([1, 2, 3])\r\n>>> b = torch.Tensor([4, 5, 6])\r\n>>> torch.cat([a.unsqueeze(-1), b.unsqueeze(-1)], -1)\r\n\r\n 1 4\r\n 2 5\r\n 3 6\r\n[torch.FloatTensor of size 3x2]\r\n```\n"},"before_files":{"kind":"list like","value":[{"content":"import torch\nfrom ._utils import _range\nfrom operator import mul\nfrom functools import reduce\n\n__all__ = [\n 'split', 'chunk', 'stack', 'unbind', 'btriunpack', 'matmul',\n]\n\n\ndef split(tensor, split_size, dim=0):\n \"\"\"Splits the tensor into equally sized chunks (if possible).\n\n Last chunk will be smaller if the tensor size along a given dimension\n is not divisible by ``split_size``.\n\n Arguments:\n tensor (Tensor): tensor to split.\n split_size (int): size of a single chunk.\n dim (int): dimension along which to split the tensor.\n \"\"\"\n if dim < 0:\n dim += tensor.dim()\n dim_size = tensor.size(dim)\n num_splits = (dim_size + split_size - 1) // split_size\n last_split_size = split_size - (split_size * num_splits - dim_size)\n\n def get_split_size(i):\n return split_size if i < num_splits - 1 else last_split_size\n return tuple(tensor.narrow(int(dim), int(i * split_size), int(get_split_size(i))) for i\n in _range(0, num_splits))\n\n\ndef chunk(tensor, chunks, dim=0):\n \"\"\"Splits a tensor into a number of chunks along a given dimension.\n\n Arguments:\n tensor (Tensor): tensor to split.\n chunks (int): number of chunks to return.\n dim (int): dimension along which to split the tensor.\n \"\"\"\n if dim < 0:\n dim += tensor.dim()\n split_size = (tensor.size(dim) + chunks - 1) // chunks\n return split(tensor, split_size, dim)\n\n\ndef stack(sequence, dim=0, out=None):\n \"\"\"Concatenates sequence of tensors along a new dimension.\n\n All tensors need to be of the same size.\n\n Arguments:\n sequence (Sequence): sequence of tensors to concatenate.\n dim (int): dimension to insert. Has to be between 0 and the number\n of dimensions of concatenated tensors (inclusive).\n \"\"\"\n if len(sequence) == 0:\n raise ValueError(\"stack expects a non-empty sequence of tensors\")\n if dim < 0:\n dim += sequence[0].dim()\n inputs = [t.unsqueeze(dim) for t in sequence]\n if out is None:\n return torch.cat(inputs, dim)\n else:\n return torch.cat(inputs, dim, out=out)\n\n\ndef unbind(tensor, dim=0):\n \"\"\"Removes a tensor dimension.\n\n Returns a tuple of all slices along a given dimension, already without it.\n\n Arguments:\n tensor (Tensor): tensor to unbind.\n dim (int): dimension to remove.\n \"\"\"\n return tuple(tensor.select(dim, i) for i in _range(tensor.size(dim)))\n\n\ndef btriunpack(LU_data, LU_pivots, unpack_data=True, unpack_pivots=True):\n \"\"\"Unpacks the data and pivots from a batched LU factorization (btrifact) of a tensor.\n\n Returns a tuple indexed by:\n 0: The pivots.\n 1: The L tensor.\n 2: The U tensor.\n\n Arguments:\n LU_data (Tensor): The packed LU factorization data.\n LU_pivots (Tensor): The packed LU factorization pivots.\n unpack_data (bool): Flag indicating if the data should be unpacked.\n unpack_pivots (bool): Flag indicating if the pivots should be unpacked.\n \"\"\"\n\n nBatch, sz, _ = LU_data.size()\n\n if unpack_data:\n I_U = torch.triu(torch.ones(sz, sz)).type_as(LU_data).byte().unsqueeze(0).expand(nBatch, sz, sz)\n I_L = 1 - I_U\n L = LU_data.new(LU_data.size()).zero_()\n U = LU_data.new(LU_data.size()).zero_()\n I_diag = torch.eye(sz).type_as(LU_data).byte().unsqueeze(0).expand(nBatch, sz, sz)\n L[I_diag] = 1.0\n L[I_L] = LU_data[I_L]\n U[I_U] = LU_data[I_U]\n else:\n L = U = None\n\n if unpack_pivots:\n P = torch.eye(sz).type_as(LU_data).unsqueeze(0).repeat(nBatch, 1, 1)\n for i in range(nBatch):\n for j in range(sz):\n k = LU_pivots[i, j] - 1\n t = P[i, :, j].clone()\n P[i, :, j] = P[i, :, k]\n P[i, :, k] = t\n else:\n P = None\n\n return P, L, U\n\n\ndef matmul(tensor1, tensor2, out=None):\n \"\"\"Matrix product of two tensors.\n\n The behavior depends on the dimensionality of the tensors as follows:\n\n - If both tensors are 1-dimensional, the dot product (scalar) is returned.\n - If both arguments are 2-dimensional, the matrix-matrix product is returned.\n - If the first argument is 1-dimensional and the second argument is 2-dimensional,\n a 1 is prepended to its dimension for the purpose of the matrix multiply.\n After the matrix multiply, the prepended dimension is removed.\n - If the first argument is 2-dimensional and the second argument is 1-dimensional,\n the matrix-vector product is returned.\n - If both arguments are at least 1-dimensional and at least one argument is\n N-dimensional (where N > 2), then a batched matrix multiply is returned. If the first\n argument is 1-dimensional, a 1 is prepended to its dimension for the purpose of the\n batched matrix multiply and removed after. If the second argument is 1-dimensional, a\n 1 is appended to its dimension for the purpose of the batched matrix multiple and removed after.\n The non-matrix (i.e. batch) dimensions are :ref:`broadcasted <broadcasting-semantics>` (and thus\n must be broadcastable). For example, if :attr:`tensor1` is a `j x 1 x n x m` Tensor\n and :attr:`tensor2` is a `k x m x p` Tensor, :attr:`out` will be an `j x k x n x p` Tensor.\n\n .. note::\n\n The 1-dimensional dot product version of this function does not support an :attr:`out` parameter.\n\n Arguments:\n tensor1 (Tensor): First tensor to be multiplied\n tensor2 (Tensor): Second tensor to be multiplied\n out (Tensor, optional): Output tensor\n \"\"\"\n dim_tensor1 = tensor1.dim()\n dim_tensor2 = tensor2.dim()\n if dim_tensor1 == 1 and dim_tensor2 == 1:\n if out is None:\n return torch.dot(tensor1, tensor2)\n else:\n raise ValueError(\"out must be None for 1-d tensor matmul, returns a scalar\")\n if dim_tensor1 == 2 and dim_tensor2 == 1:\n if out is None:\n return torch.mv(tensor1, tensor2)\n else:\n return torch.mv(tensor1, tensor2, out=out)\n elif dim_tensor1 == 1 and dim_tensor2 == 2:\n if out is None:\n return torch.mm(tensor1.unsqueeze(0), tensor2).squeeze_(0)\n else:\n return torch.mm(tensor1.unsqueeze(0), tensor2, out=out).squeeze_(0)\n elif dim_tensor1 == 2 and dim_tensor2 == 2:\n if out is None:\n return torch.mm(tensor1, tensor2)\n else:\n return torch.mm(tensor1, tensor2, out=out)\n elif dim_tensor1 >= 3 and (dim_tensor2 == 1 or dim_tensor2 == 2):\n # optimization: use mm instead of bmm by folding tensor1's batch into\n # its leading matrix dimension.\n\n if dim_tensor2 == 1:\n tensor2 = tensor2.unsqueeze(-1)\n\n size1 = tensor1.size()\n size2 = tensor2.size()\n output_size = size1[:-1] + size2[-1:]\n\n # fold the batch into the first dimension\n tensor1 = tensor1.contiguous().view(-1, size1[-1])\n\n if out is None or not out.is_contiguous():\n output = torch.mm(tensor1, tensor2)\n else:\n output = torch.mm(tensor1, tensor2, out=out)\n\n output = output.view(output_size)\n\n if dim_tensor2 == 1:\n output = output.squeeze(-1)\n\n if out is not None:\n out.set_(output)\n return out\n\n return output\n elif (dim_tensor1 >= 1 and dim_tensor2 >= 1) and (dim_tensor1 >= 3 or dim_tensor2 >= 3):\n # ensure each tensor size is at least 3-dimensional\n tensor1_exp_size = torch.Size((1,) * max(3 - tensor1.dim(), 0) + tensor1.size())\n # rhs needs to be a separate case since we can't freely expand 1s on the rhs, but can on lhs\n if dim_tensor2 == 1:\n tensor2 = tensor2.unsqueeze(1)\n tensor2_exp_size = torch.Size((1,) * max(3 - tensor2.dim(), 0) + tensor2.size())\n\n # expand the batch portion (i.e. cut off matrix dimensions and expand rest)\n expand_batch_portion = torch._C._infer_size(tensor1_exp_size[:-2], tensor2_exp_size[:-2])\n\n # flatten expanded batches\n tensor1_expanded = tensor1.expand(*(expand_batch_portion + tensor1_exp_size[-2:])) \\\n .contiguous().view(reduce(mul, expand_batch_portion), *tensor1_exp_size[-2:])\n tensor2_expanded = tensor2.expand(*(expand_batch_portion + tensor2_exp_size[-2:])) \\\n .contiguous().view(reduce(mul, expand_batch_portion), *tensor2_exp_size[-2:])\n\n # reshape batches back into result\n total_expansion = expand_batch_portion + (tensor1_exp_size[-2], tensor2_exp_size[-1])\n\n def maybeSqueeze(tensor):\n if dim_tensor1 == 1:\n return tensor.squeeze(-2)\n elif dim_tensor2 == 1:\n return tensor.squeeze(-1)\n else:\n return tensor\n\n if out is None or not out.is_contiguous():\n output = torch.bmm(tensor1_expanded, tensor2_expanded)\n else:\n output = torch.bmm(tensor1_expanded, tensor2_expanded, out=out)\n\n output = maybeSqueeze(output.view(total_expansion))\n\n if out is not None:\n out.set_(output)\n return out\n\n return output\n\n raise ValueError(\"both arguments to __matmul__ need to be at least 1D, \"\n \"but they are {}D and {}D\".format(dim_tensor1, dim_tensor2))\n","path":"torch/functional.py"}],"string":"[\n {\n \"content\": \"import torch\\nfrom ._utils import _range\\nfrom operator import mul\\nfrom functools import reduce\\n\\n__all__ = [\\n 'split', 'chunk', 'stack', 'unbind', 'btriunpack', 'matmul',\\n]\\n\\n\\ndef split(tensor, split_size, dim=0):\\n \\\"\\\"\\\"Splits the tensor into equally sized chunks (if possible).\\n\\n Last chunk will be smaller if the tensor size along a given dimension\\n is not divisible by ``split_size``.\\n\\n Arguments:\\n tensor (Tensor): tensor to split.\\n split_size (int): size of a single chunk.\\n dim (int): dimension along which to split the tensor.\\n \\\"\\\"\\\"\\n if dim < 0:\\n dim += tensor.dim()\\n dim_size = tensor.size(dim)\\n num_splits = (dim_size + split_size - 1) // split_size\\n last_split_size = split_size - (split_size * num_splits - dim_size)\\n\\n def get_split_size(i):\\n return split_size if i < num_splits - 1 else last_split_size\\n return tuple(tensor.narrow(int(dim), int(i * split_size), int(get_split_size(i))) for i\\n in _range(0, num_splits))\\n\\n\\ndef chunk(tensor, chunks, dim=0):\\n \\\"\\\"\\\"Splits a tensor into a number of chunks along a given dimension.\\n\\n Arguments:\\n tensor (Tensor): tensor to split.\\n chunks (int): number of chunks to return.\\n dim (int): dimension along which to split the tensor.\\n \\\"\\\"\\\"\\n if dim < 0:\\n dim += tensor.dim()\\n split_size = (tensor.size(dim) + chunks - 1) // chunks\\n return split(tensor, split_size, dim)\\n\\n\\ndef stack(sequence, dim=0, out=None):\\n \\\"\\\"\\\"Concatenates sequence of tensors along a new dimension.\\n\\n All tensors need to be of the same size.\\n\\n Arguments:\\n sequence (Sequence): sequence of tensors to concatenate.\\n dim (int): dimension to insert. Has to be between 0 and the number\\n of dimensions of concatenated tensors (inclusive).\\n \\\"\\\"\\\"\\n if len(sequence) == 0:\\n raise ValueError(\\\"stack expects a non-empty sequence of tensors\\\")\\n if dim < 0:\\n dim += sequence[0].dim()\\n inputs = [t.unsqueeze(dim) for t in sequence]\\n if out is None:\\n return torch.cat(inputs, dim)\\n else:\\n return torch.cat(inputs, dim, out=out)\\n\\n\\ndef unbind(tensor, dim=0):\\n \\\"\\\"\\\"Removes a tensor dimension.\\n\\n Returns a tuple of all slices along a given dimension, already without it.\\n\\n Arguments:\\n tensor (Tensor): tensor to unbind.\\n dim (int): dimension to remove.\\n \\\"\\\"\\\"\\n return tuple(tensor.select(dim, i) for i in _range(tensor.size(dim)))\\n\\n\\ndef btriunpack(LU_data, LU_pivots, unpack_data=True, unpack_pivots=True):\\n \\\"\\\"\\\"Unpacks the data and pivots from a batched LU factorization (btrifact) of a tensor.\\n\\n Returns a tuple indexed by:\\n 0: The pivots.\\n 1: The L tensor.\\n 2: The U tensor.\\n\\n Arguments:\\n LU_data (Tensor): The packed LU factorization data.\\n LU_pivots (Tensor): The packed LU factorization pivots.\\n unpack_data (bool): Flag indicating if the data should be unpacked.\\n unpack_pivots (bool): Flag indicating if the pivots should be unpacked.\\n \\\"\\\"\\\"\\n\\n nBatch, sz, _ = LU_data.size()\\n\\n if unpack_data:\\n I_U = torch.triu(torch.ones(sz, sz)).type_as(LU_data).byte().unsqueeze(0).expand(nBatch, sz, sz)\\n I_L = 1 - I_U\\n L = LU_data.new(LU_data.size()).zero_()\\n U = LU_data.new(LU_data.size()).zero_()\\n I_diag = torch.eye(sz).type_as(LU_data).byte().unsqueeze(0).expand(nBatch, sz, sz)\\n L[I_diag] = 1.0\\n L[I_L] = LU_data[I_L]\\n U[I_U] = LU_data[I_U]\\n else:\\n L = U = None\\n\\n if unpack_pivots:\\n P = torch.eye(sz).type_as(LU_data).unsqueeze(0).repeat(nBatch, 1, 1)\\n for i in range(nBatch):\\n for j in range(sz):\\n k = LU_pivots[i, j] - 1\\n t = P[i, :, j].clone()\\n P[i, :, j] = P[i, :, k]\\n P[i, :, k] = t\\n else:\\n P = None\\n\\n return P, L, U\\n\\n\\ndef matmul(tensor1, tensor2, out=None):\\n \\\"\\\"\\\"Matrix product of two tensors.\\n\\n The behavior depends on the dimensionality of the tensors as follows:\\n\\n - If both tensors are 1-dimensional, the dot product (scalar) is returned.\\n - If both arguments are 2-dimensional, the matrix-matrix product is returned.\\n - If the first argument is 1-dimensional and the second argument is 2-dimensional,\\n a 1 is prepended to its dimension for the purpose of the matrix multiply.\\n After the matrix multiply, the prepended dimension is removed.\\n - If the first argument is 2-dimensional and the second argument is 1-dimensional,\\n the matrix-vector product is returned.\\n - If both arguments are at least 1-dimensional and at least one argument is\\n N-dimensional (where N > 2), then a batched matrix multiply is returned. If the first\\n argument is 1-dimensional, a 1 is prepended to its dimension for the purpose of the\\n batched matrix multiply and removed after. If the second argument is 1-dimensional, a\\n 1 is appended to its dimension for the purpose of the batched matrix multiple and removed after.\\n The non-matrix (i.e. batch) dimensions are :ref:`broadcasted <broadcasting-semantics>` (and thus\\n must be broadcastable). For example, if :attr:`tensor1` is a `j x 1 x n x m` Tensor\\n and :attr:`tensor2` is a `k x m x p` Tensor, :attr:`out` will be an `j x k x n x p` Tensor.\\n\\n .. note::\\n\\n The 1-dimensional dot product version of this function does not support an :attr:`out` parameter.\\n\\n Arguments:\\n tensor1 (Tensor): First tensor to be multiplied\\n tensor2 (Tensor): Second tensor to be multiplied\\n out (Tensor, optional): Output tensor\\n \\\"\\\"\\\"\\n dim_tensor1 = tensor1.dim()\\n dim_tensor2 = tensor2.dim()\\n if dim_tensor1 == 1 and dim_tensor2 == 1:\\n if out is None:\\n return torch.dot(tensor1, tensor2)\\n else:\\n raise ValueError(\\\"out must be None for 1-d tensor matmul, returns a scalar\\\")\\n if dim_tensor1 == 2 and dim_tensor2 == 1:\\n if out is None:\\n return torch.mv(tensor1, tensor2)\\n else:\\n return torch.mv(tensor1, tensor2, out=out)\\n elif dim_tensor1 == 1 and dim_tensor2 == 2:\\n if out is None:\\n return torch.mm(tensor1.unsqueeze(0), tensor2).squeeze_(0)\\n else:\\n return torch.mm(tensor1.unsqueeze(0), tensor2, out=out).squeeze_(0)\\n elif dim_tensor1 == 2 and dim_tensor2 == 2:\\n if out is None:\\n return torch.mm(tensor1, tensor2)\\n else:\\n return torch.mm(tensor1, tensor2, out=out)\\n elif dim_tensor1 >= 3 and (dim_tensor2 == 1 or dim_tensor2 == 2):\\n # optimization: use mm instead of bmm by folding tensor1's batch into\\n # its leading matrix dimension.\\n\\n if dim_tensor2 == 1:\\n tensor2 = tensor2.unsqueeze(-1)\\n\\n size1 = tensor1.size()\\n size2 = tensor2.size()\\n output_size = size1[:-1] + size2[-1:]\\n\\n # fold the batch into the first dimension\\n tensor1 = tensor1.contiguous().view(-1, size1[-1])\\n\\n if out is None or not out.is_contiguous():\\n output = torch.mm(tensor1, tensor2)\\n else:\\n output = torch.mm(tensor1, tensor2, out=out)\\n\\n output = output.view(output_size)\\n\\n if dim_tensor2 == 1:\\n output = output.squeeze(-1)\\n\\n if out is not None:\\n out.set_(output)\\n return out\\n\\n return output\\n elif (dim_tensor1 >= 1 and dim_tensor2 >= 1) and (dim_tensor1 >= 3 or dim_tensor2 >= 3):\\n # ensure each tensor size is at least 3-dimensional\\n tensor1_exp_size = torch.Size((1,) * max(3 - tensor1.dim(), 0) + tensor1.size())\\n # rhs needs to be a separate case since we can't freely expand 1s on the rhs, but can on lhs\\n if dim_tensor2 == 1:\\n tensor2 = tensor2.unsqueeze(1)\\n tensor2_exp_size = torch.Size((1,) * max(3 - tensor2.dim(), 0) + tensor2.size())\\n\\n # expand the batch portion (i.e. cut off matrix dimensions and expand rest)\\n expand_batch_portion = torch._C._infer_size(tensor1_exp_size[:-2], tensor2_exp_size[:-2])\\n\\n # flatten expanded batches\\n tensor1_expanded = tensor1.expand(*(expand_batch_portion + tensor1_exp_size[-2:])) \\\\\\n .contiguous().view(reduce(mul, expand_batch_portion), *tensor1_exp_size[-2:])\\n tensor2_expanded = tensor2.expand(*(expand_batch_portion + tensor2_exp_size[-2:])) \\\\\\n .contiguous().view(reduce(mul, expand_batch_portion), *tensor2_exp_size[-2:])\\n\\n # reshape batches back into result\\n total_expansion = expand_batch_portion + (tensor1_exp_size[-2], tensor2_exp_size[-1])\\n\\n def maybeSqueeze(tensor):\\n if dim_tensor1 == 1:\\n return tensor.squeeze(-2)\\n elif dim_tensor2 == 1:\\n return tensor.squeeze(-1)\\n else:\\n return tensor\\n\\n if out is None or not out.is_contiguous():\\n output = torch.bmm(tensor1_expanded, tensor2_expanded)\\n else:\\n output = torch.bmm(tensor1_expanded, tensor2_expanded, out=out)\\n\\n output = maybeSqueeze(output.view(total_expansion))\\n\\n if out is not None:\\n out.set_(output)\\n return out\\n\\n return output\\n\\n raise ValueError(\\\"both arguments to __matmul__ need to be at least 1D, \\\"\\n \\\"but they are {}D and {}D\\\".format(dim_tensor1, dim_tensor2))\\n\",\n \"path\": \"torch/functional.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import torch\nfrom ._utils import _range\nfrom operator import mul\nfrom functools import reduce\n\n__all__ = [\n 'split', 'chunk', 'stack', 'unbind', 'btriunpack', 'matmul',\n]\n\n\ndef split(tensor, split_size, dim=0):\n \"\"\"Splits the tensor into equally sized chunks (if possible).\n\n Last chunk will be smaller if the tensor size along a given dimension\n is not divisible by ``split_size``.\n\n Arguments:\n tensor (Tensor): tensor to split.\n split_size (int): size of a single chunk.\n dim (int): dimension along which to split the tensor.\n \"\"\"\n if dim < 0:\n dim += tensor.dim()\n dim_size = tensor.size(dim)\n num_splits = (dim_size + split_size - 1) // split_size\n last_split_size = split_size - (split_size * num_splits - dim_size)\n\n def get_split_size(i):\n return split_size if i < num_splits - 1 else last_split_size\n return tuple(tensor.narrow(int(dim), int(i * split_size), int(get_split_size(i))) for i\n in _range(0, num_splits))\n\n\ndef chunk(tensor, chunks, dim=0):\n \"\"\"Splits a tensor into a number of chunks along a given dimension.\n\n Arguments:\n tensor (Tensor): tensor to split.\n chunks (int): number of chunks to return.\n dim (int): dimension along which to split the tensor.\n \"\"\"\n if dim < 0:\n dim += tensor.dim()\n split_size = (tensor.size(dim) + chunks - 1) // chunks\n return split(tensor, split_size, dim)\n\n\ndef stack(sequence, dim=0, out=None):\n \"\"\"Concatenates sequence of tensors along a new dimension.\n\n All tensors need to be of the same size.\n\n Arguments:\n sequence (Sequence): sequence of tensors to concatenate.\n dim (int): dimension to insert. Has to be between 0 and the number\n of dimensions of concatenated tensors (inclusive).\n \"\"\"\n if len(sequence) == 0:\n raise ValueError(\"stack expects a non-empty sequence of tensors\")\n if dim < 0:\n dim += sequence[0].dim() + 1\n inputs = [t.unsqueeze(dim) for t in sequence]\n if out is None:\n return torch.cat(inputs, dim)\n else:\n return torch.cat(inputs, dim, out=out)\n\n\ndef unbind(tensor, dim=0):\n \"\"\"Removes a tensor dimension.\n\n Returns a tuple of all slices along a given dimension, already without it.\n\n Arguments:\n tensor (Tensor): tensor to unbind.\n dim (int): dimension to remove.\n \"\"\"\n return tuple(tensor.select(dim, i) for i in _range(tensor.size(dim)))\n\n\ndef btriunpack(LU_data, LU_pivots, unpack_data=True, unpack_pivots=True):\n \"\"\"Unpacks the data and pivots from a batched LU factorization (btrifact) of a tensor.\n\n Returns a tuple indexed by:\n 0: The pivots.\n 1: The L tensor.\n 2: The U tensor.\n\n Arguments:\n LU_data (Tensor): The packed LU factorization data.\n LU_pivots (Tensor): The packed LU factorization pivots.\n unpack_data (bool): Flag indicating if the data should be unpacked.\n unpack_pivots (bool): Flag indicating if the pivots should be unpacked.\n \"\"\"\n\n nBatch, sz, _ = LU_data.size()\n\n if unpack_data:\n I_U = torch.triu(torch.ones(sz, sz)).type_as(LU_data).byte().unsqueeze(0).expand(nBatch, sz, sz)\n I_L = 1 - I_U\n L = LU_data.new(LU_data.size()).zero_()\n U = LU_data.new(LU_data.size()).zero_()\n I_diag = torch.eye(sz).type_as(LU_data).byte().unsqueeze(0).expand(nBatch, sz, sz)\n L[I_diag] = 1.0\n L[I_L] = LU_data[I_L]\n U[I_U] = LU_data[I_U]\n else:\n L = U = None\n\n if unpack_pivots:\n P = torch.eye(sz).type_as(LU_data).unsqueeze(0).repeat(nBatch, 1, 1)\n for i in range(nBatch):\n for j in range(sz):\n k = LU_pivots[i, j] - 1\n t = P[i, :, j].clone()\n P[i, :, j] = P[i, :, k]\n P[i, :, k] = t\n else:\n P = None\n\n return P, L, U\n\n\ndef matmul(tensor1, tensor2, out=None):\n \"\"\"Matrix product of two tensors.\n\n The behavior depends on the dimensionality of the tensors as follows:\n\n - If both tensors are 1-dimensional, the dot product (scalar) is returned.\n - If both arguments are 2-dimensional, the matrix-matrix product is returned.\n - If the first argument is 1-dimensional and the second argument is 2-dimensional,\n a 1 is prepended to its dimension for the purpose of the matrix multiply.\n After the matrix multiply, the prepended dimension is removed.\n - If the first argument is 2-dimensional and the second argument is 1-dimensional,\n the matrix-vector product is returned.\n - If both arguments are at least 1-dimensional and at least one argument is\n N-dimensional (where N > 2), then a batched matrix multiply is returned. If the first\n argument is 1-dimensional, a 1 is prepended to its dimension for the purpose of the\n batched matrix multiply and removed after. If the second argument is 1-dimensional, a\n 1 is appended to its dimension for the purpose of the batched matrix multiple and removed after.\n The non-matrix (i.e. batch) dimensions are :ref:`broadcasted <broadcasting-semantics>` (and thus\n must be broadcastable). For example, if :attr:`tensor1` is a `j x 1 x n x m` Tensor\n and :attr:`tensor2` is a `k x m x p` Tensor, :attr:`out` will be an `j x k x n x p` Tensor.\n\n .. note::\n\n The 1-dimensional dot product version of this function does not support an :attr:`out` parameter.\n\n Arguments:\n tensor1 (Tensor): First tensor to be multiplied\n tensor2 (Tensor): Second tensor to be multiplied\n out (Tensor, optional): Output tensor\n \"\"\"\n dim_tensor1 = tensor1.dim()\n dim_tensor2 = tensor2.dim()\n if dim_tensor1 == 1 and dim_tensor2 == 1:\n if out is None:\n return torch.dot(tensor1, tensor2)\n else:\n raise ValueError(\"out must be None for 1-d tensor matmul, returns a scalar\")\n if dim_tensor1 == 2 and dim_tensor2 == 1:\n if out is None:\n return torch.mv(tensor1, tensor2)\n else:\n return torch.mv(tensor1, tensor2, out=out)\n elif dim_tensor1 == 1 and dim_tensor2 == 2:\n if out is None:\n return torch.mm(tensor1.unsqueeze(0), tensor2).squeeze_(0)\n else:\n return torch.mm(tensor1.unsqueeze(0), tensor2, out=out).squeeze_(0)\n elif dim_tensor1 == 2 and dim_tensor2 == 2:\n if out is None:\n return torch.mm(tensor1, tensor2)\n else:\n return torch.mm(tensor1, tensor2, out=out)\n elif dim_tensor1 >= 3 and (dim_tensor2 == 1 or dim_tensor2 == 2):\n # optimization: use mm instead of bmm by folding tensor1's batch into\n # its leading matrix dimension.\n\n if dim_tensor2 == 1:\n tensor2 = tensor2.unsqueeze(-1)\n\n size1 = tensor1.size()\n size2 = tensor2.size()\n output_size = size1[:-1] + size2[-1:]\n\n # fold the batch into the first dimension\n tensor1 = tensor1.contiguous().view(-1, size1[-1])\n\n if out is None or not out.is_contiguous():\n output = torch.mm(tensor1, tensor2)\n else:\n output = torch.mm(tensor1, tensor2, out=out)\n\n output = output.view(output_size)\n\n if dim_tensor2 == 1:\n output = output.squeeze(-1)\n\n if out is not None:\n out.set_(output)\n return out\n\n return output\n elif (dim_tensor1 >= 1 and dim_tensor2 >= 1) and (dim_tensor1 >= 3 or dim_tensor2 >= 3):\n # ensure each tensor size is at least 3-dimensional\n tensor1_exp_size = torch.Size((1,) * max(3 - tensor1.dim(), 0) + tensor1.size())\n # rhs needs to be a separate case since we can't freely expand 1s on the rhs, but can on lhs\n if dim_tensor2 == 1:\n tensor2 = tensor2.unsqueeze(1)\n tensor2_exp_size = torch.Size((1,) * max(3 - tensor2.dim(), 0) + tensor2.size())\n\n # expand the batch portion (i.e. cut off matrix dimensions and expand rest)\n expand_batch_portion = torch._C._infer_size(tensor1_exp_size[:-2], tensor2_exp_size[:-2])\n\n # flatten expanded batches\n tensor1_expanded = tensor1.expand(*(expand_batch_portion + tensor1_exp_size[-2:])) \\\n .contiguous().view(reduce(mul, expand_batch_portion), *tensor1_exp_size[-2:])\n tensor2_expanded = tensor2.expand(*(expand_batch_portion + tensor2_exp_size[-2:])) \\\n .contiguous().view(reduce(mul, expand_batch_portion), *tensor2_exp_size[-2:])\n\n # reshape batches back into result\n total_expansion = expand_batch_portion + (tensor1_exp_size[-2], tensor2_exp_size[-1])\n\n def maybeSqueeze(tensor):\n if dim_tensor1 == 1:\n return tensor.squeeze(-2)\n elif dim_tensor2 == 1:\n return tensor.squeeze(-1)\n else:\n return tensor\n\n if out is None or not out.is_contiguous():\n output = torch.bmm(tensor1_expanded, tensor2_expanded)\n else:\n output = torch.bmm(tensor1_expanded, tensor2_expanded, out=out)\n\n output = maybeSqueeze(output.view(total_expansion))\n\n if out is not None:\n out.set_(output)\n return out\n\n return output\n\n raise ValueError(\"both arguments to __matmul__ need to be at least 1D, \"\n \"but they are {}D and {}D\".format(dim_tensor1, dim_tensor2))\n","path":"torch/functional.py"}],"string":"[\n {\n \"content\": \"import torch\\nfrom ._utils import _range\\nfrom operator import mul\\nfrom functools import reduce\\n\\n__all__ = [\\n 'split', 'chunk', 'stack', 'unbind', 'btriunpack', 'matmul',\\n]\\n\\n\\ndef split(tensor, split_size, dim=0):\\n \\\"\\\"\\\"Splits the tensor into equally sized chunks (if possible).\\n\\n Last chunk will be smaller if the tensor size along a given dimension\\n is not divisible by ``split_size``.\\n\\n Arguments:\\n tensor (Tensor): tensor to split.\\n split_size (int): size of a single chunk.\\n dim (int): dimension along which to split the tensor.\\n \\\"\\\"\\\"\\n if dim < 0:\\n dim += tensor.dim()\\n dim_size = tensor.size(dim)\\n num_splits = (dim_size + split_size - 1) // split_size\\n last_split_size = split_size - (split_size * num_splits - dim_size)\\n\\n def get_split_size(i):\\n return split_size if i < num_splits - 1 else last_split_size\\n return tuple(tensor.narrow(int(dim), int(i * split_size), int(get_split_size(i))) for i\\n in _range(0, num_splits))\\n\\n\\ndef chunk(tensor, chunks, dim=0):\\n \\\"\\\"\\\"Splits a tensor into a number of chunks along a given dimension.\\n\\n Arguments:\\n tensor (Tensor): tensor to split.\\n chunks (int): number of chunks to return.\\n dim (int): dimension along which to split the tensor.\\n \\\"\\\"\\\"\\n if dim < 0:\\n dim += tensor.dim()\\n split_size = (tensor.size(dim) + chunks - 1) // chunks\\n return split(tensor, split_size, dim)\\n\\n\\ndef stack(sequence, dim=0, out=None):\\n \\\"\\\"\\\"Concatenates sequence of tensors along a new dimension.\\n\\n All tensors need to be of the same size.\\n\\n Arguments:\\n sequence (Sequence): sequence of tensors to concatenate.\\n dim (int): dimension to insert. Has to be between 0 and the number\\n of dimensions of concatenated tensors (inclusive).\\n \\\"\\\"\\\"\\n if len(sequence) == 0:\\n raise ValueError(\\\"stack expects a non-empty sequence of tensors\\\")\\n if dim < 0:\\n dim += sequence[0].dim() + 1\\n inputs = [t.unsqueeze(dim) for t in sequence]\\n if out is None:\\n return torch.cat(inputs, dim)\\n else:\\n return torch.cat(inputs, dim, out=out)\\n\\n\\ndef unbind(tensor, dim=0):\\n \\\"\\\"\\\"Removes a tensor dimension.\\n\\n Returns a tuple of all slices along a given dimension, already without it.\\n\\n Arguments:\\n tensor (Tensor): tensor to unbind.\\n dim (int): dimension to remove.\\n \\\"\\\"\\\"\\n return tuple(tensor.select(dim, i) for i in _range(tensor.size(dim)))\\n\\n\\ndef btriunpack(LU_data, LU_pivots, unpack_data=True, unpack_pivots=True):\\n \\\"\\\"\\\"Unpacks the data and pivots from a batched LU factorization (btrifact) of a tensor.\\n\\n Returns a tuple indexed by:\\n 0: The pivots.\\n 1: The L tensor.\\n 2: The U tensor.\\n\\n Arguments:\\n LU_data (Tensor): The packed LU factorization data.\\n LU_pivots (Tensor): The packed LU factorization pivots.\\n unpack_data (bool): Flag indicating if the data should be unpacked.\\n unpack_pivots (bool): Flag indicating if the pivots should be unpacked.\\n \\\"\\\"\\\"\\n\\n nBatch, sz, _ = LU_data.size()\\n\\n if unpack_data:\\n I_U = torch.triu(torch.ones(sz, sz)).type_as(LU_data).byte().unsqueeze(0).expand(nBatch, sz, sz)\\n I_L = 1 - I_U\\n L = LU_data.new(LU_data.size()).zero_()\\n U = LU_data.new(LU_data.size()).zero_()\\n I_diag = torch.eye(sz).type_as(LU_data).byte().unsqueeze(0).expand(nBatch, sz, sz)\\n L[I_diag] = 1.0\\n L[I_L] = LU_data[I_L]\\n U[I_U] = LU_data[I_U]\\n else:\\n L = U = None\\n\\n if unpack_pivots:\\n P = torch.eye(sz).type_as(LU_data).unsqueeze(0).repeat(nBatch, 1, 1)\\n for i in range(nBatch):\\n for j in range(sz):\\n k = LU_pivots[i, j] - 1\\n t = P[i, :, j].clone()\\n P[i, :, j] = P[i, :, k]\\n P[i, :, k] = t\\n else:\\n P = None\\n\\n return P, L, U\\n\\n\\ndef matmul(tensor1, tensor2, out=None):\\n \\\"\\\"\\\"Matrix product of two tensors.\\n\\n The behavior depends on the dimensionality of the tensors as follows:\\n\\n - If both tensors are 1-dimensional, the dot product (scalar) is returned.\\n - If both arguments are 2-dimensional, the matrix-matrix product is returned.\\n - If the first argument is 1-dimensional and the second argument is 2-dimensional,\\n a 1 is prepended to its dimension for the purpose of the matrix multiply.\\n After the matrix multiply, the prepended dimension is removed.\\n - If the first argument is 2-dimensional and the second argument is 1-dimensional,\\n the matrix-vector product is returned.\\n - If both arguments are at least 1-dimensional and at least one argument is\\n N-dimensional (where N > 2), then a batched matrix multiply is returned. If the first\\n argument is 1-dimensional, a 1 is prepended to its dimension for the purpose of the\\n batched matrix multiply and removed after. If the second argument is 1-dimensional, a\\n 1 is appended to its dimension for the purpose of the batched matrix multiple and removed after.\\n The non-matrix (i.e. batch) dimensions are :ref:`broadcasted <broadcasting-semantics>` (and thus\\n must be broadcastable). For example, if :attr:`tensor1` is a `j x 1 x n x m` Tensor\\n and :attr:`tensor2` is a `k x m x p` Tensor, :attr:`out` will be an `j x k x n x p` Tensor.\\n\\n .. note::\\n\\n The 1-dimensional dot product version of this function does not support an :attr:`out` parameter.\\n\\n Arguments:\\n tensor1 (Tensor): First tensor to be multiplied\\n tensor2 (Tensor): Second tensor to be multiplied\\n out (Tensor, optional): Output tensor\\n \\\"\\\"\\\"\\n dim_tensor1 = tensor1.dim()\\n dim_tensor2 = tensor2.dim()\\n if dim_tensor1 == 1 and dim_tensor2 == 1:\\n if out is None:\\n return torch.dot(tensor1, tensor2)\\n else:\\n raise ValueError(\\\"out must be None for 1-d tensor matmul, returns a scalar\\\")\\n if dim_tensor1 == 2 and dim_tensor2 == 1:\\n if out is None:\\n return torch.mv(tensor1, tensor2)\\n else:\\n return torch.mv(tensor1, tensor2, out=out)\\n elif dim_tensor1 == 1 and dim_tensor2 == 2:\\n if out is None:\\n return torch.mm(tensor1.unsqueeze(0), tensor2).squeeze_(0)\\n else:\\n return torch.mm(tensor1.unsqueeze(0), tensor2, out=out).squeeze_(0)\\n elif dim_tensor1 == 2 and dim_tensor2 == 2:\\n if out is None:\\n return torch.mm(tensor1, tensor2)\\n else:\\n return torch.mm(tensor1, tensor2, out=out)\\n elif dim_tensor1 >= 3 and (dim_tensor2 == 1 or dim_tensor2 == 2):\\n # optimization: use mm instead of bmm by folding tensor1's batch into\\n # its leading matrix dimension.\\n\\n if dim_tensor2 == 1:\\n tensor2 = tensor2.unsqueeze(-1)\\n\\n size1 = tensor1.size()\\n size2 = tensor2.size()\\n output_size = size1[:-1] + size2[-1:]\\n\\n # fold the batch into the first dimension\\n tensor1 = tensor1.contiguous().view(-1, size1[-1])\\n\\n if out is None or not out.is_contiguous():\\n output = torch.mm(tensor1, tensor2)\\n else:\\n output = torch.mm(tensor1, tensor2, out=out)\\n\\n output = output.view(output_size)\\n\\n if dim_tensor2 == 1:\\n output = output.squeeze(-1)\\n\\n if out is not None:\\n out.set_(output)\\n return out\\n\\n return output\\n elif (dim_tensor1 >= 1 and dim_tensor2 >= 1) and (dim_tensor1 >= 3 or dim_tensor2 >= 3):\\n # ensure each tensor size is at least 3-dimensional\\n tensor1_exp_size = torch.Size((1,) * max(3 - tensor1.dim(), 0) + tensor1.size())\\n # rhs needs to be a separate case since we can't freely expand 1s on the rhs, but can on lhs\\n if dim_tensor2 == 1:\\n tensor2 = tensor2.unsqueeze(1)\\n tensor2_exp_size = torch.Size((1,) * max(3 - tensor2.dim(), 0) + tensor2.size())\\n\\n # expand the batch portion (i.e. cut off matrix dimensions and expand rest)\\n expand_batch_portion = torch._C._infer_size(tensor1_exp_size[:-2], tensor2_exp_size[:-2])\\n\\n # flatten expanded batches\\n tensor1_expanded = tensor1.expand(*(expand_batch_portion + tensor1_exp_size[-2:])) \\\\\\n .contiguous().view(reduce(mul, expand_batch_portion), *tensor1_exp_size[-2:])\\n tensor2_expanded = tensor2.expand(*(expand_batch_portion + tensor2_exp_size[-2:])) \\\\\\n .contiguous().view(reduce(mul, expand_batch_portion), *tensor2_exp_size[-2:])\\n\\n # reshape batches back into result\\n total_expansion = expand_batch_portion + (tensor1_exp_size[-2], tensor2_exp_size[-1])\\n\\n def maybeSqueeze(tensor):\\n if dim_tensor1 == 1:\\n return tensor.squeeze(-2)\\n elif dim_tensor2 == 1:\\n return tensor.squeeze(-1)\\n else:\\n return tensor\\n\\n if out is None or not out.is_contiguous():\\n output = torch.bmm(tensor1_expanded, tensor2_expanded)\\n else:\\n output = torch.bmm(tensor1_expanded, tensor2_expanded, out=out)\\n\\n output = maybeSqueeze(output.view(total_expansion))\\n\\n if out is not None:\\n out.set_(output)\\n return out\\n\\n return output\\n\\n raise ValueError(\\\"both arguments to __matmul__ need to be at least 1D, \\\"\\n \\\"but they are {}D and {}D\\\".format(dim_tensor1, dim_tensor2))\\n\",\n \"path\": \"torch/functional.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/test/test_torch.py b/test/test_torch.py\nindex e9bbb8e0c96165..ecd05a75ed0835 100644\n--- a/test/test_torch.py\n+++ b/test/test_torch.py\n@@ -1644,7 +1644,9 @@ def test_stack(self):\n z = torch.rand(2, 3, 4)\n for dim in range(4):\n res = torch.stack((x, y, z), dim)\n+ res_neg = torch.stack((x, y, z), dim - 4)\n expected_size = x.size()[:dim] + (3,) + x.size()[dim:]\n+ self.assertEqual(res, res_neg)\n self.assertEqual(res.size(), expected_size)\n self.assertEqual(res.select(dim, 0), x, 0)\n self.assertEqual(res.select(dim, 1), y, 0)\n@@ -4130,7 +4132,6 @@ def idx_tensor(size, max_val):\n ('index_select', (10, 10), lambda: [DIM_ARG, idx_tensor((10,), 10)], [METHOD, FUNCTIONAL]),\n ('split', (10, 20), lambda: [5, DIM_ARG], [METHOD, FUNCTIONAL]),\n ('squeeze', (10, 1, 20, 1), lambda: [DIM_ARG], [METHOD, INPLACE_METHOD, FUNCTIONAL]),\n- ('stack', [(2, 3, 4), (2, 3, 4)], lambda: [DIM_ARG], [FUNCTIONAL]),\n ('unbind', (2, 3, 4), lambda: [DIM_ARG], [FUNCTIONAL]),\n ('unsqueeze', (10, 20), lambda: [DIM_ARG], [METHOD, INPLACE_METHOD, FUNCTIONAL], 1),\n ('cumprod', (10, 20), lambda: [DIM_ARG], [METHOD, FUNCTIONAL]),\ndiff --git a/torch/functional.py b/torch/functional.py\nindex 15447a307a91be..41f4a90f78fa0a 100644\n--- a/torch/functional.py\n+++ b/torch/functional.py\n@@ -58,7 +58,7 @@ def stack(sequence, dim=0, out=None):\n if len(sequence) == 0:\n raise ValueError(\"stack expects a non-empty sequence of tensors\")\n if dim < 0:\n- dim += sequence[0].dim()\n+ dim += sequence[0].dim() + 1\n inputs = [t.unsqueeze(dim) for t in sequence]\n if out is None:\n return torch.cat(inputs, dim)\n"}}},{"rowIdx":4690,"cells":{"in_source_id":{"kind":"string","value":"cloud-custodian__cloud-custodian-9163"},"issue":{"kind":"string","value":"aws - glue connection has NoneType error when no VPC\n### Describe the bug\n\nWhen there is no VPC on the Glue connection resource, we get a `TypeError: 'NoneType' object is not iterable` error\n\n### What did you expect to happen?\n\nSucceed in this case.\n\n### Cloud Provider\n\nAmazon Web Services (AWS)\n\n### Cloud Custodian version and dependency information\n\n```shell\nCustodian: 0.9.32\r\nPython: 3.9.6 (default, Aug 11 2023, 19:44:49) \r\n [Clang 15.0.0 (clang-1500.0.40.1)]\n```\n\n\n### Policy\n\n_No response_\n\n### Relevant log/traceback output\n\n```shell\nERROR custodian.output:output.py:336 Error while executing policy\r\nTraceback (most recent call last):\r\n File \"/Users/timmygrable/Projects/cloud-custodian/c7n/policy.py\", line 330, in run\r\n resources = self.policy.resource_manager.resources()\r\n File \"/Users/timmygrable/Projects/cloud-custodian/c7n/query.py\", line 549, in resources\r\n resources = self.filter_resources(resources)\r\n File \"/Users/timmygrable/Projects/cloud-custodian/c7n/manager.py\", line 112, in filter_resources\r\n resources = f.process(resources, event)\r\n File \"/Users/timmygrable/Projects/cloud-custodian/c7n/filters/vpc.py\", line 98, in process\r\n related = self.get_related(resources)\r\n File \"/Users/timmygrable/Projects/cloud-custodian/c7n/filters/related.py\", line 49, in get_related\r\n return {r[model.id]: r for r in related\r\nTypeError: 'NoneType' object is not iterable\n```\n\n\n### Extra information or context\n\n_No response_\n"},"before_files":{"kind":"list like","value":[{"content":"# Copyright The Cloud Custodian Authors.\n# SPDX-License-Identifier: Apache-2.0\nimport importlib\nfrom functools import lru_cache\n\nfrom .core import ValueFilter, OPERATORS\nfrom c7n.query import ChildResourceQuery\nfrom c7n.utils import jmespath_search\n\n\nclass RelatedResourceFilter(ValueFilter):\n\n schema_alias = False\n\n RelatedResource = None\n RelatedIdsExpression = None\n AnnotationKey = None\n FetchThreshold = 10\n\n def get_permissions(self):\n return self.get_resource_manager().get_permissions()\n\n def validate(self):\n name = self.__class__.__name__\n if self.RelatedIdsExpression is None:\n raise ValueError(\n \"%s Filter requires resource expression\" % name)\n # if self.AnnotationKey is None:\n # raise ValueError(\n # \"%s Filter requires annotation key\" % name)\n\n if self.RelatedResource is None:\n raise ValueError(\n \"%s Filter requires resource manager spec\" % name)\n return super(RelatedResourceFilter, self).validate()\n\n def get_related_ids(self, resources):\n return set(jmespath_search(\n \"[].%s\" % self.RelatedIdsExpression, resources))\n\n def get_related(self, resources):\n resource_manager = self.get_resource_manager()\n related_ids = self.get_related_ids(resources)\n model = resource_manager.get_model()\n if len(related_ids) < self.FetchThreshold:\n related = resource_manager.get_resources(list(related_ids))\n else:\n related = resource_manager.resources()\n return {r[model.id]: r for r in related\n if r[model.id] in related_ids}\n\n @lru_cache(maxsize=None)\n def get_resource_manager(self):\n mod_path, class_name = self.RelatedResource.rsplit('.', 1)\n module = importlib.import_module(mod_path)\n manager_class = getattr(module, class_name)\n return manager_class(self.manager.ctx, {})\n\n def process_resource(self, resource, related):\n related_ids = self.get_related_ids([resource])\n model = self.manager.get_model()\n op = self.data.get('operator', 'or')\n found = []\n\n if self.data.get('match-resource') is True:\n self.data['value'] = self.get_resource_value(\n self.data['key'], resource)\n\n if self.data.get('value_type') == 'resource_count':\n count_matches = OPERATORS[self.data.get('op')](len(related_ids), self.data.get('value'))\n if count_matches:\n self._add_annotations(related_ids, resource)\n return count_matches\n\n for rid in related_ids:\n robj = related.get(rid, None)\n if robj is None:\n # in the event that the filter is looking specifically for absent values, we can\n # safely assume that the non-existant related resource will have an absent value at\n # any given key\n if self.data['value'] == 'absent':\n found.append(rid)\n else:\n self.log.warning(\n \"Resource %s:%s references non existant %s: %s\",\n self.manager.type,\n resource[model.id],\n self.RelatedResource.rsplit('.', 1)[-1],\n rid)\n continue\n if self.match(robj):\n found.append(rid)\n\n if found:\n self._add_annotations(found, resource)\n\n if op == 'or' and found:\n return True\n elif op == 'and' and len(found) == len(related_ids):\n return True\n return False\n\n def _add_annotations(self, related_ids, resource):\n if self.AnnotationKey is not None:\n akey = 'c7n:%s' % self.AnnotationKey\n resource[akey] = list(set(related_ids).union(resource.get(akey, [])))\n\n def process(self, resources, event=None):\n related = self.get_related(resources)\n return [r for r in resources if self.process_resource(r, related)]\n\n\nclass RelatedResourceByIdFilter(RelatedResourceFilter):\n \"\"\"\n Value filter for related resources in which the main resource only contains the related\n resource id.\n \"\"\"\n\n RelatedResourceByIdExpression = None\n\n def get_related(self, resources):\n resource_manager = self.get_resource_manager()\n related_ids = self.get_related_ids(resources)\n\n related = {}\n for r in resource_manager.resources():\n matched_vpc = self.get_related_by_ids(r) & related_ids\n if matched_vpc:\n for vpc in matched_vpc:\n related_resources = related.get(vpc, [])\n related_resources.append(r)\n related[vpc] = related_resources\n return related\n\n def get_related_by_ids(self, resources):\n RelatedResourceKey = self.RelatedResourceByIdExpression or self.RelatedIdsExpression\n ids = jmespath_search(\"%s\" % RelatedResourceKey, resources)\n if isinstance(ids, str):\n ids = [ids]\n return set(ids)\n\n def process_resource(self, resource, related):\n related_ids = self.get_related_ids([resource])\n op = self.data.get('operator', 'or')\n found = []\n\n if self.data.get('match-resource') is True:\n self.data['value'] = self.get_resource_value(\n self.data['key'], resource)\n\n if self.data.get('value_type') == 'resource_count':\n count_matches = OPERATORS[self.data.get('op')](len(related_ids), self.data.get('value'))\n if count_matches:\n self._add_annotations(related_ids, resource)\n return count_matches\n\n for rid in related_ids:\n robjs = related.get(rid, [None])\n for robj in robjs:\n if robj is None:\n continue\n if self.match(robj):\n found.append(rid)\n\n if found:\n self._add_annotations(found, resource)\n\n if op == 'or' and found:\n return True\n elif op == 'and' and len(found) == len(related_ids):\n return True\n return False\n\n\nclass ChildResourceFilter(RelatedResourceFilter):\n ChildResource = None\n RelatedIdsExpression = None\n ChildResourceParentKey = \"c7n:parent-id\"\n\n def get_related(self, resources):\n self.child_resources = {}\n\n parent_ids = self.get_related_ids(resources)\n\n child_resource_manager = self.get_resource_manager()\n child_query = ChildResourceQuery(\n child_resource_manager.session_factory,\n child_resource_manager,\n )\n children = child_query.filter(child_resource_manager, parent_ids=list(parent_ids))\n for r in children:\n self.child_resources.setdefault(r[self.ChildResourceParentKey], []).append(r)\n\n return self.child_resources\n\n def _add_annotations(self, related_ids, resource):\n if self.AnnotationKey is not None:\n model = self.manager.get_model()\n akey = 'c7n:%s' % self.AnnotationKey\n resource[akey] = self.child_resources.get(resource[model.id], [])\n","path":"c7n/filters/related.py"}],"string":"[\n {\n \"content\": \"# Copyright The Cloud Custodian Authors.\\n# SPDX-License-Identifier: Apache-2.0\\nimport importlib\\nfrom functools import lru_cache\\n\\nfrom .core import ValueFilter, OPERATORS\\nfrom c7n.query import ChildResourceQuery\\nfrom c7n.utils import jmespath_search\\n\\n\\nclass RelatedResourceFilter(ValueFilter):\\n\\n schema_alias = False\\n\\n RelatedResource = None\\n RelatedIdsExpression = None\\n AnnotationKey = None\\n FetchThreshold = 10\\n\\n def get_permissions(self):\\n return self.get_resource_manager().get_permissions()\\n\\n def validate(self):\\n name = self.__class__.__name__\\n if self.RelatedIdsExpression is None:\\n raise ValueError(\\n \\\"%s Filter requires resource expression\\\" % name)\\n # if self.AnnotationKey is None:\\n # raise ValueError(\\n # \\\"%s Filter requires annotation key\\\" % name)\\n\\n if self.RelatedResource is None:\\n raise ValueError(\\n \\\"%s Filter requires resource manager spec\\\" % name)\\n return super(RelatedResourceFilter, self).validate()\\n\\n def get_related_ids(self, resources):\\n return set(jmespath_search(\\n \\\"[].%s\\\" % self.RelatedIdsExpression, resources))\\n\\n def get_related(self, resources):\\n resource_manager = self.get_resource_manager()\\n related_ids = self.get_related_ids(resources)\\n model = resource_manager.get_model()\\n if len(related_ids) < self.FetchThreshold:\\n related = resource_manager.get_resources(list(related_ids))\\n else:\\n related = resource_manager.resources()\\n return {r[model.id]: r for r in related\\n if r[model.id] in related_ids}\\n\\n @lru_cache(maxsize=None)\\n def get_resource_manager(self):\\n mod_path, class_name = self.RelatedResource.rsplit('.', 1)\\n module = importlib.import_module(mod_path)\\n manager_class = getattr(module, class_name)\\n return manager_class(self.manager.ctx, {})\\n\\n def process_resource(self, resource, related):\\n related_ids = self.get_related_ids([resource])\\n model = self.manager.get_model()\\n op = self.data.get('operator', 'or')\\n found = []\\n\\n if self.data.get('match-resource') is True:\\n self.data['value'] = self.get_resource_value(\\n self.data['key'], resource)\\n\\n if self.data.get('value_type') == 'resource_count':\\n count_matches = OPERATORS[self.data.get('op')](len(related_ids), self.data.get('value'))\\n if count_matches:\\n self._add_annotations(related_ids, resource)\\n return count_matches\\n\\n for rid in related_ids:\\n robj = related.get(rid, None)\\n if robj is None:\\n # in the event that the filter is looking specifically for absent values, we can\\n # safely assume that the non-existant related resource will have an absent value at\\n # any given key\\n if self.data['value'] == 'absent':\\n found.append(rid)\\n else:\\n self.log.warning(\\n \\\"Resource %s:%s references non existant %s: %s\\\",\\n self.manager.type,\\n resource[model.id],\\n self.RelatedResource.rsplit('.', 1)[-1],\\n rid)\\n continue\\n if self.match(robj):\\n found.append(rid)\\n\\n if found:\\n self._add_annotations(found, resource)\\n\\n if op == 'or' and found:\\n return True\\n elif op == 'and' and len(found) == len(related_ids):\\n return True\\n return False\\n\\n def _add_annotations(self, related_ids, resource):\\n if self.AnnotationKey is not None:\\n akey = 'c7n:%s' % self.AnnotationKey\\n resource[akey] = list(set(related_ids).union(resource.get(akey, [])))\\n\\n def process(self, resources, event=None):\\n related = self.get_related(resources)\\n return [r for r in resources if self.process_resource(r, related)]\\n\\n\\nclass RelatedResourceByIdFilter(RelatedResourceFilter):\\n \\\"\\\"\\\"\\n Value filter for related resources in which the main resource only contains the related\\n resource id.\\n \\\"\\\"\\\"\\n\\n RelatedResourceByIdExpression = None\\n\\n def get_related(self, resources):\\n resource_manager = self.get_resource_manager()\\n related_ids = self.get_related_ids(resources)\\n\\n related = {}\\n for r in resource_manager.resources():\\n matched_vpc = self.get_related_by_ids(r) & related_ids\\n if matched_vpc:\\n for vpc in matched_vpc:\\n related_resources = related.get(vpc, [])\\n related_resources.append(r)\\n related[vpc] = related_resources\\n return related\\n\\n def get_related_by_ids(self, resources):\\n RelatedResourceKey = self.RelatedResourceByIdExpression or self.RelatedIdsExpression\\n ids = jmespath_search(\\\"%s\\\" % RelatedResourceKey, resources)\\n if isinstance(ids, str):\\n ids = [ids]\\n return set(ids)\\n\\n def process_resource(self, resource, related):\\n related_ids = self.get_related_ids([resource])\\n op = self.data.get('operator', 'or')\\n found = []\\n\\n if self.data.get('match-resource') is True:\\n self.data['value'] = self.get_resource_value(\\n self.data['key'], resource)\\n\\n if self.data.get('value_type') == 'resource_count':\\n count_matches = OPERATORS[self.data.get('op')](len(related_ids), self.data.get('value'))\\n if count_matches:\\n self._add_annotations(related_ids, resource)\\n return count_matches\\n\\n for rid in related_ids:\\n robjs = related.get(rid, [None])\\n for robj in robjs:\\n if robj is None:\\n continue\\n if self.match(robj):\\n found.append(rid)\\n\\n if found:\\n self._add_annotations(found, resource)\\n\\n if op == 'or' and found:\\n return True\\n elif op == 'and' and len(found) == len(related_ids):\\n return True\\n return False\\n\\n\\nclass ChildResourceFilter(RelatedResourceFilter):\\n ChildResource = None\\n RelatedIdsExpression = None\\n ChildResourceParentKey = \\\"c7n:parent-id\\\"\\n\\n def get_related(self, resources):\\n self.child_resources = {}\\n\\n parent_ids = self.get_related_ids(resources)\\n\\n child_resource_manager = self.get_resource_manager()\\n child_query = ChildResourceQuery(\\n child_resource_manager.session_factory,\\n child_resource_manager,\\n )\\n children = child_query.filter(child_resource_manager, parent_ids=list(parent_ids))\\n for r in children:\\n self.child_resources.setdefault(r[self.ChildResourceParentKey], []).append(r)\\n\\n return self.child_resources\\n\\n def _add_annotations(self, related_ids, resource):\\n if self.AnnotationKey is not None:\\n model = self.manager.get_model()\\n akey = 'c7n:%s' % self.AnnotationKey\\n resource[akey] = self.child_resources.get(resource[model.id], [])\\n\",\n \"path\": \"c7n/filters/related.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# Copyright The Cloud Custodian Authors.\n# SPDX-License-Identifier: Apache-2.0\nimport importlib\nfrom functools import lru_cache\n\nfrom .core import ValueFilter, OPERATORS\nfrom c7n.query import ChildResourceQuery\nfrom c7n.utils import jmespath_search\n\n\nclass RelatedResourceFilter(ValueFilter):\n\n schema_alias = False\n\n RelatedResource = None\n RelatedIdsExpression = None\n AnnotationKey = None\n FetchThreshold = 10\n\n def get_permissions(self):\n return self.get_resource_manager().get_permissions()\n\n def validate(self):\n name = self.__class__.__name__\n if self.RelatedIdsExpression is None:\n raise ValueError(\n \"%s Filter requires resource expression\" % name)\n # if self.AnnotationKey is None:\n # raise ValueError(\n # \"%s Filter requires annotation key\" % name)\n\n if self.RelatedResource is None:\n raise ValueError(\n \"%s Filter requires resource manager spec\" % name)\n return super(RelatedResourceFilter, self).validate()\n\n def get_related_ids(self, resources):\n return set(jmespath_search(\n \"[].%s\" % self.RelatedIdsExpression, resources))\n\n def get_related(self, resources):\n resource_manager = self.get_resource_manager()\n related_ids = self.get_related_ids(resources)\n model = resource_manager.get_model()\n if len(related_ids) < self.FetchThreshold:\n related = resource_manager.get_resources(list(related_ids))\n else:\n related = resource_manager.resources()\n\n if related is None:\n return {}\n\n return {r[model.id]: r for r in related\n if r[model.id] in related_ids}\n\n @lru_cache(maxsize=None)\n def get_resource_manager(self):\n mod_path, class_name = self.RelatedResource.rsplit('.', 1)\n module = importlib.import_module(mod_path)\n manager_class = getattr(module, class_name)\n return manager_class(self.manager.ctx, {})\n\n def process_resource(self, resource, related):\n related_ids = self.get_related_ids([resource])\n model = self.manager.get_model()\n op = self.data.get('operator', 'or')\n found = []\n\n if self.data.get('match-resource') is True:\n self.data['value'] = self.get_resource_value(\n self.data['key'], resource)\n\n if self.data.get('value_type') == 'resource_count':\n count_matches = OPERATORS[self.data.get('op')](len(related_ids), self.data.get('value'))\n if count_matches:\n self._add_annotations(related_ids, resource)\n return count_matches\n\n for rid in related_ids:\n robj = related.get(rid, None)\n if robj is None:\n # in the event that the filter is looking specifically for absent values, we can\n # safely assume that the non-existant related resource will have an absent value at\n # any given key\n if self.data['value'] == 'absent':\n found.append(rid)\n else:\n self.log.warning(\n \"Resource %s:%s references non existant %s: %s\",\n self.manager.type,\n resource[model.id],\n self.RelatedResource.rsplit('.', 1)[-1],\n rid)\n continue\n if self.match(robj):\n found.append(rid)\n\n if found:\n self._add_annotations(found, resource)\n\n if op == 'or' and found:\n return True\n elif op == 'and' and len(found) == len(related_ids):\n return True\n return False\n\n def _add_annotations(self, related_ids, resource):\n if self.AnnotationKey is not None:\n akey = 'c7n:%s' % self.AnnotationKey\n resource[akey] = list(set(related_ids).union(resource.get(akey, [])))\n\n def process(self, resources, event=None):\n related = self.get_related(resources)\n return [r for r in resources if self.process_resource(r, related)]\n\n\nclass RelatedResourceByIdFilter(RelatedResourceFilter):\n \"\"\"\n Value filter for related resources in which the main resource only contains the related\n resource id.\n \"\"\"\n\n RelatedResourceByIdExpression = None\n\n def get_related(self, resources):\n resource_manager = self.get_resource_manager()\n related_ids = self.get_related_ids(resources)\n\n related = {}\n for r in resource_manager.resources():\n matched_vpc = self.get_related_by_ids(r) & related_ids\n if matched_vpc:\n for vpc in matched_vpc:\n related_resources = related.get(vpc, [])\n related_resources.append(r)\n related[vpc] = related_resources\n return related\n\n def get_related_by_ids(self, resources):\n RelatedResourceKey = self.RelatedResourceByIdExpression or self.RelatedIdsExpression\n ids = jmespath_search(\"%s\" % RelatedResourceKey, resources)\n if isinstance(ids, str):\n ids = [ids]\n return set(ids)\n\n def process_resource(self, resource, related):\n related_ids = self.get_related_ids([resource])\n op = self.data.get('operator', 'or')\n found = []\n\n if self.data.get('match-resource') is True:\n self.data['value'] = self.get_resource_value(\n self.data['key'], resource)\n\n if self.data.get('value_type') == 'resource_count':\n count_matches = OPERATORS[self.data.get('op')](len(related_ids), self.data.get('value'))\n if count_matches:\n self._add_annotations(related_ids, resource)\n return count_matches\n\n for rid in related_ids:\n robjs = related.get(rid, [None])\n for robj in robjs:\n if robj is None:\n continue\n if self.match(robj):\n found.append(rid)\n\n if found:\n self._add_annotations(found, resource)\n\n if op == 'or' and found:\n return True\n elif op == 'and' and len(found) == len(related_ids):\n return True\n return False\n\n\nclass ChildResourceFilter(RelatedResourceFilter):\n ChildResource = None\n RelatedIdsExpression = None\n ChildResourceParentKey = \"c7n:parent-id\"\n\n def get_related(self, resources):\n self.child_resources = {}\n\n parent_ids = self.get_related_ids(resources)\n\n child_resource_manager = self.get_resource_manager()\n child_query = ChildResourceQuery(\n child_resource_manager.session_factory,\n child_resource_manager,\n )\n children = child_query.filter(child_resource_manager, parent_ids=list(parent_ids))\n for r in children:\n self.child_resources.setdefault(r[self.ChildResourceParentKey], []).append(r)\n\n return self.child_resources\n\n def _add_annotations(self, related_ids, resource):\n if self.AnnotationKey is not None:\n model = self.manager.get_model()\n akey = 'c7n:%s' % self.AnnotationKey\n resource[akey] = self.child_resources.get(resource[model.id], [])\n","path":"c7n/filters/related.py"}],"string":"[\n {\n \"content\": \"# Copyright The Cloud Custodian Authors.\\n# SPDX-License-Identifier: Apache-2.0\\nimport importlib\\nfrom functools import lru_cache\\n\\nfrom .core import ValueFilter, OPERATORS\\nfrom c7n.query import ChildResourceQuery\\nfrom c7n.utils import jmespath_search\\n\\n\\nclass RelatedResourceFilter(ValueFilter):\\n\\n schema_alias = False\\n\\n RelatedResource = None\\n RelatedIdsExpression = None\\n AnnotationKey = None\\n FetchThreshold = 10\\n\\n def get_permissions(self):\\n return self.get_resource_manager().get_permissions()\\n\\n def validate(self):\\n name = self.__class__.__name__\\n if self.RelatedIdsExpression is None:\\n raise ValueError(\\n \\\"%s Filter requires resource expression\\\" % name)\\n # if self.AnnotationKey is None:\\n # raise ValueError(\\n # \\\"%s Filter requires annotation key\\\" % name)\\n\\n if self.RelatedResource is None:\\n raise ValueError(\\n \\\"%s Filter requires resource manager spec\\\" % name)\\n return super(RelatedResourceFilter, self).validate()\\n\\n def get_related_ids(self, resources):\\n return set(jmespath_search(\\n \\\"[].%s\\\" % self.RelatedIdsExpression, resources))\\n\\n def get_related(self, resources):\\n resource_manager = self.get_resource_manager()\\n related_ids = self.get_related_ids(resources)\\n model = resource_manager.get_model()\\n if len(related_ids) < self.FetchThreshold:\\n related = resource_manager.get_resources(list(related_ids))\\n else:\\n related = resource_manager.resources()\\n\\n if related is None:\\n return {}\\n\\n return {r[model.id]: r for r in related\\n if r[model.id] in related_ids}\\n\\n @lru_cache(maxsize=None)\\n def get_resource_manager(self):\\n mod_path, class_name = self.RelatedResource.rsplit('.', 1)\\n module = importlib.import_module(mod_path)\\n manager_class = getattr(module, class_name)\\n return manager_class(self.manager.ctx, {})\\n\\n def process_resource(self, resource, related):\\n related_ids = self.get_related_ids([resource])\\n model = self.manager.get_model()\\n op = self.data.get('operator', 'or')\\n found = []\\n\\n if self.data.get('match-resource') is True:\\n self.data['value'] = self.get_resource_value(\\n self.data['key'], resource)\\n\\n if self.data.get('value_type') == 'resource_count':\\n count_matches = OPERATORS[self.data.get('op')](len(related_ids), self.data.get('value'))\\n if count_matches:\\n self._add_annotations(related_ids, resource)\\n return count_matches\\n\\n for rid in related_ids:\\n robj = related.get(rid, None)\\n if robj is None:\\n # in the event that the filter is looking specifically for absent values, we can\\n # safely assume that the non-existant related resource will have an absent value at\\n # any given key\\n if self.data['value'] == 'absent':\\n found.append(rid)\\n else:\\n self.log.warning(\\n \\\"Resource %s:%s references non existant %s: %s\\\",\\n self.manager.type,\\n resource[model.id],\\n self.RelatedResource.rsplit('.', 1)[-1],\\n rid)\\n continue\\n if self.match(robj):\\n found.append(rid)\\n\\n if found:\\n self._add_annotations(found, resource)\\n\\n if op == 'or' and found:\\n return True\\n elif op == 'and' and len(found) == len(related_ids):\\n return True\\n return False\\n\\n def _add_annotations(self, related_ids, resource):\\n if self.AnnotationKey is not None:\\n akey = 'c7n:%s' % self.AnnotationKey\\n resource[akey] = list(set(related_ids).union(resource.get(akey, [])))\\n\\n def process(self, resources, event=None):\\n related = self.get_related(resources)\\n return [r for r in resources if self.process_resource(r, related)]\\n\\n\\nclass RelatedResourceByIdFilter(RelatedResourceFilter):\\n \\\"\\\"\\\"\\n Value filter for related resources in which the main resource only contains the related\\n resource id.\\n \\\"\\\"\\\"\\n\\n RelatedResourceByIdExpression = None\\n\\n def get_related(self, resources):\\n resource_manager = self.get_resource_manager()\\n related_ids = self.get_related_ids(resources)\\n\\n related = {}\\n for r in resource_manager.resources():\\n matched_vpc = self.get_related_by_ids(r) & related_ids\\n if matched_vpc:\\n for vpc in matched_vpc:\\n related_resources = related.get(vpc, [])\\n related_resources.append(r)\\n related[vpc] = related_resources\\n return related\\n\\n def get_related_by_ids(self, resources):\\n RelatedResourceKey = self.RelatedResourceByIdExpression or self.RelatedIdsExpression\\n ids = jmespath_search(\\\"%s\\\" % RelatedResourceKey, resources)\\n if isinstance(ids, str):\\n ids = [ids]\\n return set(ids)\\n\\n def process_resource(self, resource, related):\\n related_ids = self.get_related_ids([resource])\\n op = self.data.get('operator', 'or')\\n found = []\\n\\n if self.data.get('match-resource') is True:\\n self.data['value'] = self.get_resource_value(\\n self.data['key'], resource)\\n\\n if self.data.get('value_type') == 'resource_count':\\n count_matches = OPERATORS[self.data.get('op')](len(related_ids), self.data.get('value'))\\n if count_matches:\\n self._add_annotations(related_ids, resource)\\n return count_matches\\n\\n for rid in related_ids:\\n robjs = related.get(rid, [None])\\n for robj in robjs:\\n if robj is None:\\n continue\\n if self.match(robj):\\n found.append(rid)\\n\\n if found:\\n self._add_annotations(found, resource)\\n\\n if op == 'or' and found:\\n return True\\n elif op == 'and' and len(found) == len(related_ids):\\n return True\\n return False\\n\\n\\nclass ChildResourceFilter(RelatedResourceFilter):\\n ChildResource = None\\n RelatedIdsExpression = None\\n ChildResourceParentKey = \\\"c7n:parent-id\\\"\\n\\n def get_related(self, resources):\\n self.child_resources = {}\\n\\n parent_ids = self.get_related_ids(resources)\\n\\n child_resource_manager = self.get_resource_manager()\\n child_query = ChildResourceQuery(\\n child_resource_manager.session_factory,\\n child_resource_manager,\\n )\\n children = child_query.filter(child_resource_manager, parent_ids=list(parent_ids))\\n for r in children:\\n self.child_resources.setdefault(r[self.ChildResourceParentKey], []).append(r)\\n\\n return self.child_resources\\n\\n def _add_annotations(self, related_ids, resource):\\n if self.AnnotationKey is not None:\\n model = self.manager.get_model()\\n akey = 'c7n:%s' % self.AnnotationKey\\n resource[akey] = self.child_resources.get(resource[model.id], [])\\n\",\n \"path\": \"c7n/filters/related.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/c7n/filters/related.py b/c7n/filters/related.py\nindex 9fc6e2bfbd8..d0961f5d514 100644\n--- a/c7n/filters/related.py\n+++ b/c7n/filters/related.py\n@@ -46,6 +46,10 @@ def get_related(self, resources):\n related = resource_manager.get_resources(list(related_ids))\n else:\n related = resource_manager.resources()\n+\n+ if related is None:\n+ return {}\n+\n return {r[model.id]: r for r in related\n if r[model.id] in related_ids}\n \ndiff --git a/tests/data/placebo/test_dev_endpoints_query/glue.GetDevEndpoints_1.json b/tests/data/placebo/test_dev_endpoints_query/glue.GetDevEndpoints_1.json\nnew file mode 100644\nindex 00000000000..f088e5337f7\n--- /dev/null\n+++ b/tests/data/placebo/test_dev_endpoints_query/glue.GetDevEndpoints_1.json\n@@ -0,0 +1,42 @@\n+{\n+ \"status_code\": 200,\n+ \"data\": {\n+ \"DevEndpoints\": [\n+ {\n+ \"EndpointName\": \"endpoint1\",\n+ \"RoleArn\": \"arn:aws:iam::644160558196:role/c7n-glue-test\",\n+ \"SecurityGroupIds\": [],\n+ \"ZeppelinRemoteSparkInterpreterPort\": 0,\n+ \"Status\": \"PROVISIONING\",\n+ \"GlueVersion\": \"1.0\",\n+ \"NumberOfNodes\": 3,\n+ \"AvailabilityZone\": \"us-east-1b\",\n+ \"CreatedTimestamp\": {\n+ \"__class__\": \"datetime\",\n+ \"year\": 2023,\n+ \"month\": 11,\n+ \"day\": 20,\n+ \"hour\": 17,\n+ \"minute\": 15,\n+ \"second\": 10,\n+ \"microsecond\": 982000\n+ },\n+ \"LastModifiedTimestamp\": {\n+ \"__class__\": \"datetime\",\n+ \"year\": 2023,\n+ \"month\": 11,\n+ \"day\": 20,\n+ \"hour\": 17,\n+ \"minute\": 15,\n+ \"second\": 10,\n+ \"microsecond\": 982000\n+ },\n+ \"Arguments\": {\n+ \"GLUE_PYTHON_VERSION\": \"3\"\n+ }\n+ }\n+ ],\n+ \"NextToken\": \"\",\n+ \"ResponseMetadata\": {}\n+ }\n+}\n\\ No newline at end of file\ndiff --git a/tests/data/placebo/test_dev_endpoints_query/tagging.GetResources_1.json b/tests/data/placebo/test_dev_endpoints_query/tagging.GetResources_1.json\nnew file mode 100644\nindex 00000000000..8b704d1852a\n--- /dev/null\n+++ b/tests/data/placebo/test_dev_endpoints_query/tagging.GetResources_1.json\n@@ -0,0 +1,8 @@\n+{\n+ \"status_code\": 200,\n+ \"data\": {\n+ \"PaginationToken\": \"\",\n+ \"ResourceTagMappingList\": [],\n+ \"ResponseMetadata\": {}\n+ }\n+}\n\\ No newline at end of file\ndiff --git a/tests/data/placebo/test_glue_query_resources/ec2.DescribeSubnets_1.json b/tests/data/placebo/test_glue_query_resources/ec2.DescribeSubnets_1.json\nnew file mode 100644\nindex 00000000000..0062b2c9c04\n--- /dev/null\n+++ b/tests/data/placebo/test_glue_query_resources/ec2.DescribeSubnets_1.json\n@@ -0,0 +1,57 @@\n+{\n+ \"status_code\": 200,\n+ \"data\": {\n+ \"Subnets\": [\n+ {\n+ \"AvailabilityZone\": \"us-east-1a\",\n+ \"AvailabilityZoneId\": \"use1-az4\",\n+ \"AvailableIpAddressCount\": 251,\n+ \"CidrBlock\": \"10.0.0.0/24\",\n+ \"DefaultForAz\": false,\n+ \"MapPublicIpOnLaunch\": false,\n+ \"MapCustomerOwnedIpOnLaunch\": false,\n+ \"State\": \"available\",\n+ \"SubnetId\": \"subnet-00872ab56d5fa4cdc\",\n+ \"VpcId\": \"vpc-0503a8b9ddbb3a5c5\",\n+ \"OwnerId\": \"644160558196\",\n+ \"AssignIpv6AddressOnCreation\": false,\n+ \"Ipv6CidrBlockAssociationSet\": [],\n+ \"Tags\": [\n+ {\n+ \"Key\": \"Name\",\n+ \"Value\": \"ECS c7n-test-cluster - Public Subnet 1\"\n+ },\n+ {\n+ \"Key\": \"aws:cloudformation:stack-id\",\n+ \"Value\": \"arn:aws:cloudformation:us-east-1:644160558196:stack/EC2ContainerService-c7n-test-cluster/0c488df0-4827-11ee-8f0c-12a58b5c38f1\"\n+ },\n+ {\n+ \"Key\": \"aws:cloudformation:stack-name\",\n+ \"Value\": \"EC2ContainerService-c7n-test-cluster\"\n+ },\n+ {\n+ \"Key\": \"aws:cloudformation:logical-id\",\n+ \"Value\": \"PublicSubnetAz1\"\n+ },\n+ {\n+ \"Key\": \"NetworkLocation\",\n+ \"Value\": \"Customer\"\n+ },\n+ {\n+ \"Key\": \"Description\",\n+ \"Value\": \"Created for ECS cluster c7n-test-cluster\"\n+ }\n+ ],\n+ \"SubnetArn\": \"arn:aws:ec2:us-east-1:644160558196:subnet/subnet-00872ab56d5fa4cdc\",\n+ \"EnableDns64\": false,\n+ \"Ipv6Native\": false,\n+ \"PrivateDnsNameOptionsOnLaunch\": {\n+ \"HostnameType\": \"ip-name\",\n+ \"EnableResourceNameDnsARecord\": false,\n+ \"EnableResourceNameDnsAAAARecord\": false\n+ }\n+ }\n+ ],\n+ \"ResponseMetadata\": {}\n+ }\n+}\n\\ No newline at end of file\ndiff --git a/tests/data/placebo/test_glue_query_resources/glue.GetConnections_1.json b/tests/data/placebo/test_glue_query_resources/glue.GetConnections_1.json\nindex 9957884609f..b524d5f4770 100644\n--- a/tests/data/placebo/test_glue_query_resources/glue.GetConnections_1.json\n+++ b/tests/data/placebo/test_glue_query_resources/glue.GetConnections_1.json\n@@ -1,57 +1,47 @@\n {\n- \"status_code\": 200, \n+ \"status_code\": 200,\n \"data\": {\n- \"ResponseMetadata\": {\n- \"RetryAttempts\": 0, \n- \"HTTPStatusCode\": 200, \n- \"RequestId\": \"37c71491-2ea7-11e8-bc67-05ab693096d1\", \n- \"HTTPHeaders\": {\n- \"date\": \"Fri, 23 Mar 2018 14:33:56 GMT\", \n- \"x-amzn-requestid\": \"37c71491-2ea7-11e8-bc67-05ab693096d1\", \n- \"content-length\": \"467\", \n- \"content-type\": \"application/x-amz-json-1.1\", \n- \"connection\": \"keep-alive\"\n- }\n- }, \n \"ConnectionList\": [\n {\n- \"Name\": \"c7n-test-connection\", \n- \"CreationTime\": {\n- \"hour\": 10, \n- \"__class__\": \"datetime\", \n- \"month\": 3, \n- \"second\": 12, \n- \"microsecond\": 358000, \n- \"year\": 2018, \n- \"day\": 23, \n- \"minute\": 30\n- }, \n- \"ConnectionType\": \"JDBC\", \n+ \"Name\": \"test\",\n+ \"Description\": \"\",\n+ \"ConnectionType\": \"JDBC\",\n+ \"ConnectionProperties\": {\n+ \"JDBC_ENFORCE_SSL\": \"false\",\n+ \"JDBC_CONNECTION_URL\": \"jdbc:mysql://database-3-instance-1.cz6wy8cci3uf.us-east-1.rds.amazonaws.com:3306/test\",\n+ \"SECRET_ID\": \"c7n\",\n+ \"KAFKA_SSL_ENABLED\": \"false\"\n+ },\n \"PhysicalConnectionRequirements\": {\n- \"SubnetId\": \"subnet-3a334610\", \n- \"AvailabilityZone\": \"us-east-1d\", \n+ \"SubnetId\": \"subnet-00872ab56d5fa4cdc\",\n \"SecurityGroupIdList\": [\n- \"sg-6c7fa917\"\n- ]\n- }, \n- \"LastUpdatedBy\": \"user/joshuaroot\", \n+ \"sg-045f7d0c2467c3bfb\"\n+ ],\n+ \"AvailabilityZone\": \"us-east-1a\"\n+ },\n+ \"CreationTime\": {\n+ \"__class__\": \"datetime\",\n+ \"year\": 2020,\n+ \"month\": 5,\n+ \"day\": 4,\n+ \"hour\": 20,\n+ \"minute\": 1,\n+ \"second\": 0,\n+ \"microsecond\": 856000\n+ },\n \"LastUpdatedTime\": {\n- \"hour\": 10, \n- \"__class__\": \"datetime\", \n- \"month\": 3, \n- \"second\": 12, \n- \"microsecond\": 358000, \n- \"year\": 2018, \n- \"day\": 23, \n- \"minute\": 30\n- }, \n- \"ConnectionProperties\": {\n- \"USERNAME\": \"username\", \n- \"JDBC_CONNECTION_URL\": \"jdbc:postgresql://localhost:5432/test\", \n- \"PASSWORD\": \"password\"\n- }, \n- \"Description\": \"Glue test\"\n+ \"__class__\": \"datetime\",\n+ \"year\": 2023,\n+ \"month\": 11,\n+ \"day\": 20,\n+ \"hour\": 17,\n+ \"minute\": 4,\n+ \"second\": 49,\n+ \"microsecond\": 864000\n+ },\n+ \"LastUpdatedBy\": \"user/timmy\"\n }\n- ]\n+ ],\n+ \"ResponseMetadata\": {}\n }\n }\n\\ No newline at end of file\ndiff --git a/tests/data/placebo/test_glue_query_resources/glue.GetDevEndpoints_1.json b/tests/data/placebo/test_glue_query_resources/glue.GetDevEndpoints_1.json\ndeleted file mode 100644\nindex f44ac49c78a..00000000000\n--- a/tests/data/placebo/test_glue_query_resources/glue.GetDevEndpoints_1.json\n+++ /dev/null\n@@ -1,50 +0,0 @@\n-{\n- \"status_code\": 200,\n- \"data\": {\n- \"DevEndpoints\": [\n- {\n- \"EndpointName\": \"test\",\n- \"RoleArn\": \"arn:aws:iam::644160558196:role/c7n-glue-test\",\n- \"SecurityGroupIds\": [],\n- \"ZeppelinRemoteSparkInterpreterPort\": 9007,\n- \"PublicAddress\": \"ec2-3-94-148-93.compute-1.amazonaws.com\",\n- \"Status\": \"READY\",\n- \"NumberOfNodes\": 5,\n- \"AvailabilityZone\": \"us-east-1b\",\n- \"CreatedTimestamp\": {\n- \"__class__\": \"datetime\",\n- \"year\": 2019,\n- \"month\": 5,\n- \"day\": 29,\n- \"hour\": 14,\n- \"minute\": 45,\n- \"second\": 38,\n- \"microsecond\": 448000\n- },\n- \"LastModifiedTimestamp\": {\n- \"__class__\": \"datetime\",\n- \"year\": 2019,\n- \"month\": 5,\n- \"day\": 29,\n- \"hour\": 14,\n- \"minute\": 54,\n- \"second\": 9,\n- \"microsecond\": 981000\n- }\n- }\n- ],\n- \"NextToken\": \"\",\n- \"ResponseMetadata\": {\n- \"RequestId\": \"1f7c0173-8247-11e9-97ba-6b7dba7a5ea4\",\n- \"HTTPStatusCode\": 200,\n- \"HTTPHeaders\": {\n- \"date\": \"Wed, 29 May 2019 19:22:39 GMT\",\n- \"content-type\": \"application/x-amz-json-1.1\",\n- \"content-length\": \"380\",\n- \"connection\": \"keep-alive\",\n- \"x-amzn-requestid\": \"1f7c0173-8247-11e9-97ba-6b7dba7a5ea4\"\n- },\n- \"RetryAttempts\": 0\n- }\n- }\n-}\n\\ No newline at end of file\ndiff --git a/tests/data/placebo/test_glue_query_resources/glue.GetJobs_1.json b/tests/data/placebo/test_glue_query_resources/glue.GetJobs_1.json\ndeleted file mode 100644\nindex 43bf3730e8e..00000000000\n--- a/tests/data/placebo/test_glue_query_resources/glue.GetJobs_1.json\n+++ /dev/null\n@@ -1,60 +0,0 @@\n-{\n- \"status_code\": 200,\n- \"data\": {\n- \"Jobs\": [\n- {\n- \"Name\": \"test\",\n- \"Role\": \"arn:aws:iam::644160558196:role/c7n-glue-test\",\n- \"CreatedOn\": {\n- \"__class__\": \"datetime\",\n- \"year\": 2019,\n- \"month\": 6,\n- \"day\": 10,\n- \"hour\": 16,\n- \"minute\": 19,\n- \"second\": 55,\n- \"microsecond\": 431000\n- },\n- \"LastModifiedOn\": {\n- \"__class__\": \"datetime\",\n- \"year\": 2019,\n- \"month\": 6,\n- \"day\": 10,\n- \"hour\": 16,\n- \"minute\": 19,\n- \"second\": 55,\n- \"microsecond\": 431000\n- },\n- \"ExecutionProperty\": {\n- \"MaxConcurrentRuns\": 1\n- },\n- \"Command\": {\n- \"Name\": \"glueetl\",\n- \"ScriptLocation\": \"s3://aws-glue-scripts-644160558196-us-east-1/david.yun@capitalone.com/test\"\n- },\n- \"DefaultArguments\": {\n- \"--TempDir\": \"s3://aws-glue-temporary-644160558196-us-east-1/david.yun@capitalone.com\",\n- \"--job-bookmark-option\": \"job-bookmark-disable\",\n- \"--job-language\": \"python\"\n- },\n- \"Connections\": {},\n- \"MaxRetries\": 0,\n- \"AllocatedCapacity\": 10,\n- \"Timeout\": 2880,\n- \"MaxCapacity\": 10.0\n- }\n- ],\n- \"ResponseMetadata\": {\n- \"RequestId\": \"1ec2e660-8bbd-11e9-8576-1970c67233c8\",\n- \"HTTPStatusCode\": 200,\n- \"HTTPHeaders\": {\n- \"date\": \"Mon, 10 Jun 2019 20:19:59 GMT\",\n- \"content-type\": \"application/x-amz-json-1.1\",\n- \"content-length\": \"594\",\n- \"connection\": \"keep-alive\",\n- \"x-amzn-requestid\": \"1ec2e660-8bbd-11e9-8576-1970c67233c8\"\n- },\n- \"RetryAttempts\": 0\n- }\n- }\n-}\n\\ No newline at end of file\ndiff --git a/tests/data/placebo/test_glue_query_resources/tagging.GetResources_1.json b/tests/data/placebo/test_glue_query_resources/tagging.GetResources_1.json\nindex aa236f0602f..45d3f28bb53 100644\n--- a/tests/data/placebo/test_glue_query_resources/tagging.GetResources_1.json\n+++ b/tests/data/placebo/test_glue_query_resources/tagging.GetResources_1.json\n@@ -4,20 +4,15 @@\n \"PaginationToken\": \"\",\n \"ResourceTagMappingList\": [\n {\n- \"ResourceARN\": \"arn:aws:glue:us-east-1:644160558196:devEndpoint/test\",\n- \"Tags\": []\n+ \"ResourceARN\": \"arn:aws:glue:us-east-1:644160558196:connection/test\",\n+ \"Tags\": [\n+ {\n+ \"Key\": \"owner\",\n+ \"Value\": \"pratyush\"\n+ }\n+ ]\n }\n ],\n- \"ResponseMetadata\": {\n- \"RequestId\": \"1fb11b1e-8247-11e9-a0de-99cb9b419859\",\n- \"HTTPStatusCode\": 200,\n- \"HTTPHeaders\": {\n- \"x-amzn-requestid\": \"1fb11b1e-8247-11e9-a0de-99cb9b419859\",\n- \"content-type\": \"application/x-amz-json-1.1\",\n- \"content-length\": \"130\",\n- \"date\": \"Wed, 29 May 2019 19:22:39 GMT\"\n- },\n- \"RetryAttempts\": 0\n- }\n+ \"ResponseMetadata\": {}\n }\n }\n\\ No newline at end of file\ndiff --git a/tests/data/placebo/test_glue_query_resources_no_subnet/ec2.DescribeSubnets_1.json b/tests/data/placebo/test_glue_query_resources_no_subnet/ec2.DescribeSubnets_1.json\nnew file mode 100644\nindex 00000000000..eab029f516a\n--- /dev/null\n+++ b/tests/data/placebo/test_glue_query_resources_no_subnet/ec2.DescribeSubnets_1.json\n@@ -0,0 +1,10 @@\n+{\n+ \"status_code\": 400,\n+ \"data\": {\n+ \"Error\": {\n+ \"Code\": \"InvalidSubnetID.NotFound\",\n+ \"Message\": \"The subnet ID 'subnet-0cc56341f33e72de0' does not exist\"\n+ },\n+ \"ResponseMetadata\": {}\n+ }\n+}\n\\ No newline at end of file\ndiff --git a/tests/data/placebo/test_glue_query_resources_no_subnet/glue.GetConnections_1.json b/tests/data/placebo/test_glue_query_resources_no_subnet/glue.GetConnections_1.json\nnew file mode 100644\nindex 00000000000..9c2cbc07706\n--- /dev/null\n+++ b/tests/data/placebo/test_glue_query_resources_no_subnet/glue.GetConnections_1.json\n@@ -0,0 +1,44 @@\n+{\n+ \"status_code\": 200,\n+ \"data\": {\n+ \"ConnectionList\": [\n+ {\n+ \"Name\": \"test2\",\n+ \"Description\": \"\",\n+ \"ConnectionType\": \"NETWORK\",\n+ \"ConnectionProperties\": {\n+ \"KAFKA_SSL_ENABLED\": \"false\"\n+ },\n+ \"PhysicalConnectionRequirements\": {\n+ \"SubnetId\": \"subnet-0cc56341f33e72de0\",\n+ \"SecurityGroupIdList\": [\n+ \"sg-09d0fe3ff46b19e83\"\n+ ],\n+ \"AvailabilityZone\": \"us-east-1f\"\n+ },\n+ \"CreationTime\": {\n+ \"__class__\": \"datetime\",\n+ \"year\": 2023,\n+ \"month\": 11,\n+ \"day\": 21,\n+ \"hour\": 15,\n+ \"minute\": 51,\n+ \"second\": 14,\n+ \"microsecond\": 646000\n+ },\n+ \"LastUpdatedTime\": {\n+ \"__class__\": \"datetime\",\n+ \"year\": 2023,\n+ \"month\": 11,\n+ \"day\": 21,\n+ \"hour\": 16,\n+ \"minute\": 22,\n+ \"second\": 52,\n+ \"microsecond\": 654000\n+ },\n+ \"LastUpdatedBy\": \"user/timmy\"\n+ }\n+ ],\n+ \"ResponseMetadata\": {}\n+ }\n+}\n\\ No newline at end of file\ndiff --git a/tests/data/placebo/test_glue_query_resources_no_subnet/tagging.GetResources_1.json b/tests/data/placebo/test_glue_query_resources_no_subnet/tagging.GetResources_1.json\nnew file mode 100644\nindex 00000000000..8b704d1852a\n--- /dev/null\n+++ b/tests/data/placebo/test_glue_query_resources_no_subnet/tagging.GetResources_1.json\n@@ -0,0 +1,8 @@\n+{\n+ \"status_code\": 200,\n+ \"data\": {\n+ \"PaginationToken\": \"\",\n+ \"ResourceTagMappingList\": [],\n+ \"ResponseMetadata\": {}\n+ }\n+}\n\\ No newline at end of file\ndiff --git a/tests/test_glue.py b/tests/test_glue.py\nindex b424002e812..0f0b151c12a 100644\n--- a/tests/test_glue.py\n+++ b/tests/test_glue.py\n@@ -102,11 +102,31 @@ def test_glue_connection_tag_untag(self):\n tags = client.get_tags(ResourceArn=arn)\n self.assertEqual(tags.get('Tags'), {})\n \n+ def test_glue_query_resources_no_subnet(self):\n+ session_factory = self.replay_flight_data(\"test_glue_query_resources_no_subnet\")\n+ p = self.load_policy(\n+ {\n+ \"name\": \"list-glue-connections\",\n+ \"resource\": \"glue-connection\",\n+ \"filters\": [\n+ {\n+ \"type\": \"subnet\",\n+ \"key\": \"tag:c7n-internal\",\n+ \"op\": \"ne\",\n+ \"value\": \"True\",\n+ }\n+ ],\n+ },\n+ session_factory=session_factory,\n+ )\n+ resources = p.run()\n+ self.assertEqual(len(resources), 0)\n+\n \n class TestGlueDevEndpoints(BaseTest):\n \n def test_dev_endpoints_query(self):\n- session_factory = self.replay_flight_data(\"test_glue_query_resources\")\n+ session_factory = self.replay_flight_data(\"test_dev_endpoints_query\")\n p = self.load_policy(\n {\"name\": \"list-glue-dev-endpoints\", \"resource\": \"glue-dev-endpoint\"},\n session_factory=session_factory,\n"}}},{"rowIdx":4691,"cells":{"in_source_id":{"kind":"string","value":"ansible__ansible-modules-extras-1529"},"issue":{"kind":"string","value":"rabbitmq_parameter fails when passing dynamically generated json\n##### Issue Type:\n\n“Bug Report”\n##### Ansible Version:\n\nansible 1.8.2\n configured module search path = None\n\nTested also on ansible 1.9\nansible 1.9 (devel 8f06ba2bc1) last updated 2015/02/05 11:16:37 (GMT +200)\n lib/ansible/modules/core: (detached HEAD 600fc15b42) last updated 2015/02/05 11:16:50 (GMT +200)\n lib/ansible/modules/extras: (detached HEAD 77485f6c6a) last updated 2015/02/05 11:17:01 (GMT +200)\n v2/ansible/modules/core: (detached HEAD 600fc15b42) last updated 2015/02/05 11:17:13 (GMT +200)\n v2/ansible/modules/extras: (detached HEAD 77485f6c6a) last updated 2015/02/05 11:17:36 (GMT +200)\n configured module search path = None\n##### Environment:\n\nOS X 10.9.5 > Ubuntu 14.04\n##### Summary:\n\nPassing non-hardcoded json (through templating) to rabbitmq_parameter's \"value\" argument raises an exception. It works when hardcoding the json though.\n##### Steps To Reproduce:\n\nHere's an example playbook with one successful task (the first one), and two failing tasks (the next two) which both raise the same exception (see below). All of them are supposed to do the same thing.\n\n```\n- hosts: my-host\n tasks:\n - set_fact:\n upstream_list:\n - upstream: \"test\"\n - upstream: \"test2\"\n json_upstreams: '[{\"upstream\":\"test1\"},{\"upstream\":\"test2\"}]'\n\n - rabbitmq_parameter:\n component: federation-upstream-set\n name: test-upstream-set\n value: '[{\"upstream\":\"test1\"},{\"upstream\":\"test2\"}]'\n sudo: yes\n\n - rabbitmq_parameter:\n component: federation-upstream-set\n name: test-upstream-set\n value: '{{ json_upstreams }}'\n sudo: yes\n\n - rabbitmq_parameter:\n component: federation-upstream-set\n name: test-upstream-set\n value: '{{ upstream_list|to_json }}'\n sudo: yes\n```\n##### Expected Results:\n\nSet a federation-upstream-set parameter to the default vhost.\n##### Actual Results:\n\nThe two failing tasks raise the same exception. The output from ansible with -vvvv is as follows:\n\n```\n<my-host> ESTABLISH CONNECTION FOR USER: xxxx\n<my-host> REMOTE_MODULE rabbitmq_parameter name=test-upstream-set component=federation-upstream-set vhost=/\n<my-host> EXEC ssh -C -vvv -o ForwardAgent=yes -o ControlMaster=auto -o ControlPersist=30m -o ControlPath=\"xxxx/.ansible/cp/ansible-ssh-%h-%p-%r\" -o Port=22 -o KbdInteractiveAuthentication=no -o PreferredAuthentications=gssapi-with-mic,gssapi-k\neyex,hostbased,publickey -o PasswordAuthentication=no -o User=xxxx -o ConnectTimeout=10 my- host /bin/sh -c 'sudo -k && sudo -H -S -p \"[sudo via ansible, key=xxxxxx] password: \" -u root /bin/sh -c '\"'\"'echo SUDO-SUCCESS-xxxxxx; LANG=en_US.UTF-8 LC_CTYPE=en_US.UTF-8 /usr/bin/python'\"'\"''\nfailed: [my-host] => {\"failed\": true, \"parsed\": false}\nSUDO-SUCCESS-xxxxxx\nOpenSSH_6.2p2, OSSLShim 0.9.8r 8 Dec 2011\ndebug1: Reading configuration data /xxxxx/.ssh/config\ndebug1: Reading configuration data /etc/ssh_config\ndebug1: /etc/ssh_config line 20: Applying options for *\ndebug1: /etc/ssh_config line 102: Applying options for *\ndebug1: auto-mux: Trying existing master\ndebug2: fd 3 setting O_NONBLOCK\ndebug2: mux_client_hello_exchange: master version 4\ndebug3: mux_client_forwards: request forwardings: 0 local, 0 remote\ndebug3: mux_client_request_session: entering\ndebug3: mux_client_request_alive: entering\ndebug3: mux_client_request_alive: done pid = 58450\ndebug3: mux_client_request_session: session request sent\ndebug1: mux_client_request_session: master session id: 2\n[sudo via ansible, key=xxxxx] password: Traceback (most recent call last):\n File \"<stdin>\", line 1717, in <module>\n File \"<stdin>\", line 142, in main\n File \"<stdin>\", line 104, in set\n File \"<stdin>\", line 88, in _exec\n File \"<stdin>\", line 1566, in run_command\n File \"/usr/lib/python2.7/posixpath.py\", line 261, in expanduser\n if not path.startswith('~'):\nAttributeError: 'list' object has no attribute 'startswith'\ndebug3: mux_client_read_packet: read header failed: Broken pipe\ndebug2: Received exit status from master 1\n```\n##### Tentative solution:\n\nFrom what I've seen while troubleshooting the issue, the problem comes from the rabbitmq_parameter module being passed a list to its \"value\" argument. It is then passed to AnsibleModule::run_command, which assumes it is a string and passes it through os.path.expanduser.\nI've managed to correct this behavior by setting the value to `value if type(value) == str else json.dumps(value)`.\nI can submit a more complete patch or pull request if this is indeed a bug and not an issue in my playbook.\n\n"},"before_files":{"kind":"list like","value":[{"content":"#!/usr/bin/python\n# -*- coding: utf-8 -*-\n\n# (c) 2013, Chatham Financial <oss@chathamfinancial.com>\n#\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 option) any later version.\n#\n# Ansible is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with Ansible. If not, see <http://www.gnu.org/licenses/>.\n\nDOCUMENTATION = '''\n---\nmodule: rabbitmq_parameter\nshort_description: Adds or removes parameters to RabbitMQ\ndescription:\n - Manage dynamic, cluster-wide parameters for RabbitMQ\nversion_added: \"1.1\"\nauthor: Chris Hoffman\noptions:\n component:\n description:\n - Name of the component of which the parameter is being set\n required: true\n default: null\n name:\n description:\n - Name of the parameter being set\n required: true\n default: null\n value:\n description:\n - Value of the parameter, as a JSON term\n required: false\n default: null\n vhost:\n description:\n - vhost to apply access privileges.\n required: false\n default: /\n node:\n description:\n - erlang node name of the rabbit we wish to configure\n required: false\n default: rabbit\n version_added: \"1.2\"\n state:\n description:\n - Specify if user is to be added or removed\n required: false\n default: present\n choices: [ 'present', 'absent']\n'''\n\nEXAMPLES = \"\"\"\n# Set the federation parameter 'local_username' to a value of 'guest' (in quotes)\n- rabbitmq_parameter: component=federation\n name=local-username\n value='\"guest\"'\n state=present\n\"\"\"\n\nclass RabbitMqParameter(object):\n def __init__(self, module, component, name, value, vhost, node):\n self.module = module\n self.component = component\n self.name = name\n self.value = value\n self.vhost = vhost\n self.node = node\n\n self._value = None\n\n self._rabbitmqctl = module.get_bin_path('rabbitmqctl', True)\n\n def _exec(self, args, run_in_check_mode=False):\n if not self.module.check_mode or (self.module.check_mode and run_in_check_mode):\n cmd = [self._rabbitmqctl, '-q', '-n', self.node]\n rc, out, err = self.module.run_command(cmd + args, check_rc=True)\n return out.splitlines()\n return list()\n\n def get(self):\n parameters = self._exec(['list_parameters', '-p', self.vhost], True)\n\n for param_item in parameters:\n component, name, value = param_item.split('\\t')\n\n if component == self.component and name == self.name:\n self._value = value\n return True\n return False\n\n def set(self):\n self._exec(['set_parameter', '-p', self.vhost, self.component, self.name, self.value])\n\n def delete(self):\n self._exec(['clear_parameter', '-p', self.vhost, self.component, self.name])\n\n def has_modifications(self):\n return self.value != self._value\n\ndef main():\n arg_spec = dict(\n component=dict(required=True),\n name=dict(required=True),\n value=dict(default=None),\n vhost=dict(default='/'),\n state=dict(default='present', choices=['present', 'absent']),\n node=dict(default='rabbit')\n )\n module = AnsibleModule(\n argument_spec=arg_spec,\n supports_check_mode=True\n )\n\n component = module.params['component']\n name = module.params['name']\n value = module.params['value']\n if not isinstance(value, str):\n value = json.dumps(value)\n vhost = module.params['vhost']\n state = module.params['state']\n node = module.params['node']\n\n rabbitmq_parameter = RabbitMqParameter(module, component, name, value, vhost, node)\n\n changed = False\n if rabbitmq_parameter.get():\n if state == 'absent':\n rabbitmq_parameter.delete()\n changed = True\n else:\n if rabbitmq_parameter.has_modifications():\n rabbitmq_parameter.set()\n changed = True\n elif state == 'present':\n rabbitmq_parameter.set()\n changed = True\n\n module.exit_json(changed=changed, component=component, name=name, vhost=vhost, state=state)\n\n# import module snippets\nfrom ansible.module_utils.basic import *\nmain()\n","path":"messaging/rabbitmq_parameter.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/python\\n# -*- coding: utf-8 -*-\\n\\n# (c) 2013, Chatham Financial <oss@chathamfinancial.com>\\n#\\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 option) any later version.\\n#\\n# Ansible is distributed in the hope that it will be useful,\\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\\n# GNU General Public License for more details.\\n#\\n# You should have received a copy of the GNU General Public License\\n# along with Ansible. If not, see <http://www.gnu.org/licenses/>.\\n\\nDOCUMENTATION = '''\\n---\\nmodule: rabbitmq_parameter\\nshort_description: Adds or removes parameters to RabbitMQ\\ndescription:\\n - Manage dynamic, cluster-wide parameters for RabbitMQ\\nversion_added: \\\"1.1\\\"\\nauthor: Chris Hoffman\\noptions:\\n component:\\n description:\\n - Name of the component of which the parameter is being set\\n required: true\\n default: null\\n name:\\n description:\\n - Name of the parameter being set\\n required: true\\n default: null\\n value:\\n description:\\n - Value of the parameter, as a JSON term\\n required: false\\n default: null\\n vhost:\\n description:\\n - vhost to apply access privileges.\\n required: false\\n default: /\\n node:\\n description:\\n - erlang node name of the rabbit we wish to configure\\n required: false\\n default: rabbit\\n version_added: \\\"1.2\\\"\\n state:\\n description:\\n - Specify if user is to be added or removed\\n required: false\\n default: present\\n choices: [ 'present', 'absent']\\n'''\\n\\nEXAMPLES = \\\"\\\"\\\"\\n# Set the federation parameter 'local_username' to a value of 'guest' (in quotes)\\n- rabbitmq_parameter: component=federation\\n name=local-username\\n value='\\\"guest\\\"'\\n state=present\\n\\\"\\\"\\\"\\n\\nclass RabbitMqParameter(object):\\n def __init__(self, module, component, name, value, vhost, node):\\n self.module = module\\n self.component = component\\n self.name = name\\n self.value = value\\n self.vhost = vhost\\n self.node = node\\n\\n self._value = None\\n\\n self._rabbitmqctl = module.get_bin_path('rabbitmqctl', True)\\n\\n def _exec(self, args, run_in_check_mode=False):\\n if not self.module.check_mode or (self.module.check_mode and run_in_check_mode):\\n cmd = [self._rabbitmqctl, '-q', '-n', self.node]\\n rc, out, err = self.module.run_command(cmd + args, check_rc=True)\\n return out.splitlines()\\n return list()\\n\\n def get(self):\\n parameters = self._exec(['list_parameters', '-p', self.vhost], True)\\n\\n for param_item in parameters:\\n component, name, value = param_item.split('\\\\t')\\n\\n if component == self.component and name == self.name:\\n self._value = value\\n return True\\n return False\\n\\n def set(self):\\n self._exec(['set_parameter', '-p', self.vhost, self.component, self.name, self.value])\\n\\n def delete(self):\\n self._exec(['clear_parameter', '-p', self.vhost, self.component, self.name])\\n\\n def has_modifications(self):\\n return self.value != self._value\\n\\ndef main():\\n arg_spec = dict(\\n component=dict(required=True),\\n name=dict(required=True),\\n value=dict(default=None),\\n vhost=dict(default='/'),\\n state=dict(default='present', choices=['present', 'absent']),\\n node=dict(default='rabbit')\\n )\\n module = AnsibleModule(\\n argument_spec=arg_spec,\\n supports_check_mode=True\\n )\\n\\n component = module.params['component']\\n name = module.params['name']\\n value = module.params['value']\\n if not isinstance(value, str):\\n value = json.dumps(value)\\n vhost = module.params['vhost']\\n state = module.params['state']\\n node = module.params['node']\\n\\n rabbitmq_parameter = RabbitMqParameter(module, component, name, value, vhost, node)\\n\\n changed = False\\n if rabbitmq_parameter.get():\\n if state == 'absent':\\n rabbitmq_parameter.delete()\\n changed = True\\n else:\\n if rabbitmq_parameter.has_modifications():\\n rabbitmq_parameter.set()\\n changed = True\\n elif state == 'present':\\n rabbitmq_parameter.set()\\n changed = True\\n\\n module.exit_json(changed=changed, component=component, name=name, vhost=vhost, state=state)\\n\\n# import module snippets\\nfrom ansible.module_utils.basic import *\\nmain()\\n\",\n \"path\": \"messaging/rabbitmq_parameter.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"#!/usr/bin/python\n# -*- coding: utf-8 -*-\n\n# (c) 2013, Chatham Financial <oss@chathamfinancial.com>\n#\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 option) any later version.\n#\n# Ansible is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with Ansible. If not, see <http://www.gnu.org/licenses/>.\n\nDOCUMENTATION = '''\n---\nmodule: rabbitmq_parameter\nshort_description: Adds or removes parameters to RabbitMQ\ndescription:\n - Manage dynamic, cluster-wide parameters for RabbitMQ\nversion_added: \"1.1\"\nauthor: Chris Hoffman\noptions:\n component:\n description:\n - Name of the component of which the parameter is being set\n required: true\n default: null\n name:\n description:\n - Name of the parameter being set\n required: true\n default: null\n value:\n description:\n - Value of the parameter, as a JSON term\n required: false\n default: null\n vhost:\n description:\n - vhost to apply access privileges.\n required: false\n default: /\n node:\n description:\n - erlang node name of the rabbit we wish to configure\n required: false\n default: rabbit\n version_added: \"1.2\"\n state:\n description:\n - Specify if user is to be added or removed\n required: false\n default: present\n choices: [ 'present', 'absent']\n'''\n\nEXAMPLES = \"\"\"\n# Set the federation parameter 'local_username' to a value of 'guest' (in quotes)\n- rabbitmq_parameter: component=federation\n name=local-username\n value='\"guest\"'\n state=present\n\"\"\"\n\nclass RabbitMqParameter(object):\n def __init__(self, module, component, name, value, vhost, node):\n self.module = module\n self.component = component\n self.name = name\n self.value = value\n self.vhost = vhost\n self.node = node\n\n self._value = None\n\n self._rabbitmqctl = module.get_bin_path('rabbitmqctl', True)\n\n def _exec(self, args, run_in_check_mode=False):\n if not self.module.check_mode or (self.module.check_mode and run_in_check_mode):\n cmd = [self._rabbitmqctl, '-q', '-n', self.node]\n rc, out, err = self.module.run_command(cmd + args, check_rc=True)\n return out.splitlines()\n return list()\n\n def get(self):\n parameters = self._exec(['list_parameters', '-p', self.vhost], True)\n\n for param_item in parameters:\n component, name, value = param_item.split('\\t')\n\n if component == self.component and name == self.name:\n self._value = value\n return True\n return False\n\n def set(self):\n self._exec(['set_parameter', '-p', self.vhost, self.component, self.name, self.value])\n\n def delete(self):\n self._exec(['clear_parameter', '-p', self.vhost, self.component, self.name])\n\n def has_modifications(self):\n return self.value != self._value\n\ndef main():\n arg_spec = dict(\n component=dict(required=True),\n name=dict(required=True),\n value=dict(default=None),\n vhost=dict(default='/'),\n state=dict(default='present', choices=['present', 'absent']),\n node=dict(default='rabbit')\n )\n module = AnsibleModule(\n argument_spec=arg_spec,\n supports_check_mode=True\n )\n\n component = module.params['component']\n name = module.params['name']\n value = module.params['value']\n vhost = module.params['vhost']\n state = module.params['state']\n node = module.params['node']\n\n rabbitmq_parameter = RabbitMqParameter(module, component, name, value, vhost, node)\n\n changed = False\n if rabbitmq_parameter.get():\n if state == 'absent':\n rabbitmq_parameter.delete()\n changed = True\n else:\n if rabbitmq_parameter.has_modifications():\n rabbitmq_parameter.set()\n changed = True\n elif state == 'present':\n rabbitmq_parameter.set()\n changed = True\n\n module.exit_json(changed=changed, component=component, name=name, vhost=vhost, state=state)\n\n# import module snippets\nfrom ansible.module_utils.basic import *\nmain()\n","path":"messaging/rabbitmq_parameter.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/python\\n# -*- coding: utf-8 -*-\\n\\n# (c) 2013, Chatham Financial <oss@chathamfinancial.com>\\n#\\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 option) any later version.\\n#\\n# Ansible is distributed in the hope that it will be useful,\\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\\n# GNU General Public License for more details.\\n#\\n# You should have received a copy of the GNU General Public License\\n# along with Ansible. If not, see <http://www.gnu.org/licenses/>.\\n\\nDOCUMENTATION = '''\\n---\\nmodule: rabbitmq_parameter\\nshort_description: Adds or removes parameters to RabbitMQ\\ndescription:\\n - Manage dynamic, cluster-wide parameters for RabbitMQ\\nversion_added: \\\"1.1\\\"\\nauthor: Chris Hoffman\\noptions:\\n component:\\n description:\\n - Name of the component of which the parameter is being set\\n required: true\\n default: null\\n name:\\n description:\\n - Name of the parameter being set\\n required: true\\n default: null\\n value:\\n description:\\n - Value of the parameter, as a JSON term\\n required: false\\n default: null\\n vhost:\\n description:\\n - vhost to apply access privileges.\\n required: false\\n default: /\\n node:\\n description:\\n - erlang node name of the rabbit we wish to configure\\n required: false\\n default: rabbit\\n version_added: \\\"1.2\\\"\\n state:\\n description:\\n - Specify if user is to be added or removed\\n required: false\\n default: present\\n choices: [ 'present', 'absent']\\n'''\\n\\nEXAMPLES = \\\"\\\"\\\"\\n# Set the federation parameter 'local_username' to a value of 'guest' (in quotes)\\n- rabbitmq_parameter: component=federation\\n name=local-username\\n value='\\\"guest\\\"'\\n state=present\\n\\\"\\\"\\\"\\n\\nclass RabbitMqParameter(object):\\n def __init__(self, module, component, name, value, vhost, node):\\n self.module = module\\n self.component = component\\n self.name = name\\n self.value = value\\n self.vhost = vhost\\n self.node = node\\n\\n self._value = None\\n\\n self._rabbitmqctl = module.get_bin_path('rabbitmqctl', True)\\n\\n def _exec(self, args, run_in_check_mode=False):\\n if not self.module.check_mode or (self.module.check_mode and run_in_check_mode):\\n cmd = [self._rabbitmqctl, '-q', '-n', self.node]\\n rc, out, err = self.module.run_command(cmd + args, check_rc=True)\\n return out.splitlines()\\n return list()\\n\\n def get(self):\\n parameters = self._exec(['list_parameters', '-p', self.vhost], True)\\n\\n for param_item in parameters:\\n component, name, value = param_item.split('\\\\t')\\n\\n if component == self.component and name == self.name:\\n self._value = value\\n return True\\n return False\\n\\n def set(self):\\n self._exec(['set_parameter', '-p', self.vhost, self.component, self.name, self.value])\\n\\n def delete(self):\\n self._exec(['clear_parameter', '-p', self.vhost, self.component, self.name])\\n\\n def has_modifications(self):\\n return self.value != self._value\\n\\ndef main():\\n arg_spec = dict(\\n component=dict(required=True),\\n name=dict(required=True),\\n value=dict(default=None),\\n vhost=dict(default='/'),\\n state=dict(default='present', choices=['present', 'absent']),\\n node=dict(default='rabbit')\\n )\\n module = AnsibleModule(\\n argument_spec=arg_spec,\\n supports_check_mode=True\\n )\\n\\n component = module.params['component']\\n name = module.params['name']\\n value = module.params['value']\\n vhost = module.params['vhost']\\n state = module.params['state']\\n node = module.params['node']\\n\\n rabbitmq_parameter = RabbitMqParameter(module, component, name, value, vhost, node)\\n\\n changed = False\\n if rabbitmq_parameter.get():\\n if state == 'absent':\\n rabbitmq_parameter.delete()\\n changed = True\\n else:\\n if rabbitmq_parameter.has_modifications():\\n rabbitmq_parameter.set()\\n changed = True\\n elif state == 'present':\\n rabbitmq_parameter.set()\\n changed = True\\n\\n module.exit_json(changed=changed, component=component, name=name, vhost=vhost, state=state)\\n\\n# import module snippets\\nfrom ansible.module_utils.basic import *\\nmain()\\n\",\n \"path\": \"messaging/rabbitmq_parameter.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/messaging/rabbitmq_parameter.py b/messaging/rabbitmq_parameter.py\nindex f2744ca2ae2..2f78bd4ee15 100644\n--- a/messaging/rabbitmq_parameter.py\n+++ b/messaging/rabbitmq_parameter.py\n@@ -126,8 +126,6 @@ def main():\n component = module.params['component']\n name = module.params['name']\n value = module.params['value']\n- if not isinstance(value, str):\n- value = json.dumps(value)\n vhost = module.params['vhost']\n state = module.params['state']\n node = module.params['node']\n"}}},{"rowIdx":4692,"cells":{"in_source_id":{"kind":"string","value":"facebookresearch__hydra-1685"},"issue":{"kind":"string","value":"CI fails with UserWarning raised from importing nevergrad\nexample failure here https://app.circleci.com/pipelines/github/facebookresearch/hydra/10584/workflows/d4c57363-bb31-42f4-a7ee-29c28a577f67/jobs/95695\r\n\r\nthis can be reproduced by simply importing nevergrad\r\n```\r\n>>> import nevergrad as ng\r\n/Users/jieru/opt/anaconda3/envs/testnv/lib/python3.8/site-packages/cma/s.py:13: UserWarning: Could not import matplotlib.pyplot, therefore ``cma.plot()`` etc. is not available\r\n _warnings.warn('Could not import matplotlib.pyplot, therefore'\r\n```\r\n\r\nthe warnings comes from one of nevergrad's dependency `cma` which just had a new release https://github.com/CMA-ES/pycma/releases\n"},"before_files":{"kind":"list like","value":[{"content":"# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved\n# type: ignore\nfrom pathlib import Path\n\nfrom read_version import read_version\nfrom setuptools import find_namespace_packages, setup\n\nsetup(\n name=\"hydra-nevergrad-sweeper\",\n version=read_version(\"hydra_plugins/hydra_nevergrad_sweeper\", \"__init__.py\"),\n author=\"Jeremy Rapin, Omry Yadan, Jieru Hu\",\n author_email=\"jrapin@fb.com, omry@fb.com, jieru@fb.com\",\n description=\"Hydra Nevergrad Sweeper plugin\",\n long_description=(Path(__file__).parent / \"README.md\").read_text(),\n long_description_content_type=\"text/markdown\",\n url=\"https://github.com/facebookresearch/hydra/\",\n packages=find_namespace_packages(include=[\"hydra_plugins.*\"]),\n classifiers=[\n \"License :: OSI Approved :: MIT License\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\",\n \"Operating System :: OS Independent\",\n \"Development Status :: 4 - Beta\",\n ],\n install_requires=[\n \"hydra-core>=1.1.0.dev7\",\n \"nevergrad>=0.4.3.post2\",\n \"numpy<1.20.0\", # remove once nevergrad is upgraded to support numpy 1.20\n ],\n include_package_data=True,\n)\n","path":"plugins/hydra_nevergrad_sweeper/setup.py"}],"string":"[\n {\n \"content\": \"# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved\\n# type: ignore\\nfrom pathlib import Path\\n\\nfrom read_version import read_version\\nfrom setuptools import find_namespace_packages, setup\\n\\nsetup(\\n name=\\\"hydra-nevergrad-sweeper\\\",\\n version=read_version(\\\"hydra_plugins/hydra_nevergrad_sweeper\\\", \\\"__init__.py\\\"),\\n author=\\\"Jeremy Rapin, Omry Yadan, Jieru Hu\\\",\\n author_email=\\\"jrapin@fb.com, omry@fb.com, jieru@fb.com\\\",\\n description=\\\"Hydra Nevergrad Sweeper plugin\\\",\\n long_description=(Path(__file__).parent / \\\"README.md\\\").read_text(),\\n long_description_content_type=\\\"text/markdown\\\",\\n url=\\\"https://github.com/facebookresearch/hydra/\\\",\\n packages=find_namespace_packages(include=[\\\"hydra_plugins.*\\\"]),\\n classifiers=[\\n \\\"License :: OSI Approved :: MIT License\\\",\\n \\\"Programming Language :: Python :: 3.6\\\",\\n \\\"Programming Language :: Python :: 3.7\\\",\\n \\\"Programming Language :: Python :: 3.8\\\",\\n \\\"Programming Language :: Python :: 3.9\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Development Status :: 4 - Beta\\\",\\n ],\\n install_requires=[\\n \\\"hydra-core>=1.1.0.dev7\\\",\\n \\\"nevergrad>=0.4.3.post2\\\",\\n \\\"numpy<1.20.0\\\", # remove once nevergrad is upgraded to support numpy 1.20\\n ],\\n include_package_data=True,\\n)\\n\",\n \"path\": \"plugins/hydra_nevergrad_sweeper/setup.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved\n# type: ignore\nfrom pathlib import Path\n\nfrom read_version import read_version\nfrom setuptools import find_namespace_packages, setup\n\nsetup(\n name=\"hydra-nevergrad-sweeper\",\n version=read_version(\"hydra_plugins/hydra_nevergrad_sweeper\", \"__init__.py\"),\n author=\"Jeremy Rapin, Omry Yadan, Jieru Hu\",\n author_email=\"jrapin@fb.com, omry@fb.com, jieru@fb.com\",\n description=\"Hydra Nevergrad Sweeper plugin\",\n long_description=(Path(__file__).parent / \"README.md\").read_text(),\n long_description_content_type=\"text/markdown\",\n url=\"https://github.com/facebookresearch/hydra/\",\n packages=find_namespace_packages(include=[\"hydra_plugins.*\"]),\n classifiers=[\n \"License :: OSI Approved :: MIT License\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\",\n \"Operating System :: OS Independent\",\n \"Development Status :: 4 - Beta\",\n ],\n install_requires=[\n \"hydra-core>=1.1.0.dev7\",\n \"nevergrad>=0.4.3.post2\",\n \"cma==3.0.3\", # https://github.com/facebookresearch/hydra/issues/1684\n \"numpy<1.20.0\", # remove once nevergrad is upgraded to support numpy 1.20\n ],\n include_package_data=True,\n)\n","path":"plugins/hydra_nevergrad_sweeper/setup.py"}],"string":"[\n {\n \"content\": \"# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved\\n# type: ignore\\nfrom pathlib import Path\\n\\nfrom read_version import read_version\\nfrom setuptools import find_namespace_packages, setup\\n\\nsetup(\\n name=\\\"hydra-nevergrad-sweeper\\\",\\n version=read_version(\\\"hydra_plugins/hydra_nevergrad_sweeper\\\", \\\"__init__.py\\\"),\\n author=\\\"Jeremy Rapin, Omry Yadan, Jieru Hu\\\",\\n author_email=\\\"jrapin@fb.com, omry@fb.com, jieru@fb.com\\\",\\n description=\\\"Hydra Nevergrad Sweeper plugin\\\",\\n long_description=(Path(__file__).parent / \\\"README.md\\\").read_text(),\\n long_description_content_type=\\\"text/markdown\\\",\\n url=\\\"https://github.com/facebookresearch/hydra/\\\",\\n packages=find_namespace_packages(include=[\\\"hydra_plugins.*\\\"]),\\n classifiers=[\\n \\\"License :: OSI Approved :: MIT License\\\",\\n \\\"Programming Language :: Python :: 3.6\\\",\\n \\\"Programming Language :: Python :: 3.7\\\",\\n \\\"Programming Language :: Python :: 3.8\\\",\\n \\\"Programming Language :: Python :: 3.9\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Development Status :: 4 - Beta\\\",\\n ],\\n install_requires=[\\n \\\"hydra-core>=1.1.0.dev7\\\",\\n \\\"nevergrad>=0.4.3.post2\\\",\\n \\\"cma==3.0.3\\\", # https://github.com/facebookresearch/hydra/issues/1684\\n \\\"numpy<1.20.0\\\", # remove once nevergrad is upgraded to support numpy 1.20\\n ],\\n include_package_data=True,\\n)\\n\",\n \"path\": \"plugins/hydra_nevergrad_sweeper/setup.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/plugins/hydra_nevergrad_sweeper/setup.py b/plugins/hydra_nevergrad_sweeper/setup.py\nindex 36fbfe12552..28954591ac3 100644\n--- a/plugins/hydra_nevergrad_sweeper/setup.py\n+++ b/plugins/hydra_nevergrad_sweeper/setup.py\n@@ -27,6 +27,7 @@\n install_requires=[\n \"hydra-core>=1.1.0.dev7\",\n \"nevergrad>=0.4.3.post2\",\n+ \"cma==3.0.3\", # https://github.com/facebookresearch/hydra/issues/1684\n \"numpy<1.20.0\", # remove once nevergrad is upgraded to support numpy 1.20\n ],\n include_package_data=True,\n"}}},{"rowIdx":4693,"cells":{"in_source_id":{"kind":"string","value":"sublimelsp__LSP-1699"},"issue":{"kind":"string","value":"Getting error \"list index out of range\" when no command is defined\n**Describe the bug**\r\nLSP shows a cryptic error message when you want to use elixir-ls but the package settings don't define a default command similar to other clients. When you install ElixirLS on Manjaro the executable is named `elixir-ls`.\r\n\r\n**To Reproduce**\r\nSteps to reproduce the behavior:\r\n1. In the User LSP.sublime-settings file choose a client you have installed.\r\n2. Set command to an empty array e.g.:\r\n```json\r\n{\r\n \"clients\": {\r\n \"elixir-ls\": {\r\n \"command\": [],\r\n \"enabled\": true\r\n }\r\n }\r\n}\r\n```\r\n\r\n**Expected behavior**\r\nI would expect a hint that the command is empty/missing and needs to be configured before LSP tries to call it.\r\n\r\n**Screenshots**\r\nA dialog window pops up with the following error message:\r\n```\r\nCould not start elixir-ls\r\nlist index out of range\r\nServer will be disabled for this window\r\n```\r\n\r\n**Environment (please complete the following information):**\r\n- OS: Linux Manjaro\r\n- Sublime Text version: 4096\r\n- LSP version: 1.2.9\r\n- Language servers used: only elixir-ls\r\n\r\n**Additional context**\r\nThe error originally stems from `subprocess.Popen()` which expects args to be a non-empty array. The `Popen` function is called from `def _start_subprocess` in `\"transports.py:260\"`.\r\n\r\nThe error message comes from `\"/plugin/core/windows.py:344\"`.\n"},"before_files":{"kind":"list like","value":[{"content":"from .collections import DottedDict\nfrom .logging import debug, set_debug_logging\nfrom .protocol import TextDocumentSyncKindNone\nfrom .typing import Any, Optional, List, Dict, Generator, Callable, Iterable, Union, Set, Tuple, TypeVar\nfrom .url import filename_to_uri\nfrom .url import uri_to_filename\nfrom threading import RLock\nfrom wcmatch.glob import BRACE\nfrom wcmatch.glob import globmatch\nfrom wcmatch.glob import GLOBSTAR\nimport contextlib\nimport os\nimport socket\nimport sublime\nimport time\n\nTCP_CONNECT_TIMEOUT = 5 # seconds\nFEATURES_TIMEOUT = 300 # milliseconds\n\nPANEL_FILE_REGEX = r\"^(?!\\s+\\d+:\\d+)(.*)(:)$\"\nPANEL_LINE_REGEX = r\"^\\s+(\\d+):(\\d+)\"\n\n\ndef basescope2languageid(base_scope: str) -> str:\n # This the connection between Language IDs and ST selectors.\n base_scope_map = sublime.load_settings(\"language-ids.sublime-settings\")\n result = base_scope_map.get(base_scope, base_scope.split(\".\")[-1])\n return result if isinstance(result, str) else \"\"\n\n\n@contextlib.contextmanager\ndef runtime(token: str) -> Generator[None, None, None]:\n t = time.time()\n yield\n debug(token, \"running time:\", int((time.time() - t) * 1000000), \"μs\")\n\n\nT = TypeVar(\"T\")\n\n\ndef diff(old: Iterable[T], new: Iterable[T]) -> Tuple[Set[T], Set[T]]:\n \"\"\"\n Return a tuple of (added, removed) items\n \"\"\"\n old_set = old if isinstance(old, set) else set(old)\n new_set = new if isinstance(new, set) else set(new)\n added = new_set - old_set\n removed = old_set - new_set\n return added, removed\n\n\ndef debounced(f: Callable[[], Any], timeout_ms: int = 0, condition: Callable[[], bool] = lambda: True,\n async_thread: bool = False) -> None:\n \"\"\"\n Possibly run a function at a later point in time, either on the async thread or on the main thread.\n\n :param f: The function to possibly run. Its return type is discarded.\n :param timeout_ms: The time in milliseconds after which to possibly to run the function\n :param condition: The condition that must evaluate to True in order to run the funtion\n :param async_thread: If true, run the function on the async worker thread, otherwise run the function on the\n main thread\n \"\"\"\n\n def run() -> None:\n if condition():\n f()\n\n runner = sublime.set_timeout_async if async_thread else sublime.set_timeout\n runner(run, timeout_ms)\n\n\ndef _settings_style_to_add_regions_flag(style: str) -> int:\n flags = 0\n if style == \"fill\":\n flags = sublime.DRAW_NO_OUTLINE\n elif style == \"box\":\n flags = sublime.DRAW_NO_FILL\n else:\n flags = sublime.DRAW_NO_FILL | sublime.DRAW_NO_OUTLINE\n if style == \"underline\":\n flags |= sublime.DRAW_SOLID_UNDERLINE\n elif style == \"stippled\":\n flags |= sublime.DRAW_STIPPLED_UNDERLINE\n elif style == \"squiggly\":\n flags |= sublime.DRAW_SQUIGGLY_UNDERLINE\n return flags\n\n\nclass SettingsRegistration:\n __slots__ = (\"_settings\",)\n\n def __init__(self, settings: sublime.Settings, on_change: Callable[[], None]) -> None:\n self._settings = settings\n settings.add_on_change(\"LSP\", on_change)\n\n def __del__(self) -> None:\n self._settings.clear_on_change(\"LSP\")\n\n\nclass Debouncer:\n\n def __init__(self) -> None:\n self._current_id = -1\n self._next_id = 0\n self._current_id_lock = RLock()\n\n def debounce(self, f: Callable[[], None], timeout_ms: int = 0, condition: Callable[[], bool] = lambda: True,\n async_thread: bool = False) -> None:\n \"\"\"\n Possibly run a function at a later point in time, either on the async thread or on the main thread.\n\n :param f: The function to possibly run\n :param timeout_ms: The time in milliseconds after which to possibly to run the function\n :param condition: The condition that must evaluate to True in order to run the funtion\n :param async_thread: If true, run the function on the async worker thread, otherwise run\n the function on the main thread\n \"\"\"\n\n def run(debounce_id: int) -> None:\n with self._current_id_lock:\n if debounce_id != self._current_id:\n return\n if condition():\n f()\n\n runner = sublime.set_timeout_async if async_thread else sublime.set_timeout\n with self._current_id_lock:\n current_id = self._current_id = self._next_id\n self._next_id += 1\n runner(lambda: run(current_id), timeout_ms)\n\n def cancel_pending(self) -> None:\n with self._current_id_lock:\n self._current_id = -1\n\n\ndef read_dict_setting(settings_obj: sublime.Settings, key: str, default: dict) -> dict:\n val = settings_obj.get(key)\n return val if isinstance(val, dict) else default\n\n\ndef read_list_setting(settings_obj: sublime.Settings, key: str, default: list) -> list:\n val = settings_obj.get(key)\n return val if isinstance(val, list) else default\n\n\nclass Settings:\n\n # This is only for mypy\n code_action_on_save_timeout_ms = None # type: int\n diagnostics_additional_delay_auto_complete_ms = None # type: int\n diagnostics_delay_ms = None # type: int\n diagnostics_gutter_marker = None # type: str\n diagnostics_highlight_style = None # type: str\n diagnostics_panel_include_severity_level = None # type: int\n disabled_capabilities = None # type: List[str]\n document_highlight_style = None # type: str\n inhibit_snippet_completions = None # type: bool\n inhibit_word_completions = None # type: bool\n log_debug = None # type: bool\n log_max_size = None # type: int\n log_server = None # type: List[str]\n lsp_code_actions_on_save = None # type: Dict[str, bool]\n lsp_format_on_save = None # type: bool\n only_show_lsp_completions = None # type: bool\n popup_max_characters_height = None # type: int\n popup_max_characters_width = None # type: int\n show_code_actions = None # type: bool\n show_diagnostics_count_in_view_status = None # type: bool\n show_diagnostics_in_view_status = None # type: bool\n show_diagnostics_panel_on_save = None # type: int\n show_diagnostics_severity_level = None # type: int\n show_references_in_quick_panel = None # type: bool\n show_symbol_action_links = None # type: bool\n show_view_status = None # type: bool\n\n def __init__(self, s: sublime.Settings) -> None:\n self.update(s)\n\n def update(self, s: sublime.Settings) -> None:\n\n def r(name: str, default: Union[bool, int, str, list, dict]) -> None:\n val = s.get(name)\n setattr(self, name, val if isinstance(val, default.__class__) else default)\n\n r(\"code_action_on_save_timeout_ms\", 2000)\n r(\"diagnostics_additional_delay_auto_complete_ms\", 0)\n r(\"diagnostics_delay_ms\", 0)\n r(\"diagnostics_gutter_marker\", \"dot\")\n r(\"diagnostics_highlight_style\", \"underline\")\n r(\"diagnostics_panel_include_severity_level\", 4)\n r(\"disabled_capabilities\", [])\n r(\"document_highlight_style\", \"stippled\")\n r(\"log_debug\", False)\n r(\"log_max_size\", 8 * 1024)\n r(\"lsp_code_actions_on_save\", {})\n r(\"lsp_format_on_save\", False)\n r(\"only_show_lsp_completions\", False)\n r(\"popup_max_characters_height\", 1000)\n r(\"popup_max_characters_width\", 120)\n r(\"show_code_actions\", \"annotation\")\n r(\"show_diagnostics_count_in_view_status\", False)\n r(\"show_diagnostics_in_view_status\", True)\n r(\"show_diagnostics_panel_on_save\", 2)\n r(\"show_diagnostics_severity_level\", 2)\n r(\"show_references_in_quick_panel\", False)\n r(\"show_symbol_action_links\", False)\n r(\"show_view_status\", True)\n\n # Backwards-compatible with the bool setting\n log_server = s.get(\"log_server\")\n if isinstance(log_server, bool):\n self.log_server = [\"panel\"] if log_server else []\n elif isinstance(log_server, list):\n self.log_server = log_server\n else:\n self.log_server = []\n\n # Backwards-compatible with the bool setting\n auto_show_diagnostics_panel = s.get(\"auto_show_diagnostics_panel\")\n if isinstance(auto_show_diagnostics_panel, bool):\n if not auto_show_diagnostics_panel:\n self.show_diagnostics_panel_on_save = 0\n elif isinstance(auto_show_diagnostics_panel, str):\n if auto_show_diagnostics_panel == \"never\":\n self.show_diagnostics_panel_on_save = 0\n\n # Backwards-compatible with \"only_show_lsp_completions\"\n only_show_lsp_completions = s.get(\"only_show_lsp_completions\")\n if isinstance(only_show_lsp_completions, bool):\n self.inhibit_snippet_completions = only_show_lsp_completions\n self.inhibit_word_completions = only_show_lsp_completions\n else:\n r(\"inhibit_snippet_completions\", False)\n r(\"inhibit_word_completions\", True)\n\n set_debug_logging(self.log_debug)\n\n def document_highlight_style_to_add_regions_flags(self) -> int:\n return _settings_style_to_add_regions_flag(self.document_highlight_style)\n\n def diagnostics_highlight_style_to_add_regions_flag(self) -> int:\n return _settings_style_to_add_regions_flag(self.diagnostics_highlight_style)\n\n\nclass ClientStates:\n STARTING = 0\n READY = 1\n STOPPING = 2\n\n\nclass DocumentFilter:\n \"\"\"\n A document filter denotes a document through properties like language, scheme or pattern. An example is a filter\n that applies to TypeScript files on disk. Another example is a filter that applies to JSON files with name\n package.json:\n\n { \"language\": \"typescript\", scheme: \"file\" }\n { \"language\": \"json\", \"pattern\": \"**/package.json\" }\n\n Sublime Text doesn't understand what a language ID is, so we have to maintain a global translation map from language\n IDs to selectors. Sublime Text also has no support for patterns. We use the wcmatch library for this.\n \"\"\"\n\n __slots__ = (\"language\", \"scheme\", \"pattern\")\n\n def __init__(\n self,\n language: Optional[str] = None,\n scheme: Optional[str] = None,\n pattern: Optional[str] = None\n ) -> None:\n self.scheme = scheme\n self.pattern = pattern\n self.language = language\n\n def __call__(self, view: sublime.View) -> bool:\n \"\"\"Does this filter match the view? An empty filter matches any view.\"\"\"\n if self.language:\n syntax = view.syntax()\n if not syntax or basescope2languageid(syntax.scope) != self.language:\n return False\n if self.scheme:\n # Can be \"file\" or \"untitled\"?\n pass\n if self.pattern:\n if not globmatch(view.file_name() or \"\", self.pattern, flags=GLOBSTAR | BRACE):\n return False\n return True\n\n\nclass DocumentSelector:\n \"\"\"\n A DocumentSelector is a list of DocumentFilters. A view matches a DocumentSelector if and only if any one of its\n filters matches against the view.\n \"\"\"\n\n __slots__ = (\"filters\",)\n\n def __init__(self, document_selector: List[Dict[str, Any]]) -> None:\n self.filters = [DocumentFilter(**document_filter) for document_filter in document_selector]\n\n def __bool__(self) -> bool:\n return bool(self.filters)\n\n def matches(self, view: sublime.View) -> bool:\n \"\"\"Does this selector match the view? A selector with no filters matches all views.\"\"\"\n return any(f(view) for f in self.filters) if self.filters else True\n\n\n# method -> (capability dotted path, optional registration dotted path)\n# these are the EXCEPTIONS. The general rule is: method foo/bar --> (barProvider, barProvider.id)\n_METHOD_TO_CAPABILITY_EXCEPTIONS = {\n 'workspace/symbol': ('workspaceSymbolProvider', None),\n 'workspace/didChangeWorkspaceFolders': ('workspace.workspaceFolders',\n 'workspace.workspaceFolders.changeNotifications'),\n 'textDocument/didOpen': ('textDocumentSync.didOpen', None),\n 'textDocument/didClose': ('textDocumentSync.didClose', None),\n 'textDocument/didChange': ('textDocumentSync.change', None),\n 'textDocument/didSave': ('textDocumentSync.save', None),\n 'textDocument/willSave': ('textDocumentSync.willSave', None),\n 'textDocument/willSaveWaitUntil': ('textDocumentSync.willSaveWaitUntil', None),\n 'textDocument/formatting': ('documentFormattingProvider', None),\n 'textDocument/documentColor': ('colorProvider', None)\n} # type: Dict[str, Tuple[str, Optional[str]]]\n\n\ndef method_to_capability(method: str) -> Tuple[str, str]:\n \"\"\"\n Given a method, returns the corresponding capability path, and the associated path to stash the registration key.\n\n Examples:\n\n textDocument/definition --> (definitionProvider, definitionProvider.id)\n textDocument/references --> (referencesProvider, referencesProvider.id)\n textDocument/didOpen --> (textDocumentSync.didOpen, textDocumentSync.didOpen.id)\n \"\"\"\n capability_path, registration_path = _METHOD_TO_CAPABILITY_EXCEPTIONS.get(method, (None, None))\n if capability_path is None:\n capability_path = method.split('/')[1] + \"Provider\"\n if registration_path is None:\n # This path happens to coincide with the StaticRegistrationOptions' id, which is on purpose. As a consequence,\n # if a server made a \"registration\" via the initialize response, it can call client/unregisterCapability at\n # a later date, and the capability will pop from the capabilities dict.\n registration_path = capability_path + \".id\"\n return capability_path, registration_path\n\n\ndef normalize_text_sync(textsync: Union[None, int, Dict[str, Any]]) -> Dict[str, Any]:\n \"\"\"\n Brings legacy text sync capabilities to the most modern format\n \"\"\"\n result = {} # type: Dict[str, Any]\n if isinstance(textsync, int):\n change = {\"syncKind\": textsync} # type: Optional[Dict[str, Any]]\n result[\"textDocumentSync\"] = {\"didOpen\": {}, \"save\": {}, \"didClose\": {}, \"change\": change}\n elif isinstance(textsync, dict):\n new = {}\n change = textsync.get(\"change\")\n if isinstance(change, int):\n new[\"change\"] = {\"syncKind\": change}\n elif isinstance(change, dict):\n new[\"change\"] = change\n\n def maybe_assign_bool_or_dict(key: str) -> None:\n assert isinstance(textsync, dict)\n value = textsync.get(key)\n if isinstance(value, bool) and value:\n new[key] = {}\n elif isinstance(value, dict):\n new[key] = value\n\n open_close = textsync.get(\"openClose\")\n if isinstance(open_close, bool):\n if open_close:\n new[\"didOpen\"] = {}\n new[\"didClose\"] = {}\n else:\n maybe_assign_bool_or_dict(\"didOpen\")\n maybe_assign_bool_or_dict(\"didClose\")\n maybe_assign_bool_or_dict(\"willSave\")\n maybe_assign_bool_or_dict(\"willSaveWaitUntil\")\n maybe_assign_bool_or_dict(\"save\")\n result[\"textDocumentSync\"] = new\n return result\n\n\nclass Capabilities(DottedDict):\n \"\"\"\n Maintains static and dynamic capabilities\n\n Static capabilities come from a response to the initialize request (from Client -> Server).\n Dynamic capabilities can be registered at any moment with client/registerCapability and client/unregisterCapability\n (from Server -> Client).\n \"\"\"\n\n def register(\n self,\n registration_id: str,\n capability_path: str,\n registration_path: str,\n options: Dict[str, Any]\n ) -> None:\n stored_registration_id = self.get(registration_path)\n if isinstance(stored_registration_id, str):\n msg = \"{} is already registered at {} with ID {}, overwriting\"\n debug(msg.format(capability_path, registration_path, stored_registration_id))\n self.set(capability_path, options)\n self.set(registration_path, registration_id)\n\n def unregister(\n self,\n registration_id: str,\n capability_path: str,\n registration_path: str\n ) -> Optional[Dict[str, Any]]:\n stored_registration_id = self.get(registration_path)\n if not isinstance(stored_registration_id, str):\n debug(\"stored registration ID at\", registration_path, \"is not a string\")\n return None\n elif stored_registration_id != registration_id:\n msg = \"stored registration ID ({}) is not the same as the provided registration ID ({})\"\n debug(msg.format(stored_registration_id, registration_id))\n return None\n else:\n discarded = self.get(capability_path)\n self.remove(capability_path)\n self.remove(registration_path)\n return discarded\n\n def assign(self, d: Dict[str, Any]) -> None:\n textsync = normalize_text_sync(d.pop(\"textDocumentSync\", None))\n super().assign(d)\n if textsync:\n self.update(textsync)\n\n def should_notify_did_open(self) -> bool:\n return \"textDocumentSync.didOpen\" in self\n\n def text_sync_kind(self) -> int:\n value = self.get(\"textDocumentSync.change.syncKind\")\n return value if isinstance(value, int) else TextDocumentSyncKindNone\n\n def should_notify_did_change_workspace_folders(self) -> bool:\n return \"workspace.workspaceFolders.changeNotifications\" in self\n\n def should_notify_will_save(self) -> bool:\n return \"textDocumentSync.willSave\" in self\n\n def should_notify_did_save(self) -> Tuple[bool, bool]:\n save = self.get(\"textDocumentSync.save\")\n if isinstance(save, bool):\n return save, False\n elif isinstance(save, dict):\n return True, bool(save.get(\"includeText\"))\n else:\n return False, False\n\n def should_notify_did_close(self) -> bool:\n return \"textDocumentSync.didClose\" in self\n\n\ndef _translate_path(path: str, source: str, destination: str) -> Tuple[str, bool]:\n # TODO: Case-insensitive file systems. Maybe this problem needs a much larger refactor. Even Sublime Text doesn't\n # handle case-insensitive file systems correctly. There are a few other places where case-sensitivity matters, for\n # example when looking up the correct view for diagnostics, and when finding a view for goto-def.\n if path.startswith(source) and len(path) > len(source) and path[len(source)] in (\"/\", \"\\\\\"):\n return path.replace(source, destination, 1), True\n return path, False\n\n\nclass PathMap:\n\n __slots__ = (\"_local\", \"_remote\")\n\n def __init__(self, local: str, remote: str) -> None:\n self._local = local\n self._remote = remote\n\n @classmethod\n def parse(cls, json: Any) -> \"Optional[List[PathMap]]\":\n if not isinstance(json, list):\n return None\n result = [] # type: List[PathMap]\n for path_map in json:\n if not isinstance(path_map, dict):\n debug('path map entry is not an object')\n continue\n local = path_map.get(\"local\")\n if not isinstance(local, str):\n debug('missing \"local\" key for path map entry')\n continue\n remote = path_map.get(\"remote\")\n if not isinstance(remote, str):\n debug('missing \"remote\" key for path map entry')\n continue\n result.append(PathMap(local, remote))\n return result\n\n def __eq__(self, other: Any) -> bool:\n if not isinstance(other, PathMap):\n return False\n return self._local == other._local and self._remote == other._remote\n\n def map_from_local_to_remote(self, uri: str) -> Tuple[str, bool]:\n return _translate_path(uri, self._local, self._remote)\n\n def map_from_remote_to_local(self, uri: str) -> Tuple[str, bool]:\n return _translate_path(uri, self._remote, self._local)\n\n\nclass TransportConfig:\n __slots__ = (\"name\", \"command\", \"tcp_port\", \"env\", \"listener_socket\")\n\n def __init__(\n self,\n name: str,\n command: List[str],\n tcp_port: Optional[int],\n env: Dict[str, str],\n listener_socket: Optional[socket.socket]\n ) -> None:\n self.name = name\n self.command = command\n self.tcp_port = tcp_port\n self.env = env\n self.listener_socket = listener_socket\n\n\nclass ClientConfig:\n def __init__(self,\n name: str,\n selector: str,\n priority_selector: Optional[str] = None,\n command: Optional[List[str]] = None,\n binary_args: Optional[List[str]] = None, # DEPRECATED\n tcp_port: Optional[int] = None,\n auto_complete_selector: Optional[str] = None,\n enabled: bool = True,\n init_options: DottedDict = DottedDict(),\n settings: DottedDict = DottedDict(),\n env: Dict[str, str] = {},\n experimental_capabilities: Optional[Dict[str, Any]] = None,\n disabled_capabilities: DottedDict = DottedDict(),\n path_maps: Optional[List[PathMap]] = None) -> None:\n self.name = name\n self.selector = selector\n self.priority_selector = priority_selector if priority_selector else self.selector\n if isinstance(command, list):\n self.command = command\n else:\n assert isinstance(binary_args, list)\n self.command = binary_args\n self.tcp_port = tcp_port\n self.auto_complete_selector = auto_complete_selector\n self.enabled = enabled\n self.init_options = init_options\n self.settings = settings\n self.env = env\n self.experimental_capabilities = experimental_capabilities\n self.disabled_capabilities = disabled_capabilities\n self.path_maps = path_maps\n self.status_key = \"lsp_{}\".format(self.name)\n\n @classmethod\n def from_sublime_settings(cls, name: str, s: sublime.Settings, file: str) -> \"ClientConfig\":\n base = sublime.decode_value(sublime.load_resource(file))\n settings = DottedDict(base.get(\"settings\", {})) # defined by the plugin author\n settings.update(read_dict_setting(s, \"settings\", {})) # overrides from the user\n init_options = DottedDict(base.get(\"initializationOptions\", {}))\n init_options.update(read_dict_setting(s, \"initializationOptions\", {}))\n disabled_capabilities = s.get(\"disabled_capabilities\")\n if isinstance(disabled_capabilities, dict):\n disabled_capabilities = DottedDict(disabled_capabilities)\n else:\n disabled_capabilities = DottedDict()\n return ClientConfig(\n name=name,\n selector=_read_selector(s),\n priority_selector=_read_priority_selector(s),\n command=read_list_setting(s, \"command\", []),\n tcp_port=s.get(\"tcp_port\"),\n auto_complete_selector=s.get(\"auto_complete_selector\"),\n # Default to True, because an LSP plugin is enabled iff it is enabled as a Sublime package.\n enabled=bool(s.get(\"enabled\", True)),\n init_options=init_options,\n settings=settings,\n env=read_dict_setting(s, \"env\", {}),\n experimental_capabilities=s.get(\"experimental_capabilities\"),\n disabled_capabilities=disabled_capabilities,\n path_maps=PathMap.parse(s.get(\"path_maps\"))\n )\n\n @classmethod\n def from_dict(cls, name: str, d: Dict[str, Any]) -> \"ClientConfig\":\n disabled_capabilities = d.get(\"disabled_capabilities\")\n if isinstance(disabled_capabilities, dict):\n disabled_capabilities = DottedDict(disabled_capabilities)\n else:\n disabled_capabilities = DottedDict()\n return ClientConfig(\n name=name,\n selector=_read_selector(d),\n priority_selector=_read_priority_selector(d),\n command=d.get(\"command\", []),\n tcp_port=d.get(\"tcp_port\"),\n auto_complete_selector=d.get(\"auto_complete_selector\"),\n enabled=d.get(\"enabled\", False),\n init_options=DottedDict(d.get(\"initializationOptions\")),\n settings=DottedDict(d.get(\"settings\")),\n env=d.get(\"env\", dict()),\n experimental_capabilities=d.get(\"experimental_capabilities\"),\n disabled_capabilities=disabled_capabilities,\n path_maps=PathMap.parse(d.get(\"path_maps\"))\n )\n\n @classmethod\n def from_config(cls, src_config: \"ClientConfig\", override: Dict[str, Any]) -> \"ClientConfig\":\n path_map_override = PathMap.parse(override.get(\"path_maps\"))\n disabled_capabilities = override.get(\"disabled_capabilities\")\n if isinstance(disabled_capabilities, dict):\n disabled_capabilities = DottedDict(disabled_capabilities)\n else:\n disabled_capabilities = src_config.disabled_capabilities\n return ClientConfig(\n name=src_config.name,\n selector=_read_selector(override) or src_config.selector,\n priority_selector=_read_priority_selector(override) or src_config.priority_selector,\n command=override.get(\"command\", src_config.command),\n tcp_port=override.get(\"tcp_port\", src_config.tcp_port),\n auto_complete_selector=override.get(\"auto_complete_selector\", src_config.auto_complete_selector),\n enabled=override.get(\"enabled\", src_config.enabled),\n init_options=DottedDict.from_base_and_override(\n src_config.init_options, override.get(\"initializationOptions\")),\n settings=DottedDict.from_base_and_override(src_config.settings, override.get(\"settings\")),\n env=override.get(\"env\", src_config.env),\n experimental_capabilities=override.get(\n \"experimental_capabilities\", src_config.experimental_capabilities),\n disabled_capabilities=disabled_capabilities,\n path_maps=path_map_override if path_map_override else src_config.path_maps\n )\n\n def resolve_transport_config(self, variables: Dict[str, str]) -> TransportConfig:\n tcp_port = None # type: Optional[int]\n listener_socket = None # type: Optional[socket.socket]\n if self.tcp_port is not None:\n # < 0 means we're hosting a TCP server\n if self.tcp_port < 0:\n # -1 means pick any free port\n if self.tcp_port < -1:\n tcp_port = -self.tcp_port\n # Create a listener socket for incoming connections\n listener_socket = _start_tcp_listener(tcp_port)\n tcp_port = int(listener_socket.getsockname()[1])\n else:\n tcp_port = _find_free_port() if self.tcp_port == 0 else self.tcp_port\n if tcp_port is not None:\n variables[\"port\"] = str(tcp_port)\n command = sublime.expand_variables(self.command, variables)\n command = [os.path.expanduser(arg) for arg in command]\n if tcp_port is not None:\n # DEPRECATED -- replace {port} with $port or ${port} in your client config\n command = [a.replace('{port}', str(tcp_port)) for a in command]\n env = os.environ.copy()\n for var, value in self.env.items():\n env[var] = sublime.expand_variables(value, variables)\n return TransportConfig(self.name, command, tcp_port, env, listener_socket)\n\n def set_view_status(self, view: sublime.View, message: str) -> None:\n if sublime.load_settings(\"LSP.sublime-settings\").get(\"show_view_status\"):\n status = \"{}: {}\".format(self.name, message) if message else self.name\n view.set_status(self.status_key, status)\n\n def erase_view_status(self, view: sublime.View) -> None:\n view.erase_status(self.status_key)\n\n def match_view(self, view: sublime.View) -> bool:\n syntax = view.syntax()\n if syntax:\n # Every part of a x.y.z scope seems to contribute 8.\n # An empty selector result in a score of 1.\n # A non-matching non-empty selector results in a score of 0.\n # We want to match at least one part of an x.y.z, and we don't want to match on empty selectors.\n return sublime.score_selector(syntax.scope, self.selector) >= 8\n return False\n\n def map_client_path_to_server_uri(self, path: str) -> str:\n if self.path_maps:\n for path_map in self.path_maps:\n path, mapped = path_map.map_from_local_to_remote(path)\n if mapped:\n break\n return filename_to_uri(path)\n\n def map_server_uri_to_client_path(self, uri: str) -> str:\n path = uri_to_filename(uri)\n if self.path_maps:\n for path_map in self.path_maps:\n path, mapped = path_map.map_from_remote_to_local(path)\n if mapped:\n break\n return path\n\n def is_disabled_capability(self, capability_path: str) -> bool:\n for value in self.disabled_capabilities.walk(capability_path):\n if isinstance(value, bool):\n return value\n elif isinstance(value, dict):\n if value:\n # If it's not empty we'll continue the walk\n continue\n else:\n # This might be a leaf node\n return True\n return False\n\n def filter_out_disabled_capabilities(self, capability_path: str, options: Dict[str, Any]) -> Dict[str, Any]:\n result = {} # type: Dict[str, Any]\n for k, v in options.items():\n if not self.is_disabled_capability(\"{}.{}\".format(capability_path, k)):\n result[k] = v\n return result\n\n def __repr__(self) -> str:\n items = [] # type: List[str]\n for k, v in self.__dict__.items():\n if not k.startswith(\"_\"):\n items.append(\"{}={}\".format(k, repr(v)))\n return \"{}({})\".format(self.__class__.__name__, \", \".join(items))\n\n def __eq__(self, other: Any) -> bool:\n if not isinstance(other, ClientConfig):\n return False\n for k, v in self.__dict__.items():\n if not k.startswith(\"_\") and v != getattr(other, k):\n return False\n return True\n\n\ndef syntax2scope(syntax_path: str) -> Optional[str]:\n syntax = sublime.syntax_from_path(syntax_path)\n return syntax.scope if syntax else None\n\n\ndef view2scope(view: sublime.View) -> str:\n try:\n return view.scope_name(0).split()[0]\n except IndexError:\n return ''\n\n\ndef _read_selector(config: Union[sublime.Settings, Dict[str, Any]]) -> str:\n # Best base scenario,\n selector = config.get(\"selector\")\n if isinstance(selector, str):\n return selector\n # Otherwise, look for \"languages\": [...]\n languages = config.get(\"languages\")\n if isinstance(languages, list):\n selectors = []\n for language in languages:\n # First priority is document_selector,\n document_selector = language.get(\"document_selector\")\n if isinstance(document_selector, str):\n selectors.append(document_selector)\n continue\n # After that syntaxes has priority,\n syntaxes = language.get(\"syntaxes\")\n if isinstance(syntaxes, list):\n for path in syntaxes:\n syntax = sublime.syntax_from_path(path)\n if syntax:\n selectors.append(syntax.scope)\n continue\n # No syntaxes and no document_selector... then there must exist a languageId.\n language_id = language.get(\"languageId\")\n if isinstance(language_id, str):\n selectors.append(\"source.{}\".format(language_id))\n return \"|\".join(map(\"({})\".format, selectors))\n # Otherwise, look for \"document_selector\"\n document_selector = config.get(\"document_selector\")\n if isinstance(document_selector, str):\n return document_selector\n # Otherwise, look for \"syntaxes\": [...]\n syntaxes = config.get(\"syntaxes\")\n if isinstance(syntaxes, list):\n selectors = []\n for path in syntaxes:\n syntax = sublime.syntax_from_path(path)\n if syntax:\n selectors.append(syntax.scope)\n return \"|\".join(selectors)\n # No syntaxes and no document_selector... then there must exist a languageId.\n language_id = config.get(\"languageId\")\n if language_id:\n return \"source.{}\".format(language_id)\n return \"\"\n\n\ndef _read_priority_selector(config: Union[sublime.Settings, Dict[str, Any]]) -> str:\n # Best case scenario\n selector = config.get(\"priority_selector\")\n if isinstance(selector, str):\n return selector\n # Otherwise, look for \"languages\": [...]\n languages = config.get(\"languages\")\n if isinstance(languages, list):\n selectors = []\n for language in languages:\n # First priority is feature_selector.\n feature_selector = language.get(\"feature_selector\")\n if isinstance(feature_selector, str):\n selectors.append(feature_selector)\n continue\n # After that scopes has priority.\n scopes = language.get(\"scopes\")\n if isinstance(scopes, list):\n selectors.extend(scopes)\n continue\n # No scopes and no feature_selector. So there must be a languageId\n language_id = language.get(\"languageId\")\n if isinstance(language_id, str):\n selectors.append(\"source.{}\".format(language_id))\n return \"|\".join(map(\"({})\".format, selectors))\n # Otherwise, look for \"feature_selector\"\n feature_selector = config.get(\"feature_selector\")\n if isinstance(feature_selector, str):\n return feature_selector\n # Otherwise, look for \"scopes\": [...]\n scopes = config.get(\"scopes\")\n if isinstance(scopes, list):\n return \"|\".join(map(\"({})\".format, scopes))\n # No scopes and no feature_selector... then there must exist a languageId\n language_id = config.get(\"languageId\")\n if language_id:\n return \"source.{}\".format(language_id)\n return \"\"\n\n\ndef _find_free_port() -> int:\n with contextlib.closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:\n s.bind(('', 0))\n s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)\n return s.getsockname()[1]\n\n\ndef _start_tcp_listener(tcp_port: Optional[int]) -> socket.socket:\n sock = socket.socket()\n sock.bind(('localhost', tcp_port or 0))\n sock.settimeout(TCP_CONNECT_TIMEOUT)\n sock.listen(1)\n return sock\n","path":"plugin/core/types.py"}],"string":"[\n {\n \"content\": \"from .collections import DottedDict\\nfrom .logging import debug, set_debug_logging\\nfrom .protocol import TextDocumentSyncKindNone\\nfrom .typing import Any, Optional, List, Dict, Generator, Callable, Iterable, Union, Set, Tuple, TypeVar\\nfrom .url import filename_to_uri\\nfrom .url import uri_to_filename\\nfrom threading import RLock\\nfrom wcmatch.glob import BRACE\\nfrom wcmatch.glob import globmatch\\nfrom wcmatch.glob import GLOBSTAR\\nimport contextlib\\nimport os\\nimport socket\\nimport sublime\\nimport time\\n\\nTCP_CONNECT_TIMEOUT = 5 # seconds\\nFEATURES_TIMEOUT = 300 # milliseconds\\n\\nPANEL_FILE_REGEX = r\\\"^(?!\\\\s+\\\\d+:\\\\d+)(.*)(:)$\\\"\\nPANEL_LINE_REGEX = r\\\"^\\\\s+(\\\\d+):(\\\\d+)\\\"\\n\\n\\ndef basescope2languageid(base_scope: str) -> str:\\n # This the connection between Language IDs and ST selectors.\\n base_scope_map = sublime.load_settings(\\\"language-ids.sublime-settings\\\")\\n result = base_scope_map.get(base_scope, base_scope.split(\\\".\\\")[-1])\\n return result if isinstance(result, str) else \\\"\\\"\\n\\n\\n@contextlib.contextmanager\\ndef runtime(token: str) -> Generator[None, None, None]:\\n t = time.time()\\n yield\\n debug(token, \\\"running time:\\\", int((time.time() - t) * 1000000), \\\"μs\\\")\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n\\ndef diff(old: Iterable[T], new: Iterable[T]) -> Tuple[Set[T], Set[T]]:\\n \\\"\\\"\\\"\\n Return a tuple of (added, removed) items\\n \\\"\\\"\\\"\\n old_set = old if isinstance(old, set) else set(old)\\n new_set = new if isinstance(new, set) else set(new)\\n added = new_set - old_set\\n removed = old_set - new_set\\n return added, removed\\n\\n\\ndef debounced(f: Callable[[], Any], timeout_ms: int = 0, condition: Callable[[], bool] = lambda: True,\\n async_thread: bool = False) -> None:\\n \\\"\\\"\\\"\\n Possibly run a function at a later point in time, either on the async thread or on the main thread.\\n\\n :param f: The function to possibly run. Its return type is discarded.\\n :param timeout_ms: The time in milliseconds after which to possibly to run the function\\n :param condition: The condition that must evaluate to True in order to run the funtion\\n :param async_thread: If true, run the function on the async worker thread, otherwise run the function on the\\n main thread\\n \\\"\\\"\\\"\\n\\n def run() -> None:\\n if condition():\\n f()\\n\\n runner = sublime.set_timeout_async if async_thread else sublime.set_timeout\\n runner(run, timeout_ms)\\n\\n\\ndef _settings_style_to_add_regions_flag(style: str) -> int:\\n flags = 0\\n if style == \\\"fill\\\":\\n flags = sublime.DRAW_NO_OUTLINE\\n elif style == \\\"box\\\":\\n flags = sublime.DRAW_NO_FILL\\n else:\\n flags = sublime.DRAW_NO_FILL | sublime.DRAW_NO_OUTLINE\\n if style == \\\"underline\\\":\\n flags |= sublime.DRAW_SOLID_UNDERLINE\\n elif style == \\\"stippled\\\":\\n flags |= sublime.DRAW_STIPPLED_UNDERLINE\\n elif style == \\\"squiggly\\\":\\n flags |= sublime.DRAW_SQUIGGLY_UNDERLINE\\n return flags\\n\\n\\nclass SettingsRegistration:\\n __slots__ = (\\\"_settings\\\",)\\n\\n def __init__(self, settings: sublime.Settings, on_change: Callable[[], None]) -> None:\\n self._settings = settings\\n settings.add_on_change(\\\"LSP\\\", on_change)\\n\\n def __del__(self) -> None:\\n self._settings.clear_on_change(\\\"LSP\\\")\\n\\n\\nclass Debouncer:\\n\\n def __init__(self) -> None:\\n self._current_id = -1\\n self._next_id = 0\\n self._current_id_lock = RLock()\\n\\n def debounce(self, f: Callable[[], None], timeout_ms: int = 0, condition: Callable[[], bool] = lambda: True,\\n async_thread: bool = False) -> None:\\n \\\"\\\"\\\"\\n Possibly run a function at a later point in time, either on the async thread or on the main thread.\\n\\n :param f: The function to possibly run\\n :param timeout_ms: The time in milliseconds after which to possibly to run the function\\n :param condition: The condition that must evaluate to True in order to run the funtion\\n :param async_thread: If true, run the function on the async worker thread, otherwise run\\n the function on the main thread\\n \\\"\\\"\\\"\\n\\n def run(debounce_id: int) -> None:\\n with self._current_id_lock:\\n if debounce_id != self._current_id:\\n return\\n if condition():\\n f()\\n\\n runner = sublime.set_timeout_async if async_thread else sublime.set_timeout\\n with self._current_id_lock:\\n current_id = self._current_id = self._next_id\\n self._next_id += 1\\n runner(lambda: run(current_id), timeout_ms)\\n\\n def cancel_pending(self) -> None:\\n with self._current_id_lock:\\n self._current_id = -1\\n\\n\\ndef read_dict_setting(settings_obj: sublime.Settings, key: str, default: dict) -> dict:\\n val = settings_obj.get(key)\\n return val if isinstance(val, dict) else default\\n\\n\\ndef read_list_setting(settings_obj: sublime.Settings, key: str, default: list) -> list:\\n val = settings_obj.get(key)\\n return val if isinstance(val, list) else default\\n\\n\\nclass Settings:\\n\\n # This is only for mypy\\n code_action_on_save_timeout_ms = None # type: int\\n diagnostics_additional_delay_auto_complete_ms = None # type: int\\n diagnostics_delay_ms = None # type: int\\n diagnostics_gutter_marker = None # type: str\\n diagnostics_highlight_style = None # type: str\\n diagnostics_panel_include_severity_level = None # type: int\\n disabled_capabilities = None # type: List[str]\\n document_highlight_style = None # type: str\\n inhibit_snippet_completions = None # type: bool\\n inhibit_word_completions = None # type: bool\\n log_debug = None # type: bool\\n log_max_size = None # type: int\\n log_server = None # type: List[str]\\n lsp_code_actions_on_save = None # type: Dict[str, bool]\\n lsp_format_on_save = None # type: bool\\n only_show_lsp_completions = None # type: bool\\n popup_max_characters_height = None # type: int\\n popup_max_characters_width = None # type: int\\n show_code_actions = None # type: bool\\n show_diagnostics_count_in_view_status = None # type: bool\\n show_diagnostics_in_view_status = None # type: bool\\n show_diagnostics_panel_on_save = None # type: int\\n show_diagnostics_severity_level = None # type: int\\n show_references_in_quick_panel = None # type: bool\\n show_symbol_action_links = None # type: bool\\n show_view_status = None # type: bool\\n\\n def __init__(self, s: sublime.Settings) -> None:\\n self.update(s)\\n\\n def update(self, s: sublime.Settings) -> None:\\n\\n def r(name: str, default: Union[bool, int, str, list, dict]) -> None:\\n val = s.get(name)\\n setattr(self, name, val if isinstance(val, default.__class__) else default)\\n\\n r(\\\"code_action_on_save_timeout_ms\\\", 2000)\\n r(\\\"diagnostics_additional_delay_auto_complete_ms\\\", 0)\\n r(\\\"diagnostics_delay_ms\\\", 0)\\n r(\\\"diagnostics_gutter_marker\\\", \\\"dot\\\")\\n r(\\\"diagnostics_highlight_style\\\", \\\"underline\\\")\\n r(\\\"diagnostics_panel_include_severity_level\\\", 4)\\n r(\\\"disabled_capabilities\\\", [])\\n r(\\\"document_highlight_style\\\", \\\"stippled\\\")\\n r(\\\"log_debug\\\", False)\\n r(\\\"log_max_size\\\", 8 * 1024)\\n r(\\\"lsp_code_actions_on_save\\\", {})\\n r(\\\"lsp_format_on_save\\\", False)\\n r(\\\"only_show_lsp_completions\\\", False)\\n r(\\\"popup_max_characters_height\\\", 1000)\\n r(\\\"popup_max_characters_width\\\", 120)\\n r(\\\"show_code_actions\\\", \\\"annotation\\\")\\n r(\\\"show_diagnostics_count_in_view_status\\\", False)\\n r(\\\"show_diagnostics_in_view_status\\\", True)\\n r(\\\"show_diagnostics_panel_on_save\\\", 2)\\n r(\\\"show_diagnostics_severity_level\\\", 2)\\n r(\\\"show_references_in_quick_panel\\\", False)\\n r(\\\"show_symbol_action_links\\\", False)\\n r(\\\"show_view_status\\\", True)\\n\\n # Backwards-compatible with the bool setting\\n log_server = s.get(\\\"log_server\\\")\\n if isinstance(log_server, bool):\\n self.log_server = [\\\"panel\\\"] if log_server else []\\n elif isinstance(log_server, list):\\n self.log_server = log_server\\n else:\\n self.log_server = []\\n\\n # Backwards-compatible with the bool setting\\n auto_show_diagnostics_panel = s.get(\\\"auto_show_diagnostics_panel\\\")\\n if isinstance(auto_show_diagnostics_panel, bool):\\n if not auto_show_diagnostics_panel:\\n self.show_diagnostics_panel_on_save = 0\\n elif isinstance(auto_show_diagnostics_panel, str):\\n if auto_show_diagnostics_panel == \\\"never\\\":\\n self.show_diagnostics_panel_on_save = 0\\n\\n # Backwards-compatible with \\\"only_show_lsp_completions\\\"\\n only_show_lsp_completions = s.get(\\\"only_show_lsp_completions\\\")\\n if isinstance(only_show_lsp_completions, bool):\\n self.inhibit_snippet_completions = only_show_lsp_completions\\n self.inhibit_word_completions = only_show_lsp_completions\\n else:\\n r(\\\"inhibit_snippet_completions\\\", False)\\n r(\\\"inhibit_word_completions\\\", True)\\n\\n set_debug_logging(self.log_debug)\\n\\n def document_highlight_style_to_add_regions_flags(self) -> int:\\n return _settings_style_to_add_regions_flag(self.document_highlight_style)\\n\\n def diagnostics_highlight_style_to_add_regions_flag(self) -> int:\\n return _settings_style_to_add_regions_flag(self.diagnostics_highlight_style)\\n\\n\\nclass ClientStates:\\n STARTING = 0\\n READY = 1\\n STOPPING = 2\\n\\n\\nclass DocumentFilter:\\n \\\"\\\"\\\"\\n A document filter denotes a document through properties like language, scheme or pattern. An example is a filter\\n that applies to TypeScript files on disk. Another example is a filter that applies to JSON files with name\\n package.json:\\n\\n { \\\"language\\\": \\\"typescript\\\", scheme: \\\"file\\\" }\\n { \\\"language\\\": \\\"json\\\", \\\"pattern\\\": \\\"**/package.json\\\" }\\n\\n Sublime Text doesn't understand what a language ID is, so we have to maintain a global translation map from language\\n IDs to selectors. Sublime Text also has no support for patterns. We use the wcmatch library for this.\\n \\\"\\\"\\\"\\n\\n __slots__ = (\\\"language\\\", \\\"scheme\\\", \\\"pattern\\\")\\n\\n def __init__(\\n self,\\n language: Optional[str] = None,\\n scheme: Optional[str] = None,\\n pattern: Optional[str] = None\\n ) -> None:\\n self.scheme = scheme\\n self.pattern = pattern\\n self.language = language\\n\\n def __call__(self, view: sublime.View) -> bool:\\n \\\"\\\"\\\"Does this filter match the view? An empty filter matches any view.\\\"\\\"\\\"\\n if self.language:\\n syntax = view.syntax()\\n if not syntax or basescope2languageid(syntax.scope) != self.language:\\n return False\\n if self.scheme:\\n # Can be \\\"file\\\" or \\\"untitled\\\"?\\n pass\\n if self.pattern:\\n if not globmatch(view.file_name() or \\\"\\\", self.pattern, flags=GLOBSTAR | BRACE):\\n return False\\n return True\\n\\n\\nclass DocumentSelector:\\n \\\"\\\"\\\"\\n A DocumentSelector is a list of DocumentFilters. A view matches a DocumentSelector if and only if any one of its\\n filters matches against the view.\\n \\\"\\\"\\\"\\n\\n __slots__ = (\\\"filters\\\",)\\n\\n def __init__(self, document_selector: List[Dict[str, Any]]) -> None:\\n self.filters = [DocumentFilter(**document_filter) for document_filter in document_selector]\\n\\n def __bool__(self) -> bool:\\n return bool(self.filters)\\n\\n def matches(self, view: sublime.View) -> bool:\\n \\\"\\\"\\\"Does this selector match the view? A selector with no filters matches all views.\\\"\\\"\\\"\\n return any(f(view) for f in self.filters) if self.filters else True\\n\\n\\n# method -> (capability dotted path, optional registration dotted path)\\n# these are the EXCEPTIONS. The general rule is: method foo/bar --> (barProvider, barProvider.id)\\n_METHOD_TO_CAPABILITY_EXCEPTIONS = {\\n 'workspace/symbol': ('workspaceSymbolProvider', None),\\n 'workspace/didChangeWorkspaceFolders': ('workspace.workspaceFolders',\\n 'workspace.workspaceFolders.changeNotifications'),\\n 'textDocument/didOpen': ('textDocumentSync.didOpen', None),\\n 'textDocument/didClose': ('textDocumentSync.didClose', None),\\n 'textDocument/didChange': ('textDocumentSync.change', None),\\n 'textDocument/didSave': ('textDocumentSync.save', None),\\n 'textDocument/willSave': ('textDocumentSync.willSave', None),\\n 'textDocument/willSaveWaitUntil': ('textDocumentSync.willSaveWaitUntil', None),\\n 'textDocument/formatting': ('documentFormattingProvider', None),\\n 'textDocument/documentColor': ('colorProvider', None)\\n} # type: Dict[str, Tuple[str, Optional[str]]]\\n\\n\\ndef method_to_capability(method: str) -> Tuple[str, str]:\\n \\\"\\\"\\\"\\n Given a method, returns the corresponding capability path, and the associated path to stash the registration key.\\n\\n Examples:\\n\\n textDocument/definition --> (definitionProvider, definitionProvider.id)\\n textDocument/references --> (referencesProvider, referencesProvider.id)\\n textDocument/didOpen --> (textDocumentSync.didOpen, textDocumentSync.didOpen.id)\\n \\\"\\\"\\\"\\n capability_path, registration_path = _METHOD_TO_CAPABILITY_EXCEPTIONS.get(method, (None, None))\\n if capability_path is None:\\n capability_path = method.split('/')[1] + \\\"Provider\\\"\\n if registration_path is None:\\n # This path happens to coincide with the StaticRegistrationOptions' id, which is on purpose. As a consequence,\\n # if a server made a \\\"registration\\\" via the initialize response, it can call client/unregisterCapability at\\n # a later date, and the capability will pop from the capabilities dict.\\n registration_path = capability_path + \\\".id\\\"\\n return capability_path, registration_path\\n\\n\\ndef normalize_text_sync(textsync: Union[None, int, Dict[str, Any]]) -> Dict[str, Any]:\\n \\\"\\\"\\\"\\n Brings legacy text sync capabilities to the most modern format\\n \\\"\\\"\\\"\\n result = {} # type: Dict[str, Any]\\n if isinstance(textsync, int):\\n change = {\\\"syncKind\\\": textsync} # type: Optional[Dict[str, Any]]\\n result[\\\"textDocumentSync\\\"] = {\\\"didOpen\\\": {}, \\\"save\\\": {}, \\\"didClose\\\": {}, \\\"change\\\": change}\\n elif isinstance(textsync, dict):\\n new = {}\\n change = textsync.get(\\\"change\\\")\\n if isinstance(change, int):\\n new[\\\"change\\\"] = {\\\"syncKind\\\": change}\\n elif isinstance(change, dict):\\n new[\\\"change\\\"] = change\\n\\n def maybe_assign_bool_or_dict(key: str) -> None:\\n assert isinstance(textsync, dict)\\n value = textsync.get(key)\\n if isinstance(value, bool) and value:\\n new[key] = {}\\n elif isinstance(value, dict):\\n new[key] = value\\n\\n open_close = textsync.get(\\\"openClose\\\")\\n if isinstance(open_close, bool):\\n if open_close:\\n new[\\\"didOpen\\\"] = {}\\n new[\\\"didClose\\\"] = {}\\n else:\\n maybe_assign_bool_or_dict(\\\"didOpen\\\")\\n maybe_assign_bool_or_dict(\\\"didClose\\\")\\n maybe_assign_bool_or_dict(\\\"willSave\\\")\\n maybe_assign_bool_or_dict(\\\"willSaveWaitUntil\\\")\\n maybe_assign_bool_or_dict(\\\"save\\\")\\n result[\\\"textDocumentSync\\\"] = new\\n return result\\n\\n\\nclass Capabilities(DottedDict):\\n \\\"\\\"\\\"\\n Maintains static and dynamic capabilities\\n\\n Static capabilities come from a response to the initialize request (from Client -> Server).\\n Dynamic capabilities can be registered at any moment with client/registerCapability and client/unregisterCapability\\n (from Server -> Client).\\n \\\"\\\"\\\"\\n\\n def register(\\n self,\\n registration_id: str,\\n capability_path: str,\\n registration_path: str,\\n options: Dict[str, Any]\\n ) -> None:\\n stored_registration_id = self.get(registration_path)\\n if isinstance(stored_registration_id, str):\\n msg = \\\"{} is already registered at {} with ID {}, overwriting\\\"\\n debug(msg.format(capability_path, registration_path, stored_registration_id))\\n self.set(capability_path, options)\\n self.set(registration_path, registration_id)\\n\\n def unregister(\\n self,\\n registration_id: str,\\n capability_path: str,\\n registration_path: str\\n ) -> Optional[Dict[str, Any]]:\\n stored_registration_id = self.get(registration_path)\\n if not isinstance(stored_registration_id, str):\\n debug(\\\"stored registration ID at\\\", registration_path, \\\"is not a string\\\")\\n return None\\n elif stored_registration_id != registration_id:\\n msg = \\\"stored registration ID ({}) is not the same as the provided registration ID ({})\\\"\\n debug(msg.format(stored_registration_id, registration_id))\\n return None\\n else:\\n discarded = self.get(capability_path)\\n self.remove(capability_path)\\n self.remove(registration_path)\\n return discarded\\n\\n def assign(self, d: Dict[str, Any]) -> None:\\n textsync = normalize_text_sync(d.pop(\\\"textDocumentSync\\\", None))\\n super().assign(d)\\n if textsync:\\n self.update(textsync)\\n\\n def should_notify_did_open(self) -> bool:\\n return \\\"textDocumentSync.didOpen\\\" in self\\n\\n def text_sync_kind(self) -> int:\\n value = self.get(\\\"textDocumentSync.change.syncKind\\\")\\n return value if isinstance(value, int) else TextDocumentSyncKindNone\\n\\n def should_notify_did_change_workspace_folders(self) -> bool:\\n return \\\"workspace.workspaceFolders.changeNotifications\\\" in self\\n\\n def should_notify_will_save(self) -> bool:\\n return \\\"textDocumentSync.willSave\\\" in self\\n\\n def should_notify_did_save(self) -> Tuple[bool, bool]:\\n save = self.get(\\\"textDocumentSync.save\\\")\\n if isinstance(save, bool):\\n return save, False\\n elif isinstance(save, dict):\\n return True, bool(save.get(\\\"includeText\\\"))\\n else:\\n return False, False\\n\\n def should_notify_did_close(self) -> bool:\\n return \\\"textDocumentSync.didClose\\\" in self\\n\\n\\ndef _translate_path(path: str, source: str, destination: str) -> Tuple[str, bool]:\\n # TODO: Case-insensitive file systems. Maybe this problem needs a much larger refactor. Even Sublime Text doesn't\\n # handle case-insensitive file systems correctly. There are a few other places where case-sensitivity matters, for\\n # example when looking up the correct view for diagnostics, and when finding a view for goto-def.\\n if path.startswith(source) and len(path) > len(source) and path[len(source)] in (\\\"/\\\", \\\"\\\\\\\\\\\"):\\n return path.replace(source, destination, 1), True\\n return path, False\\n\\n\\nclass PathMap:\\n\\n __slots__ = (\\\"_local\\\", \\\"_remote\\\")\\n\\n def __init__(self, local: str, remote: str) -> None:\\n self._local = local\\n self._remote = remote\\n\\n @classmethod\\n def parse(cls, json: Any) -> \\\"Optional[List[PathMap]]\\\":\\n if not isinstance(json, list):\\n return None\\n result = [] # type: List[PathMap]\\n for path_map in json:\\n if not isinstance(path_map, dict):\\n debug('path map entry is not an object')\\n continue\\n local = path_map.get(\\\"local\\\")\\n if not isinstance(local, str):\\n debug('missing \\\"local\\\" key for path map entry')\\n continue\\n remote = path_map.get(\\\"remote\\\")\\n if not isinstance(remote, str):\\n debug('missing \\\"remote\\\" key for path map entry')\\n continue\\n result.append(PathMap(local, remote))\\n return result\\n\\n def __eq__(self, other: Any) -> bool:\\n if not isinstance(other, PathMap):\\n return False\\n return self._local == other._local and self._remote == other._remote\\n\\n def map_from_local_to_remote(self, uri: str) -> Tuple[str, bool]:\\n return _translate_path(uri, self._local, self._remote)\\n\\n def map_from_remote_to_local(self, uri: str) -> Tuple[str, bool]:\\n return _translate_path(uri, self._remote, self._local)\\n\\n\\nclass TransportConfig:\\n __slots__ = (\\\"name\\\", \\\"command\\\", \\\"tcp_port\\\", \\\"env\\\", \\\"listener_socket\\\")\\n\\n def __init__(\\n self,\\n name: str,\\n command: List[str],\\n tcp_port: Optional[int],\\n env: Dict[str, str],\\n listener_socket: Optional[socket.socket]\\n ) -> None:\\n self.name = name\\n self.command = command\\n self.tcp_port = tcp_port\\n self.env = env\\n self.listener_socket = listener_socket\\n\\n\\nclass ClientConfig:\\n def __init__(self,\\n name: str,\\n selector: str,\\n priority_selector: Optional[str] = None,\\n command: Optional[List[str]] = None,\\n binary_args: Optional[List[str]] = None, # DEPRECATED\\n tcp_port: Optional[int] = None,\\n auto_complete_selector: Optional[str] = None,\\n enabled: bool = True,\\n init_options: DottedDict = DottedDict(),\\n settings: DottedDict = DottedDict(),\\n env: Dict[str, str] = {},\\n experimental_capabilities: Optional[Dict[str, Any]] = None,\\n disabled_capabilities: DottedDict = DottedDict(),\\n path_maps: Optional[List[PathMap]] = None) -> None:\\n self.name = name\\n self.selector = selector\\n self.priority_selector = priority_selector if priority_selector else self.selector\\n if isinstance(command, list):\\n self.command = command\\n else:\\n assert isinstance(binary_args, list)\\n self.command = binary_args\\n self.tcp_port = tcp_port\\n self.auto_complete_selector = auto_complete_selector\\n self.enabled = enabled\\n self.init_options = init_options\\n self.settings = settings\\n self.env = env\\n self.experimental_capabilities = experimental_capabilities\\n self.disabled_capabilities = disabled_capabilities\\n self.path_maps = path_maps\\n self.status_key = \\\"lsp_{}\\\".format(self.name)\\n\\n @classmethod\\n def from_sublime_settings(cls, name: str, s: sublime.Settings, file: str) -> \\\"ClientConfig\\\":\\n base = sublime.decode_value(sublime.load_resource(file))\\n settings = DottedDict(base.get(\\\"settings\\\", {})) # defined by the plugin author\\n settings.update(read_dict_setting(s, \\\"settings\\\", {})) # overrides from the user\\n init_options = DottedDict(base.get(\\\"initializationOptions\\\", {}))\\n init_options.update(read_dict_setting(s, \\\"initializationOptions\\\", {}))\\n disabled_capabilities = s.get(\\\"disabled_capabilities\\\")\\n if isinstance(disabled_capabilities, dict):\\n disabled_capabilities = DottedDict(disabled_capabilities)\\n else:\\n disabled_capabilities = DottedDict()\\n return ClientConfig(\\n name=name,\\n selector=_read_selector(s),\\n priority_selector=_read_priority_selector(s),\\n command=read_list_setting(s, \\\"command\\\", []),\\n tcp_port=s.get(\\\"tcp_port\\\"),\\n auto_complete_selector=s.get(\\\"auto_complete_selector\\\"),\\n # Default to True, because an LSP plugin is enabled iff it is enabled as a Sublime package.\\n enabled=bool(s.get(\\\"enabled\\\", True)),\\n init_options=init_options,\\n settings=settings,\\n env=read_dict_setting(s, \\\"env\\\", {}),\\n experimental_capabilities=s.get(\\\"experimental_capabilities\\\"),\\n disabled_capabilities=disabled_capabilities,\\n path_maps=PathMap.parse(s.get(\\\"path_maps\\\"))\\n )\\n\\n @classmethod\\n def from_dict(cls, name: str, d: Dict[str, Any]) -> \\\"ClientConfig\\\":\\n disabled_capabilities = d.get(\\\"disabled_capabilities\\\")\\n if isinstance(disabled_capabilities, dict):\\n disabled_capabilities = DottedDict(disabled_capabilities)\\n else:\\n disabled_capabilities = DottedDict()\\n return ClientConfig(\\n name=name,\\n selector=_read_selector(d),\\n priority_selector=_read_priority_selector(d),\\n command=d.get(\\\"command\\\", []),\\n tcp_port=d.get(\\\"tcp_port\\\"),\\n auto_complete_selector=d.get(\\\"auto_complete_selector\\\"),\\n enabled=d.get(\\\"enabled\\\", False),\\n init_options=DottedDict(d.get(\\\"initializationOptions\\\")),\\n settings=DottedDict(d.get(\\\"settings\\\")),\\n env=d.get(\\\"env\\\", dict()),\\n experimental_capabilities=d.get(\\\"experimental_capabilities\\\"),\\n disabled_capabilities=disabled_capabilities,\\n path_maps=PathMap.parse(d.get(\\\"path_maps\\\"))\\n )\\n\\n @classmethod\\n def from_config(cls, src_config: \\\"ClientConfig\\\", override: Dict[str, Any]) -> \\\"ClientConfig\\\":\\n path_map_override = PathMap.parse(override.get(\\\"path_maps\\\"))\\n disabled_capabilities = override.get(\\\"disabled_capabilities\\\")\\n if isinstance(disabled_capabilities, dict):\\n disabled_capabilities = DottedDict(disabled_capabilities)\\n else:\\n disabled_capabilities = src_config.disabled_capabilities\\n return ClientConfig(\\n name=src_config.name,\\n selector=_read_selector(override) or src_config.selector,\\n priority_selector=_read_priority_selector(override) or src_config.priority_selector,\\n command=override.get(\\\"command\\\", src_config.command),\\n tcp_port=override.get(\\\"tcp_port\\\", src_config.tcp_port),\\n auto_complete_selector=override.get(\\\"auto_complete_selector\\\", src_config.auto_complete_selector),\\n enabled=override.get(\\\"enabled\\\", src_config.enabled),\\n init_options=DottedDict.from_base_and_override(\\n src_config.init_options, override.get(\\\"initializationOptions\\\")),\\n settings=DottedDict.from_base_and_override(src_config.settings, override.get(\\\"settings\\\")),\\n env=override.get(\\\"env\\\", src_config.env),\\n experimental_capabilities=override.get(\\n \\\"experimental_capabilities\\\", src_config.experimental_capabilities),\\n disabled_capabilities=disabled_capabilities,\\n path_maps=path_map_override if path_map_override else src_config.path_maps\\n )\\n\\n def resolve_transport_config(self, variables: Dict[str, str]) -> TransportConfig:\\n tcp_port = None # type: Optional[int]\\n listener_socket = None # type: Optional[socket.socket]\\n if self.tcp_port is not None:\\n # < 0 means we're hosting a TCP server\\n if self.tcp_port < 0:\\n # -1 means pick any free port\\n if self.tcp_port < -1:\\n tcp_port = -self.tcp_port\\n # Create a listener socket for incoming connections\\n listener_socket = _start_tcp_listener(tcp_port)\\n tcp_port = int(listener_socket.getsockname()[1])\\n else:\\n tcp_port = _find_free_port() if self.tcp_port == 0 else self.tcp_port\\n if tcp_port is not None:\\n variables[\\\"port\\\"] = str(tcp_port)\\n command = sublime.expand_variables(self.command, variables)\\n command = [os.path.expanduser(arg) for arg in command]\\n if tcp_port is not None:\\n # DEPRECATED -- replace {port} with $port or ${port} in your client config\\n command = [a.replace('{port}', str(tcp_port)) for a in command]\\n env = os.environ.copy()\\n for var, value in self.env.items():\\n env[var] = sublime.expand_variables(value, variables)\\n return TransportConfig(self.name, command, tcp_port, env, listener_socket)\\n\\n def set_view_status(self, view: sublime.View, message: str) -> None:\\n if sublime.load_settings(\\\"LSP.sublime-settings\\\").get(\\\"show_view_status\\\"):\\n status = \\\"{}: {}\\\".format(self.name, message) if message else self.name\\n view.set_status(self.status_key, status)\\n\\n def erase_view_status(self, view: sublime.View) -> None:\\n view.erase_status(self.status_key)\\n\\n def match_view(self, view: sublime.View) -> bool:\\n syntax = view.syntax()\\n if syntax:\\n # Every part of a x.y.z scope seems to contribute 8.\\n # An empty selector result in a score of 1.\\n # A non-matching non-empty selector results in a score of 0.\\n # We want to match at least one part of an x.y.z, and we don't want to match on empty selectors.\\n return sublime.score_selector(syntax.scope, self.selector) >= 8\\n return False\\n\\n def map_client_path_to_server_uri(self, path: str) -> str:\\n if self.path_maps:\\n for path_map in self.path_maps:\\n path, mapped = path_map.map_from_local_to_remote(path)\\n if mapped:\\n break\\n return filename_to_uri(path)\\n\\n def map_server_uri_to_client_path(self, uri: str) -> str:\\n path = uri_to_filename(uri)\\n if self.path_maps:\\n for path_map in self.path_maps:\\n path, mapped = path_map.map_from_remote_to_local(path)\\n if mapped:\\n break\\n return path\\n\\n def is_disabled_capability(self, capability_path: str) -> bool:\\n for value in self.disabled_capabilities.walk(capability_path):\\n if isinstance(value, bool):\\n return value\\n elif isinstance(value, dict):\\n if value:\\n # If it's not empty we'll continue the walk\\n continue\\n else:\\n # This might be a leaf node\\n return True\\n return False\\n\\n def filter_out_disabled_capabilities(self, capability_path: str, options: Dict[str, Any]) -> Dict[str, Any]:\\n result = {} # type: Dict[str, Any]\\n for k, v in options.items():\\n if not self.is_disabled_capability(\\\"{}.{}\\\".format(capability_path, k)):\\n result[k] = v\\n return result\\n\\n def __repr__(self) -> str:\\n items = [] # type: List[str]\\n for k, v in self.__dict__.items():\\n if not k.startswith(\\\"_\\\"):\\n items.append(\\\"{}={}\\\".format(k, repr(v)))\\n return \\\"{}({})\\\".format(self.__class__.__name__, \\\", \\\".join(items))\\n\\n def __eq__(self, other: Any) -> bool:\\n if not isinstance(other, ClientConfig):\\n return False\\n for k, v in self.__dict__.items():\\n if not k.startswith(\\\"_\\\") and v != getattr(other, k):\\n return False\\n return True\\n\\n\\ndef syntax2scope(syntax_path: str) -> Optional[str]:\\n syntax = sublime.syntax_from_path(syntax_path)\\n return syntax.scope if syntax else None\\n\\n\\ndef view2scope(view: sublime.View) -> str:\\n try:\\n return view.scope_name(0).split()[0]\\n except IndexError:\\n return ''\\n\\n\\ndef _read_selector(config: Union[sublime.Settings, Dict[str, Any]]) -> str:\\n # Best base scenario,\\n selector = config.get(\\\"selector\\\")\\n if isinstance(selector, str):\\n return selector\\n # Otherwise, look for \\\"languages\\\": [...]\\n languages = config.get(\\\"languages\\\")\\n if isinstance(languages, list):\\n selectors = []\\n for language in languages:\\n # First priority is document_selector,\\n document_selector = language.get(\\\"document_selector\\\")\\n if isinstance(document_selector, str):\\n selectors.append(document_selector)\\n continue\\n # After that syntaxes has priority,\\n syntaxes = language.get(\\\"syntaxes\\\")\\n if isinstance(syntaxes, list):\\n for path in syntaxes:\\n syntax = sublime.syntax_from_path(path)\\n if syntax:\\n selectors.append(syntax.scope)\\n continue\\n # No syntaxes and no document_selector... then there must exist a languageId.\\n language_id = language.get(\\\"languageId\\\")\\n if isinstance(language_id, str):\\n selectors.append(\\\"source.{}\\\".format(language_id))\\n return \\\"|\\\".join(map(\\\"({})\\\".format, selectors))\\n # Otherwise, look for \\\"document_selector\\\"\\n document_selector = config.get(\\\"document_selector\\\")\\n if isinstance(document_selector, str):\\n return document_selector\\n # Otherwise, look for \\\"syntaxes\\\": [...]\\n syntaxes = config.get(\\\"syntaxes\\\")\\n if isinstance(syntaxes, list):\\n selectors = []\\n for path in syntaxes:\\n syntax = sublime.syntax_from_path(path)\\n if syntax:\\n selectors.append(syntax.scope)\\n return \\\"|\\\".join(selectors)\\n # No syntaxes and no document_selector... then there must exist a languageId.\\n language_id = config.get(\\\"languageId\\\")\\n if language_id:\\n return \\\"source.{}\\\".format(language_id)\\n return \\\"\\\"\\n\\n\\ndef _read_priority_selector(config: Union[sublime.Settings, Dict[str, Any]]) -> str:\\n # Best case scenario\\n selector = config.get(\\\"priority_selector\\\")\\n if isinstance(selector, str):\\n return selector\\n # Otherwise, look for \\\"languages\\\": [...]\\n languages = config.get(\\\"languages\\\")\\n if isinstance(languages, list):\\n selectors = []\\n for language in languages:\\n # First priority is feature_selector.\\n feature_selector = language.get(\\\"feature_selector\\\")\\n if isinstance(feature_selector, str):\\n selectors.append(feature_selector)\\n continue\\n # After that scopes has priority.\\n scopes = language.get(\\\"scopes\\\")\\n if isinstance(scopes, list):\\n selectors.extend(scopes)\\n continue\\n # No scopes and no feature_selector. So there must be a languageId\\n language_id = language.get(\\\"languageId\\\")\\n if isinstance(language_id, str):\\n selectors.append(\\\"source.{}\\\".format(language_id))\\n return \\\"|\\\".join(map(\\\"({})\\\".format, selectors))\\n # Otherwise, look for \\\"feature_selector\\\"\\n feature_selector = config.get(\\\"feature_selector\\\")\\n if isinstance(feature_selector, str):\\n return feature_selector\\n # Otherwise, look for \\\"scopes\\\": [...]\\n scopes = config.get(\\\"scopes\\\")\\n if isinstance(scopes, list):\\n return \\\"|\\\".join(map(\\\"({})\\\".format, scopes))\\n # No scopes and no feature_selector... then there must exist a languageId\\n language_id = config.get(\\\"languageId\\\")\\n if language_id:\\n return \\\"source.{}\\\".format(language_id)\\n return \\\"\\\"\\n\\n\\ndef _find_free_port() -> int:\\n with contextlib.closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:\\n s.bind(('', 0))\\n s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)\\n return s.getsockname()[1]\\n\\n\\ndef _start_tcp_listener(tcp_port: Optional[int]) -> socket.socket:\\n sock = socket.socket()\\n sock.bind(('localhost', tcp_port or 0))\\n sock.settimeout(TCP_CONNECT_TIMEOUT)\\n sock.listen(1)\\n return sock\\n\",\n \"path\": \"plugin/core/types.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"from .collections import DottedDict\nfrom .logging import debug, set_debug_logging\nfrom .protocol import TextDocumentSyncKindNone\nfrom .typing import Any, Optional, List, Dict, Generator, Callable, Iterable, Union, Set, Tuple, TypeVar\nfrom .url import filename_to_uri\nfrom .url import uri_to_filename\nfrom threading import RLock\nfrom wcmatch.glob import BRACE\nfrom wcmatch.glob import globmatch\nfrom wcmatch.glob import GLOBSTAR\nimport contextlib\nimport os\nimport socket\nimport sublime\nimport time\n\nTCP_CONNECT_TIMEOUT = 5 # seconds\nFEATURES_TIMEOUT = 300 # milliseconds\n\nPANEL_FILE_REGEX = r\"^(?!\\s+\\d+:\\d+)(.*)(:)$\"\nPANEL_LINE_REGEX = r\"^\\s+(\\d+):(\\d+)\"\n\n\ndef basescope2languageid(base_scope: str) -> str:\n # This the connection between Language IDs and ST selectors.\n base_scope_map = sublime.load_settings(\"language-ids.sublime-settings\")\n result = base_scope_map.get(base_scope, base_scope.split(\".\")[-1])\n return result if isinstance(result, str) else \"\"\n\n\n@contextlib.contextmanager\ndef runtime(token: str) -> Generator[None, None, None]:\n t = time.time()\n yield\n debug(token, \"running time:\", int((time.time() - t) * 1000000), \"μs\")\n\n\nT = TypeVar(\"T\")\n\n\ndef diff(old: Iterable[T], new: Iterable[T]) -> Tuple[Set[T], Set[T]]:\n \"\"\"\n Return a tuple of (added, removed) items\n \"\"\"\n old_set = old if isinstance(old, set) else set(old)\n new_set = new if isinstance(new, set) else set(new)\n added = new_set - old_set\n removed = old_set - new_set\n return added, removed\n\n\ndef debounced(f: Callable[[], Any], timeout_ms: int = 0, condition: Callable[[], bool] = lambda: True,\n async_thread: bool = False) -> None:\n \"\"\"\n Possibly run a function at a later point in time, either on the async thread or on the main thread.\n\n :param f: The function to possibly run. Its return type is discarded.\n :param timeout_ms: The time in milliseconds after which to possibly to run the function\n :param condition: The condition that must evaluate to True in order to run the funtion\n :param async_thread: If true, run the function on the async worker thread, otherwise run the function on the\n main thread\n \"\"\"\n\n def run() -> None:\n if condition():\n f()\n\n runner = sublime.set_timeout_async if async_thread else sublime.set_timeout\n runner(run, timeout_ms)\n\n\ndef _settings_style_to_add_regions_flag(style: str) -> int:\n flags = 0\n if style == \"fill\":\n flags = sublime.DRAW_NO_OUTLINE\n elif style == \"box\":\n flags = sublime.DRAW_NO_FILL\n else:\n flags = sublime.DRAW_NO_FILL | sublime.DRAW_NO_OUTLINE\n if style == \"underline\":\n flags |= sublime.DRAW_SOLID_UNDERLINE\n elif style == \"stippled\":\n flags |= sublime.DRAW_STIPPLED_UNDERLINE\n elif style == \"squiggly\":\n flags |= sublime.DRAW_SQUIGGLY_UNDERLINE\n return flags\n\n\nclass SettingsRegistration:\n __slots__ = (\"_settings\",)\n\n def __init__(self, settings: sublime.Settings, on_change: Callable[[], None]) -> None:\n self._settings = settings\n settings.add_on_change(\"LSP\", on_change)\n\n def __del__(self) -> None:\n self._settings.clear_on_change(\"LSP\")\n\n\nclass Debouncer:\n\n def __init__(self) -> None:\n self._current_id = -1\n self._next_id = 0\n self._current_id_lock = RLock()\n\n def debounce(self, f: Callable[[], None], timeout_ms: int = 0, condition: Callable[[], bool] = lambda: True,\n async_thread: bool = False) -> None:\n \"\"\"\n Possibly run a function at a later point in time, either on the async thread or on the main thread.\n\n :param f: The function to possibly run\n :param timeout_ms: The time in milliseconds after which to possibly to run the function\n :param condition: The condition that must evaluate to True in order to run the funtion\n :param async_thread: If true, run the function on the async worker thread, otherwise run\n the function on the main thread\n \"\"\"\n\n def run(debounce_id: int) -> None:\n with self._current_id_lock:\n if debounce_id != self._current_id:\n return\n if condition():\n f()\n\n runner = sublime.set_timeout_async if async_thread else sublime.set_timeout\n with self._current_id_lock:\n current_id = self._current_id = self._next_id\n self._next_id += 1\n runner(lambda: run(current_id), timeout_ms)\n\n def cancel_pending(self) -> None:\n with self._current_id_lock:\n self._current_id = -1\n\n\ndef read_dict_setting(settings_obj: sublime.Settings, key: str, default: dict) -> dict:\n val = settings_obj.get(key)\n return val if isinstance(val, dict) else default\n\n\ndef read_list_setting(settings_obj: sublime.Settings, key: str, default: list) -> list:\n val = settings_obj.get(key)\n return val if isinstance(val, list) else default\n\n\nclass Settings:\n\n # This is only for mypy\n code_action_on_save_timeout_ms = None # type: int\n diagnostics_additional_delay_auto_complete_ms = None # type: int\n diagnostics_delay_ms = None # type: int\n diagnostics_gutter_marker = None # type: str\n diagnostics_highlight_style = None # type: str\n diagnostics_panel_include_severity_level = None # type: int\n disabled_capabilities = None # type: List[str]\n document_highlight_style = None # type: str\n inhibit_snippet_completions = None # type: bool\n inhibit_word_completions = None # type: bool\n log_debug = None # type: bool\n log_max_size = None # type: int\n log_server = None # type: List[str]\n lsp_code_actions_on_save = None # type: Dict[str, bool]\n lsp_format_on_save = None # type: bool\n only_show_lsp_completions = None # type: bool\n popup_max_characters_height = None # type: int\n popup_max_characters_width = None # type: int\n show_code_actions = None # type: bool\n show_diagnostics_count_in_view_status = None # type: bool\n show_diagnostics_in_view_status = None # type: bool\n show_diagnostics_panel_on_save = None # type: int\n show_diagnostics_severity_level = None # type: int\n show_references_in_quick_panel = None # type: bool\n show_symbol_action_links = None # type: bool\n show_view_status = None # type: bool\n\n def __init__(self, s: sublime.Settings) -> None:\n self.update(s)\n\n def update(self, s: sublime.Settings) -> None:\n\n def r(name: str, default: Union[bool, int, str, list, dict]) -> None:\n val = s.get(name)\n setattr(self, name, val if isinstance(val, default.__class__) else default)\n\n r(\"code_action_on_save_timeout_ms\", 2000)\n r(\"diagnostics_additional_delay_auto_complete_ms\", 0)\n r(\"diagnostics_delay_ms\", 0)\n r(\"diagnostics_gutter_marker\", \"dot\")\n r(\"diagnostics_highlight_style\", \"underline\")\n r(\"diagnostics_panel_include_severity_level\", 4)\n r(\"disabled_capabilities\", [])\n r(\"document_highlight_style\", \"stippled\")\n r(\"log_debug\", False)\n r(\"log_max_size\", 8 * 1024)\n r(\"lsp_code_actions_on_save\", {})\n r(\"lsp_format_on_save\", False)\n r(\"only_show_lsp_completions\", False)\n r(\"popup_max_characters_height\", 1000)\n r(\"popup_max_characters_width\", 120)\n r(\"show_code_actions\", \"annotation\")\n r(\"show_diagnostics_count_in_view_status\", False)\n r(\"show_diagnostics_in_view_status\", True)\n r(\"show_diagnostics_panel_on_save\", 2)\n r(\"show_diagnostics_severity_level\", 2)\n r(\"show_references_in_quick_panel\", False)\n r(\"show_symbol_action_links\", False)\n r(\"show_view_status\", True)\n\n # Backwards-compatible with the bool setting\n log_server = s.get(\"log_server\")\n if isinstance(log_server, bool):\n self.log_server = [\"panel\"] if log_server else []\n elif isinstance(log_server, list):\n self.log_server = log_server\n else:\n self.log_server = []\n\n # Backwards-compatible with the bool setting\n auto_show_diagnostics_panel = s.get(\"auto_show_diagnostics_panel\")\n if isinstance(auto_show_diagnostics_panel, bool):\n if not auto_show_diagnostics_panel:\n self.show_diagnostics_panel_on_save = 0\n elif isinstance(auto_show_diagnostics_panel, str):\n if auto_show_diagnostics_panel == \"never\":\n self.show_diagnostics_panel_on_save = 0\n\n # Backwards-compatible with \"only_show_lsp_completions\"\n only_show_lsp_completions = s.get(\"only_show_lsp_completions\")\n if isinstance(only_show_lsp_completions, bool):\n self.inhibit_snippet_completions = only_show_lsp_completions\n self.inhibit_word_completions = only_show_lsp_completions\n else:\n r(\"inhibit_snippet_completions\", False)\n r(\"inhibit_word_completions\", True)\n\n set_debug_logging(self.log_debug)\n\n def document_highlight_style_to_add_regions_flags(self) -> int:\n return _settings_style_to_add_regions_flag(self.document_highlight_style)\n\n def diagnostics_highlight_style_to_add_regions_flag(self) -> int:\n return _settings_style_to_add_regions_flag(self.diagnostics_highlight_style)\n\n\nclass ClientStates:\n STARTING = 0\n READY = 1\n STOPPING = 2\n\n\nclass DocumentFilter:\n \"\"\"\n A document filter denotes a document through properties like language, scheme or pattern. An example is a filter\n that applies to TypeScript files on disk. Another example is a filter that applies to JSON files with name\n package.json:\n\n { \"language\": \"typescript\", scheme: \"file\" }\n { \"language\": \"json\", \"pattern\": \"**/package.json\" }\n\n Sublime Text doesn't understand what a language ID is, so we have to maintain a global translation map from language\n IDs to selectors. Sublime Text also has no support for patterns. We use the wcmatch library for this.\n \"\"\"\n\n __slots__ = (\"language\", \"scheme\", \"pattern\")\n\n def __init__(\n self,\n language: Optional[str] = None,\n scheme: Optional[str] = None,\n pattern: Optional[str] = None\n ) -> None:\n self.scheme = scheme\n self.pattern = pattern\n self.language = language\n\n def __call__(self, view: sublime.View) -> bool:\n \"\"\"Does this filter match the view? An empty filter matches any view.\"\"\"\n if self.language:\n syntax = view.syntax()\n if not syntax or basescope2languageid(syntax.scope) != self.language:\n return False\n if self.scheme:\n # Can be \"file\" or \"untitled\"?\n pass\n if self.pattern:\n if not globmatch(view.file_name() or \"\", self.pattern, flags=GLOBSTAR | BRACE):\n return False\n return True\n\n\nclass DocumentSelector:\n \"\"\"\n A DocumentSelector is a list of DocumentFilters. A view matches a DocumentSelector if and only if any one of its\n filters matches against the view.\n \"\"\"\n\n __slots__ = (\"filters\",)\n\n def __init__(self, document_selector: List[Dict[str, Any]]) -> None:\n self.filters = [DocumentFilter(**document_filter) for document_filter in document_selector]\n\n def __bool__(self) -> bool:\n return bool(self.filters)\n\n def matches(self, view: sublime.View) -> bool:\n \"\"\"Does this selector match the view? A selector with no filters matches all views.\"\"\"\n return any(f(view) for f in self.filters) if self.filters else True\n\n\n# method -> (capability dotted path, optional registration dotted path)\n# these are the EXCEPTIONS. The general rule is: method foo/bar --> (barProvider, barProvider.id)\n_METHOD_TO_CAPABILITY_EXCEPTIONS = {\n 'workspace/symbol': ('workspaceSymbolProvider', None),\n 'workspace/didChangeWorkspaceFolders': ('workspace.workspaceFolders',\n 'workspace.workspaceFolders.changeNotifications'),\n 'textDocument/didOpen': ('textDocumentSync.didOpen', None),\n 'textDocument/didClose': ('textDocumentSync.didClose', None),\n 'textDocument/didChange': ('textDocumentSync.change', None),\n 'textDocument/didSave': ('textDocumentSync.save', None),\n 'textDocument/willSave': ('textDocumentSync.willSave', None),\n 'textDocument/willSaveWaitUntil': ('textDocumentSync.willSaveWaitUntil', None),\n 'textDocument/formatting': ('documentFormattingProvider', None),\n 'textDocument/documentColor': ('colorProvider', None)\n} # type: Dict[str, Tuple[str, Optional[str]]]\n\n\ndef method_to_capability(method: str) -> Tuple[str, str]:\n \"\"\"\n Given a method, returns the corresponding capability path, and the associated path to stash the registration key.\n\n Examples:\n\n textDocument/definition --> (definitionProvider, definitionProvider.id)\n textDocument/references --> (referencesProvider, referencesProvider.id)\n textDocument/didOpen --> (textDocumentSync.didOpen, textDocumentSync.didOpen.id)\n \"\"\"\n capability_path, registration_path = _METHOD_TO_CAPABILITY_EXCEPTIONS.get(method, (None, None))\n if capability_path is None:\n capability_path = method.split('/')[1] + \"Provider\"\n if registration_path is None:\n # This path happens to coincide with the StaticRegistrationOptions' id, which is on purpose. As a consequence,\n # if a server made a \"registration\" via the initialize response, it can call client/unregisterCapability at\n # a later date, and the capability will pop from the capabilities dict.\n registration_path = capability_path + \".id\"\n return capability_path, registration_path\n\n\ndef normalize_text_sync(textsync: Union[None, int, Dict[str, Any]]) -> Dict[str, Any]:\n \"\"\"\n Brings legacy text sync capabilities to the most modern format\n \"\"\"\n result = {} # type: Dict[str, Any]\n if isinstance(textsync, int):\n change = {\"syncKind\": textsync} # type: Optional[Dict[str, Any]]\n result[\"textDocumentSync\"] = {\"didOpen\": {}, \"save\": {}, \"didClose\": {}, \"change\": change}\n elif isinstance(textsync, dict):\n new = {}\n change = textsync.get(\"change\")\n if isinstance(change, int):\n new[\"change\"] = {\"syncKind\": change}\n elif isinstance(change, dict):\n new[\"change\"] = change\n\n def maybe_assign_bool_or_dict(key: str) -> None:\n assert isinstance(textsync, dict)\n value = textsync.get(key)\n if isinstance(value, bool) and value:\n new[key] = {}\n elif isinstance(value, dict):\n new[key] = value\n\n open_close = textsync.get(\"openClose\")\n if isinstance(open_close, bool):\n if open_close:\n new[\"didOpen\"] = {}\n new[\"didClose\"] = {}\n else:\n maybe_assign_bool_or_dict(\"didOpen\")\n maybe_assign_bool_or_dict(\"didClose\")\n maybe_assign_bool_or_dict(\"willSave\")\n maybe_assign_bool_or_dict(\"willSaveWaitUntil\")\n maybe_assign_bool_or_dict(\"save\")\n result[\"textDocumentSync\"] = new\n return result\n\n\nclass Capabilities(DottedDict):\n \"\"\"\n Maintains static and dynamic capabilities\n\n Static capabilities come from a response to the initialize request (from Client -> Server).\n Dynamic capabilities can be registered at any moment with client/registerCapability and client/unregisterCapability\n (from Server -> Client).\n \"\"\"\n\n def register(\n self,\n registration_id: str,\n capability_path: str,\n registration_path: str,\n options: Dict[str, Any]\n ) -> None:\n stored_registration_id = self.get(registration_path)\n if isinstance(stored_registration_id, str):\n msg = \"{} is already registered at {} with ID {}, overwriting\"\n debug(msg.format(capability_path, registration_path, stored_registration_id))\n self.set(capability_path, options)\n self.set(registration_path, registration_id)\n\n def unregister(\n self,\n registration_id: str,\n capability_path: str,\n registration_path: str\n ) -> Optional[Dict[str, Any]]:\n stored_registration_id = self.get(registration_path)\n if not isinstance(stored_registration_id, str):\n debug(\"stored registration ID at\", registration_path, \"is not a string\")\n return None\n elif stored_registration_id != registration_id:\n msg = \"stored registration ID ({}) is not the same as the provided registration ID ({})\"\n debug(msg.format(stored_registration_id, registration_id))\n return None\n else:\n discarded = self.get(capability_path)\n self.remove(capability_path)\n self.remove(registration_path)\n return discarded\n\n def assign(self, d: Dict[str, Any]) -> None:\n textsync = normalize_text_sync(d.pop(\"textDocumentSync\", None))\n super().assign(d)\n if textsync:\n self.update(textsync)\n\n def should_notify_did_open(self) -> bool:\n return \"textDocumentSync.didOpen\" in self\n\n def text_sync_kind(self) -> int:\n value = self.get(\"textDocumentSync.change.syncKind\")\n return value if isinstance(value, int) else TextDocumentSyncKindNone\n\n def should_notify_did_change_workspace_folders(self) -> bool:\n return \"workspace.workspaceFolders.changeNotifications\" in self\n\n def should_notify_will_save(self) -> bool:\n return \"textDocumentSync.willSave\" in self\n\n def should_notify_did_save(self) -> Tuple[bool, bool]:\n save = self.get(\"textDocumentSync.save\")\n if isinstance(save, bool):\n return save, False\n elif isinstance(save, dict):\n return True, bool(save.get(\"includeText\"))\n else:\n return False, False\n\n def should_notify_did_close(self) -> bool:\n return \"textDocumentSync.didClose\" in self\n\n\ndef _translate_path(path: str, source: str, destination: str) -> Tuple[str, bool]:\n # TODO: Case-insensitive file systems. Maybe this problem needs a much larger refactor. Even Sublime Text doesn't\n # handle case-insensitive file systems correctly. There are a few other places where case-sensitivity matters, for\n # example when looking up the correct view for diagnostics, and when finding a view for goto-def.\n if path.startswith(source) and len(path) > len(source) and path[len(source)] in (\"/\", \"\\\\\"):\n return path.replace(source, destination, 1), True\n return path, False\n\n\nclass PathMap:\n\n __slots__ = (\"_local\", \"_remote\")\n\n def __init__(self, local: str, remote: str) -> None:\n self._local = local\n self._remote = remote\n\n @classmethod\n def parse(cls, json: Any) -> \"Optional[List[PathMap]]\":\n if not isinstance(json, list):\n return None\n result = [] # type: List[PathMap]\n for path_map in json:\n if not isinstance(path_map, dict):\n debug('path map entry is not an object')\n continue\n local = path_map.get(\"local\")\n if not isinstance(local, str):\n debug('missing \"local\" key for path map entry')\n continue\n remote = path_map.get(\"remote\")\n if not isinstance(remote, str):\n debug('missing \"remote\" key for path map entry')\n continue\n result.append(PathMap(local, remote))\n return result\n\n def __eq__(self, other: Any) -> bool:\n if not isinstance(other, PathMap):\n return False\n return self._local == other._local and self._remote == other._remote\n\n def map_from_local_to_remote(self, uri: str) -> Tuple[str, bool]:\n return _translate_path(uri, self._local, self._remote)\n\n def map_from_remote_to_local(self, uri: str) -> Tuple[str, bool]:\n return _translate_path(uri, self._remote, self._local)\n\n\nclass TransportConfig:\n __slots__ = (\"name\", \"command\", \"tcp_port\", \"env\", \"listener_socket\")\n\n def __init__(\n self,\n name: str,\n command: List[str],\n tcp_port: Optional[int],\n env: Dict[str, str],\n listener_socket: Optional[socket.socket]\n ) -> None:\n if not command and not tcp_port:\n raise ValueError('neither \"command\" nor \"tcp_port\" is provided; cannot start a language server')\n self.name = name\n self.command = command\n self.tcp_port = tcp_port\n self.env = env\n self.listener_socket = listener_socket\n\n\nclass ClientConfig:\n def __init__(self,\n name: str,\n selector: str,\n priority_selector: Optional[str] = None,\n command: Optional[List[str]] = None,\n binary_args: Optional[List[str]] = None, # DEPRECATED\n tcp_port: Optional[int] = None,\n auto_complete_selector: Optional[str] = None,\n enabled: bool = True,\n init_options: DottedDict = DottedDict(),\n settings: DottedDict = DottedDict(),\n env: Dict[str, str] = {},\n experimental_capabilities: Optional[Dict[str, Any]] = None,\n disabled_capabilities: DottedDict = DottedDict(),\n path_maps: Optional[List[PathMap]] = None) -> None:\n self.name = name\n self.selector = selector\n self.priority_selector = priority_selector if priority_selector else self.selector\n if isinstance(command, list):\n self.command = command\n else:\n assert isinstance(binary_args, list)\n self.command = binary_args\n self.tcp_port = tcp_port\n self.auto_complete_selector = auto_complete_selector\n self.enabled = enabled\n self.init_options = init_options\n self.settings = settings\n self.env = env\n self.experimental_capabilities = experimental_capabilities\n self.disabled_capabilities = disabled_capabilities\n self.path_maps = path_maps\n self.status_key = \"lsp_{}\".format(self.name)\n\n @classmethod\n def from_sublime_settings(cls, name: str, s: sublime.Settings, file: str) -> \"ClientConfig\":\n base = sublime.decode_value(sublime.load_resource(file))\n settings = DottedDict(base.get(\"settings\", {})) # defined by the plugin author\n settings.update(read_dict_setting(s, \"settings\", {})) # overrides from the user\n init_options = DottedDict(base.get(\"initializationOptions\", {}))\n init_options.update(read_dict_setting(s, \"initializationOptions\", {}))\n disabled_capabilities = s.get(\"disabled_capabilities\")\n if isinstance(disabled_capabilities, dict):\n disabled_capabilities = DottedDict(disabled_capabilities)\n else:\n disabled_capabilities = DottedDict()\n return ClientConfig(\n name=name,\n selector=_read_selector(s),\n priority_selector=_read_priority_selector(s),\n command=read_list_setting(s, \"command\", []),\n tcp_port=s.get(\"tcp_port\"),\n auto_complete_selector=s.get(\"auto_complete_selector\"),\n # Default to True, because an LSP plugin is enabled iff it is enabled as a Sublime package.\n enabled=bool(s.get(\"enabled\", True)),\n init_options=init_options,\n settings=settings,\n env=read_dict_setting(s, \"env\", {}),\n experimental_capabilities=s.get(\"experimental_capabilities\"),\n disabled_capabilities=disabled_capabilities,\n path_maps=PathMap.parse(s.get(\"path_maps\"))\n )\n\n @classmethod\n def from_dict(cls, name: str, d: Dict[str, Any]) -> \"ClientConfig\":\n disabled_capabilities = d.get(\"disabled_capabilities\")\n if isinstance(disabled_capabilities, dict):\n disabled_capabilities = DottedDict(disabled_capabilities)\n else:\n disabled_capabilities = DottedDict()\n return ClientConfig(\n name=name,\n selector=_read_selector(d),\n priority_selector=_read_priority_selector(d),\n command=d.get(\"command\", []),\n tcp_port=d.get(\"tcp_port\"),\n auto_complete_selector=d.get(\"auto_complete_selector\"),\n enabled=d.get(\"enabled\", False),\n init_options=DottedDict(d.get(\"initializationOptions\")),\n settings=DottedDict(d.get(\"settings\")),\n env=d.get(\"env\", dict()),\n experimental_capabilities=d.get(\"experimental_capabilities\"),\n disabled_capabilities=disabled_capabilities,\n path_maps=PathMap.parse(d.get(\"path_maps\"))\n )\n\n @classmethod\n def from_config(cls, src_config: \"ClientConfig\", override: Dict[str, Any]) -> \"ClientConfig\":\n path_map_override = PathMap.parse(override.get(\"path_maps\"))\n disabled_capabilities = override.get(\"disabled_capabilities\")\n if isinstance(disabled_capabilities, dict):\n disabled_capabilities = DottedDict(disabled_capabilities)\n else:\n disabled_capabilities = src_config.disabled_capabilities\n return ClientConfig(\n name=src_config.name,\n selector=_read_selector(override) or src_config.selector,\n priority_selector=_read_priority_selector(override) or src_config.priority_selector,\n command=override.get(\"command\", src_config.command),\n tcp_port=override.get(\"tcp_port\", src_config.tcp_port),\n auto_complete_selector=override.get(\"auto_complete_selector\", src_config.auto_complete_selector),\n enabled=override.get(\"enabled\", src_config.enabled),\n init_options=DottedDict.from_base_and_override(\n src_config.init_options, override.get(\"initializationOptions\")),\n settings=DottedDict.from_base_and_override(src_config.settings, override.get(\"settings\")),\n env=override.get(\"env\", src_config.env),\n experimental_capabilities=override.get(\n \"experimental_capabilities\", src_config.experimental_capabilities),\n disabled_capabilities=disabled_capabilities,\n path_maps=path_map_override if path_map_override else src_config.path_maps\n )\n\n def resolve_transport_config(self, variables: Dict[str, str]) -> TransportConfig:\n tcp_port = None # type: Optional[int]\n listener_socket = None # type: Optional[socket.socket]\n if self.tcp_port is not None:\n # < 0 means we're hosting a TCP server\n if self.tcp_port < 0:\n # -1 means pick any free port\n if self.tcp_port < -1:\n tcp_port = -self.tcp_port\n # Create a listener socket for incoming connections\n listener_socket = _start_tcp_listener(tcp_port)\n tcp_port = int(listener_socket.getsockname()[1])\n else:\n tcp_port = _find_free_port() if self.tcp_port == 0 else self.tcp_port\n if tcp_port is not None:\n variables[\"port\"] = str(tcp_port)\n command = sublime.expand_variables(self.command, variables)\n command = [os.path.expanduser(arg) for arg in command]\n if tcp_port is not None:\n # DEPRECATED -- replace {port} with $port or ${port} in your client config\n command = [a.replace('{port}', str(tcp_port)) for a in command]\n env = os.environ.copy()\n for var, value in self.env.items():\n env[var] = sublime.expand_variables(value, variables)\n return TransportConfig(self.name, command, tcp_port, env, listener_socket)\n\n def set_view_status(self, view: sublime.View, message: str) -> None:\n if sublime.load_settings(\"LSP.sublime-settings\").get(\"show_view_status\"):\n status = \"{}: {}\".format(self.name, message) if message else self.name\n view.set_status(self.status_key, status)\n\n def erase_view_status(self, view: sublime.View) -> None:\n view.erase_status(self.status_key)\n\n def match_view(self, view: sublime.View) -> bool:\n syntax = view.syntax()\n if syntax:\n # Every part of a x.y.z scope seems to contribute 8.\n # An empty selector result in a score of 1.\n # A non-matching non-empty selector results in a score of 0.\n # We want to match at least one part of an x.y.z, and we don't want to match on empty selectors.\n return sublime.score_selector(syntax.scope, self.selector) >= 8\n return False\n\n def map_client_path_to_server_uri(self, path: str) -> str:\n if self.path_maps:\n for path_map in self.path_maps:\n path, mapped = path_map.map_from_local_to_remote(path)\n if mapped:\n break\n return filename_to_uri(path)\n\n def map_server_uri_to_client_path(self, uri: str) -> str:\n path = uri_to_filename(uri)\n if self.path_maps:\n for path_map in self.path_maps:\n path, mapped = path_map.map_from_remote_to_local(path)\n if mapped:\n break\n return path\n\n def is_disabled_capability(self, capability_path: str) -> bool:\n for value in self.disabled_capabilities.walk(capability_path):\n if isinstance(value, bool):\n return value\n elif isinstance(value, dict):\n if value:\n # If it's not empty we'll continue the walk\n continue\n else:\n # This might be a leaf node\n return True\n return False\n\n def filter_out_disabled_capabilities(self, capability_path: str, options: Dict[str, Any]) -> Dict[str, Any]:\n result = {} # type: Dict[str, Any]\n for k, v in options.items():\n if not self.is_disabled_capability(\"{}.{}\".format(capability_path, k)):\n result[k] = v\n return result\n\n def __repr__(self) -> str:\n items = [] # type: List[str]\n for k, v in self.__dict__.items():\n if not k.startswith(\"_\"):\n items.append(\"{}={}\".format(k, repr(v)))\n return \"{}({})\".format(self.__class__.__name__, \", \".join(items))\n\n def __eq__(self, other: Any) -> bool:\n if not isinstance(other, ClientConfig):\n return False\n for k, v in self.__dict__.items():\n if not k.startswith(\"_\") and v != getattr(other, k):\n return False\n return True\n\n\ndef syntax2scope(syntax_path: str) -> Optional[str]:\n syntax = sublime.syntax_from_path(syntax_path)\n return syntax.scope if syntax else None\n\n\ndef view2scope(view: sublime.View) -> str:\n try:\n return view.scope_name(0).split()[0]\n except IndexError:\n return ''\n\n\ndef _read_selector(config: Union[sublime.Settings, Dict[str, Any]]) -> str:\n # Best base scenario,\n selector = config.get(\"selector\")\n if isinstance(selector, str):\n return selector\n # Otherwise, look for \"languages\": [...]\n languages = config.get(\"languages\")\n if isinstance(languages, list):\n selectors = []\n for language in languages:\n # First priority is document_selector,\n document_selector = language.get(\"document_selector\")\n if isinstance(document_selector, str):\n selectors.append(document_selector)\n continue\n # After that syntaxes has priority,\n syntaxes = language.get(\"syntaxes\")\n if isinstance(syntaxes, list):\n for path in syntaxes:\n syntax = sublime.syntax_from_path(path)\n if syntax:\n selectors.append(syntax.scope)\n continue\n # No syntaxes and no document_selector... then there must exist a languageId.\n language_id = language.get(\"languageId\")\n if isinstance(language_id, str):\n selectors.append(\"source.{}\".format(language_id))\n return \"|\".join(map(\"({})\".format, selectors))\n # Otherwise, look for \"document_selector\"\n document_selector = config.get(\"document_selector\")\n if isinstance(document_selector, str):\n return document_selector\n # Otherwise, look for \"syntaxes\": [...]\n syntaxes = config.get(\"syntaxes\")\n if isinstance(syntaxes, list):\n selectors = []\n for path in syntaxes:\n syntax = sublime.syntax_from_path(path)\n if syntax:\n selectors.append(syntax.scope)\n return \"|\".join(selectors)\n # No syntaxes and no document_selector... then there must exist a languageId.\n language_id = config.get(\"languageId\")\n if language_id:\n return \"source.{}\".format(language_id)\n return \"\"\n\n\ndef _read_priority_selector(config: Union[sublime.Settings, Dict[str, Any]]) -> str:\n # Best case scenario\n selector = config.get(\"priority_selector\")\n if isinstance(selector, str):\n return selector\n # Otherwise, look for \"languages\": [...]\n languages = config.get(\"languages\")\n if isinstance(languages, list):\n selectors = []\n for language in languages:\n # First priority is feature_selector.\n feature_selector = language.get(\"feature_selector\")\n if isinstance(feature_selector, str):\n selectors.append(feature_selector)\n continue\n # After that scopes has priority.\n scopes = language.get(\"scopes\")\n if isinstance(scopes, list):\n selectors.extend(scopes)\n continue\n # No scopes and no feature_selector. So there must be a languageId\n language_id = language.get(\"languageId\")\n if isinstance(language_id, str):\n selectors.append(\"source.{}\".format(language_id))\n return \"|\".join(map(\"({})\".format, selectors))\n # Otherwise, look for \"feature_selector\"\n feature_selector = config.get(\"feature_selector\")\n if isinstance(feature_selector, str):\n return feature_selector\n # Otherwise, look for \"scopes\": [...]\n scopes = config.get(\"scopes\")\n if isinstance(scopes, list):\n return \"|\".join(map(\"({})\".format, scopes))\n # No scopes and no feature_selector... then there must exist a languageId\n language_id = config.get(\"languageId\")\n if language_id:\n return \"source.{}\".format(language_id)\n return \"\"\n\n\ndef _find_free_port() -> int:\n with contextlib.closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:\n s.bind(('', 0))\n s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)\n return s.getsockname()[1]\n\n\ndef _start_tcp_listener(tcp_port: Optional[int]) -> socket.socket:\n sock = socket.socket()\n sock.bind(('localhost', tcp_port or 0))\n sock.settimeout(TCP_CONNECT_TIMEOUT)\n sock.listen(1)\n return sock\n","path":"plugin/core/types.py"}],"string":"[\n {\n \"content\": \"from .collections import DottedDict\\nfrom .logging import debug, set_debug_logging\\nfrom .protocol import TextDocumentSyncKindNone\\nfrom .typing import Any, Optional, List, Dict, Generator, Callable, Iterable, Union, Set, Tuple, TypeVar\\nfrom .url import filename_to_uri\\nfrom .url import uri_to_filename\\nfrom threading import RLock\\nfrom wcmatch.glob import BRACE\\nfrom wcmatch.glob import globmatch\\nfrom wcmatch.glob import GLOBSTAR\\nimport contextlib\\nimport os\\nimport socket\\nimport sublime\\nimport time\\n\\nTCP_CONNECT_TIMEOUT = 5 # seconds\\nFEATURES_TIMEOUT = 300 # milliseconds\\n\\nPANEL_FILE_REGEX = r\\\"^(?!\\\\s+\\\\d+:\\\\d+)(.*)(:)$\\\"\\nPANEL_LINE_REGEX = r\\\"^\\\\s+(\\\\d+):(\\\\d+)\\\"\\n\\n\\ndef basescope2languageid(base_scope: str) -> str:\\n # This the connection between Language IDs and ST selectors.\\n base_scope_map = sublime.load_settings(\\\"language-ids.sublime-settings\\\")\\n result = base_scope_map.get(base_scope, base_scope.split(\\\".\\\")[-1])\\n return result if isinstance(result, str) else \\\"\\\"\\n\\n\\n@contextlib.contextmanager\\ndef runtime(token: str) -> Generator[None, None, None]:\\n t = time.time()\\n yield\\n debug(token, \\\"running time:\\\", int((time.time() - t) * 1000000), \\\"μs\\\")\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n\\ndef diff(old: Iterable[T], new: Iterable[T]) -> Tuple[Set[T], Set[T]]:\\n \\\"\\\"\\\"\\n Return a tuple of (added, removed) items\\n \\\"\\\"\\\"\\n old_set = old if isinstance(old, set) else set(old)\\n new_set = new if isinstance(new, set) else set(new)\\n added = new_set - old_set\\n removed = old_set - new_set\\n return added, removed\\n\\n\\ndef debounced(f: Callable[[], Any], timeout_ms: int = 0, condition: Callable[[], bool] = lambda: True,\\n async_thread: bool = False) -> None:\\n \\\"\\\"\\\"\\n Possibly run a function at a later point in time, either on the async thread or on the main thread.\\n\\n :param f: The function to possibly run. Its return type is discarded.\\n :param timeout_ms: The time in milliseconds after which to possibly to run the function\\n :param condition: The condition that must evaluate to True in order to run the funtion\\n :param async_thread: If true, run the function on the async worker thread, otherwise run the function on the\\n main thread\\n \\\"\\\"\\\"\\n\\n def run() -> None:\\n if condition():\\n f()\\n\\n runner = sublime.set_timeout_async if async_thread else sublime.set_timeout\\n runner(run, timeout_ms)\\n\\n\\ndef _settings_style_to_add_regions_flag(style: str) -> int:\\n flags = 0\\n if style == \\\"fill\\\":\\n flags = sublime.DRAW_NO_OUTLINE\\n elif style == \\\"box\\\":\\n flags = sublime.DRAW_NO_FILL\\n else:\\n flags = sublime.DRAW_NO_FILL | sublime.DRAW_NO_OUTLINE\\n if style == \\\"underline\\\":\\n flags |= sublime.DRAW_SOLID_UNDERLINE\\n elif style == \\\"stippled\\\":\\n flags |= sublime.DRAW_STIPPLED_UNDERLINE\\n elif style == \\\"squiggly\\\":\\n flags |= sublime.DRAW_SQUIGGLY_UNDERLINE\\n return flags\\n\\n\\nclass SettingsRegistration:\\n __slots__ = (\\\"_settings\\\",)\\n\\n def __init__(self, settings: sublime.Settings, on_change: Callable[[], None]) -> None:\\n self._settings = settings\\n settings.add_on_change(\\\"LSP\\\", on_change)\\n\\n def __del__(self) -> None:\\n self._settings.clear_on_change(\\\"LSP\\\")\\n\\n\\nclass Debouncer:\\n\\n def __init__(self) -> None:\\n self._current_id = -1\\n self._next_id = 0\\n self._current_id_lock = RLock()\\n\\n def debounce(self, f: Callable[[], None], timeout_ms: int = 0, condition: Callable[[], bool] = lambda: True,\\n async_thread: bool = False) -> None:\\n \\\"\\\"\\\"\\n Possibly run a function at a later point in time, either on the async thread or on the main thread.\\n\\n :param f: The function to possibly run\\n :param timeout_ms: The time in milliseconds after which to possibly to run the function\\n :param condition: The condition that must evaluate to True in order to run the funtion\\n :param async_thread: If true, run the function on the async worker thread, otherwise run\\n the function on the main thread\\n \\\"\\\"\\\"\\n\\n def run(debounce_id: int) -> None:\\n with self._current_id_lock:\\n if debounce_id != self._current_id:\\n return\\n if condition():\\n f()\\n\\n runner = sublime.set_timeout_async if async_thread else sublime.set_timeout\\n with self._current_id_lock:\\n current_id = self._current_id = self._next_id\\n self._next_id += 1\\n runner(lambda: run(current_id), timeout_ms)\\n\\n def cancel_pending(self) -> None:\\n with self._current_id_lock:\\n self._current_id = -1\\n\\n\\ndef read_dict_setting(settings_obj: sublime.Settings, key: str, default: dict) -> dict:\\n val = settings_obj.get(key)\\n return val if isinstance(val, dict) else default\\n\\n\\ndef read_list_setting(settings_obj: sublime.Settings, key: str, default: list) -> list:\\n val = settings_obj.get(key)\\n return val if isinstance(val, list) else default\\n\\n\\nclass Settings:\\n\\n # This is only for mypy\\n code_action_on_save_timeout_ms = None # type: int\\n diagnostics_additional_delay_auto_complete_ms = None # type: int\\n diagnostics_delay_ms = None # type: int\\n diagnostics_gutter_marker = None # type: str\\n diagnostics_highlight_style = None # type: str\\n diagnostics_panel_include_severity_level = None # type: int\\n disabled_capabilities = None # type: List[str]\\n document_highlight_style = None # type: str\\n inhibit_snippet_completions = None # type: bool\\n inhibit_word_completions = None # type: bool\\n log_debug = None # type: bool\\n log_max_size = None # type: int\\n log_server = None # type: List[str]\\n lsp_code_actions_on_save = None # type: Dict[str, bool]\\n lsp_format_on_save = None # type: bool\\n only_show_lsp_completions = None # type: bool\\n popup_max_characters_height = None # type: int\\n popup_max_characters_width = None # type: int\\n show_code_actions = None # type: bool\\n show_diagnostics_count_in_view_status = None # type: bool\\n show_diagnostics_in_view_status = None # type: bool\\n show_diagnostics_panel_on_save = None # type: int\\n show_diagnostics_severity_level = None # type: int\\n show_references_in_quick_panel = None # type: bool\\n show_symbol_action_links = None # type: bool\\n show_view_status = None # type: bool\\n\\n def __init__(self, s: sublime.Settings) -> None:\\n self.update(s)\\n\\n def update(self, s: sublime.Settings) -> None:\\n\\n def r(name: str, default: Union[bool, int, str, list, dict]) -> None:\\n val = s.get(name)\\n setattr(self, name, val if isinstance(val, default.__class__) else default)\\n\\n r(\\\"code_action_on_save_timeout_ms\\\", 2000)\\n r(\\\"diagnostics_additional_delay_auto_complete_ms\\\", 0)\\n r(\\\"diagnostics_delay_ms\\\", 0)\\n r(\\\"diagnostics_gutter_marker\\\", \\\"dot\\\")\\n r(\\\"diagnostics_highlight_style\\\", \\\"underline\\\")\\n r(\\\"diagnostics_panel_include_severity_level\\\", 4)\\n r(\\\"disabled_capabilities\\\", [])\\n r(\\\"document_highlight_style\\\", \\\"stippled\\\")\\n r(\\\"log_debug\\\", False)\\n r(\\\"log_max_size\\\", 8 * 1024)\\n r(\\\"lsp_code_actions_on_save\\\", {})\\n r(\\\"lsp_format_on_save\\\", False)\\n r(\\\"only_show_lsp_completions\\\", False)\\n r(\\\"popup_max_characters_height\\\", 1000)\\n r(\\\"popup_max_characters_width\\\", 120)\\n r(\\\"show_code_actions\\\", \\\"annotation\\\")\\n r(\\\"show_diagnostics_count_in_view_status\\\", False)\\n r(\\\"show_diagnostics_in_view_status\\\", True)\\n r(\\\"show_diagnostics_panel_on_save\\\", 2)\\n r(\\\"show_diagnostics_severity_level\\\", 2)\\n r(\\\"show_references_in_quick_panel\\\", False)\\n r(\\\"show_symbol_action_links\\\", False)\\n r(\\\"show_view_status\\\", True)\\n\\n # Backwards-compatible with the bool setting\\n log_server = s.get(\\\"log_server\\\")\\n if isinstance(log_server, bool):\\n self.log_server = [\\\"panel\\\"] if log_server else []\\n elif isinstance(log_server, list):\\n self.log_server = log_server\\n else:\\n self.log_server = []\\n\\n # Backwards-compatible with the bool setting\\n auto_show_diagnostics_panel = s.get(\\\"auto_show_diagnostics_panel\\\")\\n if isinstance(auto_show_diagnostics_panel, bool):\\n if not auto_show_diagnostics_panel:\\n self.show_diagnostics_panel_on_save = 0\\n elif isinstance(auto_show_diagnostics_panel, str):\\n if auto_show_diagnostics_panel == \\\"never\\\":\\n self.show_diagnostics_panel_on_save = 0\\n\\n # Backwards-compatible with \\\"only_show_lsp_completions\\\"\\n only_show_lsp_completions = s.get(\\\"only_show_lsp_completions\\\")\\n if isinstance(only_show_lsp_completions, bool):\\n self.inhibit_snippet_completions = only_show_lsp_completions\\n self.inhibit_word_completions = only_show_lsp_completions\\n else:\\n r(\\\"inhibit_snippet_completions\\\", False)\\n r(\\\"inhibit_word_completions\\\", True)\\n\\n set_debug_logging(self.log_debug)\\n\\n def document_highlight_style_to_add_regions_flags(self) -> int:\\n return _settings_style_to_add_regions_flag(self.document_highlight_style)\\n\\n def diagnostics_highlight_style_to_add_regions_flag(self) -> int:\\n return _settings_style_to_add_regions_flag(self.diagnostics_highlight_style)\\n\\n\\nclass ClientStates:\\n STARTING = 0\\n READY = 1\\n STOPPING = 2\\n\\n\\nclass DocumentFilter:\\n \\\"\\\"\\\"\\n A document filter denotes a document through properties like language, scheme or pattern. An example is a filter\\n that applies to TypeScript files on disk. Another example is a filter that applies to JSON files with name\\n package.json:\\n\\n { \\\"language\\\": \\\"typescript\\\", scheme: \\\"file\\\" }\\n { \\\"language\\\": \\\"json\\\", \\\"pattern\\\": \\\"**/package.json\\\" }\\n\\n Sublime Text doesn't understand what a language ID is, so we have to maintain a global translation map from language\\n IDs to selectors. Sublime Text also has no support for patterns. We use the wcmatch library for this.\\n \\\"\\\"\\\"\\n\\n __slots__ = (\\\"language\\\", \\\"scheme\\\", \\\"pattern\\\")\\n\\n def __init__(\\n self,\\n language: Optional[str] = None,\\n scheme: Optional[str] = None,\\n pattern: Optional[str] = None\\n ) -> None:\\n self.scheme = scheme\\n self.pattern = pattern\\n self.language = language\\n\\n def __call__(self, view: sublime.View) -> bool:\\n \\\"\\\"\\\"Does this filter match the view? An empty filter matches any view.\\\"\\\"\\\"\\n if self.language:\\n syntax = view.syntax()\\n if not syntax or basescope2languageid(syntax.scope) != self.language:\\n return False\\n if self.scheme:\\n # Can be \\\"file\\\" or \\\"untitled\\\"?\\n pass\\n if self.pattern:\\n if not globmatch(view.file_name() or \\\"\\\", self.pattern, flags=GLOBSTAR | BRACE):\\n return False\\n return True\\n\\n\\nclass DocumentSelector:\\n \\\"\\\"\\\"\\n A DocumentSelector is a list of DocumentFilters. A view matches a DocumentSelector if and only if any one of its\\n filters matches against the view.\\n \\\"\\\"\\\"\\n\\n __slots__ = (\\\"filters\\\",)\\n\\n def __init__(self, document_selector: List[Dict[str, Any]]) -> None:\\n self.filters = [DocumentFilter(**document_filter) for document_filter in document_selector]\\n\\n def __bool__(self) -> bool:\\n return bool(self.filters)\\n\\n def matches(self, view: sublime.View) -> bool:\\n \\\"\\\"\\\"Does this selector match the view? A selector with no filters matches all views.\\\"\\\"\\\"\\n return any(f(view) for f in self.filters) if self.filters else True\\n\\n\\n# method -> (capability dotted path, optional registration dotted path)\\n# these are the EXCEPTIONS. The general rule is: method foo/bar --> (barProvider, barProvider.id)\\n_METHOD_TO_CAPABILITY_EXCEPTIONS = {\\n 'workspace/symbol': ('workspaceSymbolProvider', None),\\n 'workspace/didChangeWorkspaceFolders': ('workspace.workspaceFolders',\\n 'workspace.workspaceFolders.changeNotifications'),\\n 'textDocument/didOpen': ('textDocumentSync.didOpen', None),\\n 'textDocument/didClose': ('textDocumentSync.didClose', None),\\n 'textDocument/didChange': ('textDocumentSync.change', None),\\n 'textDocument/didSave': ('textDocumentSync.save', None),\\n 'textDocument/willSave': ('textDocumentSync.willSave', None),\\n 'textDocument/willSaveWaitUntil': ('textDocumentSync.willSaveWaitUntil', None),\\n 'textDocument/formatting': ('documentFormattingProvider', None),\\n 'textDocument/documentColor': ('colorProvider', None)\\n} # type: Dict[str, Tuple[str, Optional[str]]]\\n\\n\\ndef method_to_capability(method: str) -> Tuple[str, str]:\\n \\\"\\\"\\\"\\n Given a method, returns the corresponding capability path, and the associated path to stash the registration key.\\n\\n Examples:\\n\\n textDocument/definition --> (definitionProvider, definitionProvider.id)\\n textDocument/references --> (referencesProvider, referencesProvider.id)\\n textDocument/didOpen --> (textDocumentSync.didOpen, textDocumentSync.didOpen.id)\\n \\\"\\\"\\\"\\n capability_path, registration_path = _METHOD_TO_CAPABILITY_EXCEPTIONS.get(method, (None, None))\\n if capability_path is None:\\n capability_path = method.split('/')[1] + \\\"Provider\\\"\\n if registration_path is None:\\n # This path happens to coincide with the StaticRegistrationOptions' id, which is on purpose. As a consequence,\\n # if a server made a \\\"registration\\\" via the initialize response, it can call client/unregisterCapability at\\n # a later date, and the capability will pop from the capabilities dict.\\n registration_path = capability_path + \\\".id\\\"\\n return capability_path, registration_path\\n\\n\\ndef normalize_text_sync(textsync: Union[None, int, Dict[str, Any]]) -> Dict[str, Any]:\\n \\\"\\\"\\\"\\n Brings legacy text sync capabilities to the most modern format\\n \\\"\\\"\\\"\\n result = {} # type: Dict[str, Any]\\n if isinstance(textsync, int):\\n change = {\\\"syncKind\\\": textsync} # type: Optional[Dict[str, Any]]\\n result[\\\"textDocumentSync\\\"] = {\\\"didOpen\\\": {}, \\\"save\\\": {}, \\\"didClose\\\": {}, \\\"change\\\": change}\\n elif isinstance(textsync, dict):\\n new = {}\\n change = textsync.get(\\\"change\\\")\\n if isinstance(change, int):\\n new[\\\"change\\\"] = {\\\"syncKind\\\": change}\\n elif isinstance(change, dict):\\n new[\\\"change\\\"] = change\\n\\n def maybe_assign_bool_or_dict(key: str) -> None:\\n assert isinstance(textsync, dict)\\n value = textsync.get(key)\\n if isinstance(value, bool) and value:\\n new[key] = {}\\n elif isinstance(value, dict):\\n new[key] = value\\n\\n open_close = textsync.get(\\\"openClose\\\")\\n if isinstance(open_close, bool):\\n if open_close:\\n new[\\\"didOpen\\\"] = {}\\n new[\\\"didClose\\\"] = {}\\n else:\\n maybe_assign_bool_or_dict(\\\"didOpen\\\")\\n maybe_assign_bool_or_dict(\\\"didClose\\\")\\n maybe_assign_bool_or_dict(\\\"willSave\\\")\\n maybe_assign_bool_or_dict(\\\"willSaveWaitUntil\\\")\\n maybe_assign_bool_or_dict(\\\"save\\\")\\n result[\\\"textDocumentSync\\\"] = new\\n return result\\n\\n\\nclass Capabilities(DottedDict):\\n \\\"\\\"\\\"\\n Maintains static and dynamic capabilities\\n\\n Static capabilities come from a response to the initialize request (from Client -> Server).\\n Dynamic capabilities can be registered at any moment with client/registerCapability and client/unregisterCapability\\n (from Server -> Client).\\n \\\"\\\"\\\"\\n\\n def register(\\n self,\\n registration_id: str,\\n capability_path: str,\\n registration_path: str,\\n options: Dict[str, Any]\\n ) -> None:\\n stored_registration_id = self.get(registration_path)\\n if isinstance(stored_registration_id, str):\\n msg = \\\"{} is already registered at {} with ID {}, overwriting\\\"\\n debug(msg.format(capability_path, registration_path, stored_registration_id))\\n self.set(capability_path, options)\\n self.set(registration_path, registration_id)\\n\\n def unregister(\\n self,\\n registration_id: str,\\n capability_path: str,\\n registration_path: str\\n ) -> Optional[Dict[str, Any]]:\\n stored_registration_id = self.get(registration_path)\\n if not isinstance(stored_registration_id, str):\\n debug(\\\"stored registration ID at\\\", registration_path, \\\"is not a string\\\")\\n return None\\n elif stored_registration_id != registration_id:\\n msg = \\\"stored registration ID ({}) is not the same as the provided registration ID ({})\\\"\\n debug(msg.format(stored_registration_id, registration_id))\\n return None\\n else:\\n discarded = self.get(capability_path)\\n self.remove(capability_path)\\n self.remove(registration_path)\\n return discarded\\n\\n def assign(self, d: Dict[str, Any]) -> None:\\n textsync = normalize_text_sync(d.pop(\\\"textDocumentSync\\\", None))\\n super().assign(d)\\n if textsync:\\n self.update(textsync)\\n\\n def should_notify_did_open(self) -> bool:\\n return \\\"textDocumentSync.didOpen\\\" in self\\n\\n def text_sync_kind(self) -> int:\\n value = self.get(\\\"textDocumentSync.change.syncKind\\\")\\n return value if isinstance(value, int) else TextDocumentSyncKindNone\\n\\n def should_notify_did_change_workspace_folders(self) -> bool:\\n return \\\"workspace.workspaceFolders.changeNotifications\\\" in self\\n\\n def should_notify_will_save(self) -> bool:\\n return \\\"textDocumentSync.willSave\\\" in self\\n\\n def should_notify_did_save(self) -> Tuple[bool, bool]:\\n save = self.get(\\\"textDocumentSync.save\\\")\\n if isinstance(save, bool):\\n return save, False\\n elif isinstance(save, dict):\\n return True, bool(save.get(\\\"includeText\\\"))\\n else:\\n return False, False\\n\\n def should_notify_did_close(self) -> bool:\\n return \\\"textDocumentSync.didClose\\\" in self\\n\\n\\ndef _translate_path(path: str, source: str, destination: str) -> Tuple[str, bool]:\\n # TODO: Case-insensitive file systems. Maybe this problem needs a much larger refactor. Even Sublime Text doesn't\\n # handle case-insensitive file systems correctly. There are a few other places where case-sensitivity matters, for\\n # example when looking up the correct view for diagnostics, and when finding a view for goto-def.\\n if path.startswith(source) and len(path) > len(source) and path[len(source)] in (\\\"/\\\", \\\"\\\\\\\\\\\"):\\n return path.replace(source, destination, 1), True\\n return path, False\\n\\n\\nclass PathMap:\\n\\n __slots__ = (\\\"_local\\\", \\\"_remote\\\")\\n\\n def __init__(self, local: str, remote: str) -> None:\\n self._local = local\\n self._remote = remote\\n\\n @classmethod\\n def parse(cls, json: Any) -> \\\"Optional[List[PathMap]]\\\":\\n if not isinstance(json, list):\\n return None\\n result = [] # type: List[PathMap]\\n for path_map in json:\\n if not isinstance(path_map, dict):\\n debug('path map entry is not an object')\\n continue\\n local = path_map.get(\\\"local\\\")\\n if not isinstance(local, str):\\n debug('missing \\\"local\\\" key for path map entry')\\n continue\\n remote = path_map.get(\\\"remote\\\")\\n if not isinstance(remote, str):\\n debug('missing \\\"remote\\\" key for path map entry')\\n continue\\n result.append(PathMap(local, remote))\\n return result\\n\\n def __eq__(self, other: Any) -> bool:\\n if not isinstance(other, PathMap):\\n return False\\n return self._local == other._local and self._remote == other._remote\\n\\n def map_from_local_to_remote(self, uri: str) -> Tuple[str, bool]:\\n return _translate_path(uri, self._local, self._remote)\\n\\n def map_from_remote_to_local(self, uri: str) -> Tuple[str, bool]:\\n return _translate_path(uri, self._remote, self._local)\\n\\n\\nclass TransportConfig:\\n __slots__ = (\\\"name\\\", \\\"command\\\", \\\"tcp_port\\\", \\\"env\\\", \\\"listener_socket\\\")\\n\\n def __init__(\\n self,\\n name: str,\\n command: List[str],\\n tcp_port: Optional[int],\\n env: Dict[str, str],\\n listener_socket: Optional[socket.socket]\\n ) -> None:\\n if not command and not tcp_port:\\n raise ValueError('neither \\\"command\\\" nor \\\"tcp_port\\\" is provided; cannot start a language server')\\n self.name = name\\n self.command = command\\n self.tcp_port = tcp_port\\n self.env = env\\n self.listener_socket = listener_socket\\n\\n\\nclass ClientConfig:\\n def __init__(self,\\n name: str,\\n selector: str,\\n priority_selector: Optional[str] = None,\\n command: Optional[List[str]] = None,\\n binary_args: Optional[List[str]] = None, # DEPRECATED\\n tcp_port: Optional[int] = None,\\n auto_complete_selector: Optional[str] = None,\\n enabled: bool = True,\\n init_options: DottedDict = DottedDict(),\\n settings: DottedDict = DottedDict(),\\n env: Dict[str, str] = {},\\n experimental_capabilities: Optional[Dict[str, Any]] = None,\\n disabled_capabilities: DottedDict = DottedDict(),\\n path_maps: Optional[List[PathMap]] = None) -> None:\\n self.name = name\\n self.selector = selector\\n self.priority_selector = priority_selector if priority_selector else self.selector\\n if isinstance(command, list):\\n self.command = command\\n else:\\n assert isinstance(binary_args, list)\\n self.command = binary_args\\n self.tcp_port = tcp_port\\n self.auto_complete_selector = auto_complete_selector\\n self.enabled = enabled\\n self.init_options = init_options\\n self.settings = settings\\n self.env = env\\n self.experimental_capabilities = experimental_capabilities\\n self.disabled_capabilities = disabled_capabilities\\n self.path_maps = path_maps\\n self.status_key = \\\"lsp_{}\\\".format(self.name)\\n\\n @classmethod\\n def from_sublime_settings(cls, name: str, s: sublime.Settings, file: str) -> \\\"ClientConfig\\\":\\n base = sublime.decode_value(sublime.load_resource(file))\\n settings = DottedDict(base.get(\\\"settings\\\", {})) # defined by the plugin author\\n settings.update(read_dict_setting(s, \\\"settings\\\", {})) # overrides from the user\\n init_options = DottedDict(base.get(\\\"initializationOptions\\\", {}))\\n init_options.update(read_dict_setting(s, \\\"initializationOptions\\\", {}))\\n disabled_capabilities = s.get(\\\"disabled_capabilities\\\")\\n if isinstance(disabled_capabilities, dict):\\n disabled_capabilities = DottedDict(disabled_capabilities)\\n else:\\n disabled_capabilities = DottedDict()\\n return ClientConfig(\\n name=name,\\n selector=_read_selector(s),\\n priority_selector=_read_priority_selector(s),\\n command=read_list_setting(s, \\\"command\\\", []),\\n tcp_port=s.get(\\\"tcp_port\\\"),\\n auto_complete_selector=s.get(\\\"auto_complete_selector\\\"),\\n # Default to True, because an LSP plugin is enabled iff it is enabled as a Sublime package.\\n enabled=bool(s.get(\\\"enabled\\\", True)),\\n init_options=init_options,\\n settings=settings,\\n env=read_dict_setting(s, \\\"env\\\", {}),\\n experimental_capabilities=s.get(\\\"experimental_capabilities\\\"),\\n disabled_capabilities=disabled_capabilities,\\n path_maps=PathMap.parse(s.get(\\\"path_maps\\\"))\\n )\\n\\n @classmethod\\n def from_dict(cls, name: str, d: Dict[str, Any]) -> \\\"ClientConfig\\\":\\n disabled_capabilities = d.get(\\\"disabled_capabilities\\\")\\n if isinstance(disabled_capabilities, dict):\\n disabled_capabilities = DottedDict(disabled_capabilities)\\n else:\\n disabled_capabilities = DottedDict()\\n return ClientConfig(\\n name=name,\\n selector=_read_selector(d),\\n priority_selector=_read_priority_selector(d),\\n command=d.get(\\\"command\\\", []),\\n tcp_port=d.get(\\\"tcp_port\\\"),\\n auto_complete_selector=d.get(\\\"auto_complete_selector\\\"),\\n enabled=d.get(\\\"enabled\\\", False),\\n init_options=DottedDict(d.get(\\\"initializationOptions\\\")),\\n settings=DottedDict(d.get(\\\"settings\\\")),\\n env=d.get(\\\"env\\\", dict()),\\n experimental_capabilities=d.get(\\\"experimental_capabilities\\\"),\\n disabled_capabilities=disabled_capabilities,\\n path_maps=PathMap.parse(d.get(\\\"path_maps\\\"))\\n )\\n\\n @classmethod\\n def from_config(cls, src_config: \\\"ClientConfig\\\", override: Dict[str, Any]) -> \\\"ClientConfig\\\":\\n path_map_override = PathMap.parse(override.get(\\\"path_maps\\\"))\\n disabled_capabilities = override.get(\\\"disabled_capabilities\\\")\\n if isinstance(disabled_capabilities, dict):\\n disabled_capabilities = DottedDict(disabled_capabilities)\\n else:\\n disabled_capabilities = src_config.disabled_capabilities\\n return ClientConfig(\\n name=src_config.name,\\n selector=_read_selector(override) or src_config.selector,\\n priority_selector=_read_priority_selector(override) or src_config.priority_selector,\\n command=override.get(\\\"command\\\", src_config.command),\\n tcp_port=override.get(\\\"tcp_port\\\", src_config.tcp_port),\\n auto_complete_selector=override.get(\\\"auto_complete_selector\\\", src_config.auto_complete_selector),\\n enabled=override.get(\\\"enabled\\\", src_config.enabled),\\n init_options=DottedDict.from_base_and_override(\\n src_config.init_options, override.get(\\\"initializationOptions\\\")),\\n settings=DottedDict.from_base_and_override(src_config.settings, override.get(\\\"settings\\\")),\\n env=override.get(\\\"env\\\", src_config.env),\\n experimental_capabilities=override.get(\\n \\\"experimental_capabilities\\\", src_config.experimental_capabilities),\\n disabled_capabilities=disabled_capabilities,\\n path_maps=path_map_override if path_map_override else src_config.path_maps\\n )\\n\\n def resolve_transport_config(self, variables: Dict[str, str]) -> TransportConfig:\\n tcp_port = None # type: Optional[int]\\n listener_socket = None # type: Optional[socket.socket]\\n if self.tcp_port is not None:\\n # < 0 means we're hosting a TCP server\\n if self.tcp_port < 0:\\n # -1 means pick any free port\\n if self.tcp_port < -1:\\n tcp_port = -self.tcp_port\\n # Create a listener socket for incoming connections\\n listener_socket = _start_tcp_listener(tcp_port)\\n tcp_port = int(listener_socket.getsockname()[1])\\n else:\\n tcp_port = _find_free_port() if self.tcp_port == 0 else self.tcp_port\\n if tcp_port is not None:\\n variables[\\\"port\\\"] = str(tcp_port)\\n command = sublime.expand_variables(self.command, variables)\\n command = [os.path.expanduser(arg) for arg in command]\\n if tcp_port is not None:\\n # DEPRECATED -- replace {port} with $port or ${port} in your client config\\n command = [a.replace('{port}', str(tcp_port)) for a in command]\\n env = os.environ.copy()\\n for var, value in self.env.items():\\n env[var] = sublime.expand_variables(value, variables)\\n return TransportConfig(self.name, command, tcp_port, env, listener_socket)\\n\\n def set_view_status(self, view: sublime.View, message: str) -> None:\\n if sublime.load_settings(\\\"LSP.sublime-settings\\\").get(\\\"show_view_status\\\"):\\n status = \\\"{}: {}\\\".format(self.name, message) if message else self.name\\n view.set_status(self.status_key, status)\\n\\n def erase_view_status(self, view: sublime.View) -> None:\\n view.erase_status(self.status_key)\\n\\n def match_view(self, view: sublime.View) -> bool:\\n syntax = view.syntax()\\n if syntax:\\n # Every part of a x.y.z scope seems to contribute 8.\\n # An empty selector result in a score of 1.\\n # A non-matching non-empty selector results in a score of 0.\\n # We want to match at least one part of an x.y.z, and we don't want to match on empty selectors.\\n return sublime.score_selector(syntax.scope, self.selector) >= 8\\n return False\\n\\n def map_client_path_to_server_uri(self, path: str) -> str:\\n if self.path_maps:\\n for path_map in self.path_maps:\\n path, mapped = path_map.map_from_local_to_remote(path)\\n if mapped:\\n break\\n return filename_to_uri(path)\\n\\n def map_server_uri_to_client_path(self, uri: str) -> str:\\n path = uri_to_filename(uri)\\n if self.path_maps:\\n for path_map in self.path_maps:\\n path, mapped = path_map.map_from_remote_to_local(path)\\n if mapped:\\n break\\n return path\\n\\n def is_disabled_capability(self, capability_path: str) -> bool:\\n for value in self.disabled_capabilities.walk(capability_path):\\n if isinstance(value, bool):\\n return value\\n elif isinstance(value, dict):\\n if value:\\n # If it's not empty we'll continue the walk\\n continue\\n else:\\n # This might be a leaf node\\n return True\\n return False\\n\\n def filter_out_disabled_capabilities(self, capability_path: str, options: Dict[str, Any]) -> Dict[str, Any]:\\n result = {} # type: Dict[str, Any]\\n for k, v in options.items():\\n if not self.is_disabled_capability(\\\"{}.{}\\\".format(capability_path, k)):\\n result[k] = v\\n return result\\n\\n def __repr__(self) -> str:\\n items = [] # type: List[str]\\n for k, v in self.__dict__.items():\\n if not k.startswith(\\\"_\\\"):\\n items.append(\\\"{}={}\\\".format(k, repr(v)))\\n return \\\"{}({})\\\".format(self.__class__.__name__, \\\", \\\".join(items))\\n\\n def __eq__(self, other: Any) -> bool:\\n if not isinstance(other, ClientConfig):\\n return False\\n for k, v in self.__dict__.items():\\n if not k.startswith(\\\"_\\\") and v != getattr(other, k):\\n return False\\n return True\\n\\n\\ndef syntax2scope(syntax_path: str) -> Optional[str]:\\n syntax = sublime.syntax_from_path(syntax_path)\\n return syntax.scope if syntax else None\\n\\n\\ndef view2scope(view: sublime.View) -> str:\\n try:\\n return view.scope_name(0).split()[0]\\n except IndexError:\\n return ''\\n\\n\\ndef _read_selector(config: Union[sublime.Settings, Dict[str, Any]]) -> str:\\n # Best base scenario,\\n selector = config.get(\\\"selector\\\")\\n if isinstance(selector, str):\\n return selector\\n # Otherwise, look for \\\"languages\\\": [...]\\n languages = config.get(\\\"languages\\\")\\n if isinstance(languages, list):\\n selectors = []\\n for language in languages:\\n # First priority is document_selector,\\n document_selector = language.get(\\\"document_selector\\\")\\n if isinstance(document_selector, str):\\n selectors.append(document_selector)\\n continue\\n # After that syntaxes has priority,\\n syntaxes = language.get(\\\"syntaxes\\\")\\n if isinstance(syntaxes, list):\\n for path in syntaxes:\\n syntax = sublime.syntax_from_path(path)\\n if syntax:\\n selectors.append(syntax.scope)\\n continue\\n # No syntaxes and no document_selector... then there must exist a languageId.\\n language_id = language.get(\\\"languageId\\\")\\n if isinstance(language_id, str):\\n selectors.append(\\\"source.{}\\\".format(language_id))\\n return \\\"|\\\".join(map(\\\"({})\\\".format, selectors))\\n # Otherwise, look for \\\"document_selector\\\"\\n document_selector = config.get(\\\"document_selector\\\")\\n if isinstance(document_selector, str):\\n return document_selector\\n # Otherwise, look for \\\"syntaxes\\\": [...]\\n syntaxes = config.get(\\\"syntaxes\\\")\\n if isinstance(syntaxes, list):\\n selectors = []\\n for path in syntaxes:\\n syntax = sublime.syntax_from_path(path)\\n if syntax:\\n selectors.append(syntax.scope)\\n return \\\"|\\\".join(selectors)\\n # No syntaxes and no document_selector... then there must exist a languageId.\\n language_id = config.get(\\\"languageId\\\")\\n if language_id:\\n return \\\"source.{}\\\".format(language_id)\\n return \\\"\\\"\\n\\n\\ndef _read_priority_selector(config: Union[sublime.Settings, Dict[str, Any]]) -> str:\\n # Best case scenario\\n selector = config.get(\\\"priority_selector\\\")\\n if isinstance(selector, str):\\n return selector\\n # Otherwise, look for \\\"languages\\\": [...]\\n languages = config.get(\\\"languages\\\")\\n if isinstance(languages, list):\\n selectors = []\\n for language in languages:\\n # First priority is feature_selector.\\n feature_selector = language.get(\\\"feature_selector\\\")\\n if isinstance(feature_selector, str):\\n selectors.append(feature_selector)\\n continue\\n # After that scopes has priority.\\n scopes = language.get(\\\"scopes\\\")\\n if isinstance(scopes, list):\\n selectors.extend(scopes)\\n continue\\n # No scopes and no feature_selector. So there must be a languageId\\n language_id = language.get(\\\"languageId\\\")\\n if isinstance(language_id, str):\\n selectors.append(\\\"source.{}\\\".format(language_id))\\n return \\\"|\\\".join(map(\\\"({})\\\".format, selectors))\\n # Otherwise, look for \\\"feature_selector\\\"\\n feature_selector = config.get(\\\"feature_selector\\\")\\n if isinstance(feature_selector, str):\\n return feature_selector\\n # Otherwise, look for \\\"scopes\\\": [...]\\n scopes = config.get(\\\"scopes\\\")\\n if isinstance(scopes, list):\\n return \\\"|\\\".join(map(\\\"({})\\\".format, scopes))\\n # No scopes and no feature_selector... then there must exist a languageId\\n language_id = config.get(\\\"languageId\\\")\\n if language_id:\\n return \\\"source.{}\\\".format(language_id)\\n return \\\"\\\"\\n\\n\\ndef _find_free_port() -> int:\\n with contextlib.closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:\\n s.bind(('', 0))\\n s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)\\n return s.getsockname()[1]\\n\\n\\ndef _start_tcp_listener(tcp_port: Optional[int]) -> socket.socket:\\n sock = socket.socket()\\n sock.bind(('localhost', tcp_port or 0))\\n sock.settimeout(TCP_CONNECT_TIMEOUT)\\n sock.listen(1)\\n return sock\\n\",\n \"path\": \"plugin/core/types.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/plugin/core/types.py b/plugin/core/types.py\nindex 8722fcb52..d333c9c5b 100644\n--- a/plugin/core/types.py\n+++ b/plugin/core/types.py\n@@ -520,6 +520,8 @@ def __init__(\n env: Dict[str, str],\n listener_socket: Optional[socket.socket]\n ) -> None:\n+ if not command and not tcp_port:\n+ raise ValueError('neither \"command\" nor \"tcp_port\" is provided; cannot start a language server')\n self.name = name\n self.command = command\n self.tcp_port = tcp_port\n"}}},{"rowIdx":4694,"cells":{"in_source_id":{"kind":"string","value":"canonical__microk8s-3774"},"issue":{"kind":"string","value":"microk8s.reset does not remove resources\n<!--\r\n Thank you for submitting an issue. Please fill in the template below\r\n information about the bug you encountered.\r\n-->\r\n\r\n#### Summary\r\n<!-- Please explain the bug in a few short sentences -->\r\n\r\n#### What Should Happen Instead?\r\n<!-- Please explain what the expected behavior is -->\r\nAll k8s resources should be remove, no exception!\r\n\r\n#### System info\r\n```\r\narchlinux up-to-date\r\nsnap version\r\nsnap 2.56-1\r\nsnapd 2.56-1\r\nseries 16\r\narch -\r\nkernel 5.18.3-arch1-1\r\n```\r\n\r\n#### Reproduction Steps\r\n<!-- Are you able to consistently reproduce the issue? Please add a list of steps that lead to the bug. -->\r\n\r\n1. sudo snap install microk8s --classic\r\n2. microk8s enable dns\r\n```\r\n2022-06-14T14:25:12+07:00 INFO Waiting for automatic snapd restart...\r\nmicrok8s (1.24/stable) v1.24.0 from Canonical✓ installed\r\n```\r\n3. microk8s.kubectl get all -A\r\n```\r\nNAMESPACE NAME READY STATUS RESTARTS AGE\r\nkube-system pod/calico-kube-controllers-5c54889544-9h5fk 0/1 ContainerCreating 0 58s\r\nkube-system pod/calico-node-5wtlb 1/1 Running 0 59s\r\n\r\nNAMESPACE NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE\r\ndefault service/kubernetes ClusterIP 10.152.183.1 <none> 443/TCP 66s\r\n\r\nNAMESPACE NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE\r\nkube-system daemonset.apps/calico-node 1 1 1 1 1 kubernetes.io/os=linux 64s\r\n\r\nNAMESPACE NAME READY UP-TO-DATE AVAILABLE AGE\r\nkube-system deployment.apps/calico-kube-controllers 0/1 1 0 64s\r\n\r\nNAMESPACE NAME DESIRED CURRENT READY AGE\r\nkube-system replicaset.apps/calico-kube-controllers-5c54889544 1 1 0 58s\r\n```\r\n4. sudo microk8s.reset\r\n```\r\nDisabling all addons\r\nDisabling addon : core/dashboard\r\nDisabling addon : core/dns\r\nDisabling addon : core/gpu\r\nDisabling addon : core/helm\r\nDisabling addon : core/helm3\r\nDisabling addon : core/host-access\r\nDisabling addon : core/hostpath-storage\r\nDisabling addon : core/ingress\r\nDisabling addon : core/mayastor\r\nDisabling addon : core/metallb\r\nDisabling addon : core/metrics-server\r\nDisabling addon : core/prometheus\r\nDisabling addon : core/rbac\r\nDisabling addon : core/registry\r\nDisabling addon : core/storage\r\nAll addons are disabled.\r\nDeleting the CNI\r\nCleaning resources in namespace kube-system\r\nCleaning resources in namespace kube-public\r\nCleaning resources in namespace kube-node-lease\r\nCleaning resources in namespace default\r\nRemoving CRDs\r\nRemoving PriorityClasses\r\nRemoving StorageClasses\r\nRestarting cluster\r\nStopped.\r\nStarted.\r\nsudo: symbol lookup error: /snap/core18/current/lib/x86_64-linux-gnu/libpthread.so.0: undefined symbol: __libc_vfork, version GLIBC_PRIVATE\r\nSetting up the CNI\r\n```\r\n5. microk8s.kubectl get all -A\r\n```\r\nNAMESPACE NAME READY STATUS RESTARTS AGE\r\nkube-system pod/calico-node-m9jxn 1/1 Running 0 2m26s\r\nkube-system pod/calico-kube-controllers-9969d55bb-b7t76 1/1 Running 0 2m25s\r\n\r\nNAMESPACE NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE\r\ndefault service/kubernetes ClusterIP 10.152.183.1 <none> 443/TCP 5m21s\r\n\r\nNAMESPACE NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE\r\nkube-system daemonset.apps/calico-node 1 1 1 1 1 kubernetes.io/os=linux 3m28s\r\n\r\nNAMESPACE NAME READY UP-TO-DATE AVAILABLE AGE\r\nkube-system deployment.apps/calico-kube-controllers 1/1 1 1 3m28s\r\n\r\nNAMESPACE NAME DESIRED CURRENT READY AGE\r\nkube-system replicaset.apps/calico-kube-controllers-9969d55bb 1 1 1 2m25s\r\n```\r\nSo as you can see above steps, resources weren't removed after `microk8s.reset` command.\r\n\r\n\r\nI tried to do a clean refresh and re-installed snapd like below:\r\n```\r\nsudo systemctl disable snapd.socket\r\nsudo rm -rf /var/lib/snapd\r\nsudo pacman -Rns snapd\r\nsudo shutdown -r now #reboot the pc\r\nparu -S snapd #re-install snapd\r\nsudo systemctl enable --now snapd.socket\r\n```\r\nSurprisingly is that even I've not enabled `dns` yet, after above command and then I've just issued the command `microk8s.kubectl get all -A`, all calico pods and all of the resources still there (even I removed /var/lib/snapd and reboot the pc)\r\n\r\nSo why resources weren't removed and how to have a clean reset microk8s?\r\n\r\nFull `microk8s inspect` logs [here](https://drive.google.com/file/d/1B4A_cwIks64ZbNnKqKrjalpTj1u2JClj/view?usp=sharing)\n"},"before_files":{"kind":"list like","value":[{"content":"#!/usr/bin/python3\nimport click\nimport os\nimport subprocess\nimport shutil\nimport sys\nimport time\n\nfrom common.utils import (\n get_available_addons,\n get_current_arch,\n get_status,\n snap_data,\n wait_for_ready,\n snap_common,\n is_cluster_locked,\n exit_if_no_permission,\n ensure_started,\n exit_if_no_root,\n)\n\n\nKUBECTL = os.path.expandvars(\"$SNAP/microk8s-kubectl.wrapper\")\n\n\ndef exit_if_multinode():\n \"\"\"\n Exit if we cannot get the list of nodes or if we are in a multinode cluster\n \"\"\"\n cmd = [KUBECTL, \"get\", \"no\", \"-o\", \"name\"]\n res = run_silently(cmd)\n if not res:\n print(\"Failed to query the cluster nodes.\")\n sys.exit(1)\n nodes = res.split()\n if len(nodes) > 1:\n print(\n \"This is a multi-node MicroK8s deployment. Reset is applicable for single node clusters.\"\n )\n print(\"Please remove all joined nodes before calling reset.\")\n sys.exit(0)\n\n\ndef disable_addon(repo, addon, args=None):\n \"\"\"\n Try to disable an addon. Ignore any errors and/or silence any output.\n \"\"\"\n if args is None:\n args = []\n wait_for_ready(timeout=30)\n script = snap_common() / \"addons\" / repo / \"addons\" / addon / \"disable\"\n if not script.exists():\n return\n\n try:\n subprocess.run([script, *args], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\n except (FileNotFoundError, PermissionError, subprocess.CalledProcessError) as e:\n print(f\"Ignoring error: {e}\", file=sys.stderr)\n\n wait_for_ready(timeout=30)\n\n\ndef disable_addons(destroy_storage):\n \"\"\"\n Iterate over all addons and disable the enabled ones.\n \"\"\"\n print(\"Disabling all addons\")\n\n available_addons_info = get_available_addons(get_current_arch())\n enabled, disabled = get_status(available_addons_info, True)\n for addon in available_addons_info:\n # Do not disable HA\n if addon[\"name\"] == \"ha-cluster\":\n continue\n\n # Do not disable the community repository\n if addon[\"name\"] == \"community\":\n continue\n\n print(f\"Disabling addon : {addon['repository']}/{addon['name']}\")\n # Do not disable disabled addons\n if addon in disabled:\n continue\n\n if (addon[\"name\"] == \"hostpath-storage\" or addon[\"name\"] == \"storage\") and destroy_storage:\n disable_addon(addon[\"repository\"], f\"{addon['name']}\", [\"destroy-storage\"])\n else:\n disable_addon(addon[\"repository\"], addon[\"name\"])\n print(\"All addons are disabled.\")\n\n\ndef cni(operation=\"apply\"):\n \"\"\"\n Apply of delete the CNI manifest of our cluster if it exists. Silence any output.\n \"\"\"\n cni_yaml = f\"{snap_data()}/args/cni-network/cni.yaml\"\n if os.path.exists(cni_yaml):\n if operation == \"apply\":\n print(\"Setting up the CNI\")\n else:\n print(\"Deleting the CNI\")\n subprocess.run(\n [KUBECTL, operation, \"-f\", cni_yaml],\n stdout=subprocess.DEVNULL,\n stderr=subprocess.DEVNULL,\n )\n\n\ndef clean_cluster():\n \"\"\"\n Clean up the cluster by:\n 1. Delete any resources left\n 2. Restart so the cluster resets\n 3. Delete any locks and addon binaries.\n \"\"\"\n cmd = [KUBECTL, \"get\", \"ns\", \"-o=name\"]\n res = run_silently(cmd)\n nss = []\n if res:\n nss = res.split()\n resources = [\"replicationcontrollers\", \"daemonsets\", \"deployments\", \"statefulsets\"]\n for ns in nss:\n ns_name = ns.split(\"/\")[-1]\n print(f\"Cleaning resources in namespace {ns_name}\")\n for rs in resources:\n # we remove first resources that are automatically recreated so we do not risk race conditions\n # during which a deployment for example is recreated while any tokens are missing\n cmd = [KUBECTL, \"delete\", \"--all\", rs, \"-n\", ns_name, \"--timeout=60s\"]\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\n remove_extra_resources(ns_name)\n\n print(\"Removing CRDs\")\n cmd = [\n KUBECTL,\n \"delete\",\n \"--all\",\n \"customresourcedefinitions.apiextensions.k8s.io\",\n \"--timeout=60s\",\n ]\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\n\n remove_priority_classes()\n remove_storage_classes()\n\n for ns in nss:\n ns_name = ns.split(\"/\")[-1]\n if ns_name in [\"default\", \"kube-public\", \"kube-system\", \"kube-node-lease\"]:\n continue\n print(f\"Removing {ns}\")\n cmd = [KUBECTL, \"delete\", ns, \"--timeout=60s\"]\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\n\n restart_cluster()\n remove_binaries()\n reset_cert_reissue()\n\n\ndef remove_storage_classes():\n \"\"\"\n Remove storage classes. Silence any output.\n \"\"\"\n print(\"Removing StorageClasses\")\n cmd = [KUBECTL, \"get\", \"storageclasses\", \"-o=name\"]\n res = run_silently(cmd)\n classes = []\n if res:\n classes = res.split()\n for cs in classes:\n if \"microk8s-hostpath\" in cs:\n continue\n cmd = [KUBECTL, \"delete\", cs, \"--timeout=60s\"]\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\n\n\ndef remove_priority_classes():\n \"\"\"\n Remove priority classes. Silence any output.\n \"\"\"\n print(\"Removing PriorityClasses\")\n cmd = [KUBECTL, \"get\", \"priorityclasses\", \"-o=name\"]\n res = run_silently(cmd)\n classes = []\n if res:\n classes = res.split()\n for cs in classes:\n if \"system-cluster-critical\" in cs or \"system-node-critical\" in cs:\n continue\n cmd = [KUBECTL, \"delete\", cs, \"--timeout=60s\"]\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\n\n\ndef reset_cert_reissue():\n \"\"\"\n Remove the certificate no refresh lock.\n \"\"\"\n lock = snap_data() / \"var\" / \"lock\" / \"no-cert-reissue\"\n if lock.exists():\n cmd = f\"rm -rf {lock}\"\n subprocess.run(cmd.split())\n\n\ndef remove_binaries():\n \"\"\"\n Remove binaries pulled in by addons.\n \"\"\"\n bins_dir = snap_data() / \"bin\"\n if bins_dir.exists():\n shutil.rmtree(bins_dir)\n\n\ndef restart_cluster():\n \"\"\"\n Restart a cluster by calling the stop and start wrappers.\n \"\"\"\n print(\"Restarting cluster\")\n cmd = [f\"{os.environ['SNAP']}/microk8s-stop.wrapper\"]\n subprocess.run(cmd)\n time.sleep(5)\n cmd = [f\"{os.environ['SNAP']}/microk8s-start.wrapper\"]\n subprocess.run(cmd)\n wait_for_ready(timeout=30)\n ensure_started()\n\n\ndef remove_extra_resources(ns_name):\n # Remove all resource types except the standard k8s apiservices themselves\n cmd = [KUBECTL, \"api-resources\", \"-o\", \"name\", \"--verbs=delete\", \"--namespaced=true\"]\n res = run_silently(cmd)\n if not res:\n return\n extra_resources = res.split()\n for rs in extra_resources:\n if rs.startswith(\"apiservices\"):\n continue\n cmd = [KUBECTL, \"delete\", \"--all\", \"-n\", ns_name, \"--timeout=60s\"]\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\n\n\ndef run_silently(cmd):\n result = subprocess.run(\n cmd, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE\n )\n\n try:\n result.check_returncode()\n except subprocess.CalledProcessError:\n return None\n\n return result.stdout.decode(\"utf-8\")\n\n\ndef preflight_check():\n \"\"\"\n Preliminary checks to see if we can proceed with cluster reset\n \"\"\"\n exit_if_no_root()\n exit_if_no_permission()\n is_cluster_locked()\n ensure_started()\n wait_for_ready(timeout=30)\n exit_if_multinode()\n\n\n@click.command(context_settings={\"help_option_names\": [\"-h\", \"--help\"]})\n@click.option(\n \"--destroy-storage\",\n is_flag=True,\n required=False,\n default=True,\n help=\"Also destroy storage. (default: false)\",\n)\ndef reset(destroy_storage):\n \"\"\"\n Return the MicroK8s node to the default initial state.\n\n This process may take some time. All addons will be disabled and\n the configuration will be reinitialized.\n \"\"\"\n preflight_check()\n disable_addons(destroy_storage)\n cni(\"delete\")\n clean_cluster()\n cni(\"apply\")\n\n\nif __name__ == \"__main__\":\n reset(prog_name=\"microk8s reset\")\n","path":"scripts/wrappers/reset.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/python3\\nimport click\\nimport os\\nimport subprocess\\nimport shutil\\nimport sys\\nimport time\\n\\nfrom common.utils import (\\n get_available_addons,\\n get_current_arch,\\n get_status,\\n snap_data,\\n wait_for_ready,\\n snap_common,\\n is_cluster_locked,\\n exit_if_no_permission,\\n ensure_started,\\n exit_if_no_root,\\n)\\n\\n\\nKUBECTL = os.path.expandvars(\\\"$SNAP/microk8s-kubectl.wrapper\\\")\\n\\n\\ndef exit_if_multinode():\\n \\\"\\\"\\\"\\n Exit if we cannot get the list of nodes or if we are in a multinode cluster\\n \\\"\\\"\\\"\\n cmd = [KUBECTL, \\\"get\\\", \\\"no\\\", \\\"-o\\\", \\\"name\\\"]\\n res = run_silently(cmd)\\n if not res:\\n print(\\\"Failed to query the cluster nodes.\\\")\\n sys.exit(1)\\n nodes = res.split()\\n if len(nodes) > 1:\\n print(\\n \\\"This is a multi-node MicroK8s deployment. Reset is applicable for single node clusters.\\\"\\n )\\n print(\\\"Please remove all joined nodes before calling reset.\\\")\\n sys.exit(0)\\n\\n\\ndef disable_addon(repo, addon, args=None):\\n \\\"\\\"\\\"\\n Try to disable an addon. Ignore any errors and/or silence any output.\\n \\\"\\\"\\\"\\n if args is None:\\n args = []\\n wait_for_ready(timeout=30)\\n script = snap_common() / \\\"addons\\\" / repo / \\\"addons\\\" / addon / \\\"disable\\\"\\n if not script.exists():\\n return\\n\\n try:\\n subprocess.run([script, *args], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\\n except (FileNotFoundError, PermissionError, subprocess.CalledProcessError) as e:\\n print(f\\\"Ignoring error: {e}\\\", file=sys.stderr)\\n\\n wait_for_ready(timeout=30)\\n\\n\\ndef disable_addons(destroy_storage):\\n \\\"\\\"\\\"\\n Iterate over all addons and disable the enabled ones.\\n \\\"\\\"\\\"\\n print(\\\"Disabling all addons\\\")\\n\\n available_addons_info = get_available_addons(get_current_arch())\\n enabled, disabled = get_status(available_addons_info, True)\\n for addon in available_addons_info:\\n # Do not disable HA\\n if addon[\\\"name\\\"] == \\\"ha-cluster\\\":\\n continue\\n\\n # Do not disable the community repository\\n if addon[\\\"name\\\"] == \\\"community\\\":\\n continue\\n\\n print(f\\\"Disabling addon : {addon['repository']}/{addon['name']}\\\")\\n # Do not disable disabled addons\\n if addon in disabled:\\n continue\\n\\n if (addon[\\\"name\\\"] == \\\"hostpath-storage\\\" or addon[\\\"name\\\"] == \\\"storage\\\") and destroy_storage:\\n disable_addon(addon[\\\"repository\\\"], f\\\"{addon['name']}\\\", [\\\"destroy-storage\\\"])\\n else:\\n disable_addon(addon[\\\"repository\\\"], addon[\\\"name\\\"])\\n print(\\\"All addons are disabled.\\\")\\n\\n\\ndef cni(operation=\\\"apply\\\"):\\n \\\"\\\"\\\"\\n Apply of delete the CNI manifest of our cluster if it exists. Silence any output.\\n \\\"\\\"\\\"\\n cni_yaml = f\\\"{snap_data()}/args/cni-network/cni.yaml\\\"\\n if os.path.exists(cni_yaml):\\n if operation == \\\"apply\\\":\\n print(\\\"Setting up the CNI\\\")\\n else:\\n print(\\\"Deleting the CNI\\\")\\n subprocess.run(\\n [KUBECTL, operation, \\\"-f\\\", cni_yaml],\\n stdout=subprocess.DEVNULL,\\n stderr=subprocess.DEVNULL,\\n )\\n\\n\\ndef clean_cluster():\\n \\\"\\\"\\\"\\n Clean up the cluster by:\\n 1. Delete any resources left\\n 2. Restart so the cluster resets\\n 3. Delete any locks and addon binaries.\\n \\\"\\\"\\\"\\n cmd = [KUBECTL, \\\"get\\\", \\\"ns\\\", \\\"-o=name\\\"]\\n res = run_silently(cmd)\\n nss = []\\n if res:\\n nss = res.split()\\n resources = [\\\"replicationcontrollers\\\", \\\"daemonsets\\\", \\\"deployments\\\", \\\"statefulsets\\\"]\\n for ns in nss:\\n ns_name = ns.split(\\\"/\\\")[-1]\\n print(f\\\"Cleaning resources in namespace {ns_name}\\\")\\n for rs in resources:\\n # we remove first resources that are automatically recreated so we do not risk race conditions\\n # during which a deployment for example is recreated while any tokens are missing\\n cmd = [KUBECTL, \\\"delete\\\", \\\"--all\\\", rs, \\\"-n\\\", ns_name, \\\"--timeout=60s\\\"]\\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\\n remove_extra_resources(ns_name)\\n\\n print(\\\"Removing CRDs\\\")\\n cmd = [\\n KUBECTL,\\n \\\"delete\\\",\\n \\\"--all\\\",\\n \\\"customresourcedefinitions.apiextensions.k8s.io\\\",\\n \\\"--timeout=60s\\\",\\n ]\\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\\n\\n remove_priority_classes()\\n remove_storage_classes()\\n\\n for ns in nss:\\n ns_name = ns.split(\\\"/\\\")[-1]\\n if ns_name in [\\\"default\\\", \\\"kube-public\\\", \\\"kube-system\\\", \\\"kube-node-lease\\\"]:\\n continue\\n print(f\\\"Removing {ns}\\\")\\n cmd = [KUBECTL, \\\"delete\\\", ns, \\\"--timeout=60s\\\"]\\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\\n\\n restart_cluster()\\n remove_binaries()\\n reset_cert_reissue()\\n\\n\\ndef remove_storage_classes():\\n \\\"\\\"\\\"\\n Remove storage classes. Silence any output.\\n \\\"\\\"\\\"\\n print(\\\"Removing StorageClasses\\\")\\n cmd = [KUBECTL, \\\"get\\\", \\\"storageclasses\\\", \\\"-o=name\\\"]\\n res = run_silently(cmd)\\n classes = []\\n if res:\\n classes = res.split()\\n for cs in classes:\\n if \\\"microk8s-hostpath\\\" in cs:\\n continue\\n cmd = [KUBECTL, \\\"delete\\\", cs, \\\"--timeout=60s\\\"]\\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\\n\\n\\ndef remove_priority_classes():\\n \\\"\\\"\\\"\\n Remove priority classes. Silence any output.\\n \\\"\\\"\\\"\\n print(\\\"Removing PriorityClasses\\\")\\n cmd = [KUBECTL, \\\"get\\\", \\\"priorityclasses\\\", \\\"-o=name\\\"]\\n res = run_silently(cmd)\\n classes = []\\n if res:\\n classes = res.split()\\n for cs in classes:\\n if \\\"system-cluster-critical\\\" in cs or \\\"system-node-critical\\\" in cs:\\n continue\\n cmd = [KUBECTL, \\\"delete\\\", cs, \\\"--timeout=60s\\\"]\\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\\n\\n\\ndef reset_cert_reissue():\\n \\\"\\\"\\\"\\n Remove the certificate no refresh lock.\\n \\\"\\\"\\\"\\n lock = snap_data() / \\\"var\\\" / \\\"lock\\\" / \\\"no-cert-reissue\\\"\\n if lock.exists():\\n cmd = f\\\"rm -rf {lock}\\\"\\n subprocess.run(cmd.split())\\n\\n\\ndef remove_binaries():\\n \\\"\\\"\\\"\\n Remove binaries pulled in by addons.\\n \\\"\\\"\\\"\\n bins_dir = snap_data() / \\\"bin\\\"\\n if bins_dir.exists():\\n shutil.rmtree(bins_dir)\\n\\n\\ndef restart_cluster():\\n \\\"\\\"\\\"\\n Restart a cluster by calling the stop and start wrappers.\\n \\\"\\\"\\\"\\n print(\\\"Restarting cluster\\\")\\n cmd = [f\\\"{os.environ['SNAP']}/microk8s-stop.wrapper\\\"]\\n subprocess.run(cmd)\\n time.sleep(5)\\n cmd = [f\\\"{os.environ['SNAP']}/microk8s-start.wrapper\\\"]\\n subprocess.run(cmd)\\n wait_for_ready(timeout=30)\\n ensure_started()\\n\\n\\ndef remove_extra_resources(ns_name):\\n # Remove all resource types except the standard k8s apiservices themselves\\n cmd = [KUBECTL, \\\"api-resources\\\", \\\"-o\\\", \\\"name\\\", \\\"--verbs=delete\\\", \\\"--namespaced=true\\\"]\\n res = run_silently(cmd)\\n if not res:\\n return\\n extra_resources = res.split()\\n for rs in extra_resources:\\n if rs.startswith(\\\"apiservices\\\"):\\n continue\\n cmd = [KUBECTL, \\\"delete\\\", \\\"--all\\\", \\\"-n\\\", ns_name, \\\"--timeout=60s\\\"]\\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\\n\\n\\ndef run_silently(cmd):\\n result = subprocess.run(\\n cmd, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE\\n )\\n\\n try:\\n result.check_returncode()\\n except subprocess.CalledProcessError:\\n return None\\n\\n return result.stdout.decode(\\\"utf-8\\\")\\n\\n\\ndef preflight_check():\\n \\\"\\\"\\\"\\n Preliminary checks to see if we can proceed with cluster reset\\n \\\"\\\"\\\"\\n exit_if_no_root()\\n exit_if_no_permission()\\n is_cluster_locked()\\n ensure_started()\\n wait_for_ready(timeout=30)\\n exit_if_multinode()\\n\\n\\n@click.command(context_settings={\\\"help_option_names\\\": [\\\"-h\\\", \\\"--help\\\"]})\\n@click.option(\\n \\\"--destroy-storage\\\",\\n is_flag=True,\\n required=False,\\n default=True,\\n help=\\\"Also destroy storage. (default: false)\\\",\\n)\\ndef reset(destroy_storage):\\n \\\"\\\"\\\"\\n Return the MicroK8s node to the default initial state.\\n\\n This process may take some time. All addons will be disabled and\\n the configuration will be reinitialized.\\n \\\"\\\"\\\"\\n preflight_check()\\n disable_addons(destroy_storage)\\n cni(\\\"delete\\\")\\n clean_cluster()\\n cni(\\\"apply\\\")\\n\\n\\nif __name__ == \\\"__main__\\\":\\n reset(prog_name=\\\"microk8s reset\\\")\\n\",\n \"path\": \"scripts/wrappers/reset.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"#!/usr/bin/python3\nimport click\nimport os\nimport subprocess\nimport shutil\nimport sys\nimport time\n\nfrom common.utils import (\n get_available_addons,\n get_current_arch,\n get_status,\n snap_data,\n wait_for_ready,\n snap_common,\n is_cluster_locked,\n exit_if_no_permission,\n ensure_started,\n exit_if_no_root,\n)\n\n\nKUBECTL = os.path.expandvars(\"$SNAP/microk8s-kubectl.wrapper\")\n\n\ndef exit_if_multinode():\n \"\"\"\n Exit if we cannot get the list of nodes or if we are in a multinode cluster\n \"\"\"\n cmd = [KUBECTL, \"get\", \"no\", \"-o\", \"name\"]\n res = run_silently(cmd)\n if not res:\n print(\"Failed to query the cluster nodes.\")\n sys.exit(1)\n nodes = res.split()\n if len(nodes) > 1:\n print(\n \"This is a multi-node MicroK8s deployment. Reset is applicable for single node clusters.\"\n )\n print(\"Please remove all joined nodes before calling reset.\")\n sys.exit(0)\n\n\ndef disable_addon(repo, addon, args=None):\n \"\"\"\n Try to disable an addon. Ignore any errors and/or silence any output.\n \"\"\"\n if args is None:\n args = []\n wait_for_ready(timeout=30)\n script = snap_common() / \"addons\" / repo / \"addons\" / addon / \"disable\"\n if not script.exists():\n return\n\n try:\n subprocess.run([script, *args], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\n except (FileNotFoundError, PermissionError, subprocess.CalledProcessError) as e:\n print(f\"Ignoring error: {e}\", file=sys.stderr)\n\n wait_for_ready(timeout=30)\n\n\ndef disable_addons(destroy_storage):\n \"\"\"\n Iterate over all addons and disable the enabled ones.\n \"\"\"\n print(\"Disabling all addons\")\n\n available_addons_info = get_available_addons(get_current_arch())\n enabled, disabled = get_status(available_addons_info, True)\n for addon in available_addons_info:\n # Do not disable HA\n if addon[\"name\"] == \"ha-cluster\":\n continue\n\n # Do not disable the community repository\n if addon[\"name\"] == \"community\":\n continue\n\n print(f\"Disabling addon : {addon['repository']}/{addon['name']}\")\n # Do not disable disabled addons\n if addon in disabled:\n continue\n\n if (addon[\"name\"] == \"hostpath-storage\" or addon[\"name\"] == \"storage\") and destroy_storage:\n disable_addon(addon[\"repository\"], f\"{addon['name']}\", [\"destroy-storage\"])\n else:\n disable_addon(addon[\"repository\"], addon[\"name\"])\n print(\"All addons are disabled.\")\n\n\ndef cni(operation=\"apply\"):\n \"\"\"\n Apply of delete the CNI manifest of our cluster if it exists. Silence any output.\n \"\"\"\n cni_yaml = f\"{snap_data()}/args/cni-network/cni.yaml\"\n if os.path.exists(cni_yaml):\n if operation == \"apply\":\n print(\"Setting up the CNI\")\n else:\n print(\"Deleting the CNI\")\n subprocess.run(\n [KUBECTL, operation, \"-f\", cni_yaml],\n stdout=subprocess.DEVNULL,\n stderr=subprocess.DEVNULL,\n )\n\n\ndef clean_cluster():\n \"\"\"\n Clean up the cluster by:\n 1. Delete any resources left\n 2. Restart so the cluster resets\n 3. Delete any locks and addon binaries.\n \"\"\"\n cmd = [KUBECTL, \"get\", \"ns\", \"-o=name\"]\n res = run_silently(cmd)\n nss = []\n if res:\n nss = res.split()\n resources = [\"replicationcontrollers\", \"daemonsets\", \"deployments\", \"statefulsets\"]\n for ns in nss:\n ns_name = ns.split(\"/\")[-1]\n print(f\"Cleaning resources in namespace {ns_name}\")\n for rs in resources:\n # we remove first resources that are automatically recreated so we do not risk race conditions\n # during which a deployment for example is recreated while any tokens are missing\n cmd = [KUBECTL, \"delete\", \"--all\", rs, \"-n\", ns_name, \"--timeout=60s\"]\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\n remove_extra_resources(ns_name)\n\n print(\"Removing CRDs\")\n cmd = [\n KUBECTL,\n \"delete\",\n \"--all\",\n \"customresourcedefinitions.apiextensions.k8s.io\",\n \"--timeout=60s\",\n ]\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\n\n remove_priority_classes()\n remove_storage_classes()\n\n for ns in nss:\n ns_name = ns.split(\"/\")[-1]\n if ns_name in [\"default\", \"kube-public\", \"kube-system\", \"kube-node-lease\"]:\n continue\n print(f\"Removing {ns}\")\n cmd = [KUBECTL, \"delete\", ns, \"--timeout=60s\"]\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\n\n restart_cluster()\n remove_binaries()\n reset_cert_reissue()\n\n\ndef remove_storage_classes():\n \"\"\"\n Remove storage classes. Silence any output.\n \"\"\"\n print(\"Removing StorageClasses\")\n cmd = [KUBECTL, \"get\", \"storageclasses\", \"-o=name\"]\n res = run_silently(cmd)\n classes = []\n if res:\n classes = res.split()\n for cs in classes:\n if \"microk8s-hostpath\" in cs:\n continue\n cmd = [KUBECTL, \"delete\", cs, \"--timeout=60s\"]\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\n\n\ndef remove_priority_classes():\n \"\"\"\n Remove priority classes. Silence any output.\n \"\"\"\n print(\"Removing PriorityClasses\")\n cmd = [KUBECTL, \"get\", \"priorityclasses\", \"-o=name\"]\n res = run_silently(cmd)\n classes = []\n if res:\n classes = res.split()\n for cs in classes:\n if \"system-cluster-critical\" in cs or \"system-node-critical\" in cs:\n continue\n cmd = [KUBECTL, \"delete\", cs, \"--timeout=60s\"]\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\n\n\ndef reset_cert_reissue():\n \"\"\"\n Remove the certificate no refresh lock.\n \"\"\"\n lock = snap_data() / \"var\" / \"lock\" / \"no-cert-reissue\"\n if lock.exists():\n cmd = f\"rm -rf {lock}\"\n subprocess.run(cmd.split())\n\n\ndef remove_binaries():\n \"\"\"\n Remove binaries pulled in by addons.\n \"\"\"\n bins_dir = snap_data() / \"bin\"\n if bins_dir.exists():\n shutil.rmtree(bins_dir)\n\n\ndef restart_cluster():\n \"\"\"\n Restart a cluster by calling the stop and start wrappers.\n \"\"\"\n print(\"Restarting cluster\")\n cmd = [f\"{os.environ['SNAP']}/microk8s-stop.wrapper\"]\n subprocess.run(cmd)\n time.sleep(5)\n cmd = [f\"{os.environ['SNAP']}/microk8s-start.wrapper\"]\n subprocess.run(cmd)\n wait_for_ready(timeout=30)\n ensure_started()\n\n\ndef remove_extra_resources(ns_name):\n # Remove all resource types except the standard k8s apiservices themselves\n cmd = [KUBECTL, \"api-resources\", \"-o\", \"name\", \"--verbs=delete\", \"--namespaced=true\"]\n res = run_silently(cmd)\n if not res:\n return\n extra_resources = res.split()\n for rs in extra_resources:\n if rs.startswith(\"apiservices\"):\n continue\n cmd = [KUBECTL, \"delete\", \"--all\", rs, \"-n\", ns_name, \"--timeout=3s\"]\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\n\n\ndef run_silently(cmd):\n result = subprocess.run(\n cmd, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE\n )\n\n try:\n result.check_returncode()\n except subprocess.CalledProcessError:\n return None\n\n return result.stdout.decode(\"utf-8\")\n\n\ndef preflight_check():\n \"\"\"\n Preliminary checks to see if we can proceed with cluster reset\n \"\"\"\n exit_if_no_root()\n exit_if_no_permission()\n is_cluster_locked()\n ensure_started()\n wait_for_ready(timeout=30)\n exit_if_multinode()\n\n\n@click.command(context_settings={\"help_option_names\": [\"-h\", \"--help\"]})\n@click.option(\n \"--destroy-storage\",\n is_flag=True,\n required=False,\n default=True,\n help=\"Also destroy storage. (default: false)\",\n)\ndef reset(destroy_storage):\n \"\"\"\n Return the MicroK8s node to the default initial state.\n\n This process may take some time. All addons will be disabled and\n the configuration will be reinitialized.\n \"\"\"\n preflight_check()\n disable_addons(destroy_storage)\n cni(\"delete\")\n clean_cluster()\n cni(\"apply\")\n\n\nif __name__ == \"__main__\":\n reset(prog_name=\"microk8s reset\")\n","path":"scripts/wrappers/reset.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/python3\\nimport click\\nimport os\\nimport subprocess\\nimport shutil\\nimport sys\\nimport time\\n\\nfrom common.utils import (\\n get_available_addons,\\n get_current_arch,\\n get_status,\\n snap_data,\\n wait_for_ready,\\n snap_common,\\n is_cluster_locked,\\n exit_if_no_permission,\\n ensure_started,\\n exit_if_no_root,\\n)\\n\\n\\nKUBECTL = os.path.expandvars(\\\"$SNAP/microk8s-kubectl.wrapper\\\")\\n\\n\\ndef exit_if_multinode():\\n \\\"\\\"\\\"\\n Exit if we cannot get the list of nodes or if we are in a multinode cluster\\n \\\"\\\"\\\"\\n cmd = [KUBECTL, \\\"get\\\", \\\"no\\\", \\\"-o\\\", \\\"name\\\"]\\n res = run_silently(cmd)\\n if not res:\\n print(\\\"Failed to query the cluster nodes.\\\")\\n sys.exit(1)\\n nodes = res.split()\\n if len(nodes) > 1:\\n print(\\n \\\"This is a multi-node MicroK8s deployment. Reset is applicable for single node clusters.\\\"\\n )\\n print(\\\"Please remove all joined nodes before calling reset.\\\")\\n sys.exit(0)\\n\\n\\ndef disable_addon(repo, addon, args=None):\\n \\\"\\\"\\\"\\n Try to disable an addon. Ignore any errors and/or silence any output.\\n \\\"\\\"\\\"\\n if args is None:\\n args = []\\n wait_for_ready(timeout=30)\\n script = snap_common() / \\\"addons\\\" / repo / \\\"addons\\\" / addon / \\\"disable\\\"\\n if not script.exists():\\n return\\n\\n try:\\n subprocess.run([script, *args], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\\n except (FileNotFoundError, PermissionError, subprocess.CalledProcessError) as e:\\n print(f\\\"Ignoring error: {e}\\\", file=sys.stderr)\\n\\n wait_for_ready(timeout=30)\\n\\n\\ndef disable_addons(destroy_storage):\\n \\\"\\\"\\\"\\n Iterate over all addons and disable the enabled ones.\\n \\\"\\\"\\\"\\n print(\\\"Disabling all addons\\\")\\n\\n available_addons_info = get_available_addons(get_current_arch())\\n enabled, disabled = get_status(available_addons_info, True)\\n for addon in available_addons_info:\\n # Do not disable HA\\n if addon[\\\"name\\\"] == \\\"ha-cluster\\\":\\n continue\\n\\n # Do not disable the community repository\\n if addon[\\\"name\\\"] == \\\"community\\\":\\n continue\\n\\n print(f\\\"Disabling addon : {addon['repository']}/{addon['name']}\\\")\\n # Do not disable disabled addons\\n if addon in disabled:\\n continue\\n\\n if (addon[\\\"name\\\"] == \\\"hostpath-storage\\\" or addon[\\\"name\\\"] == \\\"storage\\\") and destroy_storage:\\n disable_addon(addon[\\\"repository\\\"], f\\\"{addon['name']}\\\", [\\\"destroy-storage\\\"])\\n else:\\n disable_addon(addon[\\\"repository\\\"], addon[\\\"name\\\"])\\n print(\\\"All addons are disabled.\\\")\\n\\n\\ndef cni(operation=\\\"apply\\\"):\\n \\\"\\\"\\\"\\n Apply of delete the CNI manifest of our cluster if it exists. Silence any output.\\n \\\"\\\"\\\"\\n cni_yaml = f\\\"{snap_data()}/args/cni-network/cni.yaml\\\"\\n if os.path.exists(cni_yaml):\\n if operation == \\\"apply\\\":\\n print(\\\"Setting up the CNI\\\")\\n else:\\n print(\\\"Deleting the CNI\\\")\\n subprocess.run(\\n [KUBECTL, operation, \\\"-f\\\", cni_yaml],\\n stdout=subprocess.DEVNULL,\\n stderr=subprocess.DEVNULL,\\n )\\n\\n\\ndef clean_cluster():\\n \\\"\\\"\\\"\\n Clean up the cluster by:\\n 1. Delete any resources left\\n 2. Restart so the cluster resets\\n 3. Delete any locks and addon binaries.\\n \\\"\\\"\\\"\\n cmd = [KUBECTL, \\\"get\\\", \\\"ns\\\", \\\"-o=name\\\"]\\n res = run_silently(cmd)\\n nss = []\\n if res:\\n nss = res.split()\\n resources = [\\\"replicationcontrollers\\\", \\\"daemonsets\\\", \\\"deployments\\\", \\\"statefulsets\\\"]\\n for ns in nss:\\n ns_name = ns.split(\\\"/\\\")[-1]\\n print(f\\\"Cleaning resources in namespace {ns_name}\\\")\\n for rs in resources:\\n # we remove first resources that are automatically recreated so we do not risk race conditions\\n # during which a deployment for example is recreated while any tokens are missing\\n cmd = [KUBECTL, \\\"delete\\\", \\\"--all\\\", rs, \\\"-n\\\", ns_name, \\\"--timeout=60s\\\"]\\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\\n remove_extra_resources(ns_name)\\n\\n print(\\\"Removing CRDs\\\")\\n cmd = [\\n KUBECTL,\\n \\\"delete\\\",\\n \\\"--all\\\",\\n \\\"customresourcedefinitions.apiextensions.k8s.io\\\",\\n \\\"--timeout=60s\\\",\\n ]\\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\\n\\n remove_priority_classes()\\n remove_storage_classes()\\n\\n for ns in nss:\\n ns_name = ns.split(\\\"/\\\")[-1]\\n if ns_name in [\\\"default\\\", \\\"kube-public\\\", \\\"kube-system\\\", \\\"kube-node-lease\\\"]:\\n continue\\n print(f\\\"Removing {ns}\\\")\\n cmd = [KUBECTL, \\\"delete\\\", ns, \\\"--timeout=60s\\\"]\\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\\n\\n restart_cluster()\\n remove_binaries()\\n reset_cert_reissue()\\n\\n\\ndef remove_storage_classes():\\n \\\"\\\"\\\"\\n Remove storage classes. Silence any output.\\n \\\"\\\"\\\"\\n print(\\\"Removing StorageClasses\\\")\\n cmd = [KUBECTL, \\\"get\\\", \\\"storageclasses\\\", \\\"-o=name\\\"]\\n res = run_silently(cmd)\\n classes = []\\n if res:\\n classes = res.split()\\n for cs in classes:\\n if \\\"microk8s-hostpath\\\" in cs:\\n continue\\n cmd = [KUBECTL, \\\"delete\\\", cs, \\\"--timeout=60s\\\"]\\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\\n\\n\\ndef remove_priority_classes():\\n \\\"\\\"\\\"\\n Remove priority classes. Silence any output.\\n \\\"\\\"\\\"\\n print(\\\"Removing PriorityClasses\\\")\\n cmd = [KUBECTL, \\\"get\\\", \\\"priorityclasses\\\", \\\"-o=name\\\"]\\n res = run_silently(cmd)\\n classes = []\\n if res:\\n classes = res.split()\\n for cs in classes:\\n if \\\"system-cluster-critical\\\" in cs or \\\"system-node-critical\\\" in cs:\\n continue\\n cmd = [KUBECTL, \\\"delete\\\", cs, \\\"--timeout=60s\\\"]\\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\\n\\n\\ndef reset_cert_reissue():\\n \\\"\\\"\\\"\\n Remove the certificate no refresh lock.\\n \\\"\\\"\\\"\\n lock = snap_data() / \\\"var\\\" / \\\"lock\\\" / \\\"no-cert-reissue\\\"\\n if lock.exists():\\n cmd = f\\\"rm -rf {lock}\\\"\\n subprocess.run(cmd.split())\\n\\n\\ndef remove_binaries():\\n \\\"\\\"\\\"\\n Remove binaries pulled in by addons.\\n \\\"\\\"\\\"\\n bins_dir = snap_data() / \\\"bin\\\"\\n if bins_dir.exists():\\n shutil.rmtree(bins_dir)\\n\\n\\ndef restart_cluster():\\n \\\"\\\"\\\"\\n Restart a cluster by calling the stop and start wrappers.\\n \\\"\\\"\\\"\\n print(\\\"Restarting cluster\\\")\\n cmd = [f\\\"{os.environ['SNAP']}/microk8s-stop.wrapper\\\"]\\n subprocess.run(cmd)\\n time.sleep(5)\\n cmd = [f\\\"{os.environ['SNAP']}/microk8s-start.wrapper\\\"]\\n subprocess.run(cmd)\\n wait_for_ready(timeout=30)\\n ensure_started()\\n\\n\\ndef remove_extra_resources(ns_name):\\n # Remove all resource types except the standard k8s apiservices themselves\\n cmd = [KUBECTL, \\\"api-resources\\\", \\\"-o\\\", \\\"name\\\", \\\"--verbs=delete\\\", \\\"--namespaced=true\\\"]\\n res = run_silently(cmd)\\n if not res:\\n return\\n extra_resources = res.split()\\n for rs in extra_resources:\\n if rs.startswith(\\\"apiservices\\\"):\\n continue\\n cmd = [KUBECTL, \\\"delete\\\", \\\"--all\\\", rs, \\\"-n\\\", ns_name, \\\"--timeout=3s\\\"]\\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\\n\\n\\ndef run_silently(cmd):\\n result = subprocess.run(\\n cmd, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE\\n )\\n\\n try:\\n result.check_returncode()\\n except subprocess.CalledProcessError:\\n return None\\n\\n return result.stdout.decode(\\\"utf-8\\\")\\n\\n\\ndef preflight_check():\\n \\\"\\\"\\\"\\n Preliminary checks to see if we can proceed with cluster reset\\n \\\"\\\"\\\"\\n exit_if_no_root()\\n exit_if_no_permission()\\n is_cluster_locked()\\n ensure_started()\\n wait_for_ready(timeout=30)\\n exit_if_multinode()\\n\\n\\n@click.command(context_settings={\\\"help_option_names\\\": [\\\"-h\\\", \\\"--help\\\"]})\\n@click.option(\\n \\\"--destroy-storage\\\",\\n is_flag=True,\\n required=False,\\n default=True,\\n help=\\\"Also destroy storage. (default: false)\\\",\\n)\\ndef reset(destroy_storage):\\n \\\"\\\"\\\"\\n Return the MicroK8s node to the default initial state.\\n\\n This process may take some time. All addons will be disabled and\\n the configuration will be reinitialized.\\n \\\"\\\"\\\"\\n preflight_check()\\n disable_addons(destroy_storage)\\n cni(\\\"delete\\\")\\n clean_cluster()\\n cni(\\\"apply\\\")\\n\\n\\nif __name__ == \\\"__main__\\\":\\n reset(prog_name=\\\"microk8s reset\\\")\\n\",\n \"path\": \"scripts/wrappers/reset.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/scripts/wrappers/reset.py b/scripts/wrappers/reset.py\nindex b0b5f44c68..fd6ec252a0 100644\n--- a/scripts/wrappers/reset.py\n+++ b/scripts/wrappers/reset.py\n@@ -232,7 +232,7 @@ def remove_extra_resources(ns_name):\n for rs in extra_resources:\n if rs.startswith(\"apiservices\"):\n continue\n- cmd = [KUBECTL, \"delete\", \"--all\", \"-n\", ns_name, \"--timeout=60s\"]\n+ cmd = [KUBECTL, \"delete\", \"--all\", rs, \"-n\", ns_name, \"--timeout=3s\"]\n subprocess.run(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)\n \n \n"}}},{"rowIdx":4695,"cells":{"in_source_id":{"kind":"string","value":"internetarchive__openlibrary-7789"},"issue":{"kind":"string","value":"Fix git SHA on website + status page (dupe?)\n<!-- What problem are we solving? What does the experience look like today? What are the symptoms? -->\r\n\r\nThe footer + https://openlibrary.org/status should both show the website's git sha. Somewhere down the road we had a regression.\r\n\r\n### Evidence / Screenshot (if possible)\r\n\r\n### Relevant url?\r\n<!-- `https://openlibrary.org/...` -->\r\n\r\n### Steps to Reproduce\r\n<!-- What steps caused you to find the bug? -->\r\n1. Go to ...\r\n2. Do ...\r\n\r\n<!-- What actually happened after these steps? What did you expect to happen? -->\r\n* Actual:\r\n* Expected:\r\n\r\n### Details\r\n\r\n- **Logged in (Y/N)?**\r\n- **Browser type/version?**\r\n- **Operating system?**\r\n- **Environment (prod/dev/local)?** prod\r\n<!-- If not sure, put prod -->\r\n\r\n### Proposal & Constraints\r\n<!-- What is the proposed solution / implementation? Is there a precedent of this approach succeeding elsewhere? -->\r\n\r\n### Related files\r\n<!-- Files related to this issue; this is super useful for new contributors who might want to help! If you're not sure, leave this blank; a maintainer will add them. -->\r\n\r\n### Stakeholders\r\n<!-- @ tag stakeholders of this bug -->\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"\"\"\"Generic utilities\"\"\"\n\nfrom enum import Enum\nimport re\nfrom subprocess import run\nfrom typing import TypeVar, Literal, Optional\nfrom collections.abc import Iterable, Callable\n\nto_drop = set(''';/?:@&=+$,<>#%\"{}|\\\\^[]`\\n\\r''')\n\n\ndef str_to_key(s: str) -> str:\n \"\"\"\n >>> str_to_key(\"?H$e##l{o}[0] -world!\")\n 'helo0_-world!'\n >>> str_to_key(\"\".join(to_drop))\n ''\n >>> str_to_key(\"\")\n ''\n \"\"\"\n return ''.join(c if c != ' ' else '_' for c in s.lower() if c not in to_drop)\n\n\ndef finddict(dicts, **filters):\n \"\"\"Find a dictionary that matches given filter conditions.\n\n >>> dicts = [{\"x\": 1, \"y\": 2}, {\"x\": 3, \"y\": 4}]\n >>> sorted(finddict(dicts, x=1).items())\n [('x', 1), ('y', 2)]\n \"\"\"\n for d in dicts:\n if all(d.get(k) == v for k, v in filters.items()):\n return d\n\n\nT = TypeVar('T')\n\n\ndef uniq(values: Iterable[T], key=None) -> list[T]:\n \"\"\"Returns the unique entries from the given values in the original order.\n\n The value of the optional `key` parameter should be a function that takes\n a single argument and returns a key to test the uniqueness.\n TODO: Moved this to core/utils.py\n\n >>> uniq(\"abcbcddefefg\")\n ['a', 'b', 'c', 'd', 'e', 'f', 'g']\n >>> uniq(\"011223344556677889\")\n ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9']\n \"\"\"\n key = key or (lambda x: x)\n s = set()\n result = []\n for v in values:\n k = key(v)\n if k not in s:\n s.add(k)\n result.append(v)\n return result\n\n\ndef take_best(\n items: list[T],\n optimization: Literal[\"min\", \"max\"],\n scoring_fn: Callable[[T], float],\n) -> list[T]:\n \"\"\"\n >>> take_best([], 'min', lambda x: x)\n []\n >>> take_best([3, 2, 1], 'min', lambda x: x)\n [1]\n >>> take_best([3, 4, 5], 'max', lambda x: x)\n [5]\n >>> take_best([4, 1, -1, -1], 'min', lambda x: x)\n [-1, -1]\n \"\"\"\n best_score = float(\"-inf\") if optimization == \"max\" else float(\"inf\")\n besties = []\n for item in items:\n score = scoring_fn(item)\n if (optimization == \"max\" and score > best_score) or (\n optimization == \"min\" and score < best_score\n ):\n best_score = score\n besties = [item]\n elif score == best_score:\n besties.append(item)\n else:\n continue\n return besties\n\n\ndef multisort_best(\n items: list[T], specs: list[tuple[Literal[\"min\", \"max\"], Callable[[T], float]]]\n) -> Optional[T]:\n \"\"\"\n Takes the best item, taking into account the multisorts\n\n >>> multisort_best([], [])\n\n >>> multisort_best([3,4,5], [('max', lambda x: x)])\n 5\n\n >>> multisort_best([\n ... {'provider': 'ia', 'size': 4},\n ... {'provider': 'ia', 'size': 12},\n ... {'provider': None, 'size': 42},\n ... ], [\n ... ('min', lambda x: 0 if x['provider'] == 'ia' else 1),\n ... ('max', lambda x: x['size']),\n ... ])\n {'provider': 'ia', 'size': 12}\n \"\"\"\n if not items:\n return None\n pool = items\n for optimization, fn in specs:\n # Shrink the pool down each time\n pool = take_best(pool, optimization, fn)\n return pool[0]\n\n\ndef dicthash(d):\n \"\"\"Dictionaries are not hashable. This function converts dictionary into nested\n tuples, so that it can hashed.\n \"\"\"\n if isinstance(d, dict):\n return tuple((k, dicthash(d[k])) for k in sorted(d))\n elif isinstance(d, list):\n return tuple(dicthash(v) for v in d)\n else:\n return d\n\n\nauthor_olid_embedded_re = re.compile(r'OL\\d+A', re.IGNORECASE)\n\n\ndef find_author_olid_in_string(s):\n \"\"\"\n >>> find_author_olid_in_string(\"ol123a\")\n 'OL123A'\n >>> find_author_olid_in_string(\"/authors/OL123A/edit\")\n 'OL123A'\n >>> find_author_olid_in_string(\"some random string\")\n \"\"\"\n found = re.search(author_olid_embedded_re, s)\n return found and found.group(0).upper()\n\n\nwork_olid_embedded_re = re.compile(r'OL\\d+W', re.IGNORECASE)\n\n\ndef find_work_olid_in_string(s):\n \"\"\"\n >>> find_work_olid_in_string(\"ol123w\")\n 'OL123W'\n >>> find_work_olid_in_string(\"/works/OL123W/Title_of_book\")\n 'OL123W'\n >>> find_work_olid_in_string(\"some random string\")\n \"\"\"\n found = re.search(work_olid_embedded_re, s)\n return found and found.group(0).upper()\n\n\ndef extract_numeric_id_from_olid(olid):\n \"\"\"\n >>> extract_numeric_id_from_olid(\"OL123W\")\n '123'\n >>> extract_numeric_id_from_olid(\"/authors/OL123A\")\n '123'\n \"\"\"\n if '/' in olid:\n olid = olid.split('/')[-1]\n if olid.lower().startswith('ol'):\n olid = olid[2:]\n if not is_number(olid[-1].lower()):\n olid = olid[:-1]\n return olid\n\n\ndef is_number(s):\n \"\"\"\n >>> all(is_number(n) for n in (1234, \"1234\", -1234, \"-1234\", 123.4, -123.4))\n True\n >>> not any(is_number(n) for n in (\"123.4\", \"-123.4\", \"123a\", \"--1234\"))\n True\n \"\"\"\n try:\n int(s)\n return True\n except ValueError:\n return False\n\n\ndef get_software_version() -> str:\n cmd = \"git rev-parse --short HEAD --\".split()\n return run(cmd, text=True).stdout\n\n\n# See https://docs.python.org/3/library/enum.html#orderedenum\nclass OrderedEnum(Enum):\n def __ge__(self, other):\n if self.__class__ is other.__class__:\n return self.value >= other.value\n return NotImplemented\n\n def __gt__(self, other):\n if self.__class__ is other.__class__:\n return self.value > other.value\n return NotImplemented\n\n def __le__(self, other):\n if self.__class__ is other.__class__:\n return self.value <= other.value\n return NotImplemented\n\n def __lt__(self, other):\n if self.__class__ is other.__class__:\n return self.value < other.value\n return NotImplemented\n","path":"openlibrary/utils/__init__.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"Generic utilities\\\"\\\"\\\"\\n\\nfrom enum import Enum\\nimport re\\nfrom subprocess import run\\nfrom typing import TypeVar, Literal, Optional\\nfrom collections.abc import Iterable, Callable\\n\\nto_drop = set(''';/?:@&=+$,<>#%\\\"{}|\\\\\\\\^[]`\\\\n\\\\r''')\\n\\n\\ndef str_to_key(s: str) -> str:\\n \\\"\\\"\\\"\\n >>> str_to_key(\\\"?H$e##l{o}[0] -world!\\\")\\n 'helo0_-world!'\\n >>> str_to_key(\\\"\\\".join(to_drop))\\n ''\\n >>> str_to_key(\\\"\\\")\\n ''\\n \\\"\\\"\\\"\\n return ''.join(c if c != ' ' else '_' for c in s.lower() if c not in to_drop)\\n\\n\\ndef finddict(dicts, **filters):\\n \\\"\\\"\\\"Find a dictionary that matches given filter conditions.\\n\\n >>> dicts = [{\\\"x\\\": 1, \\\"y\\\": 2}, {\\\"x\\\": 3, \\\"y\\\": 4}]\\n >>> sorted(finddict(dicts, x=1).items())\\n [('x', 1), ('y', 2)]\\n \\\"\\\"\\\"\\n for d in dicts:\\n if all(d.get(k) == v for k, v in filters.items()):\\n return d\\n\\n\\nT = TypeVar('T')\\n\\n\\ndef uniq(values: Iterable[T], key=None) -> list[T]:\\n \\\"\\\"\\\"Returns the unique entries from the given values in the original order.\\n\\n The value of the optional `key` parameter should be a function that takes\\n a single argument and returns a key to test the uniqueness.\\n TODO: Moved this to core/utils.py\\n\\n >>> uniq(\\\"abcbcddefefg\\\")\\n ['a', 'b', 'c', 'd', 'e', 'f', 'g']\\n >>> uniq(\\\"011223344556677889\\\")\\n ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9']\\n \\\"\\\"\\\"\\n key = key or (lambda x: x)\\n s = set()\\n result = []\\n for v in values:\\n k = key(v)\\n if k not in s:\\n s.add(k)\\n result.append(v)\\n return result\\n\\n\\ndef take_best(\\n items: list[T],\\n optimization: Literal[\\\"min\\\", \\\"max\\\"],\\n scoring_fn: Callable[[T], float],\\n) -> list[T]:\\n \\\"\\\"\\\"\\n >>> take_best([], 'min', lambda x: x)\\n []\\n >>> take_best([3, 2, 1], 'min', lambda x: x)\\n [1]\\n >>> take_best([3, 4, 5], 'max', lambda x: x)\\n [5]\\n >>> take_best([4, 1, -1, -1], 'min', lambda x: x)\\n [-1, -1]\\n \\\"\\\"\\\"\\n best_score = float(\\\"-inf\\\") if optimization == \\\"max\\\" else float(\\\"inf\\\")\\n besties = []\\n for item in items:\\n score = scoring_fn(item)\\n if (optimization == \\\"max\\\" and score > best_score) or (\\n optimization == \\\"min\\\" and score < best_score\\n ):\\n best_score = score\\n besties = [item]\\n elif score == best_score:\\n besties.append(item)\\n else:\\n continue\\n return besties\\n\\n\\ndef multisort_best(\\n items: list[T], specs: list[tuple[Literal[\\\"min\\\", \\\"max\\\"], Callable[[T], float]]]\\n) -> Optional[T]:\\n \\\"\\\"\\\"\\n Takes the best item, taking into account the multisorts\\n\\n >>> multisort_best([], [])\\n\\n >>> multisort_best([3,4,5], [('max', lambda x: x)])\\n 5\\n\\n >>> multisort_best([\\n ... {'provider': 'ia', 'size': 4},\\n ... {'provider': 'ia', 'size': 12},\\n ... {'provider': None, 'size': 42},\\n ... ], [\\n ... ('min', lambda x: 0 if x['provider'] == 'ia' else 1),\\n ... ('max', lambda x: x['size']),\\n ... ])\\n {'provider': 'ia', 'size': 12}\\n \\\"\\\"\\\"\\n if not items:\\n return None\\n pool = items\\n for optimization, fn in specs:\\n # Shrink the pool down each time\\n pool = take_best(pool, optimization, fn)\\n return pool[0]\\n\\n\\ndef dicthash(d):\\n \\\"\\\"\\\"Dictionaries are not hashable. This function converts dictionary into nested\\n tuples, so that it can hashed.\\n \\\"\\\"\\\"\\n if isinstance(d, dict):\\n return tuple((k, dicthash(d[k])) for k in sorted(d))\\n elif isinstance(d, list):\\n return tuple(dicthash(v) for v in d)\\n else:\\n return d\\n\\n\\nauthor_olid_embedded_re = re.compile(r'OL\\\\d+A', re.IGNORECASE)\\n\\n\\ndef find_author_olid_in_string(s):\\n \\\"\\\"\\\"\\n >>> find_author_olid_in_string(\\\"ol123a\\\")\\n 'OL123A'\\n >>> find_author_olid_in_string(\\\"/authors/OL123A/edit\\\")\\n 'OL123A'\\n >>> find_author_olid_in_string(\\\"some random string\\\")\\n \\\"\\\"\\\"\\n found = re.search(author_olid_embedded_re, s)\\n return found and found.group(0).upper()\\n\\n\\nwork_olid_embedded_re = re.compile(r'OL\\\\d+W', re.IGNORECASE)\\n\\n\\ndef find_work_olid_in_string(s):\\n \\\"\\\"\\\"\\n >>> find_work_olid_in_string(\\\"ol123w\\\")\\n 'OL123W'\\n >>> find_work_olid_in_string(\\\"/works/OL123W/Title_of_book\\\")\\n 'OL123W'\\n >>> find_work_olid_in_string(\\\"some random string\\\")\\n \\\"\\\"\\\"\\n found = re.search(work_olid_embedded_re, s)\\n return found and found.group(0).upper()\\n\\n\\ndef extract_numeric_id_from_olid(olid):\\n \\\"\\\"\\\"\\n >>> extract_numeric_id_from_olid(\\\"OL123W\\\")\\n '123'\\n >>> extract_numeric_id_from_olid(\\\"/authors/OL123A\\\")\\n '123'\\n \\\"\\\"\\\"\\n if '/' in olid:\\n olid = olid.split('/')[-1]\\n if olid.lower().startswith('ol'):\\n olid = olid[2:]\\n if not is_number(olid[-1].lower()):\\n olid = olid[:-1]\\n return olid\\n\\n\\ndef is_number(s):\\n \\\"\\\"\\\"\\n >>> all(is_number(n) for n in (1234, \\\"1234\\\", -1234, \\\"-1234\\\", 123.4, -123.4))\\n True\\n >>> not any(is_number(n) for n in (\\\"123.4\\\", \\\"-123.4\\\", \\\"123a\\\", \\\"--1234\\\"))\\n True\\n \\\"\\\"\\\"\\n try:\\n int(s)\\n return True\\n except ValueError:\\n return False\\n\\n\\ndef get_software_version() -> str:\\n cmd = \\\"git rev-parse --short HEAD --\\\".split()\\n return run(cmd, text=True).stdout\\n\\n\\n# See https://docs.python.org/3/library/enum.html#orderedenum\\nclass OrderedEnum(Enum):\\n def __ge__(self, other):\\n if self.__class__ is other.__class__:\\n return self.value >= other.value\\n return NotImplemented\\n\\n def __gt__(self, other):\\n if self.__class__ is other.__class__:\\n return self.value > other.value\\n return NotImplemented\\n\\n def __le__(self, other):\\n if self.__class__ is other.__class__:\\n return self.value <= other.value\\n return NotImplemented\\n\\n def __lt__(self, other):\\n if self.__class__ is other.__class__:\\n return self.value < other.value\\n return NotImplemented\\n\",\n \"path\": \"openlibrary/utils/__init__.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"\"\"\"Generic utilities\"\"\"\n\nfrom enum import Enum\nimport re\nfrom subprocess import run\nfrom typing import TypeVar, Literal, Optional\nfrom collections.abc import Iterable, Callable\n\nto_drop = set(''';/?:@&=+$,<>#%\"{}|\\\\^[]`\\n\\r''')\n\n\ndef str_to_key(s: str) -> str:\n \"\"\"\n >>> str_to_key(\"?H$e##l{o}[0] -world!\")\n 'helo0_-world!'\n >>> str_to_key(\"\".join(to_drop))\n ''\n >>> str_to_key(\"\")\n ''\n \"\"\"\n return ''.join(c if c != ' ' else '_' for c in s.lower() if c not in to_drop)\n\n\ndef finddict(dicts, **filters):\n \"\"\"Find a dictionary that matches given filter conditions.\n\n >>> dicts = [{\"x\": 1, \"y\": 2}, {\"x\": 3, \"y\": 4}]\n >>> sorted(finddict(dicts, x=1).items())\n [('x', 1), ('y', 2)]\n \"\"\"\n for d in dicts:\n if all(d.get(k) == v for k, v in filters.items()):\n return d\n\n\nT = TypeVar('T')\n\n\ndef uniq(values: Iterable[T], key=None) -> list[T]:\n \"\"\"Returns the unique entries from the given values in the original order.\n\n The value of the optional `key` parameter should be a function that takes\n a single argument and returns a key to test the uniqueness.\n TODO: Moved this to core/utils.py\n\n >>> uniq(\"abcbcddefefg\")\n ['a', 'b', 'c', 'd', 'e', 'f', 'g']\n >>> uniq(\"011223344556677889\")\n ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9']\n \"\"\"\n key = key or (lambda x: x)\n s = set()\n result = []\n for v in values:\n k = key(v)\n if k not in s:\n s.add(k)\n result.append(v)\n return result\n\n\ndef take_best(\n items: list[T],\n optimization: Literal[\"min\", \"max\"],\n scoring_fn: Callable[[T], float],\n) -> list[T]:\n \"\"\"\n >>> take_best([], 'min', lambda x: x)\n []\n >>> take_best([3, 2, 1], 'min', lambda x: x)\n [1]\n >>> take_best([3, 4, 5], 'max', lambda x: x)\n [5]\n >>> take_best([4, 1, -1, -1], 'min', lambda x: x)\n [-1, -1]\n \"\"\"\n best_score = float(\"-inf\") if optimization == \"max\" else float(\"inf\")\n besties = []\n for item in items:\n score = scoring_fn(item)\n if (optimization == \"max\" and score > best_score) or (\n optimization == \"min\" and score < best_score\n ):\n best_score = score\n besties = [item]\n elif score == best_score:\n besties.append(item)\n else:\n continue\n return besties\n\n\ndef multisort_best(\n items: list[T], specs: list[tuple[Literal[\"min\", \"max\"], Callable[[T], float]]]\n) -> Optional[T]:\n \"\"\"\n Takes the best item, taking into account the multisorts\n\n >>> multisort_best([], [])\n\n >>> multisort_best([3,4,5], [('max', lambda x: x)])\n 5\n\n >>> multisort_best([\n ... {'provider': 'ia', 'size': 4},\n ... {'provider': 'ia', 'size': 12},\n ... {'provider': None, 'size': 42},\n ... ], [\n ... ('min', lambda x: 0 if x['provider'] == 'ia' else 1),\n ... ('max', lambda x: x['size']),\n ... ])\n {'provider': 'ia', 'size': 12}\n \"\"\"\n if not items:\n return None\n pool = items\n for optimization, fn in specs:\n # Shrink the pool down each time\n pool = take_best(pool, optimization, fn)\n return pool[0]\n\n\ndef dicthash(d):\n \"\"\"Dictionaries are not hashable. This function converts dictionary into nested\n tuples, so that it can hashed.\n \"\"\"\n if isinstance(d, dict):\n return tuple((k, dicthash(d[k])) for k in sorted(d))\n elif isinstance(d, list):\n return tuple(dicthash(v) for v in d)\n else:\n return d\n\n\nauthor_olid_embedded_re = re.compile(r'OL\\d+A', re.IGNORECASE)\n\n\ndef find_author_olid_in_string(s):\n \"\"\"\n >>> find_author_olid_in_string(\"ol123a\")\n 'OL123A'\n >>> find_author_olid_in_string(\"/authors/OL123A/edit\")\n 'OL123A'\n >>> find_author_olid_in_string(\"some random string\")\n \"\"\"\n found = re.search(author_olid_embedded_re, s)\n return found and found.group(0).upper()\n\n\nwork_olid_embedded_re = re.compile(r'OL\\d+W', re.IGNORECASE)\n\n\ndef find_work_olid_in_string(s):\n \"\"\"\n >>> find_work_olid_in_string(\"ol123w\")\n 'OL123W'\n >>> find_work_olid_in_string(\"/works/OL123W/Title_of_book\")\n 'OL123W'\n >>> find_work_olid_in_string(\"some random string\")\n \"\"\"\n found = re.search(work_olid_embedded_re, s)\n return found and found.group(0).upper()\n\n\ndef extract_numeric_id_from_olid(olid):\n \"\"\"\n >>> extract_numeric_id_from_olid(\"OL123W\")\n '123'\n >>> extract_numeric_id_from_olid(\"/authors/OL123A\")\n '123'\n \"\"\"\n if '/' in olid:\n olid = olid.split('/')[-1]\n if olid.lower().startswith('ol'):\n olid = olid[2:]\n if not is_number(olid[-1].lower()):\n olid = olid[:-1]\n return olid\n\n\ndef is_number(s):\n \"\"\"\n >>> all(is_number(n) for n in (1234, \"1234\", -1234, \"-1234\", 123.4, -123.4))\n True\n >>> not any(is_number(n) for n in (\"123.4\", \"-123.4\", \"123a\", \"--1234\"))\n True\n \"\"\"\n try:\n int(s)\n return True\n except ValueError:\n return False\n\n\ndef get_software_version() -> str:\n \"\"\"\n assert get_software_version() # Should never return a falsy value\n \"\"\"\n cmd = \"git rev-parse --short HEAD --\".split()\n return run(cmd, capture_output=True, text=True).stdout.strip()\n\n\n# See https://docs.python.org/3/library/enum.html#orderedenum\nclass OrderedEnum(Enum):\n def __ge__(self, other):\n if self.__class__ is other.__class__:\n return self.value >= other.value\n return NotImplemented\n\n def __gt__(self, other):\n if self.__class__ is other.__class__:\n return self.value > other.value\n return NotImplemented\n\n def __le__(self, other):\n if self.__class__ is other.__class__:\n return self.value <= other.value\n return NotImplemented\n\n def __lt__(self, other):\n if self.__class__ is other.__class__:\n return self.value < other.value\n return NotImplemented\n","path":"openlibrary/utils/__init__.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"Generic utilities\\\"\\\"\\\"\\n\\nfrom enum import Enum\\nimport re\\nfrom subprocess import run\\nfrom typing import TypeVar, Literal, Optional\\nfrom collections.abc import Iterable, Callable\\n\\nto_drop = set(''';/?:@&=+$,<>#%\\\"{}|\\\\\\\\^[]`\\\\n\\\\r''')\\n\\n\\ndef str_to_key(s: str) -> str:\\n \\\"\\\"\\\"\\n >>> str_to_key(\\\"?H$e##l{o}[0] -world!\\\")\\n 'helo0_-world!'\\n >>> str_to_key(\\\"\\\".join(to_drop))\\n ''\\n >>> str_to_key(\\\"\\\")\\n ''\\n \\\"\\\"\\\"\\n return ''.join(c if c != ' ' else '_' for c in s.lower() if c not in to_drop)\\n\\n\\ndef finddict(dicts, **filters):\\n \\\"\\\"\\\"Find a dictionary that matches given filter conditions.\\n\\n >>> dicts = [{\\\"x\\\": 1, \\\"y\\\": 2}, {\\\"x\\\": 3, \\\"y\\\": 4}]\\n >>> sorted(finddict(dicts, x=1).items())\\n [('x', 1), ('y', 2)]\\n \\\"\\\"\\\"\\n for d in dicts:\\n if all(d.get(k) == v for k, v in filters.items()):\\n return d\\n\\n\\nT = TypeVar('T')\\n\\n\\ndef uniq(values: Iterable[T], key=None) -> list[T]:\\n \\\"\\\"\\\"Returns the unique entries from the given values in the original order.\\n\\n The value of the optional `key` parameter should be a function that takes\\n a single argument and returns a key to test the uniqueness.\\n TODO: Moved this to core/utils.py\\n\\n >>> uniq(\\\"abcbcddefefg\\\")\\n ['a', 'b', 'c', 'd', 'e', 'f', 'g']\\n >>> uniq(\\\"011223344556677889\\\")\\n ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9']\\n \\\"\\\"\\\"\\n key = key or (lambda x: x)\\n s = set()\\n result = []\\n for v in values:\\n k = key(v)\\n if k not in s:\\n s.add(k)\\n result.append(v)\\n return result\\n\\n\\ndef take_best(\\n items: list[T],\\n optimization: Literal[\\\"min\\\", \\\"max\\\"],\\n scoring_fn: Callable[[T], float],\\n) -> list[T]:\\n \\\"\\\"\\\"\\n >>> take_best([], 'min', lambda x: x)\\n []\\n >>> take_best([3, 2, 1], 'min', lambda x: x)\\n [1]\\n >>> take_best([3, 4, 5], 'max', lambda x: x)\\n [5]\\n >>> take_best([4, 1, -1, -1], 'min', lambda x: x)\\n [-1, -1]\\n \\\"\\\"\\\"\\n best_score = float(\\\"-inf\\\") if optimization == \\\"max\\\" else float(\\\"inf\\\")\\n besties = []\\n for item in items:\\n score = scoring_fn(item)\\n if (optimization == \\\"max\\\" and score > best_score) or (\\n optimization == \\\"min\\\" and score < best_score\\n ):\\n best_score = score\\n besties = [item]\\n elif score == best_score:\\n besties.append(item)\\n else:\\n continue\\n return besties\\n\\n\\ndef multisort_best(\\n items: list[T], specs: list[tuple[Literal[\\\"min\\\", \\\"max\\\"], Callable[[T], float]]]\\n) -> Optional[T]:\\n \\\"\\\"\\\"\\n Takes the best item, taking into account the multisorts\\n\\n >>> multisort_best([], [])\\n\\n >>> multisort_best([3,4,5], [('max', lambda x: x)])\\n 5\\n\\n >>> multisort_best([\\n ... {'provider': 'ia', 'size': 4},\\n ... {'provider': 'ia', 'size': 12},\\n ... {'provider': None, 'size': 42},\\n ... ], [\\n ... ('min', lambda x: 0 if x['provider'] == 'ia' else 1),\\n ... ('max', lambda x: x['size']),\\n ... ])\\n {'provider': 'ia', 'size': 12}\\n \\\"\\\"\\\"\\n if not items:\\n return None\\n pool = items\\n for optimization, fn in specs:\\n # Shrink the pool down each time\\n pool = take_best(pool, optimization, fn)\\n return pool[0]\\n\\n\\ndef dicthash(d):\\n \\\"\\\"\\\"Dictionaries are not hashable. This function converts dictionary into nested\\n tuples, so that it can hashed.\\n \\\"\\\"\\\"\\n if isinstance(d, dict):\\n return tuple((k, dicthash(d[k])) for k in sorted(d))\\n elif isinstance(d, list):\\n return tuple(dicthash(v) for v in d)\\n else:\\n return d\\n\\n\\nauthor_olid_embedded_re = re.compile(r'OL\\\\d+A', re.IGNORECASE)\\n\\n\\ndef find_author_olid_in_string(s):\\n \\\"\\\"\\\"\\n >>> find_author_olid_in_string(\\\"ol123a\\\")\\n 'OL123A'\\n >>> find_author_olid_in_string(\\\"/authors/OL123A/edit\\\")\\n 'OL123A'\\n >>> find_author_olid_in_string(\\\"some random string\\\")\\n \\\"\\\"\\\"\\n found = re.search(author_olid_embedded_re, s)\\n return found and found.group(0).upper()\\n\\n\\nwork_olid_embedded_re = re.compile(r'OL\\\\d+W', re.IGNORECASE)\\n\\n\\ndef find_work_olid_in_string(s):\\n \\\"\\\"\\\"\\n >>> find_work_olid_in_string(\\\"ol123w\\\")\\n 'OL123W'\\n >>> find_work_olid_in_string(\\\"/works/OL123W/Title_of_book\\\")\\n 'OL123W'\\n >>> find_work_olid_in_string(\\\"some random string\\\")\\n \\\"\\\"\\\"\\n found = re.search(work_olid_embedded_re, s)\\n return found and found.group(0).upper()\\n\\n\\ndef extract_numeric_id_from_olid(olid):\\n \\\"\\\"\\\"\\n >>> extract_numeric_id_from_olid(\\\"OL123W\\\")\\n '123'\\n >>> extract_numeric_id_from_olid(\\\"/authors/OL123A\\\")\\n '123'\\n \\\"\\\"\\\"\\n if '/' in olid:\\n olid = olid.split('/')[-1]\\n if olid.lower().startswith('ol'):\\n olid = olid[2:]\\n if not is_number(olid[-1].lower()):\\n olid = olid[:-1]\\n return olid\\n\\n\\ndef is_number(s):\\n \\\"\\\"\\\"\\n >>> all(is_number(n) for n in (1234, \\\"1234\\\", -1234, \\\"-1234\\\", 123.4, -123.4))\\n True\\n >>> not any(is_number(n) for n in (\\\"123.4\\\", \\\"-123.4\\\", \\\"123a\\\", \\\"--1234\\\"))\\n True\\n \\\"\\\"\\\"\\n try:\\n int(s)\\n return True\\n except ValueError:\\n return False\\n\\n\\ndef get_software_version() -> str:\\n \\\"\\\"\\\"\\n assert get_software_version() # Should never return a falsy value\\n \\\"\\\"\\\"\\n cmd = \\\"git rev-parse --short HEAD --\\\".split()\\n return run(cmd, capture_output=True, text=True).stdout.strip()\\n\\n\\n# See https://docs.python.org/3/library/enum.html#orderedenum\\nclass OrderedEnum(Enum):\\n def __ge__(self, other):\\n if self.__class__ is other.__class__:\\n return self.value >= other.value\\n return NotImplemented\\n\\n def __gt__(self, other):\\n if self.__class__ is other.__class__:\\n return self.value > other.value\\n return NotImplemented\\n\\n def __le__(self, other):\\n if self.__class__ is other.__class__:\\n return self.value <= other.value\\n return NotImplemented\\n\\n def __lt__(self, other):\\n if self.__class__ is other.__class__:\\n return self.value < other.value\\n return NotImplemented\\n\",\n \"path\": \"openlibrary/utils/__init__.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/openlibrary/utils/__init__.py b/openlibrary/utils/__init__.py\nindex 632b8bdc752..23839c0b139 100644\n--- a/openlibrary/utils/__init__.py\n+++ b/openlibrary/utils/__init__.py\n@@ -193,8 +193,11 @@ def is_number(s):\n \n \n def get_software_version() -> str:\n+ \"\"\"\n+ assert get_software_version() # Should never return a falsy value\n+ \"\"\"\n cmd = \"git rev-parse --short HEAD --\".split()\n- return run(cmd, text=True).stdout\n+ return run(cmd, capture_output=True, text=True).stdout.strip()\n \n \n # See https://docs.python.org/3/library/enum.html#orderedenum\n"}}},{"rowIdx":4696,"cells":{"in_source_id":{"kind":"string","value":"pytorch__pytorch-127219"},"issue":{"kind":"string","value":"[DCP] `set_model_state_dict` errors on compiled module with non-persistent buffer\n```\r\n\"\"\"\r\ntorchrun --standalone --nproc_per_node=2 repro_dcp_compile.py\r\n\"\"\"\r\nimport os\r\nimport torch\r\nimport torch.nn as nn\r\nimport torch.distributed as dist\r\nfrom torch.distributed.checkpoint.state_dict import get_model_state_dict, set_model_state_dict\r\n\r\nclass Model(nn.Module):\r\n def __init__(self):\r\n super().__init__()\r\n self.lin1 = nn.Linear(4, 4)\r\n self.lin2 = nn.Linear(4, 4)\r\n self.register_buffer(\"buf\", torch.randn((4,)), persistent=False)\r\n self.weight = nn.Parameter(torch.randn((4, 4)))\r\n\r\n\r\nif __name__ == \"__main__\":\r\n dist.init_process_group(backend=\"nccl\")\r\n gpu_id = int(os.environ[\"LOCAL_RANK\"])\r\n device = f\"cuda:{gpu_id}\"\r\n torch.cuda.set_device(device)\r\n\r\n model = Model()\r\n model = torch.compile(model)\r\n\r\n sharded_sd = get_model_state_dict(model)\r\n set_model_state_dict(model, sharded_sd)\r\n```\r\n\r\n```\r\n[rank0]: Traceback (most recent call last):\r\n[rank0]: File \"/data/users/andgu/pytorch/repro_dcp_compile.py\", line 36, in <module>\r\n[rank0]: set_model_state_dict(model, sharded_sd)\r\n[rank0]: File \"/data/users/andgu/pytorch/torch/distributed/checkpoint/state_dict.py\", line 853, in set_model_state_dict\r\n[rank0]: return _load_model_state_dict(model, model_state_dict, info)\r\n[rank0]: File \"/data/users/andgu/pytorch/torch/distributed/checkpoint/state_dict.py\", line 416, in _load_model_state_dict\r\n[rank0]: state_dict[fqn_with_prefix] = state_dict.pop(fqn)\r\n[rank0]: KeyError: 'buf'\r\n```\r\n\r\n`set_model_state_dict` calls into `_load_model_state_dict`, which iterates over `named_buffers()`. For a compiled module, `fqns` and `fqns_with_prefix` always mismatch, so `_load_model_state_dict` will try to reassign from the FQN without prefix to the one with prefix. However, this does not account for non-persistent buffers not existing in the state dict.\r\n\r\nOne solution could be just to continue `if fqn not in state_dict`.\r\n\r\n\r\n\r\ncc @LucasLLC\n"},"before_files":{"kind":"list like","value":[{"content":"import contextlib\nimport functools\nimport gc\nfrom dataclasses import asdict, dataclass, field\nfrom itertools import chain\nfrom typing import (\n Any,\n Callable,\n cast,\n Dict,\n Generator,\n Iterable,\n List,\n no_type_check,\n Optional,\n Set,\n Tuple,\n Union,\n)\n\nimport torch\nimport torch.distributed as dist\nimport torch.nn as nn\nfrom torch.distributed._shard.sharded_tensor import ShardedTensor\nfrom torch.distributed._state_dict_utils import (\n _gather_state_dict,\n _offload_state_dict_to_cpu,\n)\nfrom torch.distributed._tensor import DTensor\nfrom torch.distributed.algorithms._checkpoint.checkpoint_wrapper import (\n _CHECKPOINT_PREFIX,\n)\nfrom torch.distributed.fsdp import (\n FullOptimStateDictConfig,\n FullStateDictConfig,\n FullyShardedDataParallel as FSDP,\n OptimStateDictConfig,\n ShardedOptimStateDictConfig,\n ShardedStateDictConfig,\n StateDictConfig,\n StateDictType,\n)\nfrom torch.distributed.fsdp._common_utils import (\n _get_module_fsdp_state_if_fully_sharded_module,\n FSDP_WRAPPED_MODULE,\n)\nfrom torch.nn.modules.module import _IncompatibleKeys\nfrom torch.nn.parallel import DistributedDataParallel as DDP\n\n\nFLAT_PARAM = \"_flat_param\"\nPG = \"param_groups\"\nPG_PREFIX = f\"{PG}.\"\nSTATE = \"state\"\nSTATE_PREFIX = f\"{STATE}.\"\nPARAMS = \"params\"\nFQNS_T = Set[str]\n\n_patched_state_dict: Set[Callable] = set()\n\n\nPrimitiveType = Union[DTensor, ShardedTensor, torch.Tensor, int, float, str]\nValueType = Union[\n PrimitiveType, List[PrimitiveType], Tuple[PrimitiveType], Dict[str, \"ValueType\"]\n]\nDictValueType = Dict[str, ValueType]\nListDictValueType = List[DictValueType]\nOptimizerStateType = Dict[str, Union[DictValueType, ListDictValueType]]\n\n\n@contextlib.contextmanager\ndef gc_context():\n is_enabled = gc.isenabled()\n gc.disable()\n try:\n yield\n finally:\n # TODO: add logging for the gc details/time\n gc.collect()\n if is_enabled:\n gc.enable()\n\n\n@dataclass\nclass StateDictOptions:\n \"\"\"\n This dataclass specifies how get_state_dict/set_state_dict will work.\n\n - ``full_state_dict``: if this is set to True, all the tensors in the\n returned state_dict will be gathered. No ShardedTensor and DTensor\n will be in the returned state_dict.\n\n - ``cpu_offload``: offload all the tensors to cpu. To prevent CPU OOM, if\n ``full_state_dict`` is also true, then only the rank0 will get the\n state_dict and all other ranks will get empty state_dict.\n\n - ``ignore_frozen_params``: if the value is True, the returned state_dict\n won't contain any frozen parameters -- the ``requires_grad`` is False.\n The default value is False.\n\n - ``keep_submodule_prefixes``: when ``submodules`` is not None, this option\n indicates whether to keep the submodule prefixes from the state_dict keys.\n or example, if the submodule is ``module.pretrain`` and the full FQN of\n the parameter is ``pretrain.layer1.weight`` of the param. When this option\n is True, the parameter's key in the returned state_dict will be\n ``pretrain.layer1.weight``. If the options is False, the key will be\n ``layer1.weight``.\n Note that if ``keep_submodule_prefixes`` is False, there may be conflicted\n FQNs, hence there should be only one submodule in ``submodules``.\n\n - ``strict``: the ``strict`` option when ``set_state_dict`` calls\n model.load_state_dict().\n The default value is False.\n \"\"\"\n\n full_state_dict: bool = False\n cpu_offload: bool = False\n ignore_frozen_params: bool = False\n keep_submodule_prefixes: bool = True\n strict: bool = True\n\n\n@dataclass\nclass _StateDictInfo(StateDictOptions):\n fqn_param_mapping: Dict[\n Union[str, torch.Tensor], Union[FQNS_T, torch.Tensor]\n ] = field(default_factory=dict)\n all_fqns: Set[str] = field(default_factory=set)\n submodule_prefixes: Set[str] = field(default_factory=set)\n handle_model: bool = True\n handle_optim: bool = True\n fsdp_context: Callable = contextlib.nullcontext\n fsdp_modules: List[nn.Module] = field(default_factory=list)\n\n\ndef _get_fqns(\n model: nn.Module,\n name: str,\n skip_ddp_prefix: bool = True,\n skip_compiler_prefix: bool = True,\n) -> FQNS_T:\n \"\"\"\n This API is used to convert the name of a parameter to the FQNs. For FSDP\n without `use_orig_params`, the name of FlatParameter can be mapped to\n multiple original parameters. As a result, the return type of this function\n is `Set[str]`.\n\n Args:\n module (nn.Module): the root model.\n name (str): the name\n skip_ddp_prefix (bool): whether to skip DDP's `module` prefix\n\n Returns:\n The canonical FQNs based on the model traversal.\n \"\"\"\n\n # Remove the checkpoint prefix, if it exists.\n name = name.replace(_CHECKPOINT_PREFIX, \"\")\n if \".\" not in name:\n return {name}\n\n obj_names = name.split(\".\")\n fqn_obj_names = []\n curr_obj = model\n for i, curr_obj_name in enumerate(obj_names):\n if isinstance(curr_obj, DDP):\n assert curr_obj_name == \"module\"\n curr_obj = curr_obj.module\n if not skip_ddp_prefix:\n fqn_obj_names.append(curr_obj_name)\n elif isinstance(curr_obj, FSDP):\n if i < len(obj_names) - 1 and obj_names[i + 1] == FLAT_PARAM:\n prefix = \".\".join(fqn_obj_names)\n flat_param = getattr(curr_obj, FLAT_PARAM)\n if prefix:\n prefix = f\"{prefix}.\"\n return {f\"{prefix}{fqn}\" for fqn in flat_param._fqns}\n curr_obj = getattr(curr_obj, FSDP_WRAPPED_MODULE)\n if curr_obj_name != FSDP_WRAPPED_MODULE:\n fqn_obj_names.append(curr_obj_name)\n curr_obj = getattr(curr_obj, curr_obj_name)\n elif isinstance(curr_obj, torch._dynamo.eval_frame.OptimizedModule):\n assert curr_obj_name == \"_orig_mod\"\n curr_obj = curr_obj._orig_mod\n if not skip_compiler_prefix:\n fqn_obj_names.append(curr_obj_name)\n else:\n fqn_obj_names.append(curr_obj_name)\n if curr_obj_name == nn.modules.module._EXTRA_STATE_KEY_SUFFIX:\n if i != len(obj_names) - 1:\n raise RuntimeError(\"Expect `_extra_state` to be the last obj name\")\n else:\n curr_obj = getattr(curr_obj, curr_obj_name)\n\n return {\".\".join(fqn_obj_names).replace(_CHECKPOINT_PREFIX, \"\")}\n\n\nclass _EXTRA_STATE:\n pass\n\n\ndef _iterate_valid_model_state(model):\n visited_modules: Set[nn.Module] = set()\n\n def recurse(module: nn.Module, curr_fqn: str) -> Generator:\n visited_modules.add(module)\n\n curr_fqn = f\"{curr_fqn}.\" if curr_fqn else \"\"\n for name, submodule in module.named_children():\n if submodule in visited_modules:\n continue\n new_fqn = f\"{curr_fqn}{name}\"\n yield from recurse(submodule, new_fqn)\n\n for name, obj in chain(\n module.named_buffers(recurse=False), module.named_parameters(recurse=False)\n ):\n new_fqn = f\"{curr_fqn}{name}\"\n yield new_fqn, obj\n\n if (\n getattr(module.__class__, \"get_extra_state\", nn.Module.get_extra_state)\n != nn.Module.get_extra_state\n ):\n new_fqn = f\"{curr_fqn}{nn.modules.module._EXTRA_STATE_KEY_SUFFIX}\"\n yield new_fqn, _EXTRA_STATE()\n\n yield from recurse(model, \"\")\n\n\ndef _verify_options(\n model: nn.Module,\n optims: Tuple[torch.optim.Optimizer, ...],\n optim_only: bool,\n *,\n submodules: Optional[Set[nn.Module]] = None,\n options: Optional[StateDictOptions] = None,\n) -> _StateDictInfo:\n \"\"\"\n Verify the model and options passed by the user and generates _StateDictInfo.\n \"\"\"\n if optim_only and not optims:\n raise RuntimeError(\n \"Optimizers are not passed in but optim_only is set to True.\"\n )\n\n options = options or StateDictOptions()\n\n fqn_param_mapping: Dict[\n Union[str, torch.Tensor], Union[Set[str], torch.Tensor]\n ] = {}\n all_fqns = set()\n for name, param in _iterate_valid_model_state(model):\n fqns = _get_fqns(model, name)\n if not isinstance(param, _EXTRA_STATE):\n fqn_param_mapping[param] = fqns\n for fqn in fqns:\n if not isinstance(param, _EXTRA_STATE):\n fqn_param_mapping[fqn] = param\n all_fqns.add(fqn)\n\n submodule_prefixes = set()\n if submodules:\n submodules = set(submodules)\n for name, module in model.named_modules():\n if module not in submodules:\n continue\n fqns = _get_fqns(model, name)\n assert len(fqns) == 1, \"Submodule FQN should only have 1 instance\"\n for fqn in fqns:\n submodule_prefixes.add(f\"{fqn}.\")\n\n fsdp_modules = FSDP.fsdp_modules(model)\n state_dict_config: StateDictConfig\n optim_state_dict_config: OptimStateDictConfig\n fsdp_context: Callable\n if fsdp_modules:\n # FSDP API only work if at least one FSDP instance exists.\n if options.full_state_dict:\n state_dict_config = FullStateDictConfig(\n offload_to_cpu=options.cpu_offload, rank0_only=options.cpu_offload\n )\n optim_state_dict_config = FullOptimStateDictConfig(\n offload_to_cpu=options.cpu_offload, rank0_only=options.cpu_offload\n )\n state_dict_type = StateDictType.FULL_STATE_DICT\n else:\n state_dict_config = ShardedStateDictConfig(\n offload_to_cpu=options.cpu_offload,\n )\n optim_state_dict_config = ShardedOptimStateDictConfig(\n offload_to_cpu=options.cpu_offload,\n )\n state_dict_type = StateDictType.SHARDED_STATE_DICT\n\n fsdp_context = functools.partial(\n FSDP.state_dict_type,\n module=model,\n state_dict_type=state_dict_type,\n state_dict_config=state_dict_config,\n optim_state_dict_config=optim_state_dict_config,\n )\n else:\n fsdp_context = contextlib.nullcontext\n\n return _StateDictInfo(\n **asdict(options),\n fqn_param_mapping=fqn_param_mapping,\n all_fqns=all_fqns,\n submodule_prefixes=submodule_prefixes,\n fsdp_context=fsdp_context,\n fsdp_modules=cast(List[nn.Module], fsdp_modules),\n handle_model=not optim_only,\n handle_optim=(len(optims) > 0),\n )\n\n\ndef _verify_state_dict(\n model_state_dict: Dict[str, ValueType],\n optim_state_dict: OptimizerStateType,\n info: _StateDictInfo,\n) -> None:\n for module in info.fsdp_modules:\n fsdp_state = _get_module_fsdp_state_if_fully_sharded_module(module)\n assert fsdp_state is not None, \"Expected a fsdp_state with a fsdp module.\"\n\n # Verify if the model_state_dict and optim_state_dict are valid. This API\n # should give the users an explicit error message to debug or report.\n if (\n info.handle_model\n and not model_state_dict\n and not info.submodule_prefixes\n and not info.ignore_frozen_params\n and not (info.cpu_offload and info.full_state_dict)\n and info.strict\n ):\n raise RuntimeError(\n \"The option indicates that model state_dict is required to save \"\n \"or load, but model state_dict is empty.\"\n f\"rank = {dist.get_rank()=}.\"\n )\n\n if info.handle_optim:\n if not (optim_state_dict and optim_state_dict[STATE]) and not (\n info.cpu_offload and info.full_state_dict\n ):\n raise RuntimeError(\n \"The option indicates that model state_dict is required to save, \"\n f\"or load but optim state_dict is empty. {optim_state_dict}\"\n )\n\n for key in model_state_dict.keys():\n if FLAT_PARAM in key:\n raise RuntimeError(\n f\"{key} contains {FLAT_PARAM}. This can happen if the model \"\n \"is not the root module.\"\n )\n\n\ndef _state_dict_fn(obj: Union[nn.Module, torch.optim.Optimizer], api: str) -> Callable:\n call = getattr(obj, api)\n if call in _patched_state_dict:\n call = functools.partial(getattr(obj.__class__, api), self=obj)\n return call\n\n\ndef _get_model_state_dict(\n model: nn.Module, info: _StateDictInfo\n) -> Dict[str, ValueType]:\n if not info.handle_model:\n return {}\n\n with info.fsdp_context():\n state_dict = _state_dict_fn(model, \"state_dict\")()\n\n for key in list(state_dict.keys()):\n fqns = _get_fqns(model, key)\n assert len(fqns) == 1\n fqn = next(iter(fqns))\n if fqn != key:\n # As we only support FSDP, DDP, and TP, the only cases are\n # wrapper-based DDP and compiler. Verify if the assumption\n # is correct.\n def verify(key, fqn) -> bool:\n if len(fqn) >= len(key):\n return False\n fqn_split = fqn.split(\".\")\n key_split = key.split(\".\")\n fqn_idx = 0\n for key_idx, key_name in enumerate(key_split):\n if key_name == fqn_split[fqn_idx]:\n fqn_idx += 1\n if fqn_idx == len(fqn_split):\n return key_idx == len(key_split) - 1\n elif key_name in (\"module\", \"_orig_mod\"):\n continue\n else:\n return False\n return True\n\n if not verify(key, fqn):\n raise RuntimeError(f\"An unexpected key, {key}, exists. FQN is {fqn}\")\n state_dict[fqn] = state_dict.pop(key)\n\n if info.submodule_prefixes:\n new_state_dict: Dict[str, ValueType] = {}\n # TODO: make this faster.\n for fqn in state_dict.keys():\n for prefix in info.submodule_prefixes:\n if not fqn.startswith(prefix):\n continue\n if info.keep_submodule_prefixes:\n new_state_dict[fqn] = state_dict[fqn]\n else:\n new_fqn = fqn[len(prefix) :]\n new_state_dict[new_fqn] = state_dict[fqn]\n state_dict = new_state_dict\n\n if info.ignore_frozen_params:\n for key, param in model.named_parameters():\n if param.requires_grad:\n continue\n fqns = _get_fqns(model, key)\n for fqn in fqns:\n state_dict.pop(fqn)\n\n for key, p in list(state_dict.items()):\n if torch.is_tensor(p) and p.is_meta:\n state_dict.pop(key)\n\n if info.full_state_dict:\n ranks_only = tuple() if not info.cpu_offload else (0,)\n return _gather_state_dict(\n state_dict, cpu_offload=info.cpu_offload, ranks_only=ranks_only\n )\n elif info.cpu_offload:\n return _offload_state_dict_to_cpu(state_dict)\n else:\n return state_dict\n\n\ndef _load_model_state_dict(\n model: nn.Module,\n state_dict: Dict[str, ValueType],\n info: _StateDictInfo,\n) -> _IncompatibleKeys:\n if not info.handle_model or not state_dict:\n return _IncompatibleKeys({}, {})\n\n for key, _ in _iterate_valid_model_state(model):\n fqns = _get_fqns(model, key)\n fqns_with_prefix = _get_fqns(\n model, key, skip_ddp_prefix=False, skip_compiler_prefix=False\n )\n for fqn, fqn_with_prefix in zip(fqns, fqns_with_prefix):\n if fqn != fqn_with_prefix:\n state_dict[fqn_with_prefix] = state_dict.pop(fqn)\n\n with info.fsdp_context():\n return cast(\n _IncompatibleKeys,\n _state_dict_fn(model, \"load_state_dict\")(\n state_dict=state_dict, strict=info.strict\n ),\n )\n\n\ndef _init_optim_state(optim: torch.optim.Optimizer) -> None:\n \"\"\"\n Initialize optim states by calling the step() with zero grads.\n \"\"\"\n if optim.state:\n # The optimizer state is initialized.\n return\n\n for param_group in optim.param_groups:\n for param in param_group[PARAMS]:\n if param.grad is not None:\n raise RuntimeError(\n \"state_dict can only be used if the optimizer \"\n \"states are initialized (usually after one step() with \"\n \"gradients) or gradients are None. For the later case, \"\n \"state_dict will fake the gradients as zero \"\n \"to initialize the optimizer states. However, the \"\n \"gradients are not None.\"\n )\n if param.requires_grad:\n param.grad = torch.zeros_like(param)\n optim.step(closure=None)\n optim.zero_grad(set_to_none=True)\n\n\ndef _get_optim_state_dict(\n model: nn.Module,\n optimizers: Tuple[torch.optim.Optimizer, ...],\n info: _StateDictInfo,\n) -> OptimizerStateType:\n if not info.handle_optim:\n return {}\n\n optim_state_dict: OptimizerStateType = {STATE: {}, PG: []}\n for optim in optimizers:\n _init_optim_state(optim)\n osd = _state_dict_fn(optim, \"state_dict\")()\n if info.fsdp_modules:\n with info.fsdp_context():\n osd = FSDP.optim_state_dict(model, optim, osd)\n\n # We need to specially handle FlatParameter FSDP as\n # FlatParameter FSDP converts the FQNs.\n # There are no easy ways to do this conversion systematically.\n # We can only use a string replacment without correctness check.\n if not osd:\n continue\n for k in list(osd[STATE].keys()):\n if \"_orig_mod\" in k:\n osd[STATE][k.replace(\"_orig_mod.\", \"\")] = osd[STATE].pop(k)\n for g in osd[PG]:\n params = [k.replace(\"_orig_mod.\", \"\") for k in g[PARAMS]]\n g[PARAMS] = params\n else:\n params = list(chain.from_iterable(g[PARAMS] for g in optim.param_groups))\n param_pid_mapping = dict(zip(params, range(len(params))))\n fqn_pid_mapping = {}\n for key, param in model.named_parameters():\n fqns = _get_fqns(model, key)\n assert len(fqns) == 1\n fqn = next(iter(fqns))\n if param not in param_pid_mapping:\n continue\n pid = param_pid_mapping[param]\n fqn_pid_mapping[fqn] = pid\n fqn_pid_mapping[pid] = fqn\n\n for key in list(osd[STATE].keys()):\n fqn = fqn_pid_mapping[key]\n osd[STATE][fqn] = osd[STATE].pop(key)\n\n for group in osd[PG]:\n group[PARAMS] = [fqn_pid_mapping[pid] for pid in group[PARAMS]]\n\n if not osd:\n continue\n\n cast(DictValueType, optim_state_dict[STATE]).update(osd[STATE])\n cast(ListDictValueType, optim_state_dict[PG]).extend(osd[PG])\n\n if info.full_state_dict:\n ranks_only = tuple() if not info.cpu_offload else (0,)\n return _gather_state_dict(\n optim_state_dict, cpu_offload=info.cpu_offload, ranks_only=ranks_only\n )\n elif info.cpu_offload:\n return _offload_state_dict_to_cpu(optim_state_dict)\n else:\n return optim_state_dict\n\n\ndef _split_optim_state_dict(\n model: nn.Module,\n optim: torch.optim.Optimizer,\n optim_state_dict: OptimizerStateType,\n info: _StateDictInfo,\n) -> OptimizerStateType:\n \"\"\"\n Extract the corresponding optim state_dict from ``optim_state_dict`` for\n ``optim`` and return the result optim state_dict.\n\n Args:\n model (nn.Module): the root model.\n optim (torch.optim.Optimizer): the optimizer.\n optim_state_dict (Dict[str, ValueType]): the superset optim state_dict that\n contains the optim state_dict of ``optim``.\n info (_StateDictInfo): state dict information.\n\n Returns:\n The optim state_dict of ``optim``.\n \"\"\"\n\n state: DictValueType = {}\n pg_state: ListDictValueType = []\n return_osd: OptimizerStateType = {STATE: state, PG: pg_state}\n pg_mapping: Dict[int, int] = {}\n\n for param_group in optim.param_groups:\n pg_state.append({PARAMS: []})\n for param in param_group[PARAMS]:\n for fqn in info.fqn_param_mapping[param]:\n params = pg_state[-1][PARAMS]\n assert isinstance(params, list)\n params.append(fqn)\n if param.requires_grad:\n state[fqn] = cast(DictValueType, optim_state_dict[STATE])[fqn]\n for loaded_param_group in cast(ListDictValueType, optim_state_dict[PG]):\n params = loaded_param_group[PARAMS]\n assert isinstance(params, list)\n if fqn in params:\n pg_mapping[id(loaded_param_group)] = len(return_osd[PG]) - 1\n\n for param_group in cast(ListDictValueType, optim_state_dict[PG]):\n idx = pg_mapping.get(id(param_group), -1)\n if idx == -1:\n continue\n for key, value in param_group.items():\n if key == PARAMS:\n continue\n # TODO: check if value is the same if exists.\n pg_state[idx][key] = value\n\n return return_osd\n\n\ndef _load_optim_state_dict(\n model: nn.Module,\n optimizers: Tuple[torch.optim.Optimizer, ...],\n state_dict: OptimizerStateType,\n info: _StateDictInfo,\n) -> None:\n if not info.handle_optim:\n return\n\n for optim in optimizers:\n optim_state_dict = _split_optim_state_dict(model, optim, state_dict, info)\n if info.fsdp_modules:\n # We need to specially handle FlatParameter FSDP as\n # FlatParameter FSDP converts the FQNs.\n for original_fqn, _ in model.named_parameters():\n fqns = _get_fqns(model, original_fqn)\n fqns_with_compiler = _get_fqns(\n model, original_fqn, skip_compiler_prefix=False\n )\n if fqns == fqns_with_compiler:\n continue\n\n assert len(fqns) == 1\n fqn = fqns.pop()\n fqn_with_compiler = fqns_with_compiler.pop()\n for g in optim_state_dict[PG]:\n val = cast(Dict[str, Any], g)\n params = [\n key.replace(fqn, fqn_with_compiler) for key in val[PARAMS]\n ]\n val[PARAMS] = params\n osd_state = cast(DictValueType, optim_state_dict[STATE])\n for k in list(osd_state.keys()):\n if fqn in k:\n osd_state[k.replace(fqn, fqn_with_compiler)] = osd_state.pop(k)\n\n with info.fsdp_context():\n optim_state_dict = FSDP.optim_state_dict_to_load(\n model, optim, optim_state_dict\n )\n\n # Note that we do not have to convert the FQN back to param id here if\n # order in optim.param_groups[idx][PARAMS] is the same as the one in\n # optim_state_dict[PG][idx][PARAMS].\n _init_optim_state(optim)\n _state_dict_fn(optim, \"load_state_dict\")(state_dict=optim_state_dict)\n\n\ndef get_model_state_dict(\n model: nn.Module,\n *,\n submodules: Optional[Set[nn.Module]] = None,\n options: Optional[StateDictOptions] = None,\n) -> Dict[str, ValueType]:\n \"\"\"\n Return the model state_dict of ``model``.\n\n See ``get_state_dict`` for the detail usage.\n\n Args:\n model (nn.Module): the nn.Module to the model.\n submodules: Optional[Set[nn.Module]]: only return the model parameters\n that belong to the submodules.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be returned. See\n `StateDictOptions` for the details.\n\n Returns:\n The state_dict for ``model``.\n\n :rtype: typing.Dict[str, ValueType]\n \"\"\"\n with gc_context():\n info = _verify_options(\n model,\n tuple(),\n optim_only=False,\n submodules=submodules,\n options=options,\n )\n model_state_dict = _get_model_state_dict(model, info)\n _verify_state_dict(model_state_dict, {}, info)\n return model_state_dict\n\n\ndef get_optimizer_state_dict(\n model: nn.Module,\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\n *,\n submodules: Optional[Set[nn.Module]] = None,\n options: Optional[StateDictOptions] = None,\n) -> OptimizerStateType:\n \"\"\"\n Return the combined state_dict for optimizers.\n\n See ``get_state_dict`` for the detail usage.\n\n Args:\n model (nn.Module): the nn.Module to the model.\n optimizers (Union[None, Optimizer, Iterable[Optimizer]]):\n The optimizers that are used to optimize ``model``.\n submodules: Optional[Set[nn.Module]]: only return the model parameters\n that belong to the submodules.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be returned. See\n `StateDictOptions` for the details.\n\n Returns:\n The state_dict for ``optimizers``.\n\n :rtype: OptimizerStateType\n \"\"\"\n with gc_context():\n optimizers = (\n (optimizers,)\n if isinstance(optimizers, torch.optim.Optimizer)\n else tuple(optimizers)\n )\n info = _verify_options(\n model,\n optimizers,\n optim_only=True,\n submodules=submodules,\n options=options,\n )\n optim_state_dict = _get_optim_state_dict(model, optimizers, info)\n _verify_state_dict({}, optim_state_dict, info)\n return optim_state_dict\n\n\ndef get_state_dict(\n model: nn.Module,\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\n *,\n submodules: Optional[Set[nn.Module]] = None,\n options: Optional[StateDictOptions] = None,\n) -> Tuple[Dict[str, ValueType], OptimizerStateType]:\n \"\"\"\n Return the model state_dict and optimizers state_dict.\n\n ``get_state_dict`` can process any module that is parallelized by PyTorch\n FSDP/fully_shard, DDP/replicate, tensor_parallel/parallelize_module, and any\n combination of these parallelisms. The main functions of ``get_state_dict``\n are: 1.) returning a model and optimizer state_dict that can be resharded\n with a different number of trainers and/or different parallelisms.\n 2.) hiding the parallelism-specific state_dict APIs. Users don't have to call\n these APIs.\n 3.) sanity checking the result state_dict.\n\n The keys of the result state dictionary are the canonical FQNs (Fully\n Qualified Names). A canonical FQN refers to the FQN based on a parameter's\n position in an nn.Module hierarchy. More specifically, a canonical FQN to a\n parameter is the FQN returned by ``module.named_parameters()`` or\n ``module.named_buffers()`` when the module is not distributed by any\n parallelisms. Since the optimizer internally uses parameter IDs to represent\n a parameter, there will be a conversion from the parameter IDs to the\n canonical FQNs when calling this API.\n\n ``get_state_dict`` can also process a module that is not parallelized. In\n such a case, ``get_state_dict`` only performs one function -- converting the\n optimizer parameter IDs to the canonical FQNs.\n\n Example:\n >>> # xdoctest: +SKIP\n >>> import torch\n >>> from torch.distributed.fsdp import FullyShardedDataParallel as FSDP\n >>> from torch.nn.parallel import DistributedDataParallel as DDP\n >>> from torch.distributed.checkpoint.state_dict import get_state_dict\n\n >>> fsdp_model = FSDP(copy.deepcopy(model))\n >>> fsdp_optim = torch.optim.Adam(model.parameters(), lr=1e-3)\n >>> ddp_model = DDP(copy.deepcopy(model))\n >>> ddp_optim = torch.optim.Adam(model.parameters(), lr=1e-3)\n\n\n >>> ddp_state_dict, ddp_optim_state_dict = get_state_dict(ddp_model, ddp_optim)\n >>> fsdp_state_dict, fsdp_optim_state_dict = get_state_dict(fsdp_model, fsdp_optim)\n\n >>> # if we simply call ddp_model.state_dict() and fsdp_model.state_dict(),\n >>> # the asserts will fail.\n >>> assert ddp_state_dict == fsdp_state_dict\n >>> assert ddp_optim_state == fsdp_optim_state_dict\n\n\n Args:\n model (nn.Module): the nn.Module to the model.\n optimizers (Union[None, Optimizer, Iterable[Optimizer]]):\n The optimizers that are used to optimize ``model``.\n submodules: Optional[Set[nn.Module]]: only return the model parameters\n that belong to the submodules.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be returned. See\n `StateDictOptions` for the details.\n\n Returns:\n ``Tuple`` that contain model state_dict and optimizer state_dict.\n\n :rtype: typing.Tuple[typing.Dict[str, ValueType], OptimizerStateType]\n \"\"\"\n\n with gc_context():\n optimizers = (\n (optimizers,)\n if isinstance(optimizers, torch.optim.Optimizer)\n else tuple(optimizers)\n )\n info = _verify_options(\n model,\n optimizers,\n optim_only=False,\n submodules=submodules,\n options=options,\n )\n model_state_dict = _get_model_state_dict(model, info)\n optim_state_dict = _get_optim_state_dict(model, optimizers, info)\n _verify_state_dict(model_state_dict, optim_state_dict, info)\n return model_state_dict, optim_state_dict\n\n\ndef _unflatten_model_state_dict(\n model: nn.Module,\n state_dict: Union[Dict[nn.Module, Dict[str, ValueType]], Dict[str, ValueType]],\n) -> Dict[str, ValueType]:\n if not state_dict:\n return {}\n\n if isinstance(next(iter(state_dict.keys())), nn.Module):\n cast_state_dict = cast(Dict[nn.Module, Dict[str, ValueType]], state_dict)\n new_state_dict: Dict[str, ValueType] = {}\n for submodule, sub_state_dict in cast_state_dict.items():\n for name, m in model.named_modules():\n if m != submodule:\n continue\n\n fqns = _get_fqns(model, name)\n assert len(fqns) == 1, \"FQNs for a submodule should only have 1 element\"\n prefix = f\"{next(iter(fqns))}.\"\n new_state_dict.update(\n {prefix + subfqn: value for subfqn, value in sub_state_dict.items()}\n )\n return new_state_dict\n else:\n return cast(Dict[str, ValueType], state_dict)\n\n\ndef set_model_state_dict(\n model: nn.Module,\n model_state_dict: Dict[str, ValueType],\n *,\n options: Optional[StateDictOptions] = None,\n) -> _IncompatibleKeys:\n \"\"\"Load the model state_dict.\n\n The counterpart of ``get_model_state_dict`` to set the state_dict to the\n model. See ``set_state_dict`` for the detail usage.\n\n Args:\n model (nn.Module): the nn.Module to the model.\n model_state_dict: (Dict[str, ValueType]):\n the model state_dict to load. If the key of the ``model_state_dict``\n is nn.Module, the key is a submodule of ``model`` and the value should\n be the state_dict of the submodule. When loading the state_dict,\n the prefix of the submodule will be append to the state_dict.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be loaded. See\n `StateDictOptions` for the details.\n\n Returns:\n ``NamedTuple`` with ``missing_keys`` and ``unexpected_keys`` fields:\n * **missing_keys** is a list of str containing the missing keys\n * **unexpected_keys** is a list of str containing the unexpected keys\n\n :type model_state_dict: typing.Dict[str, ValueType]\n \"\"\"\n model_state_dict: Dict[str, ValueType] = _unflatten_model_state_dict(\n model, model_state_dict\n )\n with gc_context():\n info = _verify_options(model, tuple(), optim_only=False, options=options)\n\n _verify_state_dict(model_state_dict, {}, info)\n return _load_model_state_dict(model, model_state_dict, info)\n\n\ndef set_optimizer_state_dict(\n model: nn.Module,\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\n *,\n optim_state_dict: OptimizerStateType,\n options: Optional[StateDictOptions] = None,\n) -> None:\n \"\"\"Load the optimizers state_dict.\n\n The counterpart of ``get_optimizer_state_dict`` to set the state_dict to the\n optimizers. See ``set_state_dict`` for the detail usage.\n\n Args:\n model (nn.Module): the nn.Module to the model.\n optimizers (Union[Optimizer, Iterable[Optimizer]]):\n The optimizers that are used to optimize ``model``.\n optim_state_dict: OptimizerStateType:\n the optimizer state_dict to load.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be loaded. See\n `StateDictOptions` for the details.\n\n Returns:\n None\n\n :type optim_state_dict: typing.OptimizerStateType\n \"\"\"\n with gc_context():\n optimizers = (\n (optimizers,)\n if isinstance(optimizers, torch.optim.Optimizer)\n else tuple(optimizers)\n )\n info = _verify_options(model, optimizers, optim_only=True, options=options)\n\n _verify_state_dict({}, optim_state_dict, info)\n _load_optim_state_dict(model, optimizers, optim_state_dict, info)\n\n\ndef set_state_dict(\n model: nn.Module,\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\n *,\n model_state_dict: Dict[str, ValueType],\n optim_state_dict: OptimizerStateType,\n options: Optional[StateDictOptions] = None,\n) -> _IncompatibleKeys:\n \"\"\"Load the model state_dict and optimizers state_dict.\n\n The counterpart of ``get_state_dict`` to set the state_dict to the model and\n optimizers. The given ``model_state_dict`` and ``optim_state_dict`` do not\n have to be returned by ``get_state_dict`` but must meet the following\n requirements: 1) all FQNs are canonical FQNs as defined in ``get_state_dict``,\n 2) if a tensor is sharded, it must be either a ShardedTensor or DTensor,\n 3) optimizer state_dict cannot contain the parameter IDs; the keys should be\n the canonical FQNs.\n\n Args:\n model (nn.Module): the nn.Module to the model.\n optimizers (Union[Optimizer, Iterable[Optimizer]]):\n The optimizers that are used to optimize ``model``.\n model_state_dict: (Union[Dict[nn.Module, Dict[str, ValueType]], Dict[str, ValueType]]):\n the model state_dict to load. If the key of the ``model_state_dict``\n is nn.Module, the key is a submodule of ``model`` and the value should\n be the state_dict of the submodule. When loading the state_dict,\n the prefix of the submodule will be append to the state_dict.\n optim_state_dict: OptimizerStateType:\n the optimizer state_dict to load.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be loaded. See\n `StateDictOptions` for the details.\n\n Returns:\n ``NamedTuple`` with ``missing_keys`` and ``unexpected_keys`` fields:\n * **missing_keys** is a list of str containing the missing keys of the model state_dict.\n * **unexpected_keys** is a list of str containing the unexpected keys of the model state_dict.\n\n :type model_state_dict: typing.Dict[str, ValueType]\n :type optim_state_dict: typing.OptimizerStateType\n \"\"\"\n\n model_state_dict: Dict[str, ValueType] = _unflatten_model_state_dict(\n model, model_state_dict\n )\n with gc_context():\n optimizers = (\n (optimizers,)\n if isinstance(optimizers, torch.optim.Optimizer)\n else tuple(optimizers)\n )\n info = _verify_options(\n model, optimizers, optim_only=not model_state_dict, options=options\n )\n\n _verify_state_dict(model_state_dict, optim_state_dict, info)\n _load_optim_state_dict(model, optimizers, optim_state_dict, info)\n return _load_model_state_dict(model, model_state_dict, info)\n\n\n# TODO: correct the state_dict function signature.\n# TODO: this API is not yet fully tested. Make it private\n@no_type_check\ndef _patch_model_state_dict(\n model: nn.Module,\n *,\n options: Optional[StateDictOptions] = None,\n) -> None:\n \"\"\"Patch the ``state_dict`` and ``load_state_dict`` attributes of ``model``.\n\n Patch the ``state_dict`` and ``load_state_dict`` attributes of ``model`` to\n be a partial function to call ``get_state_dict`` and ``set_state_dict``.\n\n Example:\n from torch.distributed.fsdp import FullyShardedDataParallel as FSDP\n from torch.distributed.checkpoint.state_dict import patch_model_state_dict\n\n model = fsdp(model)\n patch_model_state_dict(model)\n\n Args:\n model (nn.Module): the nn.Module to the model.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be loaded. See\n `StateDictOptions` for the details.\n Returns:\n None\n \"\"\"\n\n _state_dict_call = functools.partial(\n get_model_state_dict,\n model=model,\n options=options,\n )\n\n def state_dict_call():\n return _state_dict_call()\n\n model.state_dict = state_dict_call\n\n _load_state_dict_call = functools.partial(\n set_model_state_dict,\n model=model,\n options=options,\n )\n\n def load_state_dict_call(state_dict: Dict[str, Any]):\n _load_state_dict_call(model_state_dict=state_dict)\n\n model.load_state_dict = load_state_dict_call\n\n _patched_state_dict.add(state_dict_call)\n _patched_state_dict.add(load_state_dict_call)\n\n\n# TODO: correct the load_state_dict function signature.\n# TODO: this API is not yet fully tested. Make it private\n@no_type_check\ndef _patch_optimizer_state_dict(\n model: nn.Module,\n *,\n optimizers: Tuple[torch.optim.Optimizer, ...],\n options: Optional[StateDictOptions] = None,\n) -> None:\n \"\"\"Patch the ``state_dict`` and ``load_state_dict`` attributes of ``optimizers``.\n\n Patch the ``state_dict`` and ``load_state_dict`` attributes of ``optimizers`` to\n be a partial function to call ``get_state_dict`` and ``set_state_dict``.\n\n Note that if there are multiple optimizers, all of the optimizers will be patched.\n So users only need to call one of the state_dict() to get the full result.\n\n Example:\n from torch.distributed.fsdp import FullyShardedDataParallel as FSDP\n from torch.distributed.checkpoint.state_dict import patch_model_state_dict\n\n model = fsdp(model)\n patch_model_state_dict(model)\n\n Args:\n model (nn.Module): the nn.Module to the model.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be loaded. See\n `StateDictOptions` for the details.\n Returns:\n None\n \"\"\"\n\n _state_dict_call = functools.partial(\n get_optimizer_state_dict,\n model=model,\n optimizers=optimizers,\n options=options,\n )\n\n def state_dict_call():\n return _state_dict_call()\n\n _load_state_dict_call = functools.partial(\n set_optimizer_state_dict,\n model=model,\n optimizers=optimizers,\n options=options,\n )\n\n def load_state_dict_call(state_dict: Dict[str, Any]):\n _load_state_dict_call(optim_state_dict=state_dict)\n\n _patched_state_dict.add(state_dict_call)\n _patched_state_dict.add(load_state_dict_call)\n optimizers = (\n (optimizers,)\n if isinstance(optimizers, torch.optim.Optimizer)\n else tuple(optimizers)\n )\n for optim in optimizers:\n optim.state_dict = state_dict_call\n optim.load_state_dict = load_state_dict_call\n","path":"torch/distributed/checkpoint/state_dict.py"}],"string":"[\n {\n \"content\": \"import contextlib\\nimport functools\\nimport gc\\nfrom dataclasses import asdict, dataclass, field\\nfrom itertools import chain\\nfrom typing import (\\n Any,\\n Callable,\\n cast,\\n Dict,\\n Generator,\\n Iterable,\\n List,\\n no_type_check,\\n Optional,\\n Set,\\n Tuple,\\n Union,\\n)\\n\\nimport torch\\nimport torch.distributed as dist\\nimport torch.nn as nn\\nfrom torch.distributed._shard.sharded_tensor import ShardedTensor\\nfrom torch.distributed._state_dict_utils import (\\n _gather_state_dict,\\n _offload_state_dict_to_cpu,\\n)\\nfrom torch.distributed._tensor import DTensor\\nfrom torch.distributed.algorithms._checkpoint.checkpoint_wrapper import (\\n _CHECKPOINT_PREFIX,\\n)\\nfrom torch.distributed.fsdp import (\\n FullOptimStateDictConfig,\\n FullStateDictConfig,\\n FullyShardedDataParallel as FSDP,\\n OptimStateDictConfig,\\n ShardedOptimStateDictConfig,\\n ShardedStateDictConfig,\\n StateDictConfig,\\n StateDictType,\\n)\\nfrom torch.distributed.fsdp._common_utils import (\\n _get_module_fsdp_state_if_fully_sharded_module,\\n FSDP_WRAPPED_MODULE,\\n)\\nfrom torch.nn.modules.module import _IncompatibleKeys\\nfrom torch.nn.parallel import DistributedDataParallel as DDP\\n\\n\\nFLAT_PARAM = \\\"_flat_param\\\"\\nPG = \\\"param_groups\\\"\\nPG_PREFIX = f\\\"{PG}.\\\"\\nSTATE = \\\"state\\\"\\nSTATE_PREFIX = f\\\"{STATE}.\\\"\\nPARAMS = \\\"params\\\"\\nFQNS_T = Set[str]\\n\\n_patched_state_dict: Set[Callable] = set()\\n\\n\\nPrimitiveType = Union[DTensor, ShardedTensor, torch.Tensor, int, float, str]\\nValueType = Union[\\n PrimitiveType, List[PrimitiveType], Tuple[PrimitiveType], Dict[str, \\\"ValueType\\\"]\\n]\\nDictValueType = Dict[str, ValueType]\\nListDictValueType = List[DictValueType]\\nOptimizerStateType = Dict[str, Union[DictValueType, ListDictValueType]]\\n\\n\\n@contextlib.contextmanager\\ndef gc_context():\\n is_enabled = gc.isenabled()\\n gc.disable()\\n try:\\n yield\\n finally:\\n # TODO: add logging for the gc details/time\\n gc.collect()\\n if is_enabled:\\n gc.enable()\\n\\n\\n@dataclass\\nclass StateDictOptions:\\n \\\"\\\"\\\"\\n This dataclass specifies how get_state_dict/set_state_dict will work.\\n\\n - ``full_state_dict``: if this is set to True, all the tensors in the\\n returned state_dict will be gathered. No ShardedTensor and DTensor\\n will be in the returned state_dict.\\n\\n - ``cpu_offload``: offload all the tensors to cpu. To prevent CPU OOM, if\\n ``full_state_dict`` is also true, then only the rank0 will get the\\n state_dict and all other ranks will get empty state_dict.\\n\\n - ``ignore_frozen_params``: if the value is True, the returned state_dict\\n won't contain any frozen parameters -- the ``requires_grad`` is False.\\n The default value is False.\\n\\n - ``keep_submodule_prefixes``: when ``submodules`` is not None, this option\\n indicates whether to keep the submodule prefixes from the state_dict keys.\\n or example, if the submodule is ``module.pretrain`` and the full FQN of\\n the parameter is ``pretrain.layer1.weight`` of the param. When this option\\n is True, the parameter's key in the returned state_dict will be\\n ``pretrain.layer1.weight``. If the options is False, the key will be\\n ``layer1.weight``.\\n Note that if ``keep_submodule_prefixes`` is False, there may be conflicted\\n FQNs, hence there should be only one submodule in ``submodules``.\\n\\n - ``strict``: the ``strict`` option when ``set_state_dict`` calls\\n model.load_state_dict().\\n The default value is False.\\n \\\"\\\"\\\"\\n\\n full_state_dict: bool = False\\n cpu_offload: bool = False\\n ignore_frozen_params: bool = False\\n keep_submodule_prefixes: bool = True\\n strict: bool = True\\n\\n\\n@dataclass\\nclass _StateDictInfo(StateDictOptions):\\n fqn_param_mapping: Dict[\\n Union[str, torch.Tensor], Union[FQNS_T, torch.Tensor]\\n ] = field(default_factory=dict)\\n all_fqns: Set[str] = field(default_factory=set)\\n submodule_prefixes: Set[str] = field(default_factory=set)\\n handle_model: bool = True\\n handle_optim: bool = True\\n fsdp_context: Callable = contextlib.nullcontext\\n fsdp_modules: List[nn.Module] = field(default_factory=list)\\n\\n\\ndef _get_fqns(\\n model: nn.Module,\\n name: str,\\n skip_ddp_prefix: bool = True,\\n skip_compiler_prefix: bool = True,\\n) -> FQNS_T:\\n \\\"\\\"\\\"\\n This API is used to convert the name of a parameter to the FQNs. For FSDP\\n without `use_orig_params`, the name of FlatParameter can be mapped to\\n multiple original parameters. As a result, the return type of this function\\n is `Set[str]`.\\n\\n Args:\\n module (nn.Module): the root model.\\n name (str): the name\\n skip_ddp_prefix (bool): whether to skip DDP's `module` prefix\\n\\n Returns:\\n The canonical FQNs based on the model traversal.\\n \\\"\\\"\\\"\\n\\n # Remove the checkpoint prefix, if it exists.\\n name = name.replace(_CHECKPOINT_PREFIX, \\\"\\\")\\n if \\\".\\\" not in name:\\n return {name}\\n\\n obj_names = name.split(\\\".\\\")\\n fqn_obj_names = []\\n curr_obj = model\\n for i, curr_obj_name in enumerate(obj_names):\\n if isinstance(curr_obj, DDP):\\n assert curr_obj_name == \\\"module\\\"\\n curr_obj = curr_obj.module\\n if not skip_ddp_prefix:\\n fqn_obj_names.append(curr_obj_name)\\n elif isinstance(curr_obj, FSDP):\\n if i < len(obj_names) - 1 and obj_names[i + 1] == FLAT_PARAM:\\n prefix = \\\".\\\".join(fqn_obj_names)\\n flat_param = getattr(curr_obj, FLAT_PARAM)\\n if prefix:\\n prefix = f\\\"{prefix}.\\\"\\n return {f\\\"{prefix}{fqn}\\\" for fqn in flat_param._fqns}\\n curr_obj = getattr(curr_obj, FSDP_WRAPPED_MODULE)\\n if curr_obj_name != FSDP_WRAPPED_MODULE:\\n fqn_obj_names.append(curr_obj_name)\\n curr_obj = getattr(curr_obj, curr_obj_name)\\n elif isinstance(curr_obj, torch._dynamo.eval_frame.OptimizedModule):\\n assert curr_obj_name == \\\"_orig_mod\\\"\\n curr_obj = curr_obj._orig_mod\\n if not skip_compiler_prefix:\\n fqn_obj_names.append(curr_obj_name)\\n else:\\n fqn_obj_names.append(curr_obj_name)\\n if curr_obj_name == nn.modules.module._EXTRA_STATE_KEY_SUFFIX:\\n if i != len(obj_names) - 1:\\n raise RuntimeError(\\\"Expect `_extra_state` to be the last obj name\\\")\\n else:\\n curr_obj = getattr(curr_obj, curr_obj_name)\\n\\n return {\\\".\\\".join(fqn_obj_names).replace(_CHECKPOINT_PREFIX, \\\"\\\")}\\n\\n\\nclass _EXTRA_STATE:\\n pass\\n\\n\\ndef _iterate_valid_model_state(model):\\n visited_modules: Set[nn.Module] = set()\\n\\n def recurse(module: nn.Module, curr_fqn: str) -> Generator:\\n visited_modules.add(module)\\n\\n curr_fqn = f\\\"{curr_fqn}.\\\" if curr_fqn else \\\"\\\"\\n for name, submodule in module.named_children():\\n if submodule in visited_modules:\\n continue\\n new_fqn = f\\\"{curr_fqn}{name}\\\"\\n yield from recurse(submodule, new_fqn)\\n\\n for name, obj in chain(\\n module.named_buffers(recurse=False), module.named_parameters(recurse=False)\\n ):\\n new_fqn = f\\\"{curr_fqn}{name}\\\"\\n yield new_fqn, obj\\n\\n if (\\n getattr(module.__class__, \\\"get_extra_state\\\", nn.Module.get_extra_state)\\n != nn.Module.get_extra_state\\n ):\\n new_fqn = f\\\"{curr_fqn}{nn.modules.module._EXTRA_STATE_KEY_SUFFIX}\\\"\\n yield new_fqn, _EXTRA_STATE()\\n\\n yield from recurse(model, \\\"\\\")\\n\\n\\ndef _verify_options(\\n model: nn.Module,\\n optims: Tuple[torch.optim.Optimizer, ...],\\n optim_only: bool,\\n *,\\n submodules: Optional[Set[nn.Module]] = None,\\n options: Optional[StateDictOptions] = None,\\n) -> _StateDictInfo:\\n \\\"\\\"\\\"\\n Verify the model and options passed by the user and generates _StateDictInfo.\\n \\\"\\\"\\\"\\n if optim_only and not optims:\\n raise RuntimeError(\\n \\\"Optimizers are not passed in but optim_only is set to True.\\\"\\n )\\n\\n options = options or StateDictOptions()\\n\\n fqn_param_mapping: Dict[\\n Union[str, torch.Tensor], Union[Set[str], torch.Tensor]\\n ] = {}\\n all_fqns = set()\\n for name, param in _iterate_valid_model_state(model):\\n fqns = _get_fqns(model, name)\\n if not isinstance(param, _EXTRA_STATE):\\n fqn_param_mapping[param] = fqns\\n for fqn in fqns:\\n if not isinstance(param, _EXTRA_STATE):\\n fqn_param_mapping[fqn] = param\\n all_fqns.add(fqn)\\n\\n submodule_prefixes = set()\\n if submodules:\\n submodules = set(submodules)\\n for name, module in model.named_modules():\\n if module not in submodules:\\n continue\\n fqns = _get_fqns(model, name)\\n assert len(fqns) == 1, \\\"Submodule FQN should only have 1 instance\\\"\\n for fqn in fqns:\\n submodule_prefixes.add(f\\\"{fqn}.\\\")\\n\\n fsdp_modules = FSDP.fsdp_modules(model)\\n state_dict_config: StateDictConfig\\n optim_state_dict_config: OptimStateDictConfig\\n fsdp_context: Callable\\n if fsdp_modules:\\n # FSDP API only work if at least one FSDP instance exists.\\n if options.full_state_dict:\\n state_dict_config = FullStateDictConfig(\\n offload_to_cpu=options.cpu_offload, rank0_only=options.cpu_offload\\n )\\n optim_state_dict_config = FullOptimStateDictConfig(\\n offload_to_cpu=options.cpu_offload, rank0_only=options.cpu_offload\\n )\\n state_dict_type = StateDictType.FULL_STATE_DICT\\n else:\\n state_dict_config = ShardedStateDictConfig(\\n offload_to_cpu=options.cpu_offload,\\n )\\n optim_state_dict_config = ShardedOptimStateDictConfig(\\n offload_to_cpu=options.cpu_offload,\\n )\\n state_dict_type = StateDictType.SHARDED_STATE_DICT\\n\\n fsdp_context = functools.partial(\\n FSDP.state_dict_type,\\n module=model,\\n state_dict_type=state_dict_type,\\n state_dict_config=state_dict_config,\\n optim_state_dict_config=optim_state_dict_config,\\n )\\n else:\\n fsdp_context = contextlib.nullcontext\\n\\n return _StateDictInfo(\\n **asdict(options),\\n fqn_param_mapping=fqn_param_mapping,\\n all_fqns=all_fqns,\\n submodule_prefixes=submodule_prefixes,\\n fsdp_context=fsdp_context,\\n fsdp_modules=cast(List[nn.Module], fsdp_modules),\\n handle_model=not optim_only,\\n handle_optim=(len(optims) > 0),\\n )\\n\\n\\ndef _verify_state_dict(\\n model_state_dict: Dict[str, ValueType],\\n optim_state_dict: OptimizerStateType,\\n info: _StateDictInfo,\\n) -> None:\\n for module in info.fsdp_modules:\\n fsdp_state = _get_module_fsdp_state_if_fully_sharded_module(module)\\n assert fsdp_state is not None, \\\"Expected a fsdp_state with a fsdp module.\\\"\\n\\n # Verify if the model_state_dict and optim_state_dict are valid. This API\\n # should give the users an explicit error message to debug or report.\\n if (\\n info.handle_model\\n and not model_state_dict\\n and not info.submodule_prefixes\\n and not info.ignore_frozen_params\\n and not (info.cpu_offload and info.full_state_dict)\\n and info.strict\\n ):\\n raise RuntimeError(\\n \\\"The option indicates that model state_dict is required to save \\\"\\n \\\"or load, but model state_dict is empty.\\\"\\n f\\\"rank = {dist.get_rank()=}.\\\"\\n )\\n\\n if info.handle_optim:\\n if not (optim_state_dict and optim_state_dict[STATE]) and not (\\n info.cpu_offload and info.full_state_dict\\n ):\\n raise RuntimeError(\\n \\\"The option indicates that model state_dict is required to save, \\\"\\n f\\\"or load but optim state_dict is empty. {optim_state_dict}\\\"\\n )\\n\\n for key in model_state_dict.keys():\\n if FLAT_PARAM in key:\\n raise RuntimeError(\\n f\\\"{key} contains {FLAT_PARAM}. This can happen if the model \\\"\\n \\\"is not the root module.\\\"\\n )\\n\\n\\ndef _state_dict_fn(obj: Union[nn.Module, torch.optim.Optimizer], api: str) -> Callable:\\n call = getattr(obj, api)\\n if call in _patched_state_dict:\\n call = functools.partial(getattr(obj.__class__, api), self=obj)\\n return call\\n\\n\\ndef _get_model_state_dict(\\n model: nn.Module, info: _StateDictInfo\\n) -> Dict[str, ValueType]:\\n if not info.handle_model:\\n return {}\\n\\n with info.fsdp_context():\\n state_dict = _state_dict_fn(model, \\\"state_dict\\\")()\\n\\n for key in list(state_dict.keys()):\\n fqns = _get_fqns(model, key)\\n assert len(fqns) == 1\\n fqn = next(iter(fqns))\\n if fqn != key:\\n # As we only support FSDP, DDP, and TP, the only cases are\\n # wrapper-based DDP and compiler. Verify if the assumption\\n # is correct.\\n def verify(key, fqn) -> bool:\\n if len(fqn) >= len(key):\\n return False\\n fqn_split = fqn.split(\\\".\\\")\\n key_split = key.split(\\\".\\\")\\n fqn_idx = 0\\n for key_idx, key_name in enumerate(key_split):\\n if key_name == fqn_split[fqn_idx]:\\n fqn_idx += 1\\n if fqn_idx == len(fqn_split):\\n return key_idx == len(key_split) - 1\\n elif key_name in (\\\"module\\\", \\\"_orig_mod\\\"):\\n continue\\n else:\\n return False\\n return True\\n\\n if not verify(key, fqn):\\n raise RuntimeError(f\\\"An unexpected key, {key}, exists. FQN is {fqn}\\\")\\n state_dict[fqn] = state_dict.pop(key)\\n\\n if info.submodule_prefixes:\\n new_state_dict: Dict[str, ValueType] = {}\\n # TODO: make this faster.\\n for fqn in state_dict.keys():\\n for prefix in info.submodule_prefixes:\\n if not fqn.startswith(prefix):\\n continue\\n if info.keep_submodule_prefixes:\\n new_state_dict[fqn] = state_dict[fqn]\\n else:\\n new_fqn = fqn[len(prefix) :]\\n new_state_dict[new_fqn] = state_dict[fqn]\\n state_dict = new_state_dict\\n\\n if info.ignore_frozen_params:\\n for key, param in model.named_parameters():\\n if param.requires_grad:\\n continue\\n fqns = _get_fqns(model, key)\\n for fqn in fqns:\\n state_dict.pop(fqn)\\n\\n for key, p in list(state_dict.items()):\\n if torch.is_tensor(p) and p.is_meta:\\n state_dict.pop(key)\\n\\n if info.full_state_dict:\\n ranks_only = tuple() if not info.cpu_offload else (0,)\\n return _gather_state_dict(\\n state_dict, cpu_offload=info.cpu_offload, ranks_only=ranks_only\\n )\\n elif info.cpu_offload:\\n return _offload_state_dict_to_cpu(state_dict)\\n else:\\n return state_dict\\n\\n\\ndef _load_model_state_dict(\\n model: nn.Module,\\n state_dict: Dict[str, ValueType],\\n info: _StateDictInfo,\\n) -> _IncompatibleKeys:\\n if not info.handle_model or not state_dict:\\n return _IncompatibleKeys({}, {})\\n\\n for key, _ in _iterate_valid_model_state(model):\\n fqns = _get_fqns(model, key)\\n fqns_with_prefix = _get_fqns(\\n model, key, skip_ddp_prefix=False, skip_compiler_prefix=False\\n )\\n for fqn, fqn_with_prefix in zip(fqns, fqns_with_prefix):\\n if fqn != fqn_with_prefix:\\n state_dict[fqn_with_prefix] = state_dict.pop(fqn)\\n\\n with info.fsdp_context():\\n return cast(\\n _IncompatibleKeys,\\n _state_dict_fn(model, \\\"load_state_dict\\\")(\\n state_dict=state_dict, strict=info.strict\\n ),\\n )\\n\\n\\ndef _init_optim_state(optim: torch.optim.Optimizer) -> None:\\n \\\"\\\"\\\"\\n Initialize optim states by calling the step() with zero grads.\\n \\\"\\\"\\\"\\n if optim.state:\\n # The optimizer state is initialized.\\n return\\n\\n for param_group in optim.param_groups:\\n for param in param_group[PARAMS]:\\n if param.grad is not None:\\n raise RuntimeError(\\n \\\"state_dict can only be used if the optimizer \\\"\\n \\\"states are initialized (usually after one step() with \\\"\\n \\\"gradients) or gradients are None. For the later case, \\\"\\n \\\"state_dict will fake the gradients as zero \\\"\\n \\\"to initialize the optimizer states. However, the \\\"\\n \\\"gradients are not None.\\\"\\n )\\n if param.requires_grad:\\n param.grad = torch.zeros_like(param)\\n optim.step(closure=None)\\n optim.zero_grad(set_to_none=True)\\n\\n\\ndef _get_optim_state_dict(\\n model: nn.Module,\\n optimizers: Tuple[torch.optim.Optimizer, ...],\\n info: _StateDictInfo,\\n) -> OptimizerStateType:\\n if not info.handle_optim:\\n return {}\\n\\n optim_state_dict: OptimizerStateType = {STATE: {}, PG: []}\\n for optim in optimizers:\\n _init_optim_state(optim)\\n osd = _state_dict_fn(optim, \\\"state_dict\\\")()\\n if info.fsdp_modules:\\n with info.fsdp_context():\\n osd = FSDP.optim_state_dict(model, optim, osd)\\n\\n # We need to specially handle FlatParameter FSDP as\\n # FlatParameter FSDP converts the FQNs.\\n # There are no easy ways to do this conversion systematically.\\n # We can only use a string replacment without correctness check.\\n if not osd:\\n continue\\n for k in list(osd[STATE].keys()):\\n if \\\"_orig_mod\\\" in k:\\n osd[STATE][k.replace(\\\"_orig_mod.\\\", \\\"\\\")] = osd[STATE].pop(k)\\n for g in osd[PG]:\\n params = [k.replace(\\\"_orig_mod.\\\", \\\"\\\") for k in g[PARAMS]]\\n g[PARAMS] = params\\n else:\\n params = list(chain.from_iterable(g[PARAMS] for g in optim.param_groups))\\n param_pid_mapping = dict(zip(params, range(len(params))))\\n fqn_pid_mapping = {}\\n for key, param in model.named_parameters():\\n fqns = _get_fqns(model, key)\\n assert len(fqns) == 1\\n fqn = next(iter(fqns))\\n if param not in param_pid_mapping:\\n continue\\n pid = param_pid_mapping[param]\\n fqn_pid_mapping[fqn] = pid\\n fqn_pid_mapping[pid] = fqn\\n\\n for key in list(osd[STATE].keys()):\\n fqn = fqn_pid_mapping[key]\\n osd[STATE][fqn] = osd[STATE].pop(key)\\n\\n for group in osd[PG]:\\n group[PARAMS] = [fqn_pid_mapping[pid] for pid in group[PARAMS]]\\n\\n if not osd:\\n continue\\n\\n cast(DictValueType, optim_state_dict[STATE]).update(osd[STATE])\\n cast(ListDictValueType, optim_state_dict[PG]).extend(osd[PG])\\n\\n if info.full_state_dict:\\n ranks_only = tuple() if not info.cpu_offload else (0,)\\n return _gather_state_dict(\\n optim_state_dict, cpu_offload=info.cpu_offload, ranks_only=ranks_only\\n )\\n elif info.cpu_offload:\\n return _offload_state_dict_to_cpu(optim_state_dict)\\n else:\\n return optim_state_dict\\n\\n\\ndef _split_optim_state_dict(\\n model: nn.Module,\\n optim: torch.optim.Optimizer,\\n optim_state_dict: OptimizerStateType,\\n info: _StateDictInfo,\\n) -> OptimizerStateType:\\n \\\"\\\"\\\"\\n Extract the corresponding optim state_dict from ``optim_state_dict`` for\\n ``optim`` and return the result optim state_dict.\\n\\n Args:\\n model (nn.Module): the root model.\\n optim (torch.optim.Optimizer): the optimizer.\\n optim_state_dict (Dict[str, ValueType]): the superset optim state_dict that\\n contains the optim state_dict of ``optim``.\\n info (_StateDictInfo): state dict information.\\n\\n Returns:\\n The optim state_dict of ``optim``.\\n \\\"\\\"\\\"\\n\\n state: DictValueType = {}\\n pg_state: ListDictValueType = []\\n return_osd: OptimizerStateType = {STATE: state, PG: pg_state}\\n pg_mapping: Dict[int, int] = {}\\n\\n for param_group in optim.param_groups:\\n pg_state.append({PARAMS: []})\\n for param in param_group[PARAMS]:\\n for fqn in info.fqn_param_mapping[param]:\\n params = pg_state[-1][PARAMS]\\n assert isinstance(params, list)\\n params.append(fqn)\\n if param.requires_grad:\\n state[fqn] = cast(DictValueType, optim_state_dict[STATE])[fqn]\\n for loaded_param_group in cast(ListDictValueType, optim_state_dict[PG]):\\n params = loaded_param_group[PARAMS]\\n assert isinstance(params, list)\\n if fqn in params:\\n pg_mapping[id(loaded_param_group)] = len(return_osd[PG]) - 1\\n\\n for param_group in cast(ListDictValueType, optim_state_dict[PG]):\\n idx = pg_mapping.get(id(param_group), -1)\\n if idx == -1:\\n continue\\n for key, value in param_group.items():\\n if key == PARAMS:\\n continue\\n # TODO: check if value is the same if exists.\\n pg_state[idx][key] = value\\n\\n return return_osd\\n\\n\\ndef _load_optim_state_dict(\\n model: nn.Module,\\n optimizers: Tuple[torch.optim.Optimizer, ...],\\n state_dict: OptimizerStateType,\\n info: _StateDictInfo,\\n) -> None:\\n if not info.handle_optim:\\n return\\n\\n for optim in optimizers:\\n optim_state_dict = _split_optim_state_dict(model, optim, state_dict, info)\\n if info.fsdp_modules:\\n # We need to specially handle FlatParameter FSDP as\\n # FlatParameter FSDP converts the FQNs.\\n for original_fqn, _ in model.named_parameters():\\n fqns = _get_fqns(model, original_fqn)\\n fqns_with_compiler = _get_fqns(\\n model, original_fqn, skip_compiler_prefix=False\\n )\\n if fqns == fqns_with_compiler:\\n continue\\n\\n assert len(fqns) == 1\\n fqn = fqns.pop()\\n fqn_with_compiler = fqns_with_compiler.pop()\\n for g in optim_state_dict[PG]:\\n val = cast(Dict[str, Any], g)\\n params = [\\n key.replace(fqn, fqn_with_compiler) for key in val[PARAMS]\\n ]\\n val[PARAMS] = params\\n osd_state = cast(DictValueType, optim_state_dict[STATE])\\n for k in list(osd_state.keys()):\\n if fqn in k:\\n osd_state[k.replace(fqn, fqn_with_compiler)] = osd_state.pop(k)\\n\\n with info.fsdp_context():\\n optim_state_dict = FSDP.optim_state_dict_to_load(\\n model, optim, optim_state_dict\\n )\\n\\n # Note that we do not have to convert the FQN back to param id here if\\n # order in optim.param_groups[idx][PARAMS] is the same as the one in\\n # optim_state_dict[PG][idx][PARAMS].\\n _init_optim_state(optim)\\n _state_dict_fn(optim, \\\"load_state_dict\\\")(state_dict=optim_state_dict)\\n\\n\\ndef get_model_state_dict(\\n model: nn.Module,\\n *,\\n submodules: Optional[Set[nn.Module]] = None,\\n options: Optional[StateDictOptions] = None,\\n) -> Dict[str, ValueType]:\\n \\\"\\\"\\\"\\n Return the model state_dict of ``model``.\\n\\n See ``get_state_dict`` for the detail usage.\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n submodules: Optional[Set[nn.Module]]: only return the model parameters\\n that belong to the submodules.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be returned. See\\n `StateDictOptions` for the details.\\n\\n Returns:\\n The state_dict for ``model``.\\n\\n :rtype: typing.Dict[str, ValueType]\\n \\\"\\\"\\\"\\n with gc_context():\\n info = _verify_options(\\n model,\\n tuple(),\\n optim_only=False,\\n submodules=submodules,\\n options=options,\\n )\\n model_state_dict = _get_model_state_dict(model, info)\\n _verify_state_dict(model_state_dict, {}, info)\\n return model_state_dict\\n\\n\\ndef get_optimizer_state_dict(\\n model: nn.Module,\\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\\n *,\\n submodules: Optional[Set[nn.Module]] = None,\\n options: Optional[StateDictOptions] = None,\\n) -> OptimizerStateType:\\n \\\"\\\"\\\"\\n Return the combined state_dict for optimizers.\\n\\n See ``get_state_dict`` for the detail usage.\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n optimizers (Union[None, Optimizer, Iterable[Optimizer]]):\\n The optimizers that are used to optimize ``model``.\\n submodules: Optional[Set[nn.Module]]: only return the model parameters\\n that belong to the submodules.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be returned. See\\n `StateDictOptions` for the details.\\n\\n Returns:\\n The state_dict for ``optimizers``.\\n\\n :rtype: OptimizerStateType\\n \\\"\\\"\\\"\\n with gc_context():\\n optimizers = (\\n (optimizers,)\\n if isinstance(optimizers, torch.optim.Optimizer)\\n else tuple(optimizers)\\n )\\n info = _verify_options(\\n model,\\n optimizers,\\n optim_only=True,\\n submodules=submodules,\\n options=options,\\n )\\n optim_state_dict = _get_optim_state_dict(model, optimizers, info)\\n _verify_state_dict({}, optim_state_dict, info)\\n return optim_state_dict\\n\\n\\ndef get_state_dict(\\n model: nn.Module,\\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\\n *,\\n submodules: Optional[Set[nn.Module]] = None,\\n options: Optional[StateDictOptions] = None,\\n) -> Tuple[Dict[str, ValueType], OptimizerStateType]:\\n \\\"\\\"\\\"\\n Return the model state_dict and optimizers state_dict.\\n\\n ``get_state_dict`` can process any module that is parallelized by PyTorch\\n FSDP/fully_shard, DDP/replicate, tensor_parallel/parallelize_module, and any\\n combination of these parallelisms. The main functions of ``get_state_dict``\\n are: 1.) returning a model and optimizer state_dict that can be resharded\\n with a different number of trainers and/or different parallelisms.\\n 2.) hiding the parallelism-specific state_dict APIs. Users don't have to call\\n these APIs.\\n 3.) sanity checking the result state_dict.\\n\\n The keys of the result state dictionary are the canonical FQNs (Fully\\n Qualified Names). A canonical FQN refers to the FQN based on a parameter's\\n position in an nn.Module hierarchy. More specifically, a canonical FQN to a\\n parameter is the FQN returned by ``module.named_parameters()`` or\\n ``module.named_buffers()`` when the module is not distributed by any\\n parallelisms. Since the optimizer internally uses parameter IDs to represent\\n a parameter, there will be a conversion from the parameter IDs to the\\n canonical FQNs when calling this API.\\n\\n ``get_state_dict`` can also process a module that is not parallelized. In\\n such a case, ``get_state_dict`` only performs one function -- converting the\\n optimizer parameter IDs to the canonical FQNs.\\n\\n Example:\\n >>> # xdoctest: +SKIP\\n >>> import torch\\n >>> from torch.distributed.fsdp import FullyShardedDataParallel as FSDP\\n >>> from torch.nn.parallel import DistributedDataParallel as DDP\\n >>> from torch.distributed.checkpoint.state_dict import get_state_dict\\n\\n >>> fsdp_model = FSDP(copy.deepcopy(model))\\n >>> fsdp_optim = torch.optim.Adam(model.parameters(), lr=1e-3)\\n >>> ddp_model = DDP(copy.deepcopy(model))\\n >>> ddp_optim = torch.optim.Adam(model.parameters(), lr=1e-3)\\n\\n\\n >>> ddp_state_dict, ddp_optim_state_dict = get_state_dict(ddp_model, ddp_optim)\\n >>> fsdp_state_dict, fsdp_optim_state_dict = get_state_dict(fsdp_model, fsdp_optim)\\n\\n >>> # if we simply call ddp_model.state_dict() and fsdp_model.state_dict(),\\n >>> # the asserts will fail.\\n >>> assert ddp_state_dict == fsdp_state_dict\\n >>> assert ddp_optim_state == fsdp_optim_state_dict\\n\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n optimizers (Union[None, Optimizer, Iterable[Optimizer]]):\\n The optimizers that are used to optimize ``model``.\\n submodules: Optional[Set[nn.Module]]: only return the model parameters\\n that belong to the submodules.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be returned. See\\n `StateDictOptions` for the details.\\n\\n Returns:\\n ``Tuple`` that contain model state_dict and optimizer state_dict.\\n\\n :rtype: typing.Tuple[typing.Dict[str, ValueType], OptimizerStateType]\\n \\\"\\\"\\\"\\n\\n with gc_context():\\n optimizers = (\\n (optimizers,)\\n if isinstance(optimizers, torch.optim.Optimizer)\\n else tuple(optimizers)\\n )\\n info = _verify_options(\\n model,\\n optimizers,\\n optim_only=False,\\n submodules=submodules,\\n options=options,\\n )\\n model_state_dict = _get_model_state_dict(model, info)\\n optim_state_dict = _get_optim_state_dict(model, optimizers, info)\\n _verify_state_dict(model_state_dict, optim_state_dict, info)\\n return model_state_dict, optim_state_dict\\n\\n\\ndef _unflatten_model_state_dict(\\n model: nn.Module,\\n state_dict: Union[Dict[nn.Module, Dict[str, ValueType]], Dict[str, ValueType]],\\n) -> Dict[str, ValueType]:\\n if not state_dict:\\n return {}\\n\\n if isinstance(next(iter(state_dict.keys())), nn.Module):\\n cast_state_dict = cast(Dict[nn.Module, Dict[str, ValueType]], state_dict)\\n new_state_dict: Dict[str, ValueType] = {}\\n for submodule, sub_state_dict in cast_state_dict.items():\\n for name, m in model.named_modules():\\n if m != submodule:\\n continue\\n\\n fqns = _get_fqns(model, name)\\n assert len(fqns) == 1, \\\"FQNs for a submodule should only have 1 element\\\"\\n prefix = f\\\"{next(iter(fqns))}.\\\"\\n new_state_dict.update(\\n {prefix + subfqn: value for subfqn, value in sub_state_dict.items()}\\n )\\n return new_state_dict\\n else:\\n return cast(Dict[str, ValueType], state_dict)\\n\\n\\ndef set_model_state_dict(\\n model: nn.Module,\\n model_state_dict: Dict[str, ValueType],\\n *,\\n options: Optional[StateDictOptions] = None,\\n) -> _IncompatibleKeys:\\n \\\"\\\"\\\"Load the model state_dict.\\n\\n The counterpart of ``get_model_state_dict`` to set the state_dict to the\\n model. See ``set_state_dict`` for the detail usage.\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n model_state_dict: (Dict[str, ValueType]):\\n the model state_dict to load. If the key of the ``model_state_dict``\\n is nn.Module, the key is a submodule of ``model`` and the value should\\n be the state_dict of the submodule. When loading the state_dict,\\n the prefix of the submodule will be append to the state_dict.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be loaded. See\\n `StateDictOptions` for the details.\\n\\n Returns:\\n ``NamedTuple`` with ``missing_keys`` and ``unexpected_keys`` fields:\\n * **missing_keys** is a list of str containing the missing keys\\n * **unexpected_keys** is a list of str containing the unexpected keys\\n\\n :type model_state_dict: typing.Dict[str, ValueType]\\n \\\"\\\"\\\"\\n model_state_dict: Dict[str, ValueType] = _unflatten_model_state_dict(\\n model, model_state_dict\\n )\\n with gc_context():\\n info = _verify_options(model, tuple(), optim_only=False, options=options)\\n\\n _verify_state_dict(model_state_dict, {}, info)\\n return _load_model_state_dict(model, model_state_dict, info)\\n\\n\\ndef set_optimizer_state_dict(\\n model: nn.Module,\\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\\n *,\\n optim_state_dict: OptimizerStateType,\\n options: Optional[StateDictOptions] = None,\\n) -> None:\\n \\\"\\\"\\\"Load the optimizers state_dict.\\n\\n The counterpart of ``get_optimizer_state_dict`` to set the state_dict to the\\n optimizers. See ``set_state_dict`` for the detail usage.\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n optimizers (Union[Optimizer, Iterable[Optimizer]]):\\n The optimizers that are used to optimize ``model``.\\n optim_state_dict: OptimizerStateType:\\n the optimizer state_dict to load.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be loaded. See\\n `StateDictOptions` for the details.\\n\\n Returns:\\n None\\n\\n :type optim_state_dict: typing.OptimizerStateType\\n \\\"\\\"\\\"\\n with gc_context():\\n optimizers = (\\n (optimizers,)\\n if isinstance(optimizers, torch.optim.Optimizer)\\n else tuple(optimizers)\\n )\\n info = _verify_options(model, optimizers, optim_only=True, options=options)\\n\\n _verify_state_dict({}, optim_state_dict, info)\\n _load_optim_state_dict(model, optimizers, optim_state_dict, info)\\n\\n\\ndef set_state_dict(\\n model: nn.Module,\\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\\n *,\\n model_state_dict: Dict[str, ValueType],\\n optim_state_dict: OptimizerStateType,\\n options: Optional[StateDictOptions] = None,\\n) -> _IncompatibleKeys:\\n \\\"\\\"\\\"Load the model state_dict and optimizers state_dict.\\n\\n The counterpart of ``get_state_dict`` to set the state_dict to the model and\\n optimizers. The given ``model_state_dict`` and ``optim_state_dict`` do not\\n have to be returned by ``get_state_dict`` but must meet the following\\n requirements: 1) all FQNs are canonical FQNs as defined in ``get_state_dict``,\\n 2) if a tensor is sharded, it must be either a ShardedTensor or DTensor,\\n 3) optimizer state_dict cannot contain the parameter IDs; the keys should be\\n the canonical FQNs.\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n optimizers (Union[Optimizer, Iterable[Optimizer]]):\\n The optimizers that are used to optimize ``model``.\\n model_state_dict: (Union[Dict[nn.Module, Dict[str, ValueType]], Dict[str, ValueType]]):\\n the model state_dict to load. If the key of the ``model_state_dict``\\n is nn.Module, the key is a submodule of ``model`` and the value should\\n be the state_dict of the submodule. When loading the state_dict,\\n the prefix of the submodule will be append to the state_dict.\\n optim_state_dict: OptimizerStateType:\\n the optimizer state_dict to load.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be loaded. See\\n `StateDictOptions` for the details.\\n\\n Returns:\\n ``NamedTuple`` with ``missing_keys`` and ``unexpected_keys`` fields:\\n * **missing_keys** is a list of str containing the missing keys of the model state_dict.\\n * **unexpected_keys** is a list of str containing the unexpected keys of the model state_dict.\\n\\n :type model_state_dict: typing.Dict[str, ValueType]\\n :type optim_state_dict: typing.OptimizerStateType\\n \\\"\\\"\\\"\\n\\n model_state_dict: Dict[str, ValueType] = _unflatten_model_state_dict(\\n model, model_state_dict\\n )\\n with gc_context():\\n optimizers = (\\n (optimizers,)\\n if isinstance(optimizers, torch.optim.Optimizer)\\n else tuple(optimizers)\\n )\\n info = _verify_options(\\n model, optimizers, optim_only=not model_state_dict, options=options\\n )\\n\\n _verify_state_dict(model_state_dict, optim_state_dict, info)\\n _load_optim_state_dict(model, optimizers, optim_state_dict, info)\\n return _load_model_state_dict(model, model_state_dict, info)\\n\\n\\n# TODO: correct the state_dict function signature.\\n# TODO: this API is not yet fully tested. Make it private\\n@no_type_check\\ndef _patch_model_state_dict(\\n model: nn.Module,\\n *,\\n options: Optional[StateDictOptions] = None,\\n) -> None:\\n \\\"\\\"\\\"Patch the ``state_dict`` and ``load_state_dict`` attributes of ``model``.\\n\\n Patch the ``state_dict`` and ``load_state_dict`` attributes of ``model`` to\\n be a partial function to call ``get_state_dict`` and ``set_state_dict``.\\n\\n Example:\\n from torch.distributed.fsdp import FullyShardedDataParallel as FSDP\\n from torch.distributed.checkpoint.state_dict import patch_model_state_dict\\n\\n model = fsdp(model)\\n patch_model_state_dict(model)\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be loaded. See\\n `StateDictOptions` for the details.\\n Returns:\\n None\\n \\\"\\\"\\\"\\n\\n _state_dict_call = functools.partial(\\n get_model_state_dict,\\n model=model,\\n options=options,\\n )\\n\\n def state_dict_call():\\n return _state_dict_call()\\n\\n model.state_dict = state_dict_call\\n\\n _load_state_dict_call = functools.partial(\\n set_model_state_dict,\\n model=model,\\n options=options,\\n )\\n\\n def load_state_dict_call(state_dict: Dict[str, Any]):\\n _load_state_dict_call(model_state_dict=state_dict)\\n\\n model.load_state_dict = load_state_dict_call\\n\\n _patched_state_dict.add(state_dict_call)\\n _patched_state_dict.add(load_state_dict_call)\\n\\n\\n# TODO: correct the load_state_dict function signature.\\n# TODO: this API is not yet fully tested. Make it private\\n@no_type_check\\ndef _patch_optimizer_state_dict(\\n model: nn.Module,\\n *,\\n optimizers: Tuple[torch.optim.Optimizer, ...],\\n options: Optional[StateDictOptions] = None,\\n) -> None:\\n \\\"\\\"\\\"Patch the ``state_dict`` and ``load_state_dict`` attributes of ``optimizers``.\\n\\n Patch the ``state_dict`` and ``load_state_dict`` attributes of ``optimizers`` to\\n be a partial function to call ``get_state_dict`` and ``set_state_dict``.\\n\\n Note that if there are multiple optimizers, all of the optimizers will be patched.\\n So users only need to call one of the state_dict() to get the full result.\\n\\n Example:\\n from torch.distributed.fsdp import FullyShardedDataParallel as FSDP\\n from torch.distributed.checkpoint.state_dict import patch_model_state_dict\\n\\n model = fsdp(model)\\n patch_model_state_dict(model)\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be loaded. See\\n `StateDictOptions` for the details.\\n Returns:\\n None\\n \\\"\\\"\\\"\\n\\n _state_dict_call = functools.partial(\\n get_optimizer_state_dict,\\n model=model,\\n optimizers=optimizers,\\n options=options,\\n )\\n\\n def state_dict_call():\\n return _state_dict_call()\\n\\n _load_state_dict_call = functools.partial(\\n set_optimizer_state_dict,\\n model=model,\\n optimizers=optimizers,\\n options=options,\\n )\\n\\n def load_state_dict_call(state_dict: Dict[str, Any]):\\n _load_state_dict_call(optim_state_dict=state_dict)\\n\\n _patched_state_dict.add(state_dict_call)\\n _patched_state_dict.add(load_state_dict_call)\\n optimizers = (\\n (optimizers,)\\n if isinstance(optimizers, torch.optim.Optimizer)\\n else tuple(optimizers)\\n )\\n for optim in optimizers:\\n optim.state_dict = state_dict_call\\n optim.load_state_dict = load_state_dict_call\\n\",\n \"path\": \"torch/distributed/checkpoint/state_dict.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import contextlib\nimport functools\nimport gc\nfrom dataclasses import asdict, dataclass, field\nfrom itertools import chain\nfrom typing import (\n Any,\n Callable,\n cast,\n Dict,\n Generator,\n Iterable,\n List,\n no_type_check,\n Optional,\n Set,\n Tuple,\n Union,\n)\n\nimport torch\nimport torch.distributed as dist\nimport torch.nn as nn\nfrom torch.distributed._shard.sharded_tensor import ShardedTensor\nfrom torch.distributed._state_dict_utils import (\n _gather_state_dict,\n _offload_state_dict_to_cpu,\n)\nfrom torch.distributed._tensor import DTensor\nfrom torch.distributed.algorithms._checkpoint.checkpoint_wrapper import (\n _CHECKPOINT_PREFIX,\n)\nfrom torch.distributed.fsdp import (\n FullOptimStateDictConfig,\n FullStateDictConfig,\n FullyShardedDataParallel as FSDP,\n OptimStateDictConfig,\n ShardedOptimStateDictConfig,\n ShardedStateDictConfig,\n StateDictConfig,\n StateDictType,\n)\nfrom torch.distributed.fsdp._common_utils import (\n _get_module_fsdp_state_if_fully_sharded_module,\n FSDP_WRAPPED_MODULE,\n)\nfrom torch.nn.modules.module import _IncompatibleKeys\nfrom torch.nn.parallel import DistributedDataParallel as DDP\n\n\nFLAT_PARAM = \"_flat_param\"\nPG = \"param_groups\"\nPG_PREFIX = f\"{PG}.\"\nSTATE = \"state\"\nSTATE_PREFIX = f\"{STATE}.\"\nPARAMS = \"params\"\nFQNS_T = Set[str]\n\n_patched_state_dict: Set[Callable] = set()\n\n\nPrimitiveType = Union[DTensor, ShardedTensor, torch.Tensor, int, float, str]\nValueType = Union[\n PrimitiveType, List[PrimitiveType], Tuple[PrimitiveType], Dict[str, \"ValueType\"]\n]\nDictValueType = Dict[str, ValueType]\nListDictValueType = List[DictValueType]\nOptimizerStateType = Dict[str, Union[DictValueType, ListDictValueType]]\n\n\n@contextlib.contextmanager\ndef gc_context():\n is_enabled = gc.isenabled()\n gc.disable()\n try:\n yield\n finally:\n # TODO: add logging for the gc details/time\n gc.collect()\n if is_enabled:\n gc.enable()\n\n\n@dataclass\nclass StateDictOptions:\n \"\"\"\n This dataclass specifies how get_state_dict/set_state_dict will work.\n\n - ``full_state_dict``: if this is set to True, all the tensors in the\n returned state_dict will be gathered. No ShardedTensor and DTensor\n will be in the returned state_dict.\n\n - ``cpu_offload``: offload all the tensors to cpu. To prevent CPU OOM, if\n ``full_state_dict`` is also true, then only the rank0 will get the\n state_dict and all other ranks will get empty state_dict.\n\n - ``ignore_frozen_params``: if the value is True, the returned state_dict\n won't contain any frozen parameters -- the ``requires_grad`` is False.\n The default value is False.\n\n - ``keep_submodule_prefixes``: when ``submodules`` is not None, this option\n indicates whether to keep the submodule prefixes from the state_dict keys.\n or example, if the submodule is ``module.pretrain`` and the full FQN of\n the parameter is ``pretrain.layer1.weight`` of the param. When this option\n is True, the parameter's key in the returned state_dict will be\n ``pretrain.layer1.weight``. If the options is False, the key will be\n ``layer1.weight``.\n Note that if ``keep_submodule_prefixes`` is False, there may be conflicted\n FQNs, hence there should be only one submodule in ``submodules``.\n\n - ``strict``: the ``strict`` option when ``set_state_dict`` calls\n model.load_state_dict().\n The default value is False.\n \"\"\"\n\n full_state_dict: bool = False\n cpu_offload: bool = False\n ignore_frozen_params: bool = False\n keep_submodule_prefixes: bool = True\n strict: bool = True\n\n\n@dataclass\nclass _StateDictInfo(StateDictOptions):\n fqn_param_mapping: Dict[\n Union[str, torch.Tensor], Union[FQNS_T, torch.Tensor]\n ] = field(default_factory=dict)\n all_fqns: Set[str] = field(default_factory=set)\n submodule_prefixes: Set[str] = field(default_factory=set)\n handle_model: bool = True\n handle_optim: bool = True\n fsdp_context: Callable = contextlib.nullcontext\n fsdp_modules: List[nn.Module] = field(default_factory=list)\n\n\ndef _get_fqns(\n model: nn.Module,\n name: str,\n skip_ddp_prefix: bool = True,\n skip_compiler_prefix: bool = True,\n) -> FQNS_T:\n \"\"\"\n This API is used to convert the name of a parameter to the FQNs. For FSDP\n without `use_orig_params`, the name of FlatParameter can be mapped to\n multiple original parameters. As a result, the return type of this function\n is `Set[str]`.\n\n Args:\n module (nn.Module): the root model.\n name (str): the name\n skip_ddp_prefix (bool): whether to skip DDP's `module` prefix\n\n Returns:\n The canonical FQNs based on the model traversal.\n \"\"\"\n\n # Remove the checkpoint prefix, if it exists.\n name = name.replace(_CHECKPOINT_PREFIX, \"\")\n if \".\" not in name:\n return {name}\n\n obj_names = name.split(\".\")\n fqn_obj_names = []\n curr_obj = model\n for i, curr_obj_name in enumerate(obj_names):\n if isinstance(curr_obj, DDP):\n assert curr_obj_name == \"module\"\n curr_obj = curr_obj.module\n if not skip_ddp_prefix:\n fqn_obj_names.append(curr_obj_name)\n elif isinstance(curr_obj, FSDP):\n if i < len(obj_names) - 1 and obj_names[i + 1] == FLAT_PARAM:\n prefix = \".\".join(fqn_obj_names)\n flat_param = getattr(curr_obj, FLAT_PARAM)\n if prefix:\n prefix = f\"{prefix}.\"\n return {f\"{prefix}{fqn}\" for fqn in flat_param._fqns}\n curr_obj = getattr(curr_obj, FSDP_WRAPPED_MODULE)\n if curr_obj_name != FSDP_WRAPPED_MODULE:\n fqn_obj_names.append(curr_obj_name)\n curr_obj = getattr(curr_obj, curr_obj_name)\n elif isinstance(curr_obj, torch._dynamo.eval_frame.OptimizedModule):\n assert curr_obj_name == \"_orig_mod\"\n curr_obj = curr_obj._orig_mod\n if not skip_compiler_prefix:\n fqn_obj_names.append(curr_obj_name)\n else:\n fqn_obj_names.append(curr_obj_name)\n if curr_obj_name == nn.modules.module._EXTRA_STATE_KEY_SUFFIX:\n if i != len(obj_names) - 1:\n raise RuntimeError(\"Expect `_extra_state` to be the last obj name\")\n else:\n curr_obj = getattr(curr_obj, curr_obj_name)\n\n return {\".\".join(fqn_obj_names).replace(_CHECKPOINT_PREFIX, \"\")}\n\n\nclass _EXTRA_STATE:\n pass\n\n\ndef _iterate_valid_model_state(model):\n visited_modules: Set[nn.Module] = set()\n\n def recurse(module: nn.Module, curr_fqn: str) -> Generator:\n visited_modules.add(module)\n\n curr_fqn = f\"{curr_fqn}.\" if curr_fqn else \"\"\n for name, submodule in module.named_children():\n if submodule in visited_modules:\n continue\n new_fqn = f\"{curr_fqn}{name}\"\n yield from recurse(submodule, new_fqn)\n\n for name, obj in chain(\n module.named_buffers(recurse=False), module.named_parameters(recurse=False)\n ):\n if name in module._non_persistent_buffers_set:\n continue\n new_fqn = f\"{curr_fqn}{name}\"\n yield new_fqn, obj\n\n if (\n getattr(module.__class__, \"get_extra_state\", nn.Module.get_extra_state)\n != nn.Module.get_extra_state\n ):\n new_fqn = f\"{curr_fqn}{nn.modules.module._EXTRA_STATE_KEY_SUFFIX}\"\n yield new_fqn, _EXTRA_STATE()\n\n yield from recurse(model, \"\")\n\n\ndef _verify_options(\n model: nn.Module,\n optims: Tuple[torch.optim.Optimizer, ...],\n optim_only: bool,\n *,\n submodules: Optional[Set[nn.Module]] = None,\n options: Optional[StateDictOptions] = None,\n) -> _StateDictInfo:\n \"\"\"\n Verify the model and options passed by the user and generates _StateDictInfo.\n \"\"\"\n if optim_only and not optims:\n raise RuntimeError(\n \"Optimizers are not passed in but optim_only is set to True.\"\n )\n\n options = options or StateDictOptions()\n\n fqn_param_mapping: Dict[\n Union[str, torch.Tensor], Union[Set[str], torch.Tensor]\n ] = {}\n all_fqns = set()\n for name, param in _iterate_valid_model_state(model):\n fqns = _get_fqns(model, name)\n if not isinstance(param, _EXTRA_STATE):\n fqn_param_mapping[param] = fqns\n for fqn in fqns:\n if not isinstance(param, _EXTRA_STATE):\n fqn_param_mapping[fqn] = param\n all_fqns.add(fqn)\n\n submodule_prefixes = set()\n if submodules:\n submodules = set(submodules)\n for name, module in model.named_modules():\n if module not in submodules:\n continue\n fqns = _get_fqns(model, name)\n assert len(fqns) == 1, \"Submodule FQN should only have 1 instance\"\n for fqn in fqns:\n submodule_prefixes.add(f\"{fqn}.\")\n\n fsdp_modules = FSDP.fsdp_modules(model)\n state_dict_config: StateDictConfig\n optim_state_dict_config: OptimStateDictConfig\n fsdp_context: Callable\n if fsdp_modules:\n # FSDP API only work if at least one FSDP instance exists.\n if options.full_state_dict:\n state_dict_config = FullStateDictConfig(\n offload_to_cpu=options.cpu_offload, rank0_only=options.cpu_offload\n )\n optim_state_dict_config = FullOptimStateDictConfig(\n offload_to_cpu=options.cpu_offload, rank0_only=options.cpu_offload\n )\n state_dict_type = StateDictType.FULL_STATE_DICT\n else:\n state_dict_config = ShardedStateDictConfig(\n offload_to_cpu=options.cpu_offload,\n )\n optim_state_dict_config = ShardedOptimStateDictConfig(\n offload_to_cpu=options.cpu_offload,\n )\n state_dict_type = StateDictType.SHARDED_STATE_DICT\n\n fsdp_context = functools.partial(\n FSDP.state_dict_type,\n module=model,\n state_dict_type=state_dict_type,\n state_dict_config=state_dict_config,\n optim_state_dict_config=optim_state_dict_config,\n )\n else:\n fsdp_context = contextlib.nullcontext\n\n return _StateDictInfo(\n **asdict(options),\n fqn_param_mapping=fqn_param_mapping,\n all_fqns=all_fqns,\n submodule_prefixes=submodule_prefixes,\n fsdp_context=fsdp_context,\n fsdp_modules=cast(List[nn.Module], fsdp_modules),\n handle_model=not optim_only,\n handle_optim=(len(optims) > 0),\n )\n\n\ndef _verify_state_dict(\n model_state_dict: Dict[str, ValueType],\n optim_state_dict: OptimizerStateType,\n info: _StateDictInfo,\n) -> None:\n for module in info.fsdp_modules:\n fsdp_state = _get_module_fsdp_state_if_fully_sharded_module(module)\n assert fsdp_state is not None, \"Expected a fsdp_state with a fsdp module.\"\n\n # Verify if the model_state_dict and optim_state_dict are valid. This API\n # should give the users an explicit error message to debug or report.\n if (\n info.handle_model\n and not model_state_dict\n and not info.submodule_prefixes\n and not info.ignore_frozen_params\n and not (info.cpu_offload and info.full_state_dict)\n and info.strict\n ):\n raise RuntimeError(\n \"The option indicates that model state_dict is required to save \"\n \"or load, but model state_dict is empty.\"\n f\"rank = {dist.get_rank()=}.\"\n )\n\n if info.handle_optim:\n if not (optim_state_dict and optim_state_dict[STATE]) and not (\n info.cpu_offload and info.full_state_dict\n ):\n raise RuntimeError(\n \"The option indicates that model state_dict is required to save, \"\n f\"or load but optim state_dict is empty. {optim_state_dict}\"\n )\n\n for key in model_state_dict.keys():\n if FLAT_PARAM in key:\n raise RuntimeError(\n f\"{key} contains {FLAT_PARAM}. This can happen if the model \"\n \"is not the root module.\"\n )\n\n\ndef _state_dict_fn(obj: Union[nn.Module, torch.optim.Optimizer], api: str) -> Callable:\n call = getattr(obj, api)\n if call in _patched_state_dict:\n call = functools.partial(getattr(obj.__class__, api), self=obj)\n return call\n\n\ndef _get_model_state_dict(\n model: nn.Module, info: _StateDictInfo\n) -> Dict[str, ValueType]:\n if not info.handle_model:\n return {}\n\n with info.fsdp_context():\n state_dict = _state_dict_fn(model, \"state_dict\")()\n\n for key in list(state_dict.keys()):\n fqns = _get_fqns(model, key)\n assert len(fqns) == 1\n fqn = next(iter(fqns))\n if fqn != key:\n # As we only support FSDP, DDP, and TP, the only cases are\n # wrapper-based DDP and compiler. Verify if the assumption\n # is correct.\n def verify(key, fqn) -> bool:\n if len(fqn) >= len(key):\n return False\n fqn_split = fqn.split(\".\")\n key_split = key.split(\".\")\n fqn_idx = 0\n for key_idx, key_name in enumerate(key_split):\n if key_name == fqn_split[fqn_idx]:\n fqn_idx += 1\n if fqn_idx == len(fqn_split):\n return key_idx == len(key_split) - 1\n elif key_name in (\"module\", \"_orig_mod\"):\n continue\n else:\n return False\n return True\n\n if not verify(key, fqn):\n raise RuntimeError(f\"An unexpected key, {key}, exists. FQN is {fqn}\")\n state_dict[fqn] = state_dict.pop(key)\n\n if info.submodule_prefixes:\n new_state_dict: Dict[str, ValueType] = {}\n # TODO: make this faster.\n for fqn in state_dict.keys():\n for prefix in info.submodule_prefixes:\n if not fqn.startswith(prefix):\n continue\n if info.keep_submodule_prefixes:\n new_state_dict[fqn] = state_dict[fqn]\n else:\n new_fqn = fqn[len(prefix) :]\n new_state_dict[new_fqn] = state_dict[fqn]\n state_dict = new_state_dict\n\n if info.ignore_frozen_params:\n for key, param in model.named_parameters():\n if param.requires_grad:\n continue\n fqns = _get_fqns(model, key)\n for fqn in fqns:\n state_dict.pop(fqn)\n\n for key, p in list(state_dict.items()):\n if torch.is_tensor(p) and p.is_meta:\n state_dict.pop(key)\n\n if info.full_state_dict:\n ranks_only = tuple() if not info.cpu_offload else (0,)\n return _gather_state_dict(\n state_dict, cpu_offload=info.cpu_offload, ranks_only=ranks_only\n )\n elif info.cpu_offload:\n return _offload_state_dict_to_cpu(state_dict)\n else:\n return state_dict\n\n\ndef _load_model_state_dict(\n model: nn.Module,\n state_dict: Dict[str, ValueType],\n info: _StateDictInfo,\n) -> _IncompatibleKeys:\n if not info.handle_model or not state_dict:\n return _IncompatibleKeys({}, {})\n\n for key, _ in _iterate_valid_model_state(model):\n fqns = _get_fqns(model, key)\n fqns_with_prefix = _get_fqns(\n model, key, skip_ddp_prefix=False, skip_compiler_prefix=False\n )\n for fqn, fqn_with_prefix in zip(fqns, fqns_with_prefix):\n if fqn != fqn_with_prefix:\n state_dict[fqn_with_prefix] = state_dict.pop(fqn)\n\n with info.fsdp_context():\n return cast(\n _IncompatibleKeys,\n _state_dict_fn(model, \"load_state_dict\")(\n state_dict=state_dict, strict=info.strict\n ),\n )\n\n\ndef _init_optim_state(optim: torch.optim.Optimizer) -> None:\n \"\"\"\n Initialize optim states by calling the step() with zero grads.\n \"\"\"\n if optim.state:\n # The optimizer state is initialized.\n return\n\n for param_group in optim.param_groups:\n for param in param_group[PARAMS]:\n if param.grad is not None:\n raise RuntimeError(\n \"state_dict can only be used if the optimizer \"\n \"states are initialized (usually after one step() with \"\n \"gradients) or gradients are None. For the later case, \"\n \"state_dict will fake the gradients as zero \"\n \"to initialize the optimizer states. However, the \"\n \"gradients are not None.\"\n )\n if param.requires_grad:\n param.grad = torch.zeros_like(param)\n optim.step(closure=None)\n optim.zero_grad(set_to_none=True)\n\n\ndef _get_optim_state_dict(\n model: nn.Module,\n optimizers: Tuple[torch.optim.Optimizer, ...],\n info: _StateDictInfo,\n) -> OptimizerStateType:\n if not info.handle_optim:\n return {}\n\n optim_state_dict: OptimizerStateType = {STATE: {}, PG: []}\n for optim in optimizers:\n _init_optim_state(optim)\n osd = _state_dict_fn(optim, \"state_dict\")()\n if info.fsdp_modules:\n with info.fsdp_context():\n osd = FSDP.optim_state_dict(model, optim, osd)\n\n # We need to specially handle FlatParameter FSDP as\n # FlatParameter FSDP converts the FQNs.\n # There are no easy ways to do this conversion systematically.\n # We can only use a string replacment without correctness check.\n if not osd:\n continue\n for k in list(osd[STATE].keys()):\n if \"_orig_mod\" in k:\n osd[STATE][k.replace(\"_orig_mod.\", \"\")] = osd[STATE].pop(k)\n for g in osd[PG]:\n params = [k.replace(\"_orig_mod.\", \"\") for k in g[PARAMS]]\n g[PARAMS] = params\n else:\n params = list(chain.from_iterable(g[PARAMS] for g in optim.param_groups))\n param_pid_mapping = dict(zip(params, range(len(params))))\n fqn_pid_mapping = {}\n for key, param in model.named_parameters():\n fqns = _get_fqns(model, key)\n assert len(fqns) == 1\n fqn = next(iter(fqns))\n if param not in param_pid_mapping:\n continue\n pid = param_pid_mapping[param]\n fqn_pid_mapping[fqn] = pid\n fqn_pid_mapping[pid] = fqn\n\n for key in list(osd[STATE].keys()):\n fqn = fqn_pid_mapping[key]\n osd[STATE][fqn] = osd[STATE].pop(key)\n\n for group in osd[PG]:\n group[PARAMS] = [fqn_pid_mapping[pid] for pid in group[PARAMS]]\n\n if not osd:\n continue\n\n cast(DictValueType, optim_state_dict[STATE]).update(osd[STATE])\n cast(ListDictValueType, optim_state_dict[PG]).extend(osd[PG])\n\n if info.full_state_dict:\n ranks_only = tuple() if not info.cpu_offload else (0,)\n return _gather_state_dict(\n optim_state_dict, cpu_offload=info.cpu_offload, ranks_only=ranks_only\n )\n elif info.cpu_offload:\n return _offload_state_dict_to_cpu(optim_state_dict)\n else:\n return optim_state_dict\n\n\ndef _split_optim_state_dict(\n model: nn.Module,\n optim: torch.optim.Optimizer,\n optim_state_dict: OptimizerStateType,\n info: _StateDictInfo,\n) -> OptimizerStateType:\n \"\"\"\n Extract the corresponding optim state_dict from ``optim_state_dict`` for\n ``optim`` and return the result optim state_dict.\n\n Args:\n model (nn.Module): the root model.\n optim (torch.optim.Optimizer): the optimizer.\n optim_state_dict (Dict[str, ValueType]): the superset optim state_dict that\n contains the optim state_dict of ``optim``.\n info (_StateDictInfo): state dict information.\n\n Returns:\n The optim state_dict of ``optim``.\n \"\"\"\n\n state: DictValueType = {}\n pg_state: ListDictValueType = []\n return_osd: OptimizerStateType = {STATE: state, PG: pg_state}\n pg_mapping: Dict[int, int] = {}\n\n for param_group in optim.param_groups:\n pg_state.append({PARAMS: []})\n for param in param_group[PARAMS]:\n for fqn in info.fqn_param_mapping[param]:\n params = pg_state[-1][PARAMS]\n assert isinstance(params, list)\n params.append(fqn)\n if param.requires_grad:\n state[fqn] = cast(DictValueType, optim_state_dict[STATE])[fqn]\n for loaded_param_group in cast(ListDictValueType, optim_state_dict[PG]):\n params = loaded_param_group[PARAMS]\n assert isinstance(params, list)\n if fqn in params:\n pg_mapping[id(loaded_param_group)] = len(return_osd[PG]) - 1\n\n for param_group in cast(ListDictValueType, optim_state_dict[PG]):\n idx = pg_mapping.get(id(param_group), -1)\n if idx == -1:\n continue\n for key, value in param_group.items():\n if key == PARAMS:\n continue\n # TODO: check if value is the same if exists.\n pg_state[idx][key] = value\n\n return return_osd\n\n\ndef _load_optim_state_dict(\n model: nn.Module,\n optimizers: Tuple[torch.optim.Optimizer, ...],\n state_dict: OptimizerStateType,\n info: _StateDictInfo,\n) -> None:\n if not info.handle_optim:\n return\n\n for optim in optimizers:\n optim_state_dict = _split_optim_state_dict(model, optim, state_dict, info)\n if info.fsdp_modules:\n # We need to specially handle FlatParameter FSDP as\n # FlatParameter FSDP converts the FQNs.\n for original_fqn, _ in model.named_parameters():\n fqns = _get_fqns(model, original_fqn)\n fqns_with_compiler = _get_fqns(\n model, original_fqn, skip_compiler_prefix=False\n )\n if fqns == fqns_with_compiler:\n continue\n\n assert len(fqns) == 1\n fqn = fqns.pop()\n fqn_with_compiler = fqns_with_compiler.pop()\n for g in optim_state_dict[PG]:\n val = cast(Dict[str, Any], g)\n params = [\n key.replace(fqn, fqn_with_compiler) for key in val[PARAMS]\n ]\n val[PARAMS] = params\n osd_state = cast(DictValueType, optim_state_dict[STATE])\n for k in list(osd_state.keys()):\n if fqn in k:\n osd_state[k.replace(fqn, fqn_with_compiler)] = osd_state.pop(k)\n\n with info.fsdp_context():\n optim_state_dict = FSDP.optim_state_dict_to_load(\n model, optim, optim_state_dict\n )\n\n # Note that we do not have to convert the FQN back to param id here if\n # order in optim.param_groups[idx][PARAMS] is the same as the one in\n # optim_state_dict[PG][idx][PARAMS].\n _init_optim_state(optim)\n _state_dict_fn(optim, \"load_state_dict\")(state_dict=optim_state_dict)\n\n\ndef get_model_state_dict(\n model: nn.Module,\n *,\n submodules: Optional[Set[nn.Module]] = None,\n options: Optional[StateDictOptions] = None,\n) -> Dict[str, ValueType]:\n \"\"\"\n Return the model state_dict of ``model``.\n\n See ``get_state_dict`` for the detail usage.\n\n Args:\n model (nn.Module): the nn.Module to the model.\n submodules: Optional[Set[nn.Module]]: only return the model parameters\n that belong to the submodules.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be returned. See\n `StateDictOptions` for the details.\n\n Returns:\n The state_dict for ``model``.\n\n :rtype: typing.Dict[str, ValueType]\n \"\"\"\n with gc_context():\n info = _verify_options(\n model,\n tuple(),\n optim_only=False,\n submodules=submodules,\n options=options,\n )\n model_state_dict = _get_model_state_dict(model, info)\n _verify_state_dict(model_state_dict, {}, info)\n return model_state_dict\n\n\ndef get_optimizer_state_dict(\n model: nn.Module,\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\n *,\n submodules: Optional[Set[nn.Module]] = None,\n options: Optional[StateDictOptions] = None,\n) -> OptimizerStateType:\n \"\"\"\n Return the combined state_dict for optimizers.\n\n See ``get_state_dict`` for the detail usage.\n\n Args:\n model (nn.Module): the nn.Module to the model.\n optimizers (Union[None, Optimizer, Iterable[Optimizer]]):\n The optimizers that are used to optimize ``model``.\n submodules: Optional[Set[nn.Module]]: only return the model parameters\n that belong to the submodules.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be returned. See\n `StateDictOptions` for the details.\n\n Returns:\n The state_dict for ``optimizers``.\n\n :rtype: OptimizerStateType\n \"\"\"\n with gc_context():\n optimizers = (\n (optimizers,)\n if isinstance(optimizers, torch.optim.Optimizer)\n else tuple(optimizers)\n )\n info = _verify_options(\n model,\n optimizers,\n optim_only=True,\n submodules=submodules,\n options=options,\n )\n optim_state_dict = _get_optim_state_dict(model, optimizers, info)\n _verify_state_dict({}, optim_state_dict, info)\n return optim_state_dict\n\n\ndef get_state_dict(\n model: nn.Module,\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\n *,\n submodules: Optional[Set[nn.Module]] = None,\n options: Optional[StateDictOptions] = None,\n) -> Tuple[Dict[str, ValueType], OptimizerStateType]:\n \"\"\"\n Return the model state_dict and optimizers state_dict.\n\n ``get_state_dict`` can process any module that is parallelized by PyTorch\n FSDP/fully_shard, DDP/replicate, tensor_parallel/parallelize_module, and any\n combination of these parallelisms. The main functions of ``get_state_dict``\n are: 1.) returning a model and optimizer state_dict that can be resharded\n with a different number of trainers and/or different parallelisms.\n 2.) hiding the parallelism-specific state_dict APIs. Users don't have to call\n these APIs.\n 3.) sanity checking the result state_dict.\n\n The keys of the result state dictionary are the canonical FQNs (Fully\n Qualified Names). A canonical FQN refers to the FQN based on a parameter's\n position in an nn.Module hierarchy. More specifically, a canonical FQN to a\n parameter is the FQN returned by ``module.named_parameters()`` or\n ``module.named_buffers()`` when the module is not distributed by any\n parallelisms. Since the optimizer internally uses parameter IDs to represent\n a parameter, there will be a conversion from the parameter IDs to the\n canonical FQNs when calling this API.\n\n ``get_state_dict`` can also process a module that is not parallelized. In\n such a case, ``get_state_dict`` only performs one function -- converting the\n optimizer parameter IDs to the canonical FQNs.\n\n Example:\n >>> # xdoctest: +SKIP\n >>> import torch\n >>> from torch.distributed.fsdp import FullyShardedDataParallel as FSDP\n >>> from torch.nn.parallel import DistributedDataParallel as DDP\n >>> from torch.distributed.checkpoint.state_dict import get_state_dict\n\n >>> fsdp_model = FSDP(copy.deepcopy(model))\n >>> fsdp_optim = torch.optim.Adam(model.parameters(), lr=1e-3)\n >>> ddp_model = DDP(copy.deepcopy(model))\n >>> ddp_optim = torch.optim.Adam(model.parameters(), lr=1e-3)\n\n\n >>> ddp_state_dict, ddp_optim_state_dict = get_state_dict(ddp_model, ddp_optim)\n >>> fsdp_state_dict, fsdp_optim_state_dict = get_state_dict(fsdp_model, fsdp_optim)\n\n >>> # if we simply call ddp_model.state_dict() and fsdp_model.state_dict(),\n >>> # the asserts will fail.\n >>> assert ddp_state_dict == fsdp_state_dict\n >>> assert ddp_optim_state == fsdp_optim_state_dict\n\n\n Args:\n model (nn.Module): the nn.Module to the model.\n optimizers (Union[None, Optimizer, Iterable[Optimizer]]):\n The optimizers that are used to optimize ``model``.\n submodules: Optional[Set[nn.Module]]: only return the model parameters\n that belong to the submodules.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be returned. See\n `StateDictOptions` for the details.\n\n Returns:\n ``Tuple`` that contain model state_dict and optimizer state_dict.\n\n :rtype: typing.Tuple[typing.Dict[str, ValueType], OptimizerStateType]\n \"\"\"\n\n with gc_context():\n optimizers = (\n (optimizers,)\n if isinstance(optimizers, torch.optim.Optimizer)\n else tuple(optimizers)\n )\n info = _verify_options(\n model,\n optimizers,\n optim_only=False,\n submodules=submodules,\n options=options,\n )\n model_state_dict = _get_model_state_dict(model, info)\n optim_state_dict = _get_optim_state_dict(model, optimizers, info)\n _verify_state_dict(model_state_dict, optim_state_dict, info)\n return model_state_dict, optim_state_dict\n\n\ndef _unflatten_model_state_dict(\n model: nn.Module,\n state_dict: Union[Dict[nn.Module, Dict[str, ValueType]], Dict[str, ValueType]],\n) -> Dict[str, ValueType]:\n if not state_dict:\n return {}\n\n if isinstance(next(iter(state_dict.keys())), nn.Module):\n cast_state_dict = cast(Dict[nn.Module, Dict[str, ValueType]], state_dict)\n new_state_dict: Dict[str, ValueType] = {}\n for submodule, sub_state_dict in cast_state_dict.items():\n for name, m in model.named_modules():\n if m != submodule:\n continue\n\n fqns = _get_fqns(model, name)\n assert len(fqns) == 1, \"FQNs for a submodule should only have 1 element\"\n prefix = f\"{next(iter(fqns))}.\"\n new_state_dict.update(\n {prefix + subfqn: value for subfqn, value in sub_state_dict.items()}\n )\n return new_state_dict\n else:\n return cast(Dict[str, ValueType], state_dict)\n\n\ndef set_model_state_dict(\n model: nn.Module,\n model_state_dict: Dict[str, ValueType],\n *,\n options: Optional[StateDictOptions] = None,\n) -> _IncompatibleKeys:\n \"\"\"Load the model state_dict.\n\n The counterpart of ``get_model_state_dict`` to set the state_dict to the\n model. See ``set_state_dict`` for the detail usage.\n\n Args:\n model (nn.Module): the nn.Module to the model.\n model_state_dict: (Dict[str, ValueType]):\n the model state_dict to load. If the key of the ``model_state_dict``\n is nn.Module, the key is a submodule of ``model`` and the value should\n be the state_dict of the submodule. When loading the state_dict,\n the prefix of the submodule will be append to the state_dict.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be loaded. See\n `StateDictOptions` for the details.\n\n Returns:\n ``NamedTuple`` with ``missing_keys`` and ``unexpected_keys`` fields:\n * **missing_keys** is a list of str containing the missing keys\n * **unexpected_keys** is a list of str containing the unexpected keys\n\n :type model_state_dict: typing.Dict[str, ValueType]\n \"\"\"\n model_state_dict: Dict[str, ValueType] = _unflatten_model_state_dict(\n model, model_state_dict\n )\n with gc_context():\n info = _verify_options(model, tuple(), optim_only=False, options=options)\n\n _verify_state_dict(model_state_dict, {}, info)\n return _load_model_state_dict(model, model_state_dict, info)\n\n\ndef set_optimizer_state_dict(\n model: nn.Module,\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\n *,\n optim_state_dict: OptimizerStateType,\n options: Optional[StateDictOptions] = None,\n) -> None:\n \"\"\"Load the optimizers state_dict.\n\n The counterpart of ``get_optimizer_state_dict`` to set the state_dict to the\n optimizers. See ``set_state_dict`` for the detail usage.\n\n Args:\n model (nn.Module): the nn.Module to the model.\n optimizers (Union[Optimizer, Iterable[Optimizer]]):\n The optimizers that are used to optimize ``model``.\n optim_state_dict: OptimizerStateType:\n the optimizer state_dict to load.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be loaded. See\n `StateDictOptions` for the details.\n\n Returns:\n None\n\n :type optim_state_dict: typing.OptimizerStateType\n \"\"\"\n with gc_context():\n optimizers = (\n (optimizers,)\n if isinstance(optimizers, torch.optim.Optimizer)\n else tuple(optimizers)\n )\n info = _verify_options(model, optimizers, optim_only=True, options=options)\n\n _verify_state_dict({}, optim_state_dict, info)\n _load_optim_state_dict(model, optimizers, optim_state_dict, info)\n\n\ndef set_state_dict(\n model: nn.Module,\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\n *,\n model_state_dict: Dict[str, ValueType],\n optim_state_dict: OptimizerStateType,\n options: Optional[StateDictOptions] = None,\n) -> _IncompatibleKeys:\n \"\"\"Load the model state_dict and optimizers state_dict.\n\n The counterpart of ``get_state_dict`` to set the state_dict to the model and\n optimizers. The given ``model_state_dict`` and ``optim_state_dict`` do not\n have to be returned by ``get_state_dict`` but must meet the following\n requirements: 1) all FQNs are canonical FQNs as defined in ``get_state_dict``,\n 2) if a tensor is sharded, it must be either a ShardedTensor or DTensor,\n 3) optimizer state_dict cannot contain the parameter IDs; the keys should be\n the canonical FQNs.\n\n Args:\n model (nn.Module): the nn.Module to the model.\n optimizers (Union[Optimizer, Iterable[Optimizer]]):\n The optimizers that are used to optimize ``model``.\n model_state_dict: (Union[Dict[nn.Module, Dict[str, ValueType]], Dict[str, ValueType]]):\n the model state_dict to load. If the key of the ``model_state_dict``\n is nn.Module, the key is a submodule of ``model`` and the value should\n be the state_dict of the submodule. When loading the state_dict,\n the prefix of the submodule will be append to the state_dict.\n optim_state_dict: OptimizerStateType:\n the optimizer state_dict to load.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be loaded. See\n `StateDictOptions` for the details.\n\n Returns:\n ``NamedTuple`` with ``missing_keys`` and ``unexpected_keys`` fields:\n * **missing_keys** is a list of str containing the missing keys of the model state_dict.\n * **unexpected_keys** is a list of str containing the unexpected keys of the model state_dict.\n\n :type model_state_dict: typing.Dict[str, ValueType]\n :type optim_state_dict: typing.OptimizerStateType\n \"\"\"\n\n model_state_dict: Dict[str, ValueType] = _unflatten_model_state_dict(\n model, model_state_dict\n )\n with gc_context():\n optimizers = (\n (optimizers,)\n if isinstance(optimizers, torch.optim.Optimizer)\n else tuple(optimizers)\n )\n info = _verify_options(\n model, optimizers, optim_only=not model_state_dict, options=options\n )\n\n _verify_state_dict(model_state_dict, optim_state_dict, info)\n _load_optim_state_dict(model, optimizers, optim_state_dict, info)\n return _load_model_state_dict(model, model_state_dict, info)\n\n\n# TODO: correct the state_dict function signature.\n# TODO: this API is not yet fully tested. Make it private\n@no_type_check\ndef _patch_model_state_dict(\n model: nn.Module,\n *,\n options: Optional[StateDictOptions] = None,\n) -> None:\n \"\"\"Patch the ``state_dict`` and ``load_state_dict`` attributes of ``model``.\n\n Patch the ``state_dict`` and ``load_state_dict`` attributes of ``model`` to\n be a partial function to call ``get_state_dict`` and ``set_state_dict``.\n\n Example:\n from torch.distributed.fsdp import FullyShardedDataParallel as FSDP\n from torch.distributed.checkpoint.state_dict import patch_model_state_dict\n\n model = fsdp(model)\n patch_model_state_dict(model)\n\n Args:\n model (nn.Module): the nn.Module to the model.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be loaded. See\n `StateDictOptions` for the details.\n Returns:\n None\n \"\"\"\n\n _state_dict_call = functools.partial(\n get_model_state_dict,\n model=model,\n options=options,\n )\n\n def state_dict_call():\n return _state_dict_call()\n\n model.state_dict = state_dict_call\n\n _load_state_dict_call = functools.partial(\n set_model_state_dict,\n model=model,\n options=options,\n )\n\n def load_state_dict_call(state_dict: Dict[str, Any]):\n _load_state_dict_call(model_state_dict=state_dict)\n\n model.load_state_dict = load_state_dict_call\n\n _patched_state_dict.add(state_dict_call)\n _patched_state_dict.add(load_state_dict_call)\n\n\n# TODO: correct the load_state_dict function signature.\n# TODO: this API is not yet fully tested. Make it private\n@no_type_check\ndef _patch_optimizer_state_dict(\n model: nn.Module,\n *,\n optimizers: Tuple[torch.optim.Optimizer, ...],\n options: Optional[StateDictOptions] = None,\n) -> None:\n \"\"\"Patch the ``state_dict`` and ``load_state_dict`` attributes of ``optimizers``.\n\n Patch the ``state_dict`` and ``load_state_dict`` attributes of ``optimizers`` to\n be a partial function to call ``get_state_dict`` and ``set_state_dict``.\n\n Note that if there are multiple optimizers, all of the optimizers will be patched.\n So users only need to call one of the state_dict() to get the full result.\n\n Example:\n from torch.distributed.fsdp import FullyShardedDataParallel as FSDP\n from torch.distributed.checkpoint.state_dict import patch_model_state_dict\n\n model = fsdp(model)\n patch_model_state_dict(model)\n\n Args:\n model (nn.Module): the nn.Module to the model.\n options (StateDictOptions): the options to control how\n model state_dict and optimizer state_dict should be loaded. See\n `StateDictOptions` for the details.\n Returns:\n None\n \"\"\"\n\n _state_dict_call = functools.partial(\n get_optimizer_state_dict,\n model=model,\n optimizers=optimizers,\n options=options,\n )\n\n def state_dict_call():\n return _state_dict_call()\n\n _load_state_dict_call = functools.partial(\n set_optimizer_state_dict,\n model=model,\n optimizers=optimizers,\n options=options,\n )\n\n def load_state_dict_call(state_dict: Dict[str, Any]):\n _load_state_dict_call(optim_state_dict=state_dict)\n\n _patched_state_dict.add(state_dict_call)\n _patched_state_dict.add(load_state_dict_call)\n optimizers = (\n (optimizers,)\n if isinstance(optimizers, torch.optim.Optimizer)\n else tuple(optimizers)\n )\n for optim in optimizers:\n optim.state_dict = state_dict_call\n optim.load_state_dict = load_state_dict_call\n","path":"torch/distributed/checkpoint/state_dict.py"}],"string":"[\n {\n \"content\": \"import contextlib\\nimport functools\\nimport gc\\nfrom dataclasses import asdict, dataclass, field\\nfrom itertools import chain\\nfrom typing import (\\n Any,\\n Callable,\\n cast,\\n Dict,\\n Generator,\\n Iterable,\\n List,\\n no_type_check,\\n Optional,\\n Set,\\n Tuple,\\n Union,\\n)\\n\\nimport torch\\nimport torch.distributed as dist\\nimport torch.nn as nn\\nfrom torch.distributed._shard.sharded_tensor import ShardedTensor\\nfrom torch.distributed._state_dict_utils import (\\n _gather_state_dict,\\n _offload_state_dict_to_cpu,\\n)\\nfrom torch.distributed._tensor import DTensor\\nfrom torch.distributed.algorithms._checkpoint.checkpoint_wrapper import (\\n _CHECKPOINT_PREFIX,\\n)\\nfrom torch.distributed.fsdp import (\\n FullOptimStateDictConfig,\\n FullStateDictConfig,\\n FullyShardedDataParallel as FSDP,\\n OptimStateDictConfig,\\n ShardedOptimStateDictConfig,\\n ShardedStateDictConfig,\\n StateDictConfig,\\n StateDictType,\\n)\\nfrom torch.distributed.fsdp._common_utils import (\\n _get_module_fsdp_state_if_fully_sharded_module,\\n FSDP_WRAPPED_MODULE,\\n)\\nfrom torch.nn.modules.module import _IncompatibleKeys\\nfrom torch.nn.parallel import DistributedDataParallel as DDP\\n\\n\\nFLAT_PARAM = \\\"_flat_param\\\"\\nPG = \\\"param_groups\\\"\\nPG_PREFIX = f\\\"{PG}.\\\"\\nSTATE = \\\"state\\\"\\nSTATE_PREFIX = f\\\"{STATE}.\\\"\\nPARAMS = \\\"params\\\"\\nFQNS_T = Set[str]\\n\\n_patched_state_dict: Set[Callable] = set()\\n\\n\\nPrimitiveType = Union[DTensor, ShardedTensor, torch.Tensor, int, float, str]\\nValueType = Union[\\n PrimitiveType, List[PrimitiveType], Tuple[PrimitiveType], Dict[str, \\\"ValueType\\\"]\\n]\\nDictValueType = Dict[str, ValueType]\\nListDictValueType = List[DictValueType]\\nOptimizerStateType = Dict[str, Union[DictValueType, ListDictValueType]]\\n\\n\\n@contextlib.contextmanager\\ndef gc_context():\\n is_enabled = gc.isenabled()\\n gc.disable()\\n try:\\n yield\\n finally:\\n # TODO: add logging for the gc details/time\\n gc.collect()\\n if is_enabled:\\n gc.enable()\\n\\n\\n@dataclass\\nclass StateDictOptions:\\n \\\"\\\"\\\"\\n This dataclass specifies how get_state_dict/set_state_dict will work.\\n\\n - ``full_state_dict``: if this is set to True, all the tensors in the\\n returned state_dict will be gathered. No ShardedTensor and DTensor\\n will be in the returned state_dict.\\n\\n - ``cpu_offload``: offload all the tensors to cpu. To prevent CPU OOM, if\\n ``full_state_dict`` is also true, then only the rank0 will get the\\n state_dict and all other ranks will get empty state_dict.\\n\\n - ``ignore_frozen_params``: if the value is True, the returned state_dict\\n won't contain any frozen parameters -- the ``requires_grad`` is False.\\n The default value is False.\\n\\n - ``keep_submodule_prefixes``: when ``submodules`` is not None, this option\\n indicates whether to keep the submodule prefixes from the state_dict keys.\\n or example, if the submodule is ``module.pretrain`` and the full FQN of\\n the parameter is ``pretrain.layer1.weight`` of the param. When this option\\n is True, the parameter's key in the returned state_dict will be\\n ``pretrain.layer1.weight``. If the options is False, the key will be\\n ``layer1.weight``.\\n Note that if ``keep_submodule_prefixes`` is False, there may be conflicted\\n FQNs, hence there should be only one submodule in ``submodules``.\\n\\n - ``strict``: the ``strict`` option when ``set_state_dict`` calls\\n model.load_state_dict().\\n The default value is False.\\n \\\"\\\"\\\"\\n\\n full_state_dict: bool = False\\n cpu_offload: bool = False\\n ignore_frozen_params: bool = False\\n keep_submodule_prefixes: bool = True\\n strict: bool = True\\n\\n\\n@dataclass\\nclass _StateDictInfo(StateDictOptions):\\n fqn_param_mapping: Dict[\\n Union[str, torch.Tensor], Union[FQNS_T, torch.Tensor]\\n ] = field(default_factory=dict)\\n all_fqns: Set[str] = field(default_factory=set)\\n submodule_prefixes: Set[str] = field(default_factory=set)\\n handle_model: bool = True\\n handle_optim: bool = True\\n fsdp_context: Callable = contextlib.nullcontext\\n fsdp_modules: List[nn.Module] = field(default_factory=list)\\n\\n\\ndef _get_fqns(\\n model: nn.Module,\\n name: str,\\n skip_ddp_prefix: bool = True,\\n skip_compiler_prefix: bool = True,\\n) -> FQNS_T:\\n \\\"\\\"\\\"\\n This API is used to convert the name of a parameter to the FQNs. For FSDP\\n without `use_orig_params`, the name of FlatParameter can be mapped to\\n multiple original parameters. As a result, the return type of this function\\n is `Set[str]`.\\n\\n Args:\\n module (nn.Module): the root model.\\n name (str): the name\\n skip_ddp_prefix (bool): whether to skip DDP's `module` prefix\\n\\n Returns:\\n The canonical FQNs based on the model traversal.\\n \\\"\\\"\\\"\\n\\n # Remove the checkpoint prefix, if it exists.\\n name = name.replace(_CHECKPOINT_PREFIX, \\\"\\\")\\n if \\\".\\\" not in name:\\n return {name}\\n\\n obj_names = name.split(\\\".\\\")\\n fqn_obj_names = []\\n curr_obj = model\\n for i, curr_obj_name in enumerate(obj_names):\\n if isinstance(curr_obj, DDP):\\n assert curr_obj_name == \\\"module\\\"\\n curr_obj = curr_obj.module\\n if not skip_ddp_prefix:\\n fqn_obj_names.append(curr_obj_name)\\n elif isinstance(curr_obj, FSDP):\\n if i < len(obj_names) - 1 and obj_names[i + 1] == FLAT_PARAM:\\n prefix = \\\".\\\".join(fqn_obj_names)\\n flat_param = getattr(curr_obj, FLAT_PARAM)\\n if prefix:\\n prefix = f\\\"{prefix}.\\\"\\n return {f\\\"{prefix}{fqn}\\\" for fqn in flat_param._fqns}\\n curr_obj = getattr(curr_obj, FSDP_WRAPPED_MODULE)\\n if curr_obj_name != FSDP_WRAPPED_MODULE:\\n fqn_obj_names.append(curr_obj_name)\\n curr_obj = getattr(curr_obj, curr_obj_name)\\n elif isinstance(curr_obj, torch._dynamo.eval_frame.OptimizedModule):\\n assert curr_obj_name == \\\"_orig_mod\\\"\\n curr_obj = curr_obj._orig_mod\\n if not skip_compiler_prefix:\\n fqn_obj_names.append(curr_obj_name)\\n else:\\n fqn_obj_names.append(curr_obj_name)\\n if curr_obj_name == nn.modules.module._EXTRA_STATE_KEY_SUFFIX:\\n if i != len(obj_names) - 1:\\n raise RuntimeError(\\\"Expect `_extra_state` to be the last obj name\\\")\\n else:\\n curr_obj = getattr(curr_obj, curr_obj_name)\\n\\n return {\\\".\\\".join(fqn_obj_names).replace(_CHECKPOINT_PREFIX, \\\"\\\")}\\n\\n\\nclass _EXTRA_STATE:\\n pass\\n\\n\\ndef _iterate_valid_model_state(model):\\n visited_modules: Set[nn.Module] = set()\\n\\n def recurse(module: nn.Module, curr_fqn: str) -> Generator:\\n visited_modules.add(module)\\n\\n curr_fqn = f\\\"{curr_fqn}.\\\" if curr_fqn else \\\"\\\"\\n for name, submodule in module.named_children():\\n if submodule in visited_modules:\\n continue\\n new_fqn = f\\\"{curr_fqn}{name}\\\"\\n yield from recurse(submodule, new_fqn)\\n\\n for name, obj in chain(\\n module.named_buffers(recurse=False), module.named_parameters(recurse=False)\\n ):\\n if name in module._non_persistent_buffers_set:\\n continue\\n new_fqn = f\\\"{curr_fqn}{name}\\\"\\n yield new_fqn, obj\\n\\n if (\\n getattr(module.__class__, \\\"get_extra_state\\\", nn.Module.get_extra_state)\\n != nn.Module.get_extra_state\\n ):\\n new_fqn = f\\\"{curr_fqn}{nn.modules.module._EXTRA_STATE_KEY_SUFFIX}\\\"\\n yield new_fqn, _EXTRA_STATE()\\n\\n yield from recurse(model, \\\"\\\")\\n\\n\\ndef _verify_options(\\n model: nn.Module,\\n optims: Tuple[torch.optim.Optimizer, ...],\\n optim_only: bool,\\n *,\\n submodules: Optional[Set[nn.Module]] = None,\\n options: Optional[StateDictOptions] = None,\\n) -> _StateDictInfo:\\n \\\"\\\"\\\"\\n Verify the model and options passed by the user and generates _StateDictInfo.\\n \\\"\\\"\\\"\\n if optim_only and not optims:\\n raise RuntimeError(\\n \\\"Optimizers are not passed in but optim_only is set to True.\\\"\\n )\\n\\n options = options or StateDictOptions()\\n\\n fqn_param_mapping: Dict[\\n Union[str, torch.Tensor], Union[Set[str], torch.Tensor]\\n ] = {}\\n all_fqns = set()\\n for name, param in _iterate_valid_model_state(model):\\n fqns = _get_fqns(model, name)\\n if not isinstance(param, _EXTRA_STATE):\\n fqn_param_mapping[param] = fqns\\n for fqn in fqns:\\n if not isinstance(param, _EXTRA_STATE):\\n fqn_param_mapping[fqn] = param\\n all_fqns.add(fqn)\\n\\n submodule_prefixes = set()\\n if submodules:\\n submodules = set(submodules)\\n for name, module in model.named_modules():\\n if module not in submodules:\\n continue\\n fqns = _get_fqns(model, name)\\n assert len(fqns) == 1, \\\"Submodule FQN should only have 1 instance\\\"\\n for fqn in fqns:\\n submodule_prefixes.add(f\\\"{fqn}.\\\")\\n\\n fsdp_modules = FSDP.fsdp_modules(model)\\n state_dict_config: StateDictConfig\\n optim_state_dict_config: OptimStateDictConfig\\n fsdp_context: Callable\\n if fsdp_modules:\\n # FSDP API only work if at least one FSDP instance exists.\\n if options.full_state_dict:\\n state_dict_config = FullStateDictConfig(\\n offload_to_cpu=options.cpu_offload, rank0_only=options.cpu_offload\\n )\\n optim_state_dict_config = FullOptimStateDictConfig(\\n offload_to_cpu=options.cpu_offload, rank0_only=options.cpu_offload\\n )\\n state_dict_type = StateDictType.FULL_STATE_DICT\\n else:\\n state_dict_config = ShardedStateDictConfig(\\n offload_to_cpu=options.cpu_offload,\\n )\\n optim_state_dict_config = ShardedOptimStateDictConfig(\\n offload_to_cpu=options.cpu_offload,\\n )\\n state_dict_type = StateDictType.SHARDED_STATE_DICT\\n\\n fsdp_context = functools.partial(\\n FSDP.state_dict_type,\\n module=model,\\n state_dict_type=state_dict_type,\\n state_dict_config=state_dict_config,\\n optim_state_dict_config=optim_state_dict_config,\\n )\\n else:\\n fsdp_context = contextlib.nullcontext\\n\\n return _StateDictInfo(\\n **asdict(options),\\n fqn_param_mapping=fqn_param_mapping,\\n all_fqns=all_fqns,\\n submodule_prefixes=submodule_prefixes,\\n fsdp_context=fsdp_context,\\n fsdp_modules=cast(List[nn.Module], fsdp_modules),\\n handle_model=not optim_only,\\n handle_optim=(len(optims) > 0),\\n )\\n\\n\\ndef _verify_state_dict(\\n model_state_dict: Dict[str, ValueType],\\n optim_state_dict: OptimizerStateType,\\n info: _StateDictInfo,\\n) -> None:\\n for module in info.fsdp_modules:\\n fsdp_state = _get_module_fsdp_state_if_fully_sharded_module(module)\\n assert fsdp_state is not None, \\\"Expected a fsdp_state with a fsdp module.\\\"\\n\\n # Verify if the model_state_dict and optim_state_dict are valid. This API\\n # should give the users an explicit error message to debug or report.\\n if (\\n info.handle_model\\n and not model_state_dict\\n and not info.submodule_prefixes\\n and not info.ignore_frozen_params\\n and not (info.cpu_offload and info.full_state_dict)\\n and info.strict\\n ):\\n raise RuntimeError(\\n \\\"The option indicates that model state_dict is required to save \\\"\\n \\\"or load, but model state_dict is empty.\\\"\\n f\\\"rank = {dist.get_rank()=}.\\\"\\n )\\n\\n if info.handle_optim:\\n if not (optim_state_dict and optim_state_dict[STATE]) and not (\\n info.cpu_offload and info.full_state_dict\\n ):\\n raise RuntimeError(\\n \\\"The option indicates that model state_dict is required to save, \\\"\\n f\\\"or load but optim state_dict is empty. {optim_state_dict}\\\"\\n )\\n\\n for key in model_state_dict.keys():\\n if FLAT_PARAM in key:\\n raise RuntimeError(\\n f\\\"{key} contains {FLAT_PARAM}. This can happen if the model \\\"\\n \\\"is not the root module.\\\"\\n )\\n\\n\\ndef _state_dict_fn(obj: Union[nn.Module, torch.optim.Optimizer], api: str) -> Callable:\\n call = getattr(obj, api)\\n if call in _patched_state_dict:\\n call = functools.partial(getattr(obj.__class__, api), self=obj)\\n return call\\n\\n\\ndef _get_model_state_dict(\\n model: nn.Module, info: _StateDictInfo\\n) -> Dict[str, ValueType]:\\n if not info.handle_model:\\n return {}\\n\\n with info.fsdp_context():\\n state_dict = _state_dict_fn(model, \\\"state_dict\\\")()\\n\\n for key in list(state_dict.keys()):\\n fqns = _get_fqns(model, key)\\n assert len(fqns) == 1\\n fqn = next(iter(fqns))\\n if fqn != key:\\n # As we only support FSDP, DDP, and TP, the only cases are\\n # wrapper-based DDP and compiler. Verify if the assumption\\n # is correct.\\n def verify(key, fqn) -> bool:\\n if len(fqn) >= len(key):\\n return False\\n fqn_split = fqn.split(\\\".\\\")\\n key_split = key.split(\\\".\\\")\\n fqn_idx = 0\\n for key_idx, key_name in enumerate(key_split):\\n if key_name == fqn_split[fqn_idx]:\\n fqn_idx += 1\\n if fqn_idx == len(fqn_split):\\n return key_idx == len(key_split) - 1\\n elif key_name in (\\\"module\\\", \\\"_orig_mod\\\"):\\n continue\\n else:\\n return False\\n return True\\n\\n if not verify(key, fqn):\\n raise RuntimeError(f\\\"An unexpected key, {key}, exists. FQN is {fqn}\\\")\\n state_dict[fqn] = state_dict.pop(key)\\n\\n if info.submodule_prefixes:\\n new_state_dict: Dict[str, ValueType] = {}\\n # TODO: make this faster.\\n for fqn in state_dict.keys():\\n for prefix in info.submodule_prefixes:\\n if not fqn.startswith(prefix):\\n continue\\n if info.keep_submodule_prefixes:\\n new_state_dict[fqn] = state_dict[fqn]\\n else:\\n new_fqn = fqn[len(prefix) :]\\n new_state_dict[new_fqn] = state_dict[fqn]\\n state_dict = new_state_dict\\n\\n if info.ignore_frozen_params:\\n for key, param in model.named_parameters():\\n if param.requires_grad:\\n continue\\n fqns = _get_fqns(model, key)\\n for fqn in fqns:\\n state_dict.pop(fqn)\\n\\n for key, p in list(state_dict.items()):\\n if torch.is_tensor(p) and p.is_meta:\\n state_dict.pop(key)\\n\\n if info.full_state_dict:\\n ranks_only = tuple() if not info.cpu_offload else (0,)\\n return _gather_state_dict(\\n state_dict, cpu_offload=info.cpu_offload, ranks_only=ranks_only\\n )\\n elif info.cpu_offload:\\n return _offload_state_dict_to_cpu(state_dict)\\n else:\\n return state_dict\\n\\n\\ndef _load_model_state_dict(\\n model: nn.Module,\\n state_dict: Dict[str, ValueType],\\n info: _StateDictInfo,\\n) -> _IncompatibleKeys:\\n if not info.handle_model or not state_dict:\\n return _IncompatibleKeys({}, {})\\n\\n for key, _ in _iterate_valid_model_state(model):\\n fqns = _get_fqns(model, key)\\n fqns_with_prefix = _get_fqns(\\n model, key, skip_ddp_prefix=False, skip_compiler_prefix=False\\n )\\n for fqn, fqn_with_prefix in zip(fqns, fqns_with_prefix):\\n if fqn != fqn_with_prefix:\\n state_dict[fqn_with_prefix] = state_dict.pop(fqn)\\n\\n with info.fsdp_context():\\n return cast(\\n _IncompatibleKeys,\\n _state_dict_fn(model, \\\"load_state_dict\\\")(\\n state_dict=state_dict, strict=info.strict\\n ),\\n )\\n\\n\\ndef _init_optim_state(optim: torch.optim.Optimizer) -> None:\\n \\\"\\\"\\\"\\n Initialize optim states by calling the step() with zero grads.\\n \\\"\\\"\\\"\\n if optim.state:\\n # The optimizer state is initialized.\\n return\\n\\n for param_group in optim.param_groups:\\n for param in param_group[PARAMS]:\\n if param.grad is not None:\\n raise RuntimeError(\\n \\\"state_dict can only be used if the optimizer \\\"\\n \\\"states are initialized (usually after one step() with \\\"\\n \\\"gradients) or gradients are None. For the later case, \\\"\\n \\\"state_dict will fake the gradients as zero \\\"\\n \\\"to initialize the optimizer states. However, the \\\"\\n \\\"gradients are not None.\\\"\\n )\\n if param.requires_grad:\\n param.grad = torch.zeros_like(param)\\n optim.step(closure=None)\\n optim.zero_grad(set_to_none=True)\\n\\n\\ndef _get_optim_state_dict(\\n model: nn.Module,\\n optimizers: Tuple[torch.optim.Optimizer, ...],\\n info: _StateDictInfo,\\n) -> OptimizerStateType:\\n if not info.handle_optim:\\n return {}\\n\\n optim_state_dict: OptimizerStateType = {STATE: {}, PG: []}\\n for optim in optimizers:\\n _init_optim_state(optim)\\n osd = _state_dict_fn(optim, \\\"state_dict\\\")()\\n if info.fsdp_modules:\\n with info.fsdp_context():\\n osd = FSDP.optim_state_dict(model, optim, osd)\\n\\n # We need to specially handle FlatParameter FSDP as\\n # FlatParameter FSDP converts the FQNs.\\n # There are no easy ways to do this conversion systematically.\\n # We can only use a string replacment without correctness check.\\n if not osd:\\n continue\\n for k in list(osd[STATE].keys()):\\n if \\\"_orig_mod\\\" in k:\\n osd[STATE][k.replace(\\\"_orig_mod.\\\", \\\"\\\")] = osd[STATE].pop(k)\\n for g in osd[PG]:\\n params = [k.replace(\\\"_orig_mod.\\\", \\\"\\\") for k in g[PARAMS]]\\n g[PARAMS] = params\\n else:\\n params = list(chain.from_iterable(g[PARAMS] for g in optim.param_groups))\\n param_pid_mapping = dict(zip(params, range(len(params))))\\n fqn_pid_mapping = {}\\n for key, param in model.named_parameters():\\n fqns = _get_fqns(model, key)\\n assert len(fqns) == 1\\n fqn = next(iter(fqns))\\n if param not in param_pid_mapping:\\n continue\\n pid = param_pid_mapping[param]\\n fqn_pid_mapping[fqn] = pid\\n fqn_pid_mapping[pid] = fqn\\n\\n for key in list(osd[STATE].keys()):\\n fqn = fqn_pid_mapping[key]\\n osd[STATE][fqn] = osd[STATE].pop(key)\\n\\n for group in osd[PG]:\\n group[PARAMS] = [fqn_pid_mapping[pid] for pid in group[PARAMS]]\\n\\n if not osd:\\n continue\\n\\n cast(DictValueType, optim_state_dict[STATE]).update(osd[STATE])\\n cast(ListDictValueType, optim_state_dict[PG]).extend(osd[PG])\\n\\n if info.full_state_dict:\\n ranks_only = tuple() if not info.cpu_offload else (0,)\\n return _gather_state_dict(\\n optim_state_dict, cpu_offload=info.cpu_offload, ranks_only=ranks_only\\n )\\n elif info.cpu_offload:\\n return _offload_state_dict_to_cpu(optim_state_dict)\\n else:\\n return optim_state_dict\\n\\n\\ndef _split_optim_state_dict(\\n model: nn.Module,\\n optim: torch.optim.Optimizer,\\n optim_state_dict: OptimizerStateType,\\n info: _StateDictInfo,\\n) -> OptimizerStateType:\\n \\\"\\\"\\\"\\n Extract the corresponding optim state_dict from ``optim_state_dict`` for\\n ``optim`` and return the result optim state_dict.\\n\\n Args:\\n model (nn.Module): the root model.\\n optim (torch.optim.Optimizer): the optimizer.\\n optim_state_dict (Dict[str, ValueType]): the superset optim state_dict that\\n contains the optim state_dict of ``optim``.\\n info (_StateDictInfo): state dict information.\\n\\n Returns:\\n The optim state_dict of ``optim``.\\n \\\"\\\"\\\"\\n\\n state: DictValueType = {}\\n pg_state: ListDictValueType = []\\n return_osd: OptimizerStateType = {STATE: state, PG: pg_state}\\n pg_mapping: Dict[int, int] = {}\\n\\n for param_group in optim.param_groups:\\n pg_state.append({PARAMS: []})\\n for param in param_group[PARAMS]:\\n for fqn in info.fqn_param_mapping[param]:\\n params = pg_state[-1][PARAMS]\\n assert isinstance(params, list)\\n params.append(fqn)\\n if param.requires_grad:\\n state[fqn] = cast(DictValueType, optim_state_dict[STATE])[fqn]\\n for loaded_param_group in cast(ListDictValueType, optim_state_dict[PG]):\\n params = loaded_param_group[PARAMS]\\n assert isinstance(params, list)\\n if fqn in params:\\n pg_mapping[id(loaded_param_group)] = len(return_osd[PG]) - 1\\n\\n for param_group in cast(ListDictValueType, optim_state_dict[PG]):\\n idx = pg_mapping.get(id(param_group), -1)\\n if idx == -1:\\n continue\\n for key, value in param_group.items():\\n if key == PARAMS:\\n continue\\n # TODO: check if value is the same if exists.\\n pg_state[idx][key] = value\\n\\n return return_osd\\n\\n\\ndef _load_optim_state_dict(\\n model: nn.Module,\\n optimizers: Tuple[torch.optim.Optimizer, ...],\\n state_dict: OptimizerStateType,\\n info: _StateDictInfo,\\n) -> None:\\n if not info.handle_optim:\\n return\\n\\n for optim in optimizers:\\n optim_state_dict = _split_optim_state_dict(model, optim, state_dict, info)\\n if info.fsdp_modules:\\n # We need to specially handle FlatParameter FSDP as\\n # FlatParameter FSDP converts the FQNs.\\n for original_fqn, _ in model.named_parameters():\\n fqns = _get_fqns(model, original_fqn)\\n fqns_with_compiler = _get_fqns(\\n model, original_fqn, skip_compiler_prefix=False\\n )\\n if fqns == fqns_with_compiler:\\n continue\\n\\n assert len(fqns) == 1\\n fqn = fqns.pop()\\n fqn_with_compiler = fqns_with_compiler.pop()\\n for g in optim_state_dict[PG]:\\n val = cast(Dict[str, Any], g)\\n params = [\\n key.replace(fqn, fqn_with_compiler) for key in val[PARAMS]\\n ]\\n val[PARAMS] = params\\n osd_state = cast(DictValueType, optim_state_dict[STATE])\\n for k in list(osd_state.keys()):\\n if fqn in k:\\n osd_state[k.replace(fqn, fqn_with_compiler)] = osd_state.pop(k)\\n\\n with info.fsdp_context():\\n optim_state_dict = FSDP.optim_state_dict_to_load(\\n model, optim, optim_state_dict\\n )\\n\\n # Note that we do not have to convert the FQN back to param id here if\\n # order in optim.param_groups[idx][PARAMS] is the same as the one in\\n # optim_state_dict[PG][idx][PARAMS].\\n _init_optim_state(optim)\\n _state_dict_fn(optim, \\\"load_state_dict\\\")(state_dict=optim_state_dict)\\n\\n\\ndef get_model_state_dict(\\n model: nn.Module,\\n *,\\n submodules: Optional[Set[nn.Module]] = None,\\n options: Optional[StateDictOptions] = None,\\n) -> Dict[str, ValueType]:\\n \\\"\\\"\\\"\\n Return the model state_dict of ``model``.\\n\\n See ``get_state_dict`` for the detail usage.\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n submodules: Optional[Set[nn.Module]]: only return the model parameters\\n that belong to the submodules.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be returned. See\\n `StateDictOptions` for the details.\\n\\n Returns:\\n The state_dict for ``model``.\\n\\n :rtype: typing.Dict[str, ValueType]\\n \\\"\\\"\\\"\\n with gc_context():\\n info = _verify_options(\\n model,\\n tuple(),\\n optim_only=False,\\n submodules=submodules,\\n options=options,\\n )\\n model_state_dict = _get_model_state_dict(model, info)\\n _verify_state_dict(model_state_dict, {}, info)\\n return model_state_dict\\n\\n\\ndef get_optimizer_state_dict(\\n model: nn.Module,\\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\\n *,\\n submodules: Optional[Set[nn.Module]] = None,\\n options: Optional[StateDictOptions] = None,\\n) -> OptimizerStateType:\\n \\\"\\\"\\\"\\n Return the combined state_dict for optimizers.\\n\\n See ``get_state_dict`` for the detail usage.\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n optimizers (Union[None, Optimizer, Iterable[Optimizer]]):\\n The optimizers that are used to optimize ``model``.\\n submodules: Optional[Set[nn.Module]]: only return the model parameters\\n that belong to the submodules.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be returned. See\\n `StateDictOptions` for the details.\\n\\n Returns:\\n The state_dict for ``optimizers``.\\n\\n :rtype: OptimizerStateType\\n \\\"\\\"\\\"\\n with gc_context():\\n optimizers = (\\n (optimizers,)\\n if isinstance(optimizers, torch.optim.Optimizer)\\n else tuple(optimizers)\\n )\\n info = _verify_options(\\n model,\\n optimizers,\\n optim_only=True,\\n submodules=submodules,\\n options=options,\\n )\\n optim_state_dict = _get_optim_state_dict(model, optimizers, info)\\n _verify_state_dict({}, optim_state_dict, info)\\n return optim_state_dict\\n\\n\\ndef get_state_dict(\\n model: nn.Module,\\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\\n *,\\n submodules: Optional[Set[nn.Module]] = None,\\n options: Optional[StateDictOptions] = None,\\n) -> Tuple[Dict[str, ValueType], OptimizerStateType]:\\n \\\"\\\"\\\"\\n Return the model state_dict and optimizers state_dict.\\n\\n ``get_state_dict`` can process any module that is parallelized by PyTorch\\n FSDP/fully_shard, DDP/replicate, tensor_parallel/parallelize_module, and any\\n combination of these parallelisms. The main functions of ``get_state_dict``\\n are: 1.) returning a model and optimizer state_dict that can be resharded\\n with a different number of trainers and/or different parallelisms.\\n 2.) hiding the parallelism-specific state_dict APIs. Users don't have to call\\n these APIs.\\n 3.) sanity checking the result state_dict.\\n\\n The keys of the result state dictionary are the canonical FQNs (Fully\\n Qualified Names). A canonical FQN refers to the FQN based on a parameter's\\n position in an nn.Module hierarchy. More specifically, a canonical FQN to a\\n parameter is the FQN returned by ``module.named_parameters()`` or\\n ``module.named_buffers()`` when the module is not distributed by any\\n parallelisms. Since the optimizer internally uses parameter IDs to represent\\n a parameter, there will be a conversion from the parameter IDs to the\\n canonical FQNs when calling this API.\\n\\n ``get_state_dict`` can also process a module that is not parallelized. In\\n such a case, ``get_state_dict`` only performs one function -- converting the\\n optimizer parameter IDs to the canonical FQNs.\\n\\n Example:\\n >>> # xdoctest: +SKIP\\n >>> import torch\\n >>> from torch.distributed.fsdp import FullyShardedDataParallel as FSDP\\n >>> from torch.nn.parallel import DistributedDataParallel as DDP\\n >>> from torch.distributed.checkpoint.state_dict import get_state_dict\\n\\n >>> fsdp_model = FSDP(copy.deepcopy(model))\\n >>> fsdp_optim = torch.optim.Adam(model.parameters(), lr=1e-3)\\n >>> ddp_model = DDP(copy.deepcopy(model))\\n >>> ddp_optim = torch.optim.Adam(model.parameters(), lr=1e-3)\\n\\n\\n >>> ddp_state_dict, ddp_optim_state_dict = get_state_dict(ddp_model, ddp_optim)\\n >>> fsdp_state_dict, fsdp_optim_state_dict = get_state_dict(fsdp_model, fsdp_optim)\\n\\n >>> # if we simply call ddp_model.state_dict() and fsdp_model.state_dict(),\\n >>> # the asserts will fail.\\n >>> assert ddp_state_dict == fsdp_state_dict\\n >>> assert ddp_optim_state == fsdp_optim_state_dict\\n\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n optimizers (Union[None, Optimizer, Iterable[Optimizer]]):\\n The optimizers that are used to optimize ``model``.\\n submodules: Optional[Set[nn.Module]]: only return the model parameters\\n that belong to the submodules.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be returned. See\\n `StateDictOptions` for the details.\\n\\n Returns:\\n ``Tuple`` that contain model state_dict and optimizer state_dict.\\n\\n :rtype: typing.Tuple[typing.Dict[str, ValueType], OptimizerStateType]\\n \\\"\\\"\\\"\\n\\n with gc_context():\\n optimizers = (\\n (optimizers,)\\n if isinstance(optimizers, torch.optim.Optimizer)\\n else tuple(optimizers)\\n )\\n info = _verify_options(\\n model,\\n optimizers,\\n optim_only=False,\\n submodules=submodules,\\n options=options,\\n )\\n model_state_dict = _get_model_state_dict(model, info)\\n optim_state_dict = _get_optim_state_dict(model, optimizers, info)\\n _verify_state_dict(model_state_dict, optim_state_dict, info)\\n return model_state_dict, optim_state_dict\\n\\n\\ndef _unflatten_model_state_dict(\\n model: nn.Module,\\n state_dict: Union[Dict[nn.Module, Dict[str, ValueType]], Dict[str, ValueType]],\\n) -> Dict[str, ValueType]:\\n if not state_dict:\\n return {}\\n\\n if isinstance(next(iter(state_dict.keys())), nn.Module):\\n cast_state_dict = cast(Dict[nn.Module, Dict[str, ValueType]], state_dict)\\n new_state_dict: Dict[str, ValueType] = {}\\n for submodule, sub_state_dict in cast_state_dict.items():\\n for name, m in model.named_modules():\\n if m != submodule:\\n continue\\n\\n fqns = _get_fqns(model, name)\\n assert len(fqns) == 1, \\\"FQNs for a submodule should only have 1 element\\\"\\n prefix = f\\\"{next(iter(fqns))}.\\\"\\n new_state_dict.update(\\n {prefix + subfqn: value for subfqn, value in sub_state_dict.items()}\\n )\\n return new_state_dict\\n else:\\n return cast(Dict[str, ValueType], state_dict)\\n\\n\\ndef set_model_state_dict(\\n model: nn.Module,\\n model_state_dict: Dict[str, ValueType],\\n *,\\n options: Optional[StateDictOptions] = None,\\n) -> _IncompatibleKeys:\\n \\\"\\\"\\\"Load the model state_dict.\\n\\n The counterpart of ``get_model_state_dict`` to set the state_dict to the\\n model. See ``set_state_dict`` for the detail usage.\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n model_state_dict: (Dict[str, ValueType]):\\n the model state_dict to load. If the key of the ``model_state_dict``\\n is nn.Module, the key is a submodule of ``model`` and the value should\\n be the state_dict of the submodule. When loading the state_dict,\\n the prefix of the submodule will be append to the state_dict.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be loaded. See\\n `StateDictOptions` for the details.\\n\\n Returns:\\n ``NamedTuple`` with ``missing_keys`` and ``unexpected_keys`` fields:\\n * **missing_keys** is a list of str containing the missing keys\\n * **unexpected_keys** is a list of str containing the unexpected keys\\n\\n :type model_state_dict: typing.Dict[str, ValueType]\\n \\\"\\\"\\\"\\n model_state_dict: Dict[str, ValueType] = _unflatten_model_state_dict(\\n model, model_state_dict\\n )\\n with gc_context():\\n info = _verify_options(model, tuple(), optim_only=False, options=options)\\n\\n _verify_state_dict(model_state_dict, {}, info)\\n return _load_model_state_dict(model, model_state_dict, info)\\n\\n\\ndef set_optimizer_state_dict(\\n model: nn.Module,\\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\\n *,\\n optim_state_dict: OptimizerStateType,\\n options: Optional[StateDictOptions] = None,\\n) -> None:\\n \\\"\\\"\\\"Load the optimizers state_dict.\\n\\n The counterpart of ``get_optimizer_state_dict`` to set the state_dict to the\\n optimizers. See ``set_state_dict`` for the detail usage.\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n optimizers (Union[Optimizer, Iterable[Optimizer]]):\\n The optimizers that are used to optimize ``model``.\\n optim_state_dict: OptimizerStateType:\\n the optimizer state_dict to load.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be loaded. See\\n `StateDictOptions` for the details.\\n\\n Returns:\\n None\\n\\n :type optim_state_dict: typing.OptimizerStateType\\n \\\"\\\"\\\"\\n with gc_context():\\n optimizers = (\\n (optimizers,)\\n if isinstance(optimizers, torch.optim.Optimizer)\\n else tuple(optimizers)\\n )\\n info = _verify_options(model, optimizers, optim_only=True, options=options)\\n\\n _verify_state_dict({}, optim_state_dict, info)\\n _load_optim_state_dict(model, optimizers, optim_state_dict, info)\\n\\n\\ndef set_state_dict(\\n model: nn.Module,\\n optimizers: Union[torch.optim.Optimizer, Iterable[torch.optim.Optimizer]],\\n *,\\n model_state_dict: Dict[str, ValueType],\\n optim_state_dict: OptimizerStateType,\\n options: Optional[StateDictOptions] = None,\\n) -> _IncompatibleKeys:\\n \\\"\\\"\\\"Load the model state_dict and optimizers state_dict.\\n\\n The counterpart of ``get_state_dict`` to set the state_dict to the model and\\n optimizers. The given ``model_state_dict`` and ``optim_state_dict`` do not\\n have to be returned by ``get_state_dict`` but must meet the following\\n requirements: 1) all FQNs are canonical FQNs as defined in ``get_state_dict``,\\n 2) if a tensor is sharded, it must be either a ShardedTensor or DTensor,\\n 3) optimizer state_dict cannot contain the parameter IDs; the keys should be\\n the canonical FQNs.\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n optimizers (Union[Optimizer, Iterable[Optimizer]]):\\n The optimizers that are used to optimize ``model``.\\n model_state_dict: (Union[Dict[nn.Module, Dict[str, ValueType]], Dict[str, ValueType]]):\\n the model state_dict to load. If the key of the ``model_state_dict``\\n is nn.Module, the key is a submodule of ``model`` and the value should\\n be the state_dict of the submodule. When loading the state_dict,\\n the prefix of the submodule will be append to the state_dict.\\n optim_state_dict: OptimizerStateType:\\n the optimizer state_dict to load.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be loaded. See\\n `StateDictOptions` for the details.\\n\\n Returns:\\n ``NamedTuple`` with ``missing_keys`` and ``unexpected_keys`` fields:\\n * **missing_keys** is a list of str containing the missing keys of the model state_dict.\\n * **unexpected_keys** is a list of str containing the unexpected keys of the model state_dict.\\n\\n :type model_state_dict: typing.Dict[str, ValueType]\\n :type optim_state_dict: typing.OptimizerStateType\\n \\\"\\\"\\\"\\n\\n model_state_dict: Dict[str, ValueType] = _unflatten_model_state_dict(\\n model, model_state_dict\\n )\\n with gc_context():\\n optimizers = (\\n (optimizers,)\\n if isinstance(optimizers, torch.optim.Optimizer)\\n else tuple(optimizers)\\n )\\n info = _verify_options(\\n model, optimizers, optim_only=not model_state_dict, options=options\\n )\\n\\n _verify_state_dict(model_state_dict, optim_state_dict, info)\\n _load_optim_state_dict(model, optimizers, optim_state_dict, info)\\n return _load_model_state_dict(model, model_state_dict, info)\\n\\n\\n# TODO: correct the state_dict function signature.\\n# TODO: this API is not yet fully tested. Make it private\\n@no_type_check\\ndef _patch_model_state_dict(\\n model: nn.Module,\\n *,\\n options: Optional[StateDictOptions] = None,\\n) -> None:\\n \\\"\\\"\\\"Patch the ``state_dict`` and ``load_state_dict`` attributes of ``model``.\\n\\n Patch the ``state_dict`` and ``load_state_dict`` attributes of ``model`` to\\n be a partial function to call ``get_state_dict`` and ``set_state_dict``.\\n\\n Example:\\n from torch.distributed.fsdp import FullyShardedDataParallel as FSDP\\n from torch.distributed.checkpoint.state_dict import patch_model_state_dict\\n\\n model = fsdp(model)\\n patch_model_state_dict(model)\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be loaded. See\\n `StateDictOptions` for the details.\\n Returns:\\n None\\n \\\"\\\"\\\"\\n\\n _state_dict_call = functools.partial(\\n get_model_state_dict,\\n model=model,\\n options=options,\\n )\\n\\n def state_dict_call():\\n return _state_dict_call()\\n\\n model.state_dict = state_dict_call\\n\\n _load_state_dict_call = functools.partial(\\n set_model_state_dict,\\n model=model,\\n options=options,\\n )\\n\\n def load_state_dict_call(state_dict: Dict[str, Any]):\\n _load_state_dict_call(model_state_dict=state_dict)\\n\\n model.load_state_dict = load_state_dict_call\\n\\n _patched_state_dict.add(state_dict_call)\\n _patched_state_dict.add(load_state_dict_call)\\n\\n\\n# TODO: correct the load_state_dict function signature.\\n# TODO: this API is not yet fully tested. Make it private\\n@no_type_check\\ndef _patch_optimizer_state_dict(\\n model: nn.Module,\\n *,\\n optimizers: Tuple[torch.optim.Optimizer, ...],\\n options: Optional[StateDictOptions] = None,\\n) -> None:\\n \\\"\\\"\\\"Patch the ``state_dict`` and ``load_state_dict`` attributes of ``optimizers``.\\n\\n Patch the ``state_dict`` and ``load_state_dict`` attributes of ``optimizers`` to\\n be a partial function to call ``get_state_dict`` and ``set_state_dict``.\\n\\n Note that if there are multiple optimizers, all of the optimizers will be patched.\\n So users only need to call one of the state_dict() to get the full result.\\n\\n Example:\\n from torch.distributed.fsdp import FullyShardedDataParallel as FSDP\\n from torch.distributed.checkpoint.state_dict import patch_model_state_dict\\n\\n model = fsdp(model)\\n patch_model_state_dict(model)\\n\\n Args:\\n model (nn.Module): the nn.Module to the model.\\n options (StateDictOptions): the options to control how\\n model state_dict and optimizer state_dict should be loaded. See\\n `StateDictOptions` for the details.\\n Returns:\\n None\\n \\\"\\\"\\\"\\n\\n _state_dict_call = functools.partial(\\n get_optimizer_state_dict,\\n model=model,\\n optimizers=optimizers,\\n options=options,\\n )\\n\\n def state_dict_call():\\n return _state_dict_call()\\n\\n _load_state_dict_call = functools.partial(\\n set_optimizer_state_dict,\\n model=model,\\n optimizers=optimizers,\\n options=options,\\n )\\n\\n def load_state_dict_call(state_dict: Dict[str, Any]):\\n _load_state_dict_call(optim_state_dict=state_dict)\\n\\n _patched_state_dict.add(state_dict_call)\\n _patched_state_dict.add(load_state_dict_call)\\n optimizers = (\\n (optimizers,)\\n if isinstance(optimizers, torch.optim.Optimizer)\\n else tuple(optimizers)\\n )\\n for optim in optimizers:\\n optim.state_dict = state_dict_call\\n optim.load_state_dict = load_state_dict_call\\n\",\n \"path\": \"torch/distributed/checkpoint/state_dict.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/test/distributed/checkpoint/test_state_dict.py b/test/distributed/checkpoint/test_state_dict.py\nindex ec8e80a2a3012a..ce13ad22e46da6 100644\n--- a/test/distributed/checkpoint/test_state_dict.py\n+++ b/test/distributed/checkpoint/test_state_dict.py\n@@ -556,6 +556,17 @@ def _test_activation_ckpt_fqns_fsdp1(self, use_orig_params: bool) -> None:\n \n self.assertEqual(original_keys, new_keys)\n \n+ @with_comms\n+ @skip_if_lt_x_gpu(1)\n+ def test_non_persistent_buffers(self) -> None:\n+ model = CompositeParamModel(device=torch.device(\"cuda\"))\n+ model.register_buffer(\n+ \"dont_save_me\", torch.rand(100, device=\"cuda\"), persistent=False\n+ )\n+ ddp_model = DDP(copy.deepcopy(model))\n+ set_model_state_dict(ddp_model, get_model_state_dict(ddp_model))\n+ self.assertEqual(model.state_dict(), get_model_state_dict(ddp_model))\n+\n @with_comms\n @skip_if_lt_x_gpu(2)\n def test_fsdp_root_not_initialized(self) -> None:\ndiff --git a/torch/distributed/checkpoint/state_dict.py b/torch/distributed/checkpoint/state_dict.py\nindex 62ba5db2700762..e3dd875ec2c6d1 100644\n--- a/torch/distributed/checkpoint/state_dict.py\n+++ b/torch/distributed/checkpoint/state_dict.py\n@@ -215,6 +215,8 @@ def recurse(module: nn.Module, curr_fqn: str) -> Generator:\n for name, obj in chain(\n module.named_buffers(recurse=False), module.named_parameters(recurse=False)\n ):\n+ if name in module._non_persistent_buffers_set:\n+ continue\n new_fqn = f\"{curr_fqn}{name}\"\n yield new_fqn, obj\n \n"}}},{"rowIdx":4697,"cells":{"in_source_id":{"kind":"string","value":"python-telegram-bot__python-telegram-bot-2168"},"issue":{"kind":"string","value":"mypy doesn't pick up type hints[BUG]\n<!--\r\nThanks for reporting issues of python-telegram-bot!\r\n\r\nUse this template to notify us if you found a bug.\r\n\r\nTo make it easier for us to help you please enter detailed information below.\r\n\r\nPlease note, we only support the latest version of python-telegram-bot and\r\nmaster branch. Please make sure to upgrade & recreate the issue on the latest\r\nversion prior to opening an issue.\r\n-->\r\n### Steps to reproduce\r\n1. import python-telegram-bot modules into your `test.py` file (e.g. `from telegram import InlineKeyboardMarkup`)\r\n\r\n2. run `mypy test.py`\r\n\r\n3. receive the following output `error: Skipping analyzing 'telegram': found module but no type hints or library stubs`\r\n\r\n### Expected behaviour\r\nmypy should pickup the typehints as they've been added in the latest release (version `13` )\r\n\r\n### Actual behaviour\r\nmypy doesn't pickup the typehints.\r\n\r\nI'm confident this can be solved by either\r\n\r\n1. adding `python-telegram-bot` to `typeshed` \r\n2. adding a `py.typed` file\r\n\r\nMore information can be found [here.](https://stackoverflow.com/questions/60856237/mypy-cant-find-type-hints-for-black)\r\n\r\n### Configuration\r\n**Operating System:**\r\nUbuntu 18.04\r\n\r\n**Version of Python, python-telegram-bot & dependencies:**\r\n\r\n``$ python -m telegram``\r\npython-telegram-bot 13.0\r\ncertifi 2020.06.20\r\nPython 3.8.0 (default, Oct 30 2020, 19:06:04) [GCC 7.5.0]\r\n### Logs\r\n```\r\nerror: Skipping analyzing 'telegram.ext': found module but no type hints or library stubs\r\nnote: See https://mypy.readthedocs.io/en/latest/running_mypy.html#missing-imports\r\nerror: Skipping analyzing 'telegram': found module but no type hints or library stubs\r\nerror: Skipping analyzing 'telegram.ext': found module but no type hints or library stubs\r\nerror: Skipping analyzing 'telegram': found module but no type hints or library stubs\r\n```\n"},"before_files":{"kind":"list like","value":[{"content":"#!/usr/bin/env python\n\"\"\"The setup and build script for the python-telegram-bot library.\"\"\"\n\nimport codecs\nimport os\nimport sys\n\nfrom setuptools import setup, find_packages\n\n\ndef requirements():\n \"\"\"Build the requirements list for this project\"\"\"\n requirements_list = []\n\n with open('requirements.txt') as requirements:\n for install in requirements:\n requirements_list.append(install.strip())\n\n return requirements_list\n\n\npackages = find_packages(exclude=['tests*'])\nrequirements = requirements()\n\n# Allow for a package install to not use the vendored urllib3\nUPSTREAM_URLLIB3_FLAG = '--with-upstream-urllib3'\nif UPSTREAM_URLLIB3_FLAG in sys.argv:\n sys.argv.remove(UPSTREAM_URLLIB3_FLAG)\n requirements.append('urllib3 >= 1.19.1')\n packages = [x for x in packages if not x.startswith('telegram.vendor.ptb_urllib3')]\n\nwith codecs.open('README.rst', 'r', 'utf-8') as fd:\n fn = os.path.join('telegram', 'version.py')\n with open(fn) as fh:\n code = compile(fh.read(), fn, 'exec')\n exec(code)\n\n setup(name='python-telegram-bot',\n version=__version__,\n author='Leandro Toledo',\n author_email='devs@python-telegram-bot.org',\n license='LGPLv3',\n url='https://python-telegram-bot.org/',\n keywords='python telegram bot api wrapper',\n description=\"We have made you a wrapper you can't refuse\",\n long_description=fd.read(),\n packages=packages,\n install_requires=requirements,\n extras_require={\n 'json': 'ujson',\n 'socks': 'PySocks'\n },\n include_package_data=True,\n classifiers=[\n 'Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)',\n 'Operating System :: OS Independent',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Communications :: Chat',\n 'Topic :: Internet',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.6',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n ],)\n","path":"setup.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/env python\\n\\\"\\\"\\\"The setup and build script for the python-telegram-bot library.\\\"\\\"\\\"\\n\\nimport codecs\\nimport os\\nimport sys\\n\\nfrom setuptools import setup, find_packages\\n\\n\\ndef requirements():\\n \\\"\\\"\\\"Build the requirements list for this project\\\"\\\"\\\"\\n requirements_list = []\\n\\n with open('requirements.txt') as requirements:\\n for install in requirements:\\n requirements_list.append(install.strip())\\n\\n return requirements_list\\n\\n\\npackages = find_packages(exclude=['tests*'])\\nrequirements = requirements()\\n\\n# Allow for a package install to not use the vendored urllib3\\nUPSTREAM_URLLIB3_FLAG = '--with-upstream-urllib3'\\nif UPSTREAM_URLLIB3_FLAG in sys.argv:\\n sys.argv.remove(UPSTREAM_URLLIB3_FLAG)\\n requirements.append('urllib3 >= 1.19.1')\\n packages = [x for x in packages if not x.startswith('telegram.vendor.ptb_urllib3')]\\n\\nwith codecs.open('README.rst', 'r', 'utf-8') as fd:\\n fn = os.path.join('telegram', 'version.py')\\n with open(fn) as fh:\\n code = compile(fh.read(), fn, 'exec')\\n exec(code)\\n\\n setup(name='python-telegram-bot',\\n version=__version__,\\n author='Leandro Toledo',\\n author_email='devs@python-telegram-bot.org',\\n license='LGPLv3',\\n url='https://python-telegram-bot.org/',\\n keywords='python telegram bot api wrapper',\\n description=\\\"We have made you a wrapper you can't refuse\\\",\\n long_description=fd.read(),\\n packages=packages,\\n install_requires=requirements,\\n extras_require={\\n 'json': 'ujson',\\n 'socks': 'PySocks'\\n },\\n include_package_data=True,\\n classifiers=[\\n 'Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)',\\n 'Operating System :: OS Independent',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Communications :: Chat',\\n 'Topic :: Internet',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.6',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n ],)\\n\",\n \"path\": \"setup.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"#!/usr/bin/env python\n\"\"\"The setup and build script for the python-telegram-bot library.\"\"\"\n\nimport codecs\nimport os\nimport sys\n\nfrom setuptools import setup, find_packages\n\n\ndef requirements():\n \"\"\"Build the requirements list for this project\"\"\"\n requirements_list = []\n\n with open('requirements.txt') as requirements:\n for install in requirements:\n requirements_list.append(install.strip())\n\n return requirements_list\n\n\npackages = find_packages(exclude=['tests*'])\nrequirements = requirements()\n\n# Allow for a package install to not use the vendored urllib3\nUPSTREAM_URLLIB3_FLAG = '--with-upstream-urllib3'\nif UPSTREAM_URLLIB3_FLAG in sys.argv:\n sys.argv.remove(UPSTREAM_URLLIB3_FLAG)\n requirements.append('urllib3 >= 1.19.1')\n packages = [x for x in packages if not x.startswith('telegram.vendor.ptb_urllib3')]\n\nwith codecs.open('README.rst', 'r', 'utf-8') as fd:\n fn = os.path.join('telegram', 'version.py')\n with open(fn) as fh:\n code = compile(fh.read(), fn, 'exec')\n exec(code)\n\n setup(name='python-telegram-bot',\n version=__version__,\n author='Leandro Toledo',\n author_email='devs@python-telegram-bot.org',\n license='LGPLv3',\n url='https://python-telegram-bot.org/',\n keywords='python telegram bot api wrapper',\n description=\"We have made you a wrapper you can't refuse\",\n long_description=fd.read(),\n packages=packages,\n package_data={'telegram': ['py.typed']},\n install_requires=requirements,\n extras_require={\n 'json': 'ujson',\n 'socks': 'PySocks'\n },\n include_package_data=True,\n classifiers=[\n 'Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)',\n 'Operating System :: OS Independent',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Communications :: Chat',\n 'Topic :: Internet',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.6',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n ],)\n","path":"setup.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/env python\\n\\\"\\\"\\\"The setup and build script for the python-telegram-bot library.\\\"\\\"\\\"\\n\\nimport codecs\\nimport os\\nimport sys\\n\\nfrom setuptools import setup, find_packages\\n\\n\\ndef requirements():\\n \\\"\\\"\\\"Build the requirements list for this project\\\"\\\"\\\"\\n requirements_list = []\\n\\n with open('requirements.txt') as requirements:\\n for install in requirements:\\n requirements_list.append(install.strip())\\n\\n return requirements_list\\n\\n\\npackages = find_packages(exclude=['tests*'])\\nrequirements = requirements()\\n\\n# Allow for a package install to not use the vendored urllib3\\nUPSTREAM_URLLIB3_FLAG = '--with-upstream-urllib3'\\nif UPSTREAM_URLLIB3_FLAG in sys.argv:\\n sys.argv.remove(UPSTREAM_URLLIB3_FLAG)\\n requirements.append('urllib3 >= 1.19.1')\\n packages = [x for x in packages if not x.startswith('telegram.vendor.ptb_urllib3')]\\n\\nwith codecs.open('README.rst', 'r', 'utf-8') as fd:\\n fn = os.path.join('telegram', 'version.py')\\n with open(fn) as fh:\\n code = compile(fh.read(), fn, 'exec')\\n exec(code)\\n\\n setup(name='python-telegram-bot',\\n version=__version__,\\n author='Leandro Toledo',\\n author_email='devs@python-telegram-bot.org',\\n license='LGPLv3',\\n url='https://python-telegram-bot.org/',\\n keywords='python telegram bot api wrapper',\\n description=\\\"We have made you a wrapper you can't refuse\\\",\\n long_description=fd.read(),\\n packages=packages,\\n package_data={'telegram': ['py.typed']},\\n install_requires=requirements,\\n extras_require={\\n 'json': 'ujson',\\n 'socks': 'PySocks'\\n },\\n include_package_data=True,\\n classifiers=[\\n 'Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)',\\n 'Operating System :: OS Independent',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Communications :: Chat',\\n 'Topic :: Internet',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.6',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n ],)\\n\",\n \"path\": \"setup.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/MANIFEST.in b/MANIFEST.in\nindex 2a6b5ab8a35..55bc61aca7b 100644\n--- a/MANIFEST.in\n+++ b/MANIFEST.in\n@@ -1 +1 @@\n-include LICENSE LICENSE.lesser Makefile requirements.txt\n+include LICENSE LICENSE.lesser Makefile requirements.txt py.typed\ndiff --git a/setup.py b/setup.py\nindex 08dfe8ef179..cb13e49178f 100644\n--- a/setup.py\n+++ b/setup.py\n@@ -45,6 +45,7 @@ def requirements():\n description=\"We have made you a wrapper you can't refuse\",\n long_description=fd.read(),\n packages=packages,\n+ package_data={'telegram': ['py.typed']},\n install_requires=requirements,\n extras_require={\n 'json': 'ujson',\ndiff --git a/telegram/py.typed b/telegram/py.typed\nnew file mode 100644\nindex 00000000000..e69de29bb2d\n"}}},{"rowIdx":4698,"cells":{"in_source_id":{"kind":"string","value":"adamchainz__django-cors-headers-715"},"issue":{"kind":"string","value":"unhandled invalid HTTP_ORIGIN\n### Understanding CORS\n\n- [X] I have read the resources.\n\n### Python Version\n\n3.9.7\n\n### Django Version\n\n3.2.8\n\n### Package Version\n\n3.10.0\n\n### Description\n\nit seems that an unparsable, invalid `HTTP_ORIGIN` header is a trivial way to exception/mail spam a django instance:\r\n\r\n```\r\nInternal Server Error: /\r\n\r\nValueError at /\r\nInvalid IPv6 URL\r\n...\r\nHTTP_ORIGIN = 'https://example.com].evil.com'\r\nHTTP_REFERER = 'https://example.com].evil.com'\r\n```\r\n\r\nhttps://github.com/adamchainz/django-cors-headers/blob/main/src/corsheaders/middleware.py#L135\r\n\r\nthis was generated by a security scanner btw.\r\n\r\ni think in this case `HTTP_ORIGIN` should be simply ignored and the library should behave as if there was no header at all.\n"},"before_files":{"kind":"list like","value":[{"content":"import re\nfrom typing import Any, Optional\nfrom urllib.parse import ParseResult, urlparse\n\nfrom django.http import HttpRequest, HttpResponse\nfrom django.utils.cache import patch_vary_headers\nfrom django.utils.deprecation import MiddlewareMixin\n\nfrom corsheaders.conf import conf\nfrom corsheaders.signals import check_request_enabled\n\nACCESS_CONTROL_ALLOW_ORIGIN = \"Access-Control-Allow-Origin\"\nACCESS_CONTROL_EXPOSE_HEADERS = \"Access-Control-Expose-Headers\"\nACCESS_CONTROL_ALLOW_CREDENTIALS = \"Access-Control-Allow-Credentials\"\nACCESS_CONTROL_ALLOW_HEADERS = \"Access-Control-Allow-Headers\"\nACCESS_CONTROL_ALLOW_METHODS = \"Access-Control-Allow-Methods\"\nACCESS_CONTROL_MAX_AGE = \"Access-Control-Max-Age\"\n\n\nclass CorsPostCsrfMiddleware(MiddlewareMixin):\n def _https_referer_replace_reverse(self, request: HttpRequest) -> None:\n \"\"\"\n Put the HTTP_REFERER back to its original value and delete the\n temporary storage\n \"\"\"\n if conf.CORS_REPLACE_HTTPS_REFERER and \"ORIGINAL_HTTP_REFERER\" in request.META:\n http_referer = request.META[\"ORIGINAL_HTTP_REFERER\"]\n request.META[\"HTTP_REFERER\"] = http_referer\n del request.META[\"ORIGINAL_HTTP_REFERER\"]\n\n def process_request(self, request: HttpRequest) -> None:\n self._https_referer_replace_reverse(request)\n return None\n\n def process_view(\n self,\n request: HttpRequest,\n callback: Any,\n callback_args: Any,\n callback_kwargs: Any,\n ) -> None:\n self._https_referer_replace_reverse(request)\n return None\n\n\nclass CorsMiddleware(MiddlewareMixin):\n def _https_referer_replace(self, request: HttpRequest) -> None:\n \"\"\"\n When https is enabled, django CSRF checking includes referer checking\n which breaks when using CORS. This function updates the HTTP_REFERER\n header to make sure it matches HTTP_HOST, provided that our cors logic\n succeeds\n \"\"\"\n origin = request.META.get(\"HTTP_ORIGIN\")\n\n if (\n request.is_secure()\n and origin\n and \"ORIGINAL_HTTP_REFERER\" not in request.META\n ):\n\n url = urlparse(origin)\n if (\n not conf.CORS_ALLOW_ALL_ORIGINS\n and not self.origin_found_in_white_lists(origin, url)\n ):\n return\n\n try:\n http_referer = request.META[\"HTTP_REFERER\"]\n http_host = \"https://%s/\" % request.META[\"HTTP_HOST\"]\n request.META = request.META.copy()\n request.META[\"ORIGINAL_HTTP_REFERER\"] = http_referer\n request.META[\"HTTP_REFERER\"] = http_host\n except KeyError:\n pass\n\n def process_request(self, request: HttpRequest) -> Optional[HttpResponse]:\n \"\"\"\n If CORS preflight header, then create an\n empty body response (200 OK) and return it\n\n Django won't bother calling any other request\n view/exception middleware along with the requested view;\n it will call any response middlewares\n \"\"\"\n request._cors_enabled = self.is_enabled(request)\n if request._cors_enabled:\n if conf.CORS_REPLACE_HTTPS_REFERER:\n self._https_referer_replace(request)\n\n if (\n request.method == \"OPTIONS\"\n and \"HTTP_ACCESS_CONTROL_REQUEST_METHOD\" in request.META\n ):\n response = HttpResponse()\n response[\"Content-Length\"] = \"0\"\n return response\n return None\n\n def process_view(\n self,\n request: HttpRequest,\n callback: Any,\n callback_args: Any,\n callback_kwargs: Any,\n ) -> None:\n \"\"\"\n Do the referer replacement here as well\n \"\"\"\n if request._cors_enabled and conf.CORS_REPLACE_HTTPS_REFERER:\n self._https_referer_replace(request)\n return None\n\n def process_response(\n self, request: HttpRequest, response: HttpResponse\n ) -> HttpResponse:\n \"\"\"\n Add the respective CORS headers\n \"\"\"\n enabled = getattr(request, \"_cors_enabled\", None)\n if enabled is None:\n enabled = self.is_enabled(request)\n\n if not enabled:\n return response\n\n patch_vary_headers(response, [\"Origin\"])\n\n origin = request.META.get(\"HTTP_ORIGIN\")\n if not origin:\n return response\n\n # todo: check hostname from db instead\n url = urlparse(origin)\n\n if conf.CORS_ALLOW_CREDENTIALS:\n response[ACCESS_CONTROL_ALLOW_CREDENTIALS] = \"true\"\n\n if (\n not conf.CORS_ALLOW_ALL_ORIGINS\n and not self.origin_found_in_white_lists(origin, url)\n and not self.check_signal(request)\n ):\n return response\n\n if conf.CORS_ALLOW_ALL_ORIGINS and not conf.CORS_ALLOW_CREDENTIALS:\n response[ACCESS_CONTROL_ALLOW_ORIGIN] = \"*\"\n else:\n response[ACCESS_CONTROL_ALLOW_ORIGIN] = origin\n\n if len(conf.CORS_EXPOSE_HEADERS):\n response[ACCESS_CONTROL_EXPOSE_HEADERS] = \", \".join(\n conf.CORS_EXPOSE_HEADERS\n )\n\n if request.method == \"OPTIONS\":\n response[ACCESS_CONTROL_ALLOW_HEADERS] = \", \".join(conf.CORS_ALLOW_HEADERS)\n response[ACCESS_CONTROL_ALLOW_METHODS] = \", \".join(conf.CORS_ALLOW_METHODS)\n if conf.CORS_PREFLIGHT_MAX_AGE:\n response[ACCESS_CONTROL_MAX_AGE] = str(conf.CORS_PREFLIGHT_MAX_AGE)\n\n return response\n\n def origin_found_in_white_lists(self, origin: str, url: ParseResult) -> bool:\n return (\n (origin == \"null\" and origin in conf.CORS_ALLOWED_ORIGINS)\n or self._url_in_whitelist(url)\n or self.regex_domain_match(origin)\n )\n\n def regex_domain_match(self, origin: str) -> bool:\n return any(\n re.match(domain_pattern, origin)\n for domain_pattern in conf.CORS_ALLOWED_ORIGIN_REGEXES\n )\n\n def is_enabled(self, request: HttpRequest) -> bool:\n return bool(\n re.match(conf.CORS_URLS_REGEX, request.path_info)\n ) or self.check_signal(request)\n\n def check_signal(self, request: HttpRequest) -> bool:\n signal_responses = check_request_enabled.send(sender=None, request=request)\n return any(return_value for function, return_value in signal_responses)\n\n def _url_in_whitelist(self, url: ParseResult) -> bool:\n origins = [urlparse(o) for o in conf.CORS_ALLOWED_ORIGINS]\n return any(\n origin.scheme == url.scheme and origin.netloc == url.netloc\n for origin in origins\n )\n","path":"src/corsheaders/middleware.py"}],"string":"[\n {\n \"content\": \"import re\\nfrom typing import Any, Optional\\nfrom urllib.parse import ParseResult, urlparse\\n\\nfrom django.http import HttpRequest, HttpResponse\\nfrom django.utils.cache import patch_vary_headers\\nfrom django.utils.deprecation import MiddlewareMixin\\n\\nfrom corsheaders.conf import conf\\nfrom corsheaders.signals import check_request_enabled\\n\\nACCESS_CONTROL_ALLOW_ORIGIN = \\\"Access-Control-Allow-Origin\\\"\\nACCESS_CONTROL_EXPOSE_HEADERS = \\\"Access-Control-Expose-Headers\\\"\\nACCESS_CONTROL_ALLOW_CREDENTIALS = \\\"Access-Control-Allow-Credentials\\\"\\nACCESS_CONTROL_ALLOW_HEADERS = \\\"Access-Control-Allow-Headers\\\"\\nACCESS_CONTROL_ALLOW_METHODS = \\\"Access-Control-Allow-Methods\\\"\\nACCESS_CONTROL_MAX_AGE = \\\"Access-Control-Max-Age\\\"\\n\\n\\nclass CorsPostCsrfMiddleware(MiddlewareMixin):\\n def _https_referer_replace_reverse(self, request: HttpRequest) -> None:\\n \\\"\\\"\\\"\\n Put the HTTP_REFERER back to its original value and delete the\\n temporary storage\\n \\\"\\\"\\\"\\n if conf.CORS_REPLACE_HTTPS_REFERER and \\\"ORIGINAL_HTTP_REFERER\\\" in request.META:\\n http_referer = request.META[\\\"ORIGINAL_HTTP_REFERER\\\"]\\n request.META[\\\"HTTP_REFERER\\\"] = http_referer\\n del request.META[\\\"ORIGINAL_HTTP_REFERER\\\"]\\n\\n def process_request(self, request: HttpRequest) -> None:\\n self._https_referer_replace_reverse(request)\\n return None\\n\\n def process_view(\\n self,\\n request: HttpRequest,\\n callback: Any,\\n callback_args: Any,\\n callback_kwargs: Any,\\n ) -> None:\\n self._https_referer_replace_reverse(request)\\n return None\\n\\n\\nclass CorsMiddleware(MiddlewareMixin):\\n def _https_referer_replace(self, request: HttpRequest) -> None:\\n \\\"\\\"\\\"\\n When https is enabled, django CSRF checking includes referer checking\\n which breaks when using CORS. This function updates the HTTP_REFERER\\n header to make sure it matches HTTP_HOST, provided that our cors logic\\n succeeds\\n \\\"\\\"\\\"\\n origin = request.META.get(\\\"HTTP_ORIGIN\\\")\\n\\n if (\\n request.is_secure()\\n and origin\\n and \\\"ORIGINAL_HTTP_REFERER\\\" not in request.META\\n ):\\n\\n url = urlparse(origin)\\n if (\\n not conf.CORS_ALLOW_ALL_ORIGINS\\n and not self.origin_found_in_white_lists(origin, url)\\n ):\\n return\\n\\n try:\\n http_referer = request.META[\\\"HTTP_REFERER\\\"]\\n http_host = \\\"https://%s/\\\" % request.META[\\\"HTTP_HOST\\\"]\\n request.META = request.META.copy()\\n request.META[\\\"ORIGINAL_HTTP_REFERER\\\"] = http_referer\\n request.META[\\\"HTTP_REFERER\\\"] = http_host\\n except KeyError:\\n pass\\n\\n def process_request(self, request: HttpRequest) -> Optional[HttpResponse]:\\n \\\"\\\"\\\"\\n If CORS preflight header, then create an\\n empty body response (200 OK) and return it\\n\\n Django won't bother calling any other request\\n view/exception middleware along with the requested view;\\n it will call any response middlewares\\n \\\"\\\"\\\"\\n request._cors_enabled = self.is_enabled(request)\\n if request._cors_enabled:\\n if conf.CORS_REPLACE_HTTPS_REFERER:\\n self._https_referer_replace(request)\\n\\n if (\\n request.method == \\\"OPTIONS\\\"\\n and \\\"HTTP_ACCESS_CONTROL_REQUEST_METHOD\\\" in request.META\\n ):\\n response = HttpResponse()\\n response[\\\"Content-Length\\\"] = \\\"0\\\"\\n return response\\n return None\\n\\n def process_view(\\n self,\\n request: HttpRequest,\\n callback: Any,\\n callback_args: Any,\\n callback_kwargs: Any,\\n ) -> None:\\n \\\"\\\"\\\"\\n Do the referer replacement here as well\\n \\\"\\\"\\\"\\n if request._cors_enabled and conf.CORS_REPLACE_HTTPS_REFERER:\\n self._https_referer_replace(request)\\n return None\\n\\n def process_response(\\n self, request: HttpRequest, response: HttpResponse\\n ) -> HttpResponse:\\n \\\"\\\"\\\"\\n Add the respective CORS headers\\n \\\"\\\"\\\"\\n enabled = getattr(request, \\\"_cors_enabled\\\", None)\\n if enabled is None:\\n enabled = self.is_enabled(request)\\n\\n if not enabled:\\n return response\\n\\n patch_vary_headers(response, [\\\"Origin\\\"])\\n\\n origin = request.META.get(\\\"HTTP_ORIGIN\\\")\\n if not origin:\\n return response\\n\\n # todo: check hostname from db instead\\n url = urlparse(origin)\\n\\n if conf.CORS_ALLOW_CREDENTIALS:\\n response[ACCESS_CONTROL_ALLOW_CREDENTIALS] = \\\"true\\\"\\n\\n if (\\n not conf.CORS_ALLOW_ALL_ORIGINS\\n and not self.origin_found_in_white_lists(origin, url)\\n and not self.check_signal(request)\\n ):\\n return response\\n\\n if conf.CORS_ALLOW_ALL_ORIGINS and not conf.CORS_ALLOW_CREDENTIALS:\\n response[ACCESS_CONTROL_ALLOW_ORIGIN] = \\\"*\\\"\\n else:\\n response[ACCESS_CONTROL_ALLOW_ORIGIN] = origin\\n\\n if len(conf.CORS_EXPOSE_HEADERS):\\n response[ACCESS_CONTROL_EXPOSE_HEADERS] = \\\", \\\".join(\\n conf.CORS_EXPOSE_HEADERS\\n )\\n\\n if request.method == \\\"OPTIONS\\\":\\n response[ACCESS_CONTROL_ALLOW_HEADERS] = \\\", \\\".join(conf.CORS_ALLOW_HEADERS)\\n response[ACCESS_CONTROL_ALLOW_METHODS] = \\\", \\\".join(conf.CORS_ALLOW_METHODS)\\n if conf.CORS_PREFLIGHT_MAX_AGE:\\n response[ACCESS_CONTROL_MAX_AGE] = str(conf.CORS_PREFLIGHT_MAX_AGE)\\n\\n return response\\n\\n def origin_found_in_white_lists(self, origin: str, url: ParseResult) -> bool:\\n return (\\n (origin == \\\"null\\\" and origin in conf.CORS_ALLOWED_ORIGINS)\\n or self._url_in_whitelist(url)\\n or self.regex_domain_match(origin)\\n )\\n\\n def regex_domain_match(self, origin: str) -> bool:\\n return any(\\n re.match(domain_pattern, origin)\\n for domain_pattern in conf.CORS_ALLOWED_ORIGIN_REGEXES\\n )\\n\\n def is_enabled(self, request: HttpRequest) -> bool:\\n return bool(\\n re.match(conf.CORS_URLS_REGEX, request.path_info)\\n ) or self.check_signal(request)\\n\\n def check_signal(self, request: HttpRequest) -> bool:\\n signal_responses = check_request_enabled.send(sender=None, request=request)\\n return any(return_value for function, return_value in signal_responses)\\n\\n def _url_in_whitelist(self, url: ParseResult) -> bool:\\n origins = [urlparse(o) for o in conf.CORS_ALLOWED_ORIGINS]\\n return any(\\n origin.scheme == url.scheme and origin.netloc == url.netloc\\n for origin in origins\\n )\\n\",\n \"path\": \"src/corsheaders/middleware.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import re\nfrom typing import Any, Optional\nfrom urllib.parse import ParseResult, urlparse\n\nfrom django.http import HttpRequest, HttpResponse\nfrom django.utils.cache import patch_vary_headers\nfrom django.utils.deprecation import MiddlewareMixin\n\nfrom corsheaders.conf import conf\nfrom corsheaders.signals import check_request_enabled\n\nACCESS_CONTROL_ALLOW_ORIGIN = \"Access-Control-Allow-Origin\"\nACCESS_CONTROL_EXPOSE_HEADERS = \"Access-Control-Expose-Headers\"\nACCESS_CONTROL_ALLOW_CREDENTIALS = \"Access-Control-Allow-Credentials\"\nACCESS_CONTROL_ALLOW_HEADERS = \"Access-Control-Allow-Headers\"\nACCESS_CONTROL_ALLOW_METHODS = \"Access-Control-Allow-Methods\"\nACCESS_CONTROL_MAX_AGE = \"Access-Control-Max-Age\"\n\n\nclass CorsPostCsrfMiddleware(MiddlewareMixin):\n def _https_referer_replace_reverse(self, request: HttpRequest) -> None:\n \"\"\"\n Put the HTTP_REFERER back to its original value and delete the\n temporary storage\n \"\"\"\n if conf.CORS_REPLACE_HTTPS_REFERER and \"ORIGINAL_HTTP_REFERER\" in request.META:\n http_referer = request.META[\"ORIGINAL_HTTP_REFERER\"]\n request.META[\"HTTP_REFERER\"] = http_referer\n del request.META[\"ORIGINAL_HTTP_REFERER\"]\n\n def process_request(self, request: HttpRequest) -> None:\n self._https_referer_replace_reverse(request)\n return None\n\n def process_view(\n self,\n request: HttpRequest,\n callback: Any,\n callback_args: Any,\n callback_kwargs: Any,\n ) -> None:\n self._https_referer_replace_reverse(request)\n return None\n\n\nclass CorsMiddleware(MiddlewareMixin):\n def _https_referer_replace(self, request: HttpRequest) -> None:\n \"\"\"\n When https is enabled, django CSRF checking includes referer checking\n which breaks when using CORS. This function updates the HTTP_REFERER\n header to make sure it matches HTTP_HOST, provided that our cors logic\n succeeds\n \"\"\"\n origin = request.META.get(\"HTTP_ORIGIN\")\n\n if (\n request.is_secure()\n and origin\n and \"ORIGINAL_HTTP_REFERER\" not in request.META\n ):\n\n url = urlparse(origin)\n if (\n not conf.CORS_ALLOW_ALL_ORIGINS\n and not self.origin_found_in_white_lists(origin, url)\n ):\n return\n\n try:\n http_referer = request.META[\"HTTP_REFERER\"]\n http_host = \"https://%s/\" % request.META[\"HTTP_HOST\"]\n request.META = request.META.copy()\n request.META[\"ORIGINAL_HTTP_REFERER\"] = http_referer\n request.META[\"HTTP_REFERER\"] = http_host\n except KeyError:\n pass\n\n def process_request(self, request: HttpRequest) -> Optional[HttpResponse]:\n \"\"\"\n If CORS preflight header, then create an\n empty body response (200 OK) and return it\n\n Django won't bother calling any other request\n view/exception middleware along with the requested view;\n it will call any response middlewares\n \"\"\"\n request._cors_enabled = self.is_enabled(request)\n if request._cors_enabled:\n if conf.CORS_REPLACE_HTTPS_REFERER:\n self._https_referer_replace(request)\n\n if (\n request.method == \"OPTIONS\"\n and \"HTTP_ACCESS_CONTROL_REQUEST_METHOD\" in request.META\n ):\n response = HttpResponse()\n response[\"Content-Length\"] = \"0\"\n return response\n return None\n\n def process_view(\n self,\n request: HttpRequest,\n callback: Any,\n callback_args: Any,\n callback_kwargs: Any,\n ) -> None:\n \"\"\"\n Do the referer replacement here as well\n \"\"\"\n if request._cors_enabled and conf.CORS_REPLACE_HTTPS_REFERER:\n self._https_referer_replace(request)\n return None\n\n def process_response(\n self, request: HttpRequest, response: HttpResponse\n ) -> HttpResponse:\n \"\"\"\n Add the respective CORS headers\n \"\"\"\n enabled = getattr(request, \"_cors_enabled\", None)\n if enabled is None:\n enabled = self.is_enabled(request)\n\n if not enabled:\n return response\n\n patch_vary_headers(response, [\"Origin\"])\n\n origin = request.META.get(\"HTTP_ORIGIN\")\n if not origin:\n return response\n\n try:\n url = urlparse(origin)\n except ValueError:\n return response\n\n if conf.CORS_ALLOW_CREDENTIALS:\n response[ACCESS_CONTROL_ALLOW_CREDENTIALS] = \"true\"\n\n if (\n not conf.CORS_ALLOW_ALL_ORIGINS\n and not self.origin_found_in_white_lists(origin, url)\n and not self.check_signal(request)\n ):\n return response\n\n if conf.CORS_ALLOW_ALL_ORIGINS and not conf.CORS_ALLOW_CREDENTIALS:\n response[ACCESS_CONTROL_ALLOW_ORIGIN] = \"*\"\n else:\n response[ACCESS_CONTROL_ALLOW_ORIGIN] = origin\n\n if len(conf.CORS_EXPOSE_HEADERS):\n response[ACCESS_CONTROL_EXPOSE_HEADERS] = \", \".join(\n conf.CORS_EXPOSE_HEADERS\n )\n\n if request.method == \"OPTIONS\":\n response[ACCESS_CONTROL_ALLOW_HEADERS] = \", \".join(conf.CORS_ALLOW_HEADERS)\n response[ACCESS_CONTROL_ALLOW_METHODS] = \", \".join(conf.CORS_ALLOW_METHODS)\n if conf.CORS_PREFLIGHT_MAX_AGE:\n response[ACCESS_CONTROL_MAX_AGE] = str(conf.CORS_PREFLIGHT_MAX_AGE)\n\n return response\n\n def origin_found_in_white_lists(self, origin: str, url: ParseResult) -> bool:\n return (\n (origin == \"null\" and origin in conf.CORS_ALLOWED_ORIGINS)\n or self._url_in_whitelist(url)\n or self.regex_domain_match(origin)\n )\n\n def regex_domain_match(self, origin: str) -> bool:\n return any(\n re.match(domain_pattern, origin)\n for domain_pattern in conf.CORS_ALLOWED_ORIGIN_REGEXES\n )\n\n def is_enabled(self, request: HttpRequest) -> bool:\n return bool(\n re.match(conf.CORS_URLS_REGEX, request.path_info)\n ) or self.check_signal(request)\n\n def check_signal(self, request: HttpRequest) -> bool:\n signal_responses = check_request_enabled.send(sender=None, request=request)\n return any(return_value for function, return_value in signal_responses)\n\n def _url_in_whitelist(self, url: ParseResult) -> bool:\n origins = [urlparse(o) for o in conf.CORS_ALLOWED_ORIGINS]\n return any(\n origin.scheme == url.scheme and origin.netloc == url.netloc\n for origin in origins\n )\n","path":"src/corsheaders/middleware.py"}],"string":"[\n {\n \"content\": \"import re\\nfrom typing import Any, Optional\\nfrom urllib.parse import ParseResult, urlparse\\n\\nfrom django.http import HttpRequest, HttpResponse\\nfrom django.utils.cache import patch_vary_headers\\nfrom django.utils.deprecation import MiddlewareMixin\\n\\nfrom corsheaders.conf import conf\\nfrom corsheaders.signals import check_request_enabled\\n\\nACCESS_CONTROL_ALLOW_ORIGIN = \\\"Access-Control-Allow-Origin\\\"\\nACCESS_CONTROL_EXPOSE_HEADERS = \\\"Access-Control-Expose-Headers\\\"\\nACCESS_CONTROL_ALLOW_CREDENTIALS = \\\"Access-Control-Allow-Credentials\\\"\\nACCESS_CONTROL_ALLOW_HEADERS = \\\"Access-Control-Allow-Headers\\\"\\nACCESS_CONTROL_ALLOW_METHODS = \\\"Access-Control-Allow-Methods\\\"\\nACCESS_CONTROL_MAX_AGE = \\\"Access-Control-Max-Age\\\"\\n\\n\\nclass CorsPostCsrfMiddleware(MiddlewareMixin):\\n def _https_referer_replace_reverse(self, request: HttpRequest) -> None:\\n \\\"\\\"\\\"\\n Put the HTTP_REFERER back to its original value and delete the\\n temporary storage\\n \\\"\\\"\\\"\\n if conf.CORS_REPLACE_HTTPS_REFERER and \\\"ORIGINAL_HTTP_REFERER\\\" in request.META:\\n http_referer = request.META[\\\"ORIGINAL_HTTP_REFERER\\\"]\\n request.META[\\\"HTTP_REFERER\\\"] = http_referer\\n del request.META[\\\"ORIGINAL_HTTP_REFERER\\\"]\\n\\n def process_request(self, request: HttpRequest) -> None:\\n self._https_referer_replace_reverse(request)\\n return None\\n\\n def process_view(\\n self,\\n request: HttpRequest,\\n callback: Any,\\n callback_args: Any,\\n callback_kwargs: Any,\\n ) -> None:\\n self._https_referer_replace_reverse(request)\\n return None\\n\\n\\nclass CorsMiddleware(MiddlewareMixin):\\n def _https_referer_replace(self, request: HttpRequest) -> None:\\n \\\"\\\"\\\"\\n When https is enabled, django CSRF checking includes referer checking\\n which breaks when using CORS. This function updates the HTTP_REFERER\\n header to make sure it matches HTTP_HOST, provided that our cors logic\\n succeeds\\n \\\"\\\"\\\"\\n origin = request.META.get(\\\"HTTP_ORIGIN\\\")\\n\\n if (\\n request.is_secure()\\n and origin\\n and \\\"ORIGINAL_HTTP_REFERER\\\" not in request.META\\n ):\\n\\n url = urlparse(origin)\\n if (\\n not conf.CORS_ALLOW_ALL_ORIGINS\\n and not self.origin_found_in_white_lists(origin, url)\\n ):\\n return\\n\\n try:\\n http_referer = request.META[\\\"HTTP_REFERER\\\"]\\n http_host = \\\"https://%s/\\\" % request.META[\\\"HTTP_HOST\\\"]\\n request.META = request.META.copy()\\n request.META[\\\"ORIGINAL_HTTP_REFERER\\\"] = http_referer\\n request.META[\\\"HTTP_REFERER\\\"] = http_host\\n except KeyError:\\n pass\\n\\n def process_request(self, request: HttpRequest) -> Optional[HttpResponse]:\\n \\\"\\\"\\\"\\n If CORS preflight header, then create an\\n empty body response (200 OK) and return it\\n\\n Django won't bother calling any other request\\n view/exception middleware along with the requested view;\\n it will call any response middlewares\\n \\\"\\\"\\\"\\n request._cors_enabled = self.is_enabled(request)\\n if request._cors_enabled:\\n if conf.CORS_REPLACE_HTTPS_REFERER:\\n self._https_referer_replace(request)\\n\\n if (\\n request.method == \\\"OPTIONS\\\"\\n and \\\"HTTP_ACCESS_CONTROL_REQUEST_METHOD\\\" in request.META\\n ):\\n response = HttpResponse()\\n response[\\\"Content-Length\\\"] = \\\"0\\\"\\n return response\\n return None\\n\\n def process_view(\\n self,\\n request: HttpRequest,\\n callback: Any,\\n callback_args: Any,\\n callback_kwargs: Any,\\n ) -> None:\\n \\\"\\\"\\\"\\n Do the referer replacement here as well\\n \\\"\\\"\\\"\\n if request._cors_enabled and conf.CORS_REPLACE_HTTPS_REFERER:\\n self._https_referer_replace(request)\\n return None\\n\\n def process_response(\\n self, request: HttpRequest, response: HttpResponse\\n ) -> HttpResponse:\\n \\\"\\\"\\\"\\n Add the respective CORS headers\\n \\\"\\\"\\\"\\n enabled = getattr(request, \\\"_cors_enabled\\\", None)\\n if enabled is None:\\n enabled = self.is_enabled(request)\\n\\n if not enabled:\\n return response\\n\\n patch_vary_headers(response, [\\\"Origin\\\"])\\n\\n origin = request.META.get(\\\"HTTP_ORIGIN\\\")\\n if not origin:\\n return response\\n\\n try:\\n url = urlparse(origin)\\n except ValueError:\\n return response\\n\\n if conf.CORS_ALLOW_CREDENTIALS:\\n response[ACCESS_CONTROL_ALLOW_CREDENTIALS] = \\\"true\\\"\\n\\n if (\\n not conf.CORS_ALLOW_ALL_ORIGINS\\n and not self.origin_found_in_white_lists(origin, url)\\n and not self.check_signal(request)\\n ):\\n return response\\n\\n if conf.CORS_ALLOW_ALL_ORIGINS and not conf.CORS_ALLOW_CREDENTIALS:\\n response[ACCESS_CONTROL_ALLOW_ORIGIN] = \\\"*\\\"\\n else:\\n response[ACCESS_CONTROL_ALLOW_ORIGIN] = origin\\n\\n if len(conf.CORS_EXPOSE_HEADERS):\\n response[ACCESS_CONTROL_EXPOSE_HEADERS] = \\\", \\\".join(\\n conf.CORS_EXPOSE_HEADERS\\n )\\n\\n if request.method == \\\"OPTIONS\\\":\\n response[ACCESS_CONTROL_ALLOW_HEADERS] = \\\", \\\".join(conf.CORS_ALLOW_HEADERS)\\n response[ACCESS_CONTROL_ALLOW_METHODS] = \\\", \\\".join(conf.CORS_ALLOW_METHODS)\\n if conf.CORS_PREFLIGHT_MAX_AGE:\\n response[ACCESS_CONTROL_MAX_AGE] = str(conf.CORS_PREFLIGHT_MAX_AGE)\\n\\n return response\\n\\n def origin_found_in_white_lists(self, origin: str, url: ParseResult) -> bool:\\n return (\\n (origin == \\\"null\\\" and origin in conf.CORS_ALLOWED_ORIGINS)\\n or self._url_in_whitelist(url)\\n or self.regex_domain_match(origin)\\n )\\n\\n def regex_domain_match(self, origin: str) -> bool:\\n return any(\\n re.match(domain_pattern, origin)\\n for domain_pattern in conf.CORS_ALLOWED_ORIGIN_REGEXES\\n )\\n\\n def is_enabled(self, request: HttpRequest) -> bool:\\n return bool(\\n re.match(conf.CORS_URLS_REGEX, request.path_info)\\n ) or self.check_signal(request)\\n\\n def check_signal(self, request: HttpRequest) -> bool:\\n signal_responses = check_request_enabled.send(sender=None, request=request)\\n return any(return_value for function, return_value in signal_responses)\\n\\n def _url_in_whitelist(self, url: ParseResult) -> bool:\\n origins = [urlparse(o) for o in conf.CORS_ALLOWED_ORIGINS]\\n return any(\\n origin.scheme == url.scheme and origin.netloc == url.netloc\\n for origin in origins\\n )\\n\",\n \"path\": \"src/corsheaders/middleware.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/HISTORY.rst b/HISTORY.rst\nindex f29fed35..7dc52420 100644\n--- a/HISTORY.rst\n+++ b/HISTORY.rst\n@@ -2,6 +2,10 @@\n History\n =======\n \n+* Prevent a crash when an invalid ``Origin`` header is sent.\n+\n+ Thanks to minusf for the report in `Issue #701 <https://github.com/adamchainz/django-cors-headers/issues/701>`__.\n+\n 3.10.0 (2021-10-05)\n -------------------\n \ndiff --git a/src/corsheaders/middleware.py b/src/corsheaders/middleware.py\nindex 6cb57512..b9f8dac0 100644\n--- a/src/corsheaders/middleware.py\n+++ b/src/corsheaders/middleware.py\n@@ -131,8 +131,10 @@ def process_response(\n if not origin:\n return response\n \n- # todo: check hostname from db instead\n- url = urlparse(origin)\n+ try:\n+ url = urlparse(origin)\n+ except ValueError:\n+ return response\n \n if conf.CORS_ALLOW_CREDENTIALS:\n response[ACCESS_CONTROL_ALLOW_CREDENTIALS] = \"true\"\ndiff --git a/tests/test_middleware.py b/tests/test_middleware.py\nindex 73b39e1c..1a85afb9 100644\n--- a/tests/test_middleware.py\n+++ b/tests/test_middleware.py\n@@ -32,6 +32,10 @@ def test_get_origin_vary_by_default(self):\n resp = self.client.get(\"/\")\n assert resp[\"Vary\"] == \"Origin\"\n \n+ def test_get_invalid_origin(self):\n+ resp = self.client.get(\"/\", HTTP_ORIGIN=\"http://example.com]\")\n+ assert ACCESS_CONTROL_ALLOW_ORIGIN not in resp\n+\n @override_settings(CORS_ALLOWED_ORIGINS=[\"http://example.com\"])\n def test_get_not_in_allowed_origins(self):\n resp = self.client.get(\"/\", HTTP_ORIGIN=\"http://example.org\")\n"}}},{"rowIdx":4699,"cells":{"in_source_id":{"kind":"string","value":"freedomofpress__securedrop-3709"},"issue":{"kind":"string","value":"[functional testing] Fix staging CI job on tbb-0.9.0\nWe removed the application/functional test run from the staging environment in #3697. We should also update the testinfra test references and remove the application test run from CI, otherwise we get a few testinfra test failures due to pip deps, and an error when we attempt to run the application tests in CI: \r\n\r\n```\r\nTASK [Run application tests] ***************************************************\r\n Friday 10 August 2018 19:28:17 +0000 (0:00:00.037) 0:01:08.223 *********\r\n fatal: [app-staging]: FAILED! => {\"changed\": true, \"msg\": \"non-zero return code\", \"rc\": 127, \"stderr\": \"Shared connection to 52.36.194.59 closed.\\r\\n\", \"stdout\": \"/home/sdrop/.ansible/tmp/ansible-tmp-1533929297.62-93522333058246/app-tests.sh: line 13: pytest: command not found\\r\\n\", \"stdout_lines\": [\"/home/sdrop/.ansible/tmp/ansible-tmp-1533929297.62-93522333058246/app-tests.sh: line 13: pytest: command not found\"]}\r\n ...ignoring\r\n```\n"},"before_files":{"kind":"list like","value":[{"content":"#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n\nimport datetime\nimport os\nimport sys\nimport argparse\nfrom sqlalchemy.exc import IntegrityError\n\nos.environ[\"SECUREDROP_ENV\"] = \"dev\" # noqa\nimport journalist_app\nfrom sdconfig import config\nfrom db import db\nfrom models import Journalist, Source, Submission\n\n\ndef add_test_user(username, password, otp_secret, is_admin=False):\n context = journalist_app.create_app(config).app_context()\n context.push()\n\n try:\n user = Journalist(username=username,\n password=password,\n is_admin=is_admin)\n user.otp_secret = otp_secret\n db.session.add(user)\n db.session.commit()\n print('Test user successfully added: '\n 'username={}, password={}, otp_secret={}, is_admin={}'\n ''.format(username, password, otp_secret, is_admin))\n except IntegrityError:\n print(\"Test user already added\")\n db.session.rollback()\n\n context.pop()\n\n\ndef create_source_and_submissions(num_submissions=2):\n app = journalist_app.create_app(config)\n\n with app.app_context():\n # Store source in database\n codename = app.crypto_util.genrandomid()\n filesystem_id = app.crypto_util.hash_codename(codename)\n journalist_designation = app.crypto_util.display_id()\n source = Source(filesystem_id, journalist_designation)\n source.pending = False\n db.session.add(source)\n db.session.commit()\n\n # Generate submissions directory and generate source key\n os.mkdir(app.storage.path(source.filesystem_id))\n app.crypto_util.genkeypair(source.filesystem_id, codename)\n\n # Generate some test submissions\n for _ in range(num_submissions):\n source.interaction_count += 1\n fpath = app.storage.save_message_submission(\n source.filesystem_id,\n source.interaction_count,\n source.journalist_filename,\n 'test submission!'\n )\n source.last_updated = datetime.datetime.utcnow()\n submission = Submission(source, fpath)\n db.session.add(submission)\n\n db.session.commit()\n print(\"Test source '{}' added with {} submissions\".format(\n journalist_designation, num_submissions)\n )\n\n\nif __name__ == \"__main__\": # pragma: no cover\n # Add two test users\n test_password = \"correct horse battery staple profanity oil chewy\"\n test_otp_secret = \"JHCOGO7VCER3EJ4L\"\n\n parser = argparse.ArgumentParser()\n parser.add_argument(\"--staging\", help=\"Adding user for staging tests.\",\n action=\"store_true\")\n args = parser.parse_args()\n add_test_user(\"journalist\",\n test_password,\n test_otp_secret,\n is_admin=True)\n\n # If staging, we only need the journalist user (admin)\n if args.staging:\n sys.exit(0)\n\n add_test_user(\"dellsberg\",\n test_password,\n test_otp_secret,\n is_admin=False)\n\n # Add test sources and submissions\n num_sources = 2\n for _ in range(num_sources):\n create_source_and_submissions()\n","path":"securedrop/create-dev-data.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/env python\\n# -*- coding: utf-8 -*-\\n\\nimport datetime\\nimport os\\nimport sys\\nimport argparse\\nfrom sqlalchemy.exc import IntegrityError\\n\\nos.environ[\\\"SECUREDROP_ENV\\\"] = \\\"dev\\\" # noqa\\nimport journalist_app\\nfrom sdconfig import config\\nfrom db import db\\nfrom models import Journalist, Source, Submission\\n\\n\\ndef add_test_user(username, password, otp_secret, is_admin=False):\\n context = journalist_app.create_app(config).app_context()\\n context.push()\\n\\n try:\\n user = Journalist(username=username,\\n password=password,\\n is_admin=is_admin)\\n user.otp_secret = otp_secret\\n db.session.add(user)\\n db.session.commit()\\n print('Test user successfully added: '\\n 'username={}, password={}, otp_secret={}, is_admin={}'\\n ''.format(username, password, otp_secret, is_admin))\\n except IntegrityError:\\n print(\\\"Test user already added\\\")\\n db.session.rollback()\\n\\n context.pop()\\n\\n\\ndef create_source_and_submissions(num_submissions=2):\\n app = journalist_app.create_app(config)\\n\\n with app.app_context():\\n # Store source in database\\n codename = app.crypto_util.genrandomid()\\n filesystem_id = app.crypto_util.hash_codename(codename)\\n journalist_designation = app.crypto_util.display_id()\\n source = Source(filesystem_id, journalist_designation)\\n source.pending = False\\n db.session.add(source)\\n db.session.commit()\\n\\n # Generate submissions directory and generate source key\\n os.mkdir(app.storage.path(source.filesystem_id))\\n app.crypto_util.genkeypair(source.filesystem_id, codename)\\n\\n # Generate some test submissions\\n for _ in range(num_submissions):\\n source.interaction_count += 1\\n fpath = app.storage.save_message_submission(\\n source.filesystem_id,\\n source.interaction_count,\\n source.journalist_filename,\\n 'test submission!'\\n )\\n source.last_updated = datetime.datetime.utcnow()\\n submission = Submission(source, fpath)\\n db.session.add(submission)\\n\\n db.session.commit()\\n print(\\\"Test source '{}' added with {} submissions\\\".format(\\n journalist_designation, num_submissions)\\n )\\n\\n\\nif __name__ == \\\"__main__\\\": # pragma: no cover\\n # Add two test users\\n test_password = \\\"correct horse battery staple profanity oil chewy\\\"\\n test_otp_secret = \\\"JHCOGO7VCER3EJ4L\\\"\\n\\n parser = argparse.ArgumentParser()\\n parser.add_argument(\\\"--staging\\\", help=\\\"Adding user for staging tests.\\\",\\n action=\\\"store_true\\\")\\n args = parser.parse_args()\\n add_test_user(\\\"journalist\\\",\\n test_password,\\n test_otp_secret,\\n is_admin=True)\\n\\n # If staging, we only need the journalist user (admin)\\n if args.staging:\\n sys.exit(0)\\n\\n add_test_user(\\\"dellsberg\\\",\\n test_password,\\n test_otp_secret,\\n is_admin=False)\\n\\n # Add test sources and submissions\\n num_sources = 2\\n for _ in range(num_sources):\\n create_source_and_submissions()\\n\",\n \"path\": \"securedrop/create-dev-data.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n\nimport datetime\nimport os\nimport sys\nimport argparse\nfrom sqlalchemy.exc import IntegrityError\n\nos.environ[\"SECUREDROP_ENV\"] = \"dev\" # noqa\nimport journalist_app\nfrom sdconfig import config\nfrom db import db\nfrom models import Journalist, Source, Submission\n\n\ndef add_test_user(username, password, otp_secret, is_admin=False):\n context = journalist_app.create_app(config).app_context()\n context.push()\n\n try:\n user = Journalist(username=username,\n password=password,\n is_admin=is_admin)\n user.otp_secret = otp_secret\n db.session.add(user)\n db.session.commit()\n print('Test user successfully added: '\n 'username={}, password={}, otp_secret={}, is_admin={}'\n ''.format(username, password, otp_secret, is_admin))\n except IntegrityError:\n print(\"Test user already added\")\n db.session.rollback()\n\n context.pop()\n\n\ndef create_source_and_submissions(num_submissions=2):\n app = journalist_app.create_app(config)\n\n with app.app_context():\n # Store source in database\n codename = app.crypto_util.genrandomid()\n filesystem_id = app.crypto_util.hash_codename(codename)\n journalist_designation = app.crypto_util.display_id()\n source = Source(filesystem_id, journalist_designation)\n source.pending = False\n db.session.add(source)\n db.session.commit()\n\n # Generate submissions directory and generate source key\n os.mkdir(app.storage.path(source.filesystem_id))\n app.crypto_util.genkeypair(source.filesystem_id, codename)\n\n # Generate some test submissions\n for _ in range(num_submissions):\n source.interaction_count += 1\n fpath = app.storage.save_message_submission(\n source.filesystem_id,\n source.interaction_count,\n source.journalist_filename,\n 'test submission!'\n )\n source.last_updated = datetime.datetime.utcnow()\n submission = Submission(source, fpath)\n db.session.add(submission)\n\n db.session.commit()\n print(\"Test source '{}' added with {} submissions\".format(\n journalist_designation, num_submissions)\n )\n\n\nif __name__ == \"__main__\": # pragma: no cover\n # Add two test users\n test_password = \"correct horse battery staple profanity oil chewy\"\n test_otp_secret = \"JHCOGO7VCER3EJ4L\"\n\n parser = argparse.ArgumentParser()\n parser.add_argument(\"--staging\", help=\"Adding user for staging tests.\",\n action=\"store_true\")\n args = parser.parse_args()\n add_test_user(\"journalist\",\n test_password,\n test_otp_secret,\n is_admin=True)\n\n # If staging, we only need the journalist user (admin)\n if args.staging:\n sys.exit(0)\n\n add_test_user(\"dellsberg\",\n test_password,\n test_otp_secret,\n is_admin=False)\n\n # Add test sources and submissions\n num_sources = 2\n for _ in range(num_sources):\n create_source_and_submissions()\n","path":"securedrop/create-dev-data.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/env python\\n# -*- coding: utf-8 -*-\\n\\nimport datetime\\nimport os\\nimport sys\\nimport argparse\\nfrom sqlalchemy.exc import IntegrityError\\n\\nos.environ[\\\"SECUREDROP_ENV\\\"] = \\\"dev\\\" # noqa\\nimport journalist_app\\nfrom sdconfig import config\\nfrom db import db\\nfrom models import Journalist, Source, Submission\\n\\n\\ndef add_test_user(username, password, otp_secret, is_admin=False):\\n context = journalist_app.create_app(config).app_context()\\n context.push()\\n\\n try:\\n user = Journalist(username=username,\\n password=password,\\n is_admin=is_admin)\\n user.otp_secret = otp_secret\\n db.session.add(user)\\n db.session.commit()\\n print('Test user successfully added: '\\n 'username={}, password={}, otp_secret={}, is_admin={}'\\n ''.format(username, password, otp_secret, is_admin))\\n except IntegrityError:\\n print(\\\"Test user already added\\\")\\n db.session.rollback()\\n\\n context.pop()\\n\\n\\ndef create_source_and_submissions(num_submissions=2):\\n app = journalist_app.create_app(config)\\n\\n with app.app_context():\\n # Store source in database\\n codename = app.crypto_util.genrandomid()\\n filesystem_id = app.crypto_util.hash_codename(codename)\\n journalist_designation = app.crypto_util.display_id()\\n source = Source(filesystem_id, journalist_designation)\\n source.pending = False\\n db.session.add(source)\\n db.session.commit()\\n\\n # Generate submissions directory and generate source key\\n os.mkdir(app.storage.path(source.filesystem_id))\\n app.crypto_util.genkeypair(source.filesystem_id, codename)\\n\\n # Generate some test submissions\\n for _ in range(num_submissions):\\n source.interaction_count += 1\\n fpath = app.storage.save_message_submission(\\n source.filesystem_id,\\n source.interaction_count,\\n source.journalist_filename,\\n 'test submission!'\\n )\\n source.last_updated = datetime.datetime.utcnow()\\n submission = Submission(source, fpath)\\n db.session.add(submission)\\n\\n db.session.commit()\\n print(\\\"Test source '{}' added with {} submissions\\\".format(\\n journalist_designation, num_submissions)\\n )\\n\\n\\nif __name__ == \\\"__main__\\\": # pragma: no cover\\n # Add two test users\\n test_password = \\\"correct horse battery staple profanity oil chewy\\\"\\n test_otp_secret = \\\"JHCOGO7VCER3EJ4L\\\"\\n\\n parser = argparse.ArgumentParser()\\n parser.add_argument(\\\"--staging\\\", help=\\\"Adding user for staging tests.\\\",\\n action=\\\"store_true\\\")\\n args = parser.parse_args()\\n add_test_user(\\\"journalist\\\",\\n test_password,\\n test_otp_secret,\\n is_admin=True)\\n\\n # If staging, we only need the journalist user (admin)\\n if args.staging:\\n sys.exit(0)\\n\\n add_test_user(\\\"dellsberg\\\",\\n test_password,\\n test_otp_secret,\\n is_admin=False)\\n\\n # Add test sources and submissions\\n num_sources = 2\\n for _ in range(num_sources):\\n create_source_and_submissions()\\n\",\n \"path\": \"securedrop/create-dev-data.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/molecule/aws/scripts/app-tests.sh b/molecule/aws/scripts/app-tests.sh\ndeleted file mode 100644\nindex 292a8b39ee..0000000000\n--- a/molecule/aws/scripts/app-tests.sh\n+++ /dev/null\n@@ -1,13 +0,0 @@\n-#!/bin/bash\n-#\n-#\n-export DISPLAY=:1\n-\n-\n-cd \"$1\" || exit 1\n-\n-# --page-layout are created for selected languages only because they\n-# are time consuming.\n-# * en_US: source strings\n-# * fr_FR: left-to-right translations\n-PAGE_LAYOUT_LOCALES='en_US,ar,fr_FR' pytest --page-layout --junit-xml=/tmp/apptest.xml --junit-prefix=apptest tests/\ndiff --git a/molecule/aws/side_effect.yml b/molecule/aws/side_effect.yml\nindex 5e8c468e2b..7071f1d915 100755\n--- a/molecule/aws/side_effect.yml\n+++ b/molecule/aws/side_effect.yml\n@@ -45,11 +45,6 @@\n gather_facts: false\n tasks:\n \n- - name: Run application tests\n- script: scripts/app-tests.sh \"{{ app_dir[ci_env] }}\"\n- register: app_test_register\n- ignore_errors: true\n-\n # The test results file will be posted as an artifact for the CI run,\n # so developers can download it and inspect it in detail.\n - name: Fetch JUnit test results XML file.\n@@ -74,9 +69,6 @@\n - name: Establish list of raw test results\n set_fact:\n raw_test_results:\n- - type: app\n- file: scripts/app-tests.sh\n- result: \"{{ app_test_register }}\"\n - type: testinfra\n file: scripts/ci-tester.sh\n result: \"{{ testinfra_results }}\"\n@@ -109,7 +101,7 @@\n become: no\n \n - fail:\n- when: app_test_register|failed or testinfra_results|failed\n+ when: testinfra_results|failed\n vars:\n ci_env: \"{{ lookup('env', 'CI_SD_ENV') }}\"\n # We must define this var at the play-level since the group/host vars\ndiff --git a/securedrop/create-dev-data.py b/securedrop/create-dev-data.py\nindex 1826383083..809f4edee7 100755\n--- a/securedrop/create-dev-data.py\n+++ b/securedrop/create-dev-data.py\n@@ -78,7 +78,7 @@ def create_source_and_submissions(num_submissions=2):\n \n parser = argparse.ArgumentParser()\n parser.add_argument(\"--staging\", help=\"Adding user for staging tests.\",\n- action=\"store_true\")\n+ action=\"store_true\")\n args = parser.parse_args()\n add_test_user(\"journalist\",\n test_password,\ndiff --git a/securedrop/tests/pages-layout/functional_test.py b/securedrop/tests/pages-layout/functional_test.py\nindex d3152b53fc..8dfe225506 100644\n--- a/securedrop/tests/pages-layout/functional_test.py\n+++ b/securedrop/tests/pages-layout/functional_test.py\n@@ -44,7 +44,8 @@ def webdriver_fixture(self, request):\n if not os.path.exists(self.log_dir):\n os.makedirs(self.log_dir)\n self.new_profile = webdriver.FirefoxProfile()\n- self.new_profile.set_preference(\"intl.accept_languages\", self.accept_languages)\n+ self.new_profile.set_preference(\"intl.accept_languages\",\n+ self.accept_languages)\n self.override_driver = True\n yield None\n \ndiff --git a/testinfra/vars/app-staging.yml b/testinfra/vars/app-staging.yml\nindex 5a2353091a..6013cdbdf7 100644\n--- a/testinfra/vars/app-staging.yml\n+++ b/testinfra/vars/app-staging.yml\n@@ -27,14 +27,8 @@ mon_ip: 10.0.1.3\n app_ip: 10.0.1.2\n \n pip_deps:\n- - name: 'Flask-Testing'\n- version: '0.7.1'\n- - name: 'mock'\n- version: '2.0.0'\n- - name: 'pytest'\n- version: '3.3.2'\n- - name: 'selenium'\n- version: '2.53.6'\n+ - name: 'Flask'\n+ version: '0.12.2'\n \n apparmor_complain: []\n \n"}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":46,"numItemsPerPage":100,"numTotalItems":69711,"offset":4600,"length":100}},"jwt":"eyJhbGciOiJFZERTQSIsImtpZCI6IjVHZDBvd0g5MTM2eDZjc1FvbE1zcktNWUZoRVFoUm5PVVVybEpjOUhaUEEifQ.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sImlhdCI6MTc4NjIxOTIwMCwianRpIjoiMzdiNzcwNzMtNzMyNi00ZmVlLTk0YzItOTM4ZWRjMWVlNDBlIiwic3ViIjoiL2RhdGFzZXRzL3Jhc2RhbmkvZ2l0aHViLXBhdGNoZXMiLCJleHAiOjE3ODYyMjI4MDAsImlzcyI6Imh0dHBzOi8vaHVnZ2luZ2ZhY2UuY28ifQ.gWqyvwpdt3T_unvQk8gwcWGsypaaIWYv69oVzk-UGNrRRk96XyqhmBehqDzCiCoaF5wDgJn7bCogZsDqfy5xCw","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 ⌀ |
|---|---|---|---|---|
lnbits__lnbits-1278 | [BUG] Topup button visible but request returns 401 unauthorized
**Describe the bug**
The "+" topup button is visible for an admin user (set via LNBITS_ADMIN_USERS env variable) but clicking it (specifying amount + enter) returns 401 unauthorized
**Expected behavior**
I expect the topup button to not even be visibl... | [
{
"content": "import asyncio\nfrom http import HTTPStatus\nfrom typing import Optional\n\nfrom fastapi import Depends, Query, Request, status\nfrom fastapi.exceptions import HTTPException\nfrom fastapi.responses import FileResponse, RedirectResponse\nfrom fastapi.routing import APIRouter\nfrom loguru import log... | [
{
"content": "import asyncio\nfrom http import HTTPStatus\nfrom typing import Optional\n\nfrom fastapi import Depends, Query, Request, status\nfrom fastapi.exceptions import HTTPException\nfrom fastapi.responses import FileResponse, RedirectResponse\nfrom fastapi.routing import APIRouter\nfrom loguru import log... | diff --git a/.env.example b/.env.example
index bb4e64a12f..6a3710c2fc 100644
--- a/.env.example
+++ b/.env.example
@@ -11,7 +11,11 @@ LNBITS_ALLOWED_USERS=""
LNBITS_ADMIN_USERS=""
# Extensions only admin can access
LNBITS_ADMIN_EXTENSIONS="ngrok, admin"
+
# Enable Admin GUI, available for the first user in LNBITS_A... |
spack__spack-18515 | SpecList has instances of mutable types as default __init__ arguments
While debugging #18338 I stepped on this definition:
https://github.com/spack/spack/blob/3701633937a80c56ce212cd77c82c082f705e7ad/lib/spack/spack/spec_list.py#L26-L30
that might cause unwanted interactions between different instances of `SpecLi... | [
{
"content": "# Copyright 2013-2020 Lawrence Livermore National Security, LLC and other\n# Spack Project Developers. See the top-level COPYRIGHT file for details.\n#\n# SPDX-License-Identifier: (Apache-2.0 OR MIT)\nimport itertools\nfrom six import string_types\n\nimport spack.variant\nfrom spack.spec import Sp... | [
{
"content": "# Copyright 2013-2020 Lawrence Livermore National Security, LLC and other\n# Spack Project Developers. See the top-level COPYRIGHT file for details.\n#\n# SPDX-License-Identifier: (Apache-2.0 OR MIT)\nimport itertools\nfrom six import string_types\n\nimport spack.variant\nfrom spack.spec import Sp... | diff --git a/lib/spack/spack/spec_list.py b/lib/spack/spack/spec_list.py
index bc473f530cce11..1aa0ab870e665d 100644
--- a/lib/spack/spack/spec_list.py
+++ b/lib/spack/spack/spec_list.py
@@ -25,7 +25,11 @@ def spec_ordering_key(s):
class SpecList(object):
- def __init__(self, name='specs', yaml_list=[], referen... |
open-telemetry__opentelemetry-python-2414 | Did you mean to use f-string here?
Did you mean to use f-string here?
_Originally posted by @lonewolf3739 in https://github.com/open-telemetry/opentelemetry-python/pull/2405#discussion_r792096137_
| [
{
"content": "# Copyright The OpenTelemetry Authors\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... | [
{
"content": "# Copyright The OpenTelemetry Authors\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... | diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_metrics/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/_metrics/__init__.py
index 705e814d695..4f0d5d141aa 100644
--- a/opentelemetry-sdk/src/opentelemetry/sdk/_metrics/__init__.py
+++ b/opentelemetry-sdk/src/opentelemetry/sdk/_metrics/__init__.py
@@ -205,7 +... |
falconry__falcon-1593 | Official support for CPython 3.8
CPython 3.8.0 was [released Oct 14, 2019](https://www.python.org/downloads/release/python-380/).
Make Falcon offically support CPython 3.8:
- [ ] README
- [ ] Docker images
- [ ] Docs
- [ ] Tox
- [ ] Travis
- [ ] setup.py
| [
{
"content": "import glob\nimport imp\nimport io\nimport os\nfrom os import path\nimport re\nimport sys\n\nfrom setuptools import Extension, find_packages, setup\n\nMYDIR = path.abspath(os.path.dirname(__file__))\n\nVERSION = imp.load_source('version', path.join('.', 'falcon', 'version.py'))\nVERSION = VERSION.... | [
{
"content": "import glob\nimport imp\nimport io\nimport os\nfrom os import path\nimport re\nimport sys\n\nfrom setuptools import Extension, find_packages, setup\n\nMYDIR = path.abspath(os.path.dirname(__file__))\n\nVERSION = imp.load_source('version', path.join('.', 'falcon', 'version.py'))\nVERSION = VERSION.... | diff --git a/.travis.yml b/.travis.yml
index 70e19189e..780d04583 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -33,6 +33,10 @@ matrix:
env: TOXENV=hug
- python: 3.7
env: TOXENV=check_vendored
+ - python: 3.8
+ env: TOXENV=py38
+ - python: 3.8
+ env: TOXENV... |
freqtrade__freqtrade-2197 | Build number in -dev versioning
Since we do not have a build number in the -dev version, it may be quite complex to understand which particular version of freqtrade the user runs (especially with that your conda). So if we change user interface I guess it's better for a while to make those changes along with changing t... | [
{
"content": "\"\"\" FreqTrade bot \"\"\"\n__version__ = '2019.7-dev'\n\n\nclass DependencyException(Exception):\n \"\"\"\n Indicates that an assumed dependency is not met.\n This could happen when there is currently not enough money on the account.\n \"\"\"\n\n\nclass OperationalException(Exception... | [
{
"content": "\"\"\" FreqTrade bot \"\"\"\n__version__ = 'develop'\n\nif __version__ == 'develop':\n\n try:\n import subprocess\n __version__ = 'develop-' + subprocess.check_output(\n ['git', 'log', '--format=\"%h\"', '-n 1'],\n stderr=subprocess.DEVNULL).decode(\"utf-8\")... | diff --git a/freqtrade/__init__.py b/freqtrade/__init__.py
index 5ccc2ff3cf0..83fee0b0d70 100644
--- a/freqtrade/__init__.py
+++ b/freqtrade/__init__.py
@@ -1,5 +1,16 @@
""" FreqTrade bot """
-__version__ = '2019.7-dev'
+__version__ = 'develop'
+
+if __version__ == 'develop':
+
+ try:
+ import subprocess
+ ... |
django-oscar__django-oscar-1866 | ShippingAddressView.get_initial <Country: XXX> is not JSON serializable
If you are to return back to the shipping address after you've reached further into the checkout process and you selected a country from the list, doing a GET request to the address /checkout/shipping-address/ would result in the following error:
... | [
{
"content": "import logging\n\nfrom django import http\nfrom django.contrib import messages\nfrom django.contrib.auth import login\nfrom django.core.urlresolvers import reverse, reverse_lazy\nfrom django.shortcuts import redirect\nfrom django.utils import six\nfrom django.utils.http import urlquote\nfrom djang... | [
{
"content": "import logging\n\nfrom django import http\nfrom django.contrib import messages\nfrom django.contrib.auth import login\nfrom django.core.urlresolvers import reverse, reverse_lazy\nfrom django.shortcuts import redirect\nfrom django.utils import six\nfrom django.utils.http import urlquote\nfrom djang... | diff --git a/src/oscar/apps/checkout/views.py b/src/oscar/apps/checkout/views.py
index b8372f4375a..f464ecf73f8 100644
--- a/src/oscar/apps/checkout/views.py
+++ b/src/oscar/apps/checkout/views.py
@@ -140,6 +140,7 @@ class ShippingAddressView(CheckoutSessionMixin, generic.FormView):
def get_initial(self):
... |
aio-libs__aiohttp-3434 | Design good distribution extras support
Follow-up https://github.com/aio-libs/aiohttp/pull/2312#issuecomment-339335603: this issue is intended to encourage discussion about adding extras support.
There's several optional dependencies mentioned in docs, and they instruct users to do `pip install {{dep_name}}`.
Com... | [
{
"content": "import codecs\nimport pathlib\nimport re\nimport sys\nfrom distutils.command.build_ext import build_ext\nfrom distutils.errors import (CCompilerError, DistutilsExecError,\n DistutilsPlatformError)\n\nfrom setuptools import Extension, setup\n\n\nif sys.version_info < (3... | [
{
"content": "import codecs\nimport pathlib\nimport re\nimport sys\nfrom distutils.command.build_ext import build_ext\nfrom distutils.errors import (CCompilerError, DistutilsExecError,\n DistutilsPlatformError)\n\nfrom setuptools import Extension, setup\n\n\nif sys.version_info < (3... | diff --git a/setup.py b/setup.py
index 19afe83758e..5f477ef0824 100644
--- a/setup.py
+++ b/setup.py
@@ -151,6 +151,13 @@ def read(f):
packages=['aiohttp'],
python_requires='>=3.5.3',
install_requires=install_requires,
+ extras_require={
+ 'speedups': [
+ 'aiodns',
+ 'brot... |
PrefectHQ__prefect-1991 | ifelse checks for True/False rather than truthy/falsy values
## Description
`prefect.tasks.control_flow.conditional.ifelse` should check for truthy/falsy values, but (relying on `switch`) checks for exact equality to `True` or `False`.
## Expected Behavior
[From the docs](https://docs.prefect.io/core/task_library/... | [
{
"content": "from typing import Any, Dict\n\nimport prefect\nfrom prefect import Task\nfrom prefect.engine import signals\n\n__all__ = [\"switch\", \"ifelse\"]\n\n\nclass Merge(Task):\n def __init__(self, **kwargs) -> None:\n if kwargs.setdefault(\"skip_on_upstream_skip\", False):\n raise ... | [
{
"content": "from typing import Any, Dict\n\nimport prefect\nfrom prefect import Task\nfrom prefect.engine import signals\n\n__all__ = [\"switch\", \"ifelse\"]\n\n\nclass Merge(Task):\n def __init__(self, **kwargs) -> None:\n if kwargs.setdefault(\"skip_on_upstream_skip\", False):\n raise ... | diff --git a/CHANGELOG.md b/CHANGELOG.md
index 29fec3ae4069..56a8bed5f289 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -18,7 +18,7 @@ These changes are available in the [master branch](https://github.com/PrefectHQ/
### Fixes
-- None
+- Ensure `ifelse` casts its condition to `bool` prior to evaluation - [#1991](... |
locustio__locust-2451 | 2.18 - fasthttp error for no content response
### Prerequisites
- [X] I am using [the latest version of Locust](https://github.com/locustio/locust/releases/)
- [X] I am reporting a bug, not asking a question
### Description
Sending a request that generates a no content response is throwing a error when using fasthtt... | [
{
"content": "from __future__ import annotations\nimport re\nimport socket\nimport json\nimport json as unshadowed_json # some methods take a named parameter called json\nfrom base64 import b64encode\nfrom contextlib import contextmanager\nfrom json.decoder import JSONDecodeError\nfrom urllib.parse import urlp... | [
{
"content": "from __future__ import annotations\nimport re\nimport socket\nimport json\nimport json as unshadowed_json # some methods take a named parameter called json\nfrom base64 import b64encode\nfrom contextlib import contextmanager\nfrom json.decoder import JSONDecodeError\nfrom urllib.parse import urlp... | diff --git a/locust/contrib/fasthttp.py b/locust/contrib/fasthttp.py
index 9887b06297..4f0720e2a4 100644
--- a/locust/contrib/fasthttp.py
+++ b/locust/contrib/fasthttp.py
@@ -463,7 +463,7 @@ def text(self) -> Optional[str]:
if self.headers is None:
self.encoding = "utf-8"
else... |
encode__starlette-1940 | middleware causes exceptions to not be raised/handled silently
### Discussed in https://github.com/encode/starlette/discussions/1976
<div type='discussions-op-text'>
<sup>Originally posted by **fraser-langton** December 6, 2022</sup>
From [issue in FastAPI](https://github.com/tiangolo/fastapi/issues/5173) - iss... | [
{
"content": "import typing\n\nimport anyio\n\nfrom starlette.requests import Request\nfrom starlette.responses import Response, StreamingResponse\nfrom starlette.types import ASGIApp, Message, Receive, Scope, Send\n\nRequestResponseEndpoint = typing.Callable[[Request], typing.Awaitable[Response]]\nDispatchFunc... | [
{
"content": "import typing\n\nimport anyio\n\nfrom starlette.requests import Request\nfrom starlette.responses import Response, StreamingResponse\nfrom starlette.types import ASGIApp, Message, Receive, Scope, Send\n\nRequestResponseEndpoint = typing.Callable[[Request], typing.Awaitable[Response]]\nDispatchFunc... | diff --git a/starlette/middleware/base.py b/starlette/middleware/base.py
index 586c9870d..8f2f02ea0 100644
--- a/starlette/middleware/base.py
+++ b/starlette/middleware/base.py
@@ -89,8 +89,6 @@ async def body_stream() -> typing.AsyncGenerator[bytes, None]:
body = message.get("body", b"")
... |
zulip__zulip-20905 | docs: Some of the Nginx words are not capitalized.
E.g. https://github.com/zulip/zulip/blob/fd1d4e101b5d6baaa19ae3166e568244c2582f26/docs/production/authentication-methods.md?plain=1#L768
| [
{
"content": "import os\nfrom typing import List, Union\n\nfrom django.conf import settings\nfrom django.conf.urls import include\nfrom django.conf.urls.i18n import i18n_patterns\nfrom django.contrib.auth.views import (\n LoginView,\n PasswordResetCompleteView,\n PasswordResetConfirmView,\n Password... | [
{
"content": "import os\nfrom typing import List, Union\n\nfrom django.conf import settings\nfrom django.conf.urls import include\nfrom django.conf.urls.i18n import i18n_patterns\nfrom django.contrib.auth.views import (\n LoginView,\n PasswordResetCompleteView,\n PasswordResetConfirmView,\n Password... | diff --git a/docs/production/install-existing-server.md b/docs/production/install-existing-server.md
index e46e43e31194f..be587851ef076 100644
--- a/docs/production/install-existing-server.md
+++ b/docs/production/install-existing-server.md
@@ -21,7 +21,7 @@ Linux sysadmin, you will have a much better experience if you... |
scrapy__scrapy-3371 | AttributeError from contract errback
When running a contract with a URL that returns non-200 response, I get the following:
```
2018-08-09 14:40:23 [scrapy.core.scraper] ERROR: Spider error processing <GET https://www.bureauxlocaux.com/annonce/a-louer-bureaux-a-louer-a-nantes--1289-358662> (referer: None)
Traceback ... | [
{
"content": "import sys\nimport re\nfrom functools import wraps\nfrom unittest import TestCase\n\nfrom scrapy.http import Request\nfrom scrapy.utils.spider import iterate_spider_output\nfrom scrapy.utils.python import get_spec\n\n\nclass ContractsManager(object):\n contracts = {}\n\n def __init__(self, c... | [
{
"content": "import sys\nimport re\nfrom functools import wraps\nfrom unittest import TestCase\n\nfrom scrapy.http import Request\nfrom scrapy.utils.spider import iterate_spider_output\nfrom scrapy.utils.python import get_spec\n\n\nclass ContractsManager(object):\n contracts = {}\n\n def __init__(self, c... | diff --git a/scrapy/contracts/__init__.py b/scrapy/contracts/__init__.py
index 5eaee3d11be..8315d21d2ef 100644
--- a/scrapy/contracts/__init__.py
+++ b/scrapy/contracts/__init__.py
@@ -84,7 +84,7 @@ def cb_wrapper(response):
def eb_wrapper(failure):
case = _create_testcase(method, 'errback')
- ... |
keras-team__keras-19484 | keras adamw optimizer failed with callable parameters in TensorFlow2.16
When we were working on upgrading keras 2 to keras 3 in TensorFlow plugin, one of our adamw related unit test failed, which is a sub unit test using callable lambda as learning_rate argument. We also found this ut failed in TensorFlow2.16 official... | [
{
"content": "import re\nimport warnings\n\nimport numpy as np\n\nfrom keras import backend\nfrom keras import initializers\nfrom keras import ops\nfrom keras.optimizers.schedules import learning_rate_schedule\nfrom keras.saving import serialization_lib\nfrom keras.utils import tracking\nfrom keras.utils.naming... | [
{
"content": "import re\nimport warnings\n\nimport numpy as np\n\nfrom keras import backend\nfrom keras import initializers\nfrom keras import ops\nfrom keras.optimizers.schedules import learning_rate_schedule\nfrom keras.saving import serialization_lib\nfrom keras.utils import tracking\nfrom keras.utils.naming... | diff --git a/keras/optimizers/base_optimizer.py b/keras/optimizers/base_optimizer.py
index e18f3c1deb35..8709a95b95fe 100644
--- a/keras/optimizers/base_optimizer.py
+++ b/keras/optimizers/base_optimizer.py
@@ -567,7 +567,7 @@ def _get_current_learning_rate(self):
):
return self._learning_rate(sel... |
oppia__oppia-1465 | In the rich-text editor, auto-prepend "https://" to links which don't specify a protocol
```
Currently the non-interactive link widget will only accept links that begin
with either "http://" or "https://". I propose that whenever a link does not,
e.g. "www.google.com" we automatically prepend "http://www.google.com" ... | [
{
"content": "# coding: utf-8\n#\n# Copyright 2014 The Oppia Authors. All Rights Reserved.\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/licen... | [
{
"content": "# coding: utf-8\n#\n# Copyright 2014 The Oppia Authors. All Rights Reserved.\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/licen... | diff --git a/extensions/objects/templates/SanitizedUrlEditor.js b/extensions/objects/templates/SanitizedUrlEditor.js
index e9b129802aed4..921b86db5ca7b 100644
--- a/extensions/objects/templates/SanitizedUrlEditor.js
+++ b/extensions/objects/templates/SanitizedUrlEditor.js
@@ -16,7 +16,7 @@
oppia.directive('sanitized... |
gratipay__gratipay.com-1934 | Sign up with a Twitter account fails.
```
Internal server error, program!
Traceback (most recent call last):
File "/home/sim6/www.gittip.com/env/local/lib/python2.7/site-packages/algorithm.py", line 288, in run
new_state = function(**deps.as_kwargs)
File "/home/sim6/www.gittip.com/env/local/lib/python2.7/site-p... | [
{
"content": "\"\"\"This subpackage contains functionality for working with accounts elsewhere.\n\"\"\"\nfrom __future__ import print_function, unicode_literals\nfrom collections import OrderedDict\n\nfrom aspen.utils import typecheck\nfrom aspen import json\nfrom psycopg2 import IntegrityError\n\nimport gittip... | [
{
"content": "\"\"\"This subpackage contains functionality for working with accounts elsewhere.\n\"\"\"\nfrom __future__ import print_function, unicode_literals\nfrom collections import OrderedDict\n\nfrom aspen.utils import typecheck\nfrom aspen import json\nfrom psycopg2 import IntegrityError\n\nimport gittip... | diff --git a/gittip/elsewhere/__init__.py b/gittip/elsewhere/__init__.py
index fd4b03ee7f..598c3574cc 100644
--- a/gittip/elsewhere/__init__.py
+++ b/gittip/elsewhere/__init__.py
@@ -77,7 +77,7 @@ def __init__(self, db, user_id, user_info=None, existing_record=None):
Or:
- Takes a user_id and existing... |
cal-itp__benefits-1114 | Investigate console errors from CA State Template
We get a ton of Javascript console errors coming from the CA State Template. Why? Can we avoid and/or fix some of them?
## To Reproduce
Steps to reproduce the behavior:
1. Go to the dev site
2. Open the browser console / dev tools with `F12`
3. Scroll on the ... | [
{
"content": "\"\"\"\nDjango settings for benefits project.\n\"\"\"\nimport os\nimport benefits.logging\n\n\ndef _filter_empty(ls):\n return [s for s in ls if s]\n\n\n# Build paths inside the project like this: os.path.join(BASE_DIR, ...)\nBASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))... | [
{
"content": "\"\"\"\nDjango settings for benefits project.\n\"\"\"\nimport os\nimport benefits.logging\n\n\ndef _filter_empty(ls):\n return [s for s in ls if s]\n\n\n# Build paths inside the project like this: os.path.join(BASE_DIR, ...)\nBASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))... | diff --git a/benefits/core/templates/core/base.html b/benefits/core/templates/core/base.html
index 4c569777ef..06c712d3e1 100644
--- a/benefits/core/templates/core/base.html
+++ b/benefits/core/templates/core/base.html
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fi... |
interlegis__sapl-1997 | Relatório Matéria por Autor: ordem
O relatório Matérias por Autor está desordenado. Penso que deveria ser pelo número da matéria.
https://sapl.agudo.rs.leg.br/sistema/relatorios/materia-por-autor?tipo=1&data_apresentacao_0=01%2F01%2F2018&data_apresentacao_1=&autoria__autor=
| [
{
"content": "import django_filters\nfrom crispy_forms.bootstrap import FieldWithButtons, InlineRadios, StrictButton\nfrom crispy_forms.helper import FormHelper\nfrom crispy_forms.layout import HTML, Button, Div, Field, Fieldset, Layout, Row\nfrom django import forms\nfrom django.conf import settings\nfrom djan... | [
{
"content": "import django_filters\nfrom crispy_forms.bootstrap import FieldWithButtons, InlineRadios, StrictButton\nfrom crispy_forms.helper import FormHelper\nfrom crispy_forms.layout import HTML, Button, Div, Field, Fieldset, Layout, Row\nfrom django import forms\nfrom django.conf import settings\nfrom djan... | diff --git a/sapl/base/forms.py b/sapl/base/forms.py
index 5410ee3fe..f72ab2c8d 100644
--- a/sapl/base/forms.py
+++ b/sapl/base/forms.py
@@ -729,6 +729,11 @@ class RelatorioMateriasPorAutorFilterSet(django_filters.FilterSet):
autoria__autor = django_filters.CharFilter(widget=forms.HiddenInput())
+ @property... |
cookiecutter__cookiecutter-django-1830 | Creating a new project with TravisCI support fails first build.
## What happened?
Creating a new project with travisci enabled will fail on its first run
## What should've happened instead?
It should pass
## Steps to reproduce
1. Create new project using this cookie cutter template.
2. Enable travi... | [
{
"content": "\"\"\"\nNOTE:\n the below code is to be maintained Python 2.x-compatible\n as the whole Cookiecutter Django project initialization\n can potentially be run in Python 2.x environment\n (at least so we presume in `pre_gen_project.py`).\n\nTODO: ? restrict Cookiecutter Django project init... | [
{
"content": "\"\"\"\nNOTE:\n the below code is to be maintained Python 2.x-compatible\n as the whole Cookiecutter Django project initialization\n can potentially be run in Python 2.x environment\n (at least so we presume in `pre_gen_project.py`).\n\nTODO: ? restrict Cookiecutter Django project init... | diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst
index c17c951ef3..d6c0d93639 100644
--- a/CONTRIBUTORS.rst
+++ b/CONTRIBUTORS.rst
@@ -78,6 +78,7 @@ Listed in alphabetical order.
Chris Franklin `@hairychris`_
Chris Pappalardo `@ChrisPappalardo`_
Christopher Clarke `@chrisdev`_
+ Cole M... |
sunpy__sunpy-1142 | EIT fits file do not provide rotation information
map.plot() from an EIT image requires an CROTA2 key which is not provided in EIT fits file
``` python
>>> map.plot()
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/usr/local/lib/python2.7/dist-packages/sunpy/visualization/visualizatio... | [
{
"content": "\"\"\"\nMap is a generic Map class from which all other Map classes inherit from.\n\"\"\"\nfrom __future__ import absolute_import\n\n#pylint: disable=E1101,E1121,W0404,W0613\n__authors__ = [\"Russell Hewett, Stuart Mumford, Keith Hughitt, Steven Christe\"]\n__email__ = \"stuart@mumford.me.uk\"\n\n... | [
{
"content": "\"\"\"\nMap is a generic Map class from which all other Map classes inherit from.\n\"\"\"\nfrom __future__ import absolute_import\n\n#pylint: disable=E1101,E1121,W0404,W0613\n__authors__ = [\"Russell Hewett, Stuart Mumford, Keith Hughitt, Steven Christe\"]\n__email__ = \"stuart@mumford.me.uk\"\n\n... | diff --git a/sunpy/map/mapbase.py b/sunpy/map/mapbase.py
index ec3fdbea7cd..4df84321918 100644
--- a/sunpy/map/mapbase.py
+++ b/sunpy/map/mapbase.py
@@ -396,7 +396,7 @@ def _rotation_matrix_from_crota(self):
conversion.
"""
lam = self.scale['y'] / self.scale['x']
- p = np.deg2rad(self.... |
deepchecks__deepchecks-521 | [BUG] Documentation - Examples - structure and check demonstration examples
**Bug Description**
Two-in-One:
1. Name of sections disappeared from sidebar ("How-to Guides, Check Demonstrations", and soon - "Use Cases").
Please note it should be "How-to Guides" and not "Guides".
See screenshot (pink)
2. Notebooks h... | [
{
"content": "# Configuration file for the Sphinx documentation builder.\n#\n# This file only contains a selection of the most common options. For a full\n# list see the documentation:\n# https://www.sphinx-doc.org/en/master/usage/configuration.html\n\n# -- Path setup -------------------------------------------... | [
{
"content": "# Configuration file for the Sphinx documentation builder.\n#\n# This file only contains a selection of the most common options. For a full\n# list see the documentation:\n# https://www.sphinx-doc.org/en/master/usage/configuration.html\n\n# -- Path setup -------------------------------------------... | diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000000..7f8dff5227
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,141 @@
+ <!--
+ ~ ----------------------------------------------------------------------------
+ ~ Copyright (C) 2021 Deepchecks (https://www.deepchecks.co... |
aws__aws-cli-1769 | JSON Cache for AssumeRoleProvider not truncating files
When we open a file for writing, if we're reusing the same file (same cache key) we don't truncate the file before writing. If the second JSON response is smaller it will result in extra data at the end of the JSON document.
This will trigger a json parsing error... | [
{
"content": "import os\nimport json\nimport logging\n\nfrom botocore.exceptions import ProfileNotFound\n\nLOG = logging.getLogger(__name__)\n\n\ndef register_assume_role_provider(event_handlers):\n event_handlers.register('session-initialized',\n inject_assume_role_provider_cache,... | [
{
"content": "import os\nimport json\nimport logging\n\nfrom botocore.exceptions import ProfileNotFound\n\nLOG = logging.getLogger(__name__)\n\n\ndef register_assume_role_provider(event_handlers):\n event_handlers.register('session-initialized',\n inject_assume_role_provider_cache,... | diff --git a/awscli/customizations/assumerole.py b/awscli/customizations/assumerole.py
index 5f94d2450b99..ee9ce47c1328 100644
--- a/awscli/customizations/assumerole.py
+++ b/awscli/customizations/assumerole.py
@@ -80,6 +80,7 @@ def __setitem__(self, cache_key, value):
os.makedirs(self._working_dir)
... |
learningequality__kolibri-5037 | Facing error while kolibri 0.12.0 deb file installation
### Observed behavior
After running below command it shows error:
**sudo dpkg -i kolibri_0.12.0b4-0ubuntu1_all.deb**
File downloaded from https://github.com/learningequality/kolibri/releases.
![1](https://user-images.githubusercontent.com/12776071/52693166... | [
{
"content": "\"\"\"\nCAUTION! Keep everything here at at minimum. Do not import stuff.\nThis module is imported in setup.py, so you cannot for instance\nimport a dependency.\n\"\"\"\nfrom __future__ import absolute_import\nfrom __future__ import print_function\nfrom __future__ import unicode_literals\n\nfrom .... | [
{
"content": "\"\"\"\nCAUTION! Keep everything here at at minimum. Do not import stuff.\nThis module is imported in setup.py, so you cannot for instance\nimport a dependency.\n\"\"\"\nfrom __future__ import absolute_import\nfrom __future__ import print_function\nfrom __future__ import unicode_literals\n\nfrom .... | diff --git a/kolibri/__init__.py b/kolibri/__init__.py
index 141b1c71220..4213a76cbf4 100755
--- a/kolibri/__init__.py
+++ b/kolibri/__init__.py
@@ -15,7 +15,7 @@
#: This may not be the exact version as it's subject to modification with
#: get_version() - use ``kolibri.__version__`` for the exact version string.
-V... |
pallets__werkzeug-930 | Add an 'extras_require' entry to setup.py for watchdog
The reloader feature has an optional dependency on the watchdog package:
http://werkzeug.pocoo.org/docs/0.11/serving/#reloader
Whilst people can just add 'watchdog' to their requirements files, it's clearer to specifically add an `extras_require` entry for it to s... | [
{
"content": "# -*- coding: utf-8 -*-\n\"\"\"\nWerkzeug\n========\n\nWerkzeug started as simple collection of various utilities for WSGI\napplications and has become one of the most advanced WSGI utility\nmodules. It includes a powerful debugger, full featured request and\nresponse objects, HTTP utilities to h... | [
{
"content": "# -*- coding: utf-8 -*-\n\"\"\"\nWerkzeug\n========\n\nWerkzeug started as simple collection of various utilities for WSGI\napplications and has become one of the most advanced WSGI utility\nmodules. It includes a powerful debugger, full featured request and\nresponse objects, HTTP utilities to h... | diff --git a/docs/serving.rst b/docs/serving.rst
index 744159cda..ca8890ab2 100644
--- a/docs/serving.rst
+++ b/docs/serving.rst
@@ -56,7 +56,8 @@ Since version 0.10, there are two backends the reloader supports: ``stat`` and
- The ``watchdog`` backend uses filesystem events, and is much faster than
``stat``. It ... |
pallets__werkzeug-2236 | `CallbackDict` in datastructures.pyi is not utilizing a bound TypeVar
<!--
This issue tracker is a tool to address bugs in Werkzeug itself. Please
use Pallets Discord or Stack Overflow for questions about your own code.
Replace this comment with a clear outline of what the bug is.
-->
<!--
Describe how to rep... | [
{
"content": "import typing as t\nfrom datetime import datetime\nfrom datetime import timedelta\nfrom datetime import timezone\nfrom http import HTTPStatus\n\nfrom .._internal import _to_str\nfrom ..datastructures import Headers\nfrom ..datastructures import HeaderSet\nfrom ..http import dump_cookie\nfrom ..htt... | [
{
"content": "import typing as t\nfrom datetime import datetime\nfrom datetime import timedelta\nfrom datetime import timezone\nfrom http import HTTPStatus\n\nfrom .._internal import _to_str\nfrom ..datastructures import Headers\nfrom ..datastructures import HeaderSet\nfrom ..http import dump_cookie\nfrom ..htt... | diff --git a/CHANGES.rst b/CHANGES.rst
index d4f44162e..728623a78 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -34,6 +34,8 @@ Unreleased
- Ad-hoc TLS certs are generated with SAN matching CN. :issue:`2158`
- Fix memory usage for locals when using Python 3.6 or pre 0.4.17
greenlet versions. :pr:`2212`
+- F... |
pytorch__ignite-416 | ModelCheckpoint parameter `save_as_state_dict` should default to True
Given that the recommended way to save model checkpoints is to only serialize the `state_dict` rather than the whole object (see https://pytorch.org/docs/stable/notes/serialization.html), shouldn't `save_as_state_dict` in `ModelCheckpoint` default to... | [
{
"content": "import os\nimport tempfile\n\nimport torch\n\n\nclass ModelCheckpoint(object):\n \"\"\" ModelCheckpoint handler can be used to periodically save objects to disk.\n\n This handler expects two arguments:\n\n - an :class:`~ignite.engine.Engine` object\n - a `dict` mapping names (`... | [
{
"content": "import os\nimport tempfile\n\nimport torch\n\n\nclass ModelCheckpoint(object):\n \"\"\" ModelCheckpoint handler can be used to periodically save objects to disk.\n\n This handler expects two arguments:\n\n - an :class:`~ignite.engine.Engine` object\n - a `dict` mapping names (`... | diff --git a/ignite/handlers/checkpoint.py b/ignite/handlers/checkpoint.py
index 00e40d2cf5dc..b3c7ebd57af6 100644
--- a/ignite/handlers/checkpoint.py
+++ b/ignite/handlers/checkpoint.py
@@ -81,7 +81,7 @@ def __init__(self, dirname, filename_prefix,
n_saved=1,
atomic=True, require_em... |
pwndbg__pwndbg-1222 | ipi doesn't work with multiline inputs
TL;DR:
<img width="550" alt="image" src="https://user-images.githubusercontent.com/10009354/193942063-af410d4d-3cdd-4bcb-a102-9bb87d101656.png">
```
pwndbg> ipi
In [1]: from ctypes import *
In [2]: class A(LittleEndianStructure):
...: a = LittleEndianStructure
... | [
{
"content": "\"\"\"\nCommand to start an interactive IPython prompt.\n\"\"\"\nimport sys\nfrom contextlib import contextmanager\n\nimport gdb\n\nimport pwndbg.color.message as M\nimport pwndbg.commands\nimport pwndbg.lib.stdio\n\n\n@contextmanager\ndef switch_to_ipython_env():\n \"\"\"We need to change stdo... | [
{
"content": "\"\"\"\nCommand to start an interactive IPython prompt.\n\"\"\"\nimport sys\nfrom contextlib import contextmanager\n\nimport gdb\n\nimport pwndbg.color.message as M\nimport pwndbg.commands\nimport pwndbg.lib.stdio\n\n\n@contextmanager\ndef switch_to_ipython_env():\n \"\"\"We need to change stdo... | diff --git a/pwndbg/commands/ipython_interactive.py b/pwndbg/commands/ipython_interactive.py
index 92a9c438a83..a5f0b3fb127 100644
--- a/pwndbg/commands/ipython_interactive.py
+++ b/pwndbg/commands/ipython_interactive.py
@@ -43,6 +43,6 @@ def ipi():
code4ipython = """import jedi
import pwn
jedi.Interpreter._... |
python-telegram-bot__python-telegram-bot-1158 | Filters.regex fails on non-text messages
<!--
Thanks for reporting issues of python-telegram-bot!
Use this template to notify us if you found a bug, or if you want to request a new feature.
If you're looking for help with programming your bot using our library, feel free to ask your
questions in out telegram grou... | [
{
"content": "#!/usr/bin/env python\n#\n# A library that provides a Python interface to the Telegram Bot API\n# Copyright (C) 2015-2018\n# Leandro Toledo de Souza <devs@python-telegram-bot.org>\n#\n# This program is free software: you can redistribute it and/or modify\n# it under the terms of the GNU Lesser Pub... | [
{
"content": "#!/usr/bin/env python\n#\n# A library that provides a Python interface to the Telegram Bot API\n# Copyright (C) 2015-2018\n# Leandro Toledo de Souza <devs@python-telegram-bot.org>\n#\n# This program is free software: you can redistribute it and/or modify\n# it under the terms of the GNU Lesser Pub... | diff --git a/telegram/ext/filters.py b/telegram/ext/filters.py
index 4b3ade78d44..782cbd36d21 100644
--- a/telegram/ext/filters.py
+++ b/telegram/ext/filters.py
@@ -198,7 +198,9 @@ def __init__(self, pattern):
# the matched groups and groupdict to the context object.
def filter(self, message):
- ... |
dbt-labs__dbt-core-3286 | Use test materialization when executing ✨generic✨ tests
### Current Behavior
generic (aka schema) tests are currently executed using the python api directly.
https://github.com/fishtown-analytics/dbt/blob/77c10713a325d2bee91d1822951ce5d91ccc3278/core/dbt/task/test.py#L84-L85
### Desired Behavior
Schema tests shou... | [
{
"content": "import os\nfrom collections import defaultdict\nfrom typing import List, Dict, Any, Tuple, cast, Optional\n\nimport networkx as nx # type: ignore\nimport sqlparse\n\nfrom dbt import flags\nfrom dbt.adapters.factory import get_adapter\nfrom dbt.clients import jinja\nfrom dbt.clients.system import ... | [
{
"content": "import os\nfrom collections import defaultdict\nfrom typing import List, Dict, Any, Tuple, cast, Optional\n\nimport networkx as nx # type: ignore\nimport sqlparse\n\nfrom dbt import flags\nfrom dbt.adapters.factory import get_adapter\nfrom dbt.clients import jinja\nfrom dbt.clients.system import ... | diff --git a/CHANGELOG.md b/CHANGELOG.md
index b263b0c2483..70cd8f201b3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -32,6 +32,7 @@
- Add a new materialization for tests, update data tests to use test materialization when executing. ([#3154](https://github.com/fishtown-analytics/dbt/issues/3154), [#3181](https://gi... |
horovod__horovod-959 | Getting error while running Horovod for spark clusters which dosen't have GPU's or NCCL
**Environment:**
1. Framework: (TensorFlow, Keras, PyTorch, MXNet): MKL enabled Tensorflow
2. Framework version: 1.13.1
3. Horovod version: 0.16.1
4. MPI version: 4.0.0
5. CUDA version: NA
6. NCCL version: NA
7. Python versio... | [
{
"content": "# Copyright 2017 onwards, fast.ai, Inc.\n# Modifications copyright (C) 2018 Uber Technologies, 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:... | [
{
"content": "# Copyright 2017 onwards, fast.ai, Inc.\n# Modifications copyright (C) 2018 Uber Technologies, 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:... | diff --git a/docs/spark.md b/docs/spark.md
index e01752a791..2f0e4de20c 100644
--- a/docs/spark.md
+++ b/docs/spark.md
@@ -63,7 +63,7 @@ a submission file.
To run the example, please install the following dependencies:
* `pyspark`
-* `petastorm >= 0.5.1`
+* `petastorm >= 0.7.0`
* `h5py >= 2.9.0`
* `tensorflow-gpu... |
frappe__frappe-15362 | re.error: missing ), unterminated subpattern via remove_db_aggregation (patch)
<!--
Welcome to the Frappe Framework issue tracker! Before creating an issue, please heed the following:
1. This tracker should only be used to report bugs and request features / enhancements to Frappe
- For questions and general su... | [
{
"content": "import re\n\nimport frappe\nfrom frappe.query_builder import DocType\n\n\ndef execute():\n\t\"\"\"Replace temporarily available Database Aggregate APIs on frappe (develop)\n\n\tAPIs changed:\n\t\t* frappe.db.max => frappe.qb.max\n\t\t* frappe.db.min => frappe.qb.min\n\t\t* frappe.db.sum => frappe.... | [
{
"content": "import re\n\nimport frappe\nfrom frappe.query_builder import DocType\n\n\ndef execute():\n\t\"\"\"Replace temporarily available Database Aggregate APIs on frappe (develop)\n\n\tAPIs changed:\n\t\t* frappe.db.max => frappe.qb.max\n\t\t* frappe.db.min => frappe.qb.min\n\t\t* frappe.db.sum => frappe.... | diff --git a/frappe/patches/v14_0/remove_db_aggregation.py b/frappe/patches/v14_0/remove_db_aggregation.py
index 25a170f36297..a8fa5b2ba14b 100644
--- a/frappe/patches/v14_0/remove_db_aggregation.py
+++ b/frappe/patches/v14_0/remove_db_aggregation.py
@@ -27,6 +27,6 @@ def execute():
name, script = server_script["nam... |
mytardis__mytardis-1134 | /search/parameter_field_list/ failures with Unicode first/last names in Users table
This can occur:
```
Internal Server Error: /search/parameter_field_list/
Traceback (most recent call last):
File "/home/mytardis/virtualenvs/mytardis/local/lib/python2.7/site-packages/django/core/handlers/base.py", line 132, in ge... | [
{
"content": "\"\"\"\nviews relevant to search\n\"\"\"\nimport logging\nimport warnings\n\nfrom django.contrib.auth.models import User\nfrom django.http import HttpResponse\nfrom haystack.generic_views import SearchView\n\nfrom tardis.search.forms import GroupedSearchForm\nfrom tardis.search.utils import Search... | [
{
"content": "\"\"\"\nviews relevant to search\n\"\"\"\nimport logging\nimport warnings\n\nfrom django.contrib.auth.models import User\nfrom django.http import HttpResponse\nfrom haystack.generic_views import SearchView\n\nfrom tardis.search.forms import GroupedSearchForm\nfrom tardis.search.utils import Search... | diff --git a/tardis/search/views.py b/tardis/search/views.py
index e4f8991107..aa40164199 100644
--- a/tardis/search/views.py
+++ b/tardis/search/views.py
@@ -276,7 +276,11 @@ def retrieve_field_list(request):
users = User.objects.all()
- usernames = [u.first_name + ' ' + u.last_name + ':username' for u in ... |
mlflow__mlflow-11426 | [DOC-FIX] Add JFrog MLFlow plugin in order to store your artifacts on a preferred JFrog repository
### Willingness to contribute
Yes. I can contribute a documentation fix independently.
### URL(s) with the issue
https://mlflow.org/docs/latest/plugins.html#artifact-repository-plugins
### Description of proposal (wha... | [
{
"content": "from __future__ import annotations\n\nimport re\nimport shutil\nimport subprocess\nfrom pathlib import Path\n\nimport toml\n\nSEPARATOR = \"\"\"\n# Package metadata: can't be updated manually, use dev/pyproject.py\n# -----------------------------------------------------------------\n# Dev tool set... | [
{
"content": "from __future__ import annotations\n\nimport re\nimport shutil\nimport subprocess\nfrom pathlib import Path\n\nimport toml\n\nSEPARATOR = \"\"\"\n# Package metadata: can't be updated manually, use dev/pyproject.py\n# -----------------------------------------------------------------\n# Dev tool set... | diff --git a/dev/pyproject.py b/dev/pyproject.py
index c7d14109975dc..4d8a1d676278e 100644
--- a/dev/pyproject.py
+++ b/dev/pyproject.py
@@ -102,6 +102,7 @@ def build(skinny: bool) -> None:
"sqlserver": ["mlflow-dbstore"],
"aliyun-oss": ["aliyunstoreplugin"],
"xethub":... |
Lightning-AI__pytorch-lightning-3459 | Error in transfer_batch_to_device when None type is in the batch
<!--
### Common bugs:
1. Tensorboard not showing in Jupyter-notebook see [issue 79](https://github.com/PyTorchLightning/pytorch-lightning/issues/79).
2. PyTorch 1.1.0 vs 1.2.0 support [see FAQ](https://github.com/PyTorchLightning/pytorch-lightning... | [
{
"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/pytorch_lightning/utilities/apply_func.py b/pytorch_lightning/utilities/apply_func.py
index 7ef3824b94e57..4f2212ba2b7d7 100644
--- a/pytorch_lightning/utilities/apply_func.py
+++ b/pytorch_lightning/utilities/apply_func.py
@@ -121,4 +121,5 @@ def batch_to(data):
kwargs = dict(non_blocking=True) i... |
certbot__certbot-7519 | scl_source may not exist
As described in the comments following https://community.letsencrypt.org/t/certbot-failing-to-find-python-version-on-centos-6-10/105634/5, it's possible that `scl_source` does not exist on RHEL 6 based systems. To reproduce this in the CentOS 6 Docker image, run:
```
yum install epel-release ... | [
{
"content": "\"\"\"Certbot main entry point.\"\"\"\n# pylint: disable=too-many-lines\nfrom __future__ import print_function\n\nimport functools\nimport logging.handlers\nimport sys\n\nimport configobj\nimport josepy as jose\nimport zope.component\n\nfrom acme import errors as acme_errors\nfrom acme.magic_typin... | [
{
"content": "\"\"\"Certbot main entry point.\"\"\"\n# pylint: disable=too-many-lines\nfrom __future__ import print_function\n\nimport functools\nimport logging.handlers\nimport sys\n\nimport configobj\nimport josepy as jose\nimport zope.component\n\nfrom acme import errors as acme_errors\nfrom acme.magic_typin... | diff --git a/.gitignore b/.gitignore
index 68762da6b5f..6dd422187e3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -26,6 +26,7 @@ tags
\#*#
.idea
.ropeproject
+.vscode
# auth --cert-path --chain-path
/*.pem
diff --git a/.travis.yml b/.travis.yml
index 63129c9b14c..fdb692ac179 100644
--- a/.travis.yml
+++ b/.travis.... |
scikit-hep__pyhf-791 | Schema missing from docs
# Description
Need to use something like [sphinx-jsonschema](https://pypi.org/project/sphinx-jsonschema/) to fix it up.
# Expected Behavior
I was able to navigate to the schemas...
# Actual Behavior
Schemas are gone :o
# Checklist
- [x] Run `git fetch` to get the most up to... | [
{
"content": "# -*- coding: utf-8 -*-\n#\n# pyhf documentation build configuration file, created by\n# sphinx-quickstart on Fri Feb 9 11:58:49 2018.\n#\n# This file is execfile()d with the current directory set to its\n# containing dir.\n#\n# Note that not all possible configuration values are present in this\... | [
{
"content": "# -*- coding: utf-8 -*-\n#\n# pyhf documentation build configuration file, created by\n# sphinx-quickstart on Fri Feb 9 11:58:49 2018.\n#\n# This file is execfile()d with the current directory set to its\n# containing dir.\n#\n# Note that not all possible configuration values are present in this\... | diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index e9a194f0f4..4f59750faa 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -108,6 +108,14 @@ jobs:
python -m doctest README.md
python setup.py build_sphinx
touch docs/_build/html/.nojekyll
+ - name: ... |
pyro-ppl__pyro-1462 | Make dynamic distribution mixin wrappers in torch.py picklable
We load torch distributions and create distribution mixin classes dynamically in `torch.py`. These distribution instances are not picklable however.
```python
>>> pickle.dumps(Pareto(1., 1.))
Traceback (most recent call last):
File "<stdin>", line 1... | [
{
"content": "from __future__ import absolute_import, division, print_function\n\nimport torch\nfrom torch.distributions import constraints\n\nfrom pyro.distributions.torch_distribution import IndependentConstraint, TorchDistributionMixin\n\n\nclass Bernoulli(torch.distributions.Bernoulli, TorchDistributionMixi... | [
{
"content": "from __future__ import absolute_import, division, print_function\n\nimport torch\nfrom torch.distributions import constraints\n\nfrom pyro.distributions.torch_distribution import IndependentConstraint, TorchDistributionMixin\n\n\nclass Bernoulli(torch.distributions.Bernoulli, TorchDistributionMixi... | diff --git a/pyro/distributions/torch.py b/pyro/distributions/torch.py
index ea82e5504b..ccd575b1ae 100644
--- a/pyro/distributions/torch.py
+++ b/pyro/distributions/torch.py
@@ -313,11 +313,8 @@ def expand(self, batch_shape):
try:
_PyroDist = locals()[_name]
except KeyError:
-
- class _PyroDi... |
WeblateOrg__weblate-1243 | Rename html to templates folder, use subfolder
I load Weblate from my virtual. This works great, three suggestions to make it even better:
- Weblate's template folder should be called `templates` so it's automatically picked up by Django (saves me the trouble of having to use the `TEMPLATE_DIRS` variable)
- More blocks... | [
{
"content": "# -*- coding: utf-8 -*-\n#\n# Copyright © 2012 - 2016 Michal Čihař <michal@cihar.com>\n#\n# This file is part of Weblate <https://weblate.org/>\n#\n# This program 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 ... | [
{
"content": "# -*- coding: utf-8 -*-\n#\n# Copyright © 2012 - 2016 Michal Čihař <michal@cihar.com>\n#\n# This file is part of Weblate <https://weblate.org/>\n#\n# This program 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 ... | diff --git a/MANIFEST.in b/MANIFEST.in
index 1b5ab29ea8d2..2efab8624819 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -9,9 +9,9 @@ include manage.py
recursive-include weblate *.py
recursive-include weblate/ttf *
recursive-include weblate/static *
-recursive-include weblate/html *.txt
-recursive-include weblate/html ... |
zestedesavoir__zds-site-5011 | « Vous êtes déjà inscrits » après s'être connecté
Bonjour,
Après m'être inscrit et activé mon compte via le lien reçu par mail, j'ai fermé l'onglet ouvert lors de l'activation, puis sur le premier onglet dans lequel j'ai effectué mon inscription, j'ai cliqué sur le bouton de connexion en haut à droite, et après m'êt... | [
{
"content": "import uuid\nfrom datetime import datetime, timedelta\n\nfrom oauth2_provider.models import AccessToken\n\nfrom django.conf import settings\nfrom django.contrib import messages\nfrom django.contrib.auth import authenticate, login, logout\nfrom django.contrib.auth.decorators import login_required, ... | [
{
"content": "import uuid\nfrom datetime import datetime, timedelta\n\nfrom oauth2_provider.models import AccessToken\n\nfrom django.conf import settings\nfrom django.contrib import messages\nfrom django.contrib.auth import authenticate, login, logout\nfrom django.contrib.auth.decorators import login_required, ... | diff --git a/zds/member/views.py b/zds/member/views.py
index 9c58cf29c7..0ea93a4702 100644
--- a/zds/member/views.py
+++ b/zds/member/views.py
@@ -904,6 +904,8 @@ def remove_hat(request, user_pk, hat_pk):
def login_view(request):
"""Logs user in."""
next_page = request.GET.get('next', '/')
+ if next_page ... |
ephios-dev__ephios-220 | List of own upcoming shifts
As a user, I want to see a list of shifts that I have been confirmed for on the main page.
| [
{
"content": "from django import template\nfrom django.utils.safestring import mark_safe\n\nfrom ephios.event_management.models import AbstractParticipation\n\nregister = template.Library()\n\n\n@register.filter(name=\"shift_status\")\ndef shift_status(shift, user):\n participation = user.as_participant().pa... | [
{
"content": "from django import template\nfrom django.utils.safestring import mark_safe\n\nfrom ephios.event_management.models import AbstractParticipation\n\nregister = template.Library()\n\n\n@register.filter(name=\"shift_status\")\ndef shift_status(shift, user):\n participation = user.as_participant().pa... | diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 9b4caed7c..20f84b706 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,5 +1,5 @@
default_language_version:
- python: python3.8
+ python: python3.9
repos:
- repo: https://github.com/myint/autoflake
rev: v1.4
diff --gi... |
weecology__retriever-706 | Error while installing BBS and BBS50 on python2
```
goelakas@ubuntu:~/dev/retriever$ retriever install --debug csv BBS
=> Installing USGS North American Breeding Bird Survey
Progress: 746 / 746 rows inserted into ./BBS_species.csv:
Progress: 5627 / 5627 rows inserted into ./BBS_routes.csv:
Progress: 116098 / 11609... | [
{
"content": "from __future__ import print_function\nfrom __future__ import division\nfrom future import standard_library\nstandard_library.install_aliases()\nfrom builtins import object\nfrom builtins import range\nfrom builtins import input\nfrom builtins import zip\nfrom builtins import next\nfrom builtins i... | [
{
"content": "from __future__ import print_function\nfrom __future__ import division\nfrom future import standard_library\nstandard_library.install_aliases()\nfrom builtins import object\nfrom builtins import range\nfrom builtins import input\nfrom builtins import zip\nfrom builtins import next\nfrom builtins i... | diff --git a/lib/engine.py b/lib/engine.py
index b8042cb17..9fc375a99 100644
--- a/lib/engine.py
+++ b/lib/engine.py
@@ -16,10 +16,7 @@
import tarfile
import csv
import io
-if sys.version_info[0] >= 3:
- from urllib.request import urlretrieve
-else:
- from urllib import urlretrieve
+from urllib.request import ... |
getpelican__pelican-2306 | folder syslink are ignored inside ```theme/static```
how to reproduce
```
$ cd ~/blog/theme/yourtheme/static
$ mkdir testfolder # folders are copied
$ ln -s ../screenshot.png . # linked files are copied
$ ln -s ../templates . # syslinked folders arent copied. Any folder should do for testing purposes
$ cd ~/bl... | [
{
"content": "# -*- coding: utf-8 -*-\nfrom __future__ import print_function, unicode_literals\n\nimport codecs\nimport datetime\nimport errno\nimport fnmatch\nimport locale\nimport logging\nimport os\nimport re\nimport shutil\nimport sys\nimport traceback\nfrom collections import Hashable\nfrom contextlib impo... | [
{
"content": "# -*- coding: utf-8 -*-\nfrom __future__ import print_function, unicode_literals\n\nimport codecs\nimport datetime\nimport errno\nimport fnmatch\nimport locale\nimport logging\nimport os\nimport re\nimport shutil\nimport sys\nimport traceback\nfrom collections import Hashable\nfrom contextlib impo... | diff --git a/pelican/utils.py b/pelican/utils.py
index ef9da23b3..c1c41253b 100644
--- a/pelican/utils.py
+++ b/pelican/utils.py
@@ -360,7 +360,7 @@ def walk_error(err):
source_, destination_)
return
- for src_dir, subdirs, others in os.walk(source_):
+ for src_d... |
elastic__ecs-1483 | Remove `ignore_above` setting when not indexing field
Certain ECS fields are type `keyword` but are also not:
* searchable (`index: false`)
* used in aggregations, sorting, or scripting (`doc_values: false`)
The ECS tooling's behavior is to set `ignore_above: 1024` for all `keyword` fields.
However, `ignore_a... | [
{
"content": "import copy\n\nfrom generators import ecs_helpers\nfrom schema import visitor\n\n# This script performs a few cleanup functions in place, within the deeply nested\n# 'fields' structure passed to `clean(fields)`.\n#\n# What happens here:\n#\n# - check that mandatory attributes are present, without ... | [
{
"content": "import copy\n\nfrom generators import ecs_helpers\nfrom schema import visitor\n\n# This script performs a few cleanup functions in place, within the deeply nested\n# 'fields' structure passed to `clean(fields)`.\n#\n# What happens here:\n#\n# - check that mandatory attributes are present, without ... | diff --git a/CHANGELOG.next.md b/CHANGELOG.next.md
index 296df595cc..061a2f7c2e 100644
--- a/CHANGELOG.next.md
+++ b/CHANGELOG.next.md
@@ -45,6 +45,8 @@ Thanks, you're awesome :-) -->
#### Bugfixes
+* Remove `ignore_above` when `index: false` and `doc_values: false`. #1483
+
#### Added
* Support `match_only_te... |
mozilla__bugbug-2654 | Replace typing.Dict with dict
It is now possible to use `dict` directly instead of `typing.Dict` in type definitions.
| [
{
"content": "# -*- coding: utf-8 -*-\n# This Source Code Form is subject to the terms of the Mozilla Public\n# License, v. 2.0. If a copy of the MPL was not distributed with this file,\n# You can obtain one at http://mozilla.org/MPL/2.0/.\n\nimport os\n\nfrom setuptools import find_packages, setup\n\nhere = os... | [
{
"content": "# -*- coding: utf-8 -*-\n# This Source Code Form is subject to the terms of the Mozilla Public\n# License, v. 2.0. If a copy of the MPL was not distributed with this file,\n# You can obtain one at http://mozilla.org/MPL/2.0/.\n\nimport os\n\nfrom setuptools import find_packages, setup\n\nhere = os... | diff --git a/README.md b/README.md
index ae98acfe23..1f09ec3713 100644
--- a/README.md
+++ b/README.md
@@ -65,7 +65,7 @@ pip3 install -r requirements.txt
You may also need `pip install -r test-requirements.txt`. Depending on the parts of bugbug you want to run, you might need to install dependencies from other requi... |
napari__napari-4889 | specific values for scale parameter can break dims
## 🐛 Bug
haven't dug deeper yet, but reposting here from
https://forum.image.sc/t/image-layer-in-napari-showing-the-wrong-dimension-size-one-plane-is-missing/69939/10
```python
d = np.random.rand(5, 170, 240)
viewer = napari.view_image(d, scale=[3.533, 1.0, 1... | [
{
"content": "from numbers import Integral\nfrom typing import Sequence, Tuple, Union\n\nimport numpy as np\nfrom pydantic import root_validator, validator\nfrom typing_extensions import Literal # Added to typing in 3.8\n\nfrom ..utils.events import EventedModel\nfrom ..utils.translations import trans\n\n\ncla... | [
{
"content": "from numbers import Integral\nfrom typing import Sequence, Tuple, Union\n\nimport numpy as np\nfrom pydantic import root_validator, validator\nfrom typing_extensions import Literal # Added to typing in 3.8\n\nfrom ..utils.events import EventedModel\nfrom ..utils.translations import trans\n\n\ncla... | diff --git a/napari/components/_tests/test_dims.py b/napari/components/_tests/test_dims.py
index 8d2edda72b7..44b7dc4d0f0 100644
--- a/napari/components/_tests/test_dims.py
+++ b/napari/components/_tests/test_dims.py
@@ -294,3 +294,10 @@ def test_changing_focus():
assert dims.last_used == 0
dims._focus_down()... |
OpenNMT__OpenNMT-tf-569 | Error while running the exported model
Hi,
I was trying to run the example given [https://github.com/OpenNMT/OpenNMT-tf/tree/master/examples/serving/python](url).
I am getting the following error.
> Source: I am going.
Traceback (most recent call last):
File "ende_client.py", line 66, in <module>
mai... | [
{
"content": "import argparse\nimport os\n\nimport tensorflow as tf\nimport tensorflow_addons as tfa # Register TensorFlow Addons kernels.\n\nimport pyonmttok\n\n\nclass EnDeTranslator(object):\n\n def __init__(self, export_dir):\n imported = tf.saved_model.load(export_dir)\n self._translate_fn = import... | [
{
"content": "import argparse\nimport os\n\nimport tensorflow as tf\nimport tensorflow_addons as tfa # Register TensorFlow Addons kernels.\n\nimport pyonmttok\n\n\nclass EnDeTranslator(object):\n\n def __init__(self, export_dir):\n imported = tf.saved_model.load(export_dir)\n self._translate_fn = import... | diff --git a/examples/serving/python/ende_client.py b/examples/serving/python/ende_client.py
index 7045afdaf..d573b6561 100644
--- a/examples/serving/python/ende_client.py
+++ b/examples/serving/python/ende_client.py
@@ -43,7 +43,7 @@ def _preprocess(self, texts):
def _postprocess(self, outputs):
texts = []
... |
jazzband__django-debug-toolbar-1651 | Refused to get unsafe header "djdt-store-id"
We're getting instances of this error in the javascript console while using the toolbar in local development.
This stems from a CORS issue where only certain headers are only allowed to be accessed unless whitelisted. In 997387228ecb4e0787568047237ca0455dfa9ec6 this code... | [
{
"content": "import json\n\nfrom django.http.request import RawPostDataException\nfrom django.template.loader import render_to_string\nfrom django.templatetags.static import static\nfrom django.urls import path\nfrom django.utils import timezone\nfrom django.utils.translation import gettext_lazy as _\n\nfrom d... | [
{
"content": "import json\n\nfrom django.http.request import RawPostDataException\nfrom django.template.loader import render_to_string\nfrom django.templatetags.static import static\nfrom django.urls import path\nfrom django.utils import timezone\nfrom django.utils.translation import gettext_lazy as _\n\nfrom d... | diff --git a/debug_toolbar/panels/history/panel.py b/debug_toolbar/panels/history/panel.py
index 596bcfb4a..2e637083a 100644
--- a/debug_toolbar/panels/history/panel.py
+++ b/debug_toolbar/panels/history/panel.py
@@ -24,7 +24,7 @@ def get_headers(self, request):
observe_request = self.toolbar.get_observe_reque... |
python__mypy-15218 | Daemon `dmypy` crashes with `disable_error_code` configuration option
## Description
Evertything was working until i tried to disable some error codes using the `disable_error_code = 'no-untyped-def,empty-body'` option in the `pyproject.toml` file.
After restarting the daemon, it crashed with the error `Timed out... | [
{
"content": "\"\"\"Classification of possible errors mypy can detect.\n\nThese can be used for filtering specific errors.\n\"\"\"\n\nfrom __future__ import annotations\n\nfrom collections import defaultdict\nfrom typing_extensions import Final\n\nerror_codes: dict[str, ErrorCode] = {}\nsub_code_map: dict[str, ... | [
{
"content": "\"\"\"Classification of possible errors mypy can detect.\n\nThese can be used for filtering specific errors.\n\"\"\"\n\nfrom __future__ import annotations\n\nfrom collections import defaultdict\nfrom typing_extensions import Final\n\nfrom mypy_extensions import mypyc_attr\n\nerror_codes: dict[str,... | diff --git a/mypy/errorcodes.py b/mypy/errorcodes.py
index 6b63bad72683..fe460fdec744 100644
--- a/mypy/errorcodes.py
+++ b/mypy/errorcodes.py
@@ -8,10 +8,13 @@
from collections import defaultdict
from typing_extensions import Final
+from mypy_extensions import mypyc_attr
+
error_codes: dict[str, ErrorCode] = {}
... |
arviz-devs__arviz-1695 | Non np.array coords cause hard to diagnose shape error
**Describe the bug**
When one of the `coords` has a `tuple` as its values, the conversion to an xarray variable fails.
**To Reproduce**
A simple PyMC3 model that someone might write:
```python
coords = {
"d1": ("A", "B", "C")
}
with pymc3.Model(coords... | [
{
"content": "\"\"\"Low level converters usually used by other functions.\"\"\"\nimport datetime\nimport functools\nimport warnings\nfrom copy import deepcopy\nfrom typing import Any, Callable, Dict, List, Optional, Tuple, TypeVar, Union\n\nimport numpy as np\nimport pkg_resources\nimport xarray as xr\n\ntry:\n... | [
{
"content": "\"\"\"Low level converters usually used by other functions.\"\"\"\nimport datetime\nimport functools\nimport warnings\nfrom copy import deepcopy\nfrom typing import Any, Callable, Dict, List, Optional, Tuple, TypeVar, Union\n\nimport numpy as np\nimport pkg_resources\nimport xarray as xr\n\ntry:\n... | diff --git a/arviz/data/base.py b/arviz/data/base.py
index b679fea118..5d6638084f 100644
--- a/arviz/data/base.py
+++ b/arviz/data/base.py
@@ -245,7 +245,7 @@ def numpy_to_data_array(
coords["draw"] = np.arange(index_origin, n_samples + index_origin)
# filter coords based on the dims
- coords = {key:... |
ansible__ansible-modules-core-5476 | yum module doesn't validate that RPM could be downloaded before reading
##### ISSUE TYPE
Bug Report
##### COMPONENT NAME
`yum`
##### ANSIBLE VERSION
<!--- Paste verbatim output from “ansible --version” between quotes below -->
```
ansible 2.3.0 (type-filter a6feeee50f) last updated 2016/10/28 15:41:12 (GMT... | [
{
"content": "#!/usr/bin/python -tt\n# -*- coding: utf-8 -*-\n\n# (c) 2012, Red Hat, Inc\n# Written by Seth Vidal <skvidal at fedoraproject.org>\n# (c) 2014, Epic Games, Inc.\n#\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... | [
{
"content": "#!/usr/bin/python -tt\n# -*- coding: utf-8 -*-\n\n# (c) 2012, Red Hat, Inc\n# Written by Seth Vidal <skvidal at fedoraproject.org>\n# (c) 2014, Epic Games, Inc.\n#\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... | diff --git a/packaging/os/yum.py b/packaging/os/yum.py
index 131144d8535..be5e1676999 100644
--- a/packaging/os/yum.py
+++ b/packaging/os/yum.py
@@ -225,6 +225,8 @@ def fetch_rpm_from_url(spec, module=None):
package = os.path.join(tempdir, str(spec.rsplit('/', 1)[1]))
try:
rsp, info = fetch_url(modul... |
jupyter__docker-stacks-1412 | We fail to push our multi-arch images
We successfully login with `docker login`, but we fail to push images. I'm unsure why, we only get 401 Unauthorized and that's it.
### From [CI run that failed](https://github.com/jupyter/docker-stacks/runs/3090573663?check_suite_focus=true)
```
#36 exporting to image
#... | [
{
"content": "#!/usr/bin/env python3\n# Copyright (c) Jupyter Development Team.\n# Distributed under the terms of the Modified BSD License.\nimport argparse\nimport logging\nfrom plumbum.cmd import docker\nfrom .docker_runner import DockerRunner\nfrom .get_taggers_and_manifests import get_taggers_and_manifests\... | [
{
"content": "#!/usr/bin/env python3\n# Copyright (c) Jupyter Development Team.\n# Distributed under the terms of the Modified BSD License.\nimport argparse\nimport logging\nfrom plumbum.cmd import docker\nfrom .docker_runner import DockerRunner\nfrom .get_taggers_and_manifests import get_taggers_and_manifests\... | diff --git a/tagging/tag_image.py b/tagging/tag_image.py
index ae795e7d01..105da483cb 100755
--- a/tagging/tag_image.py
+++ b/tagging/tag_image.py
@@ -38,7 +38,9 @@ def tag_image(short_image_name: str, owner: str) -> None:
if tags:
env_name = f'{short_image_name.replace("-", "_")}_EXTRA_TAG_ARGS... |
MycroftAI__mycroft-core-2528 | mycroft "devices" web UI doesn't show core version
Version/setup same as MycroftAI/mycroft-core#2523 2523
## Try to provide steps that we can use to replicate the Issue
Hit up https://account.mycroft.ai/devices
![Selection_039](https://user-images.githubusercontent.com/6778269/78091868-20c38b80-739c-11ea-8934-... | [
{
"content": "# Copyright 2017 Mycroft AI 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 appli... | [
{
"content": "# Copyright 2017 Mycroft AI 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 appli... | diff --git a/mycroft/version/__init__.py b/mycroft/version/__init__.py
index c76f61f950e1..9d4a0b4d1ce0 100644
--- a/mycroft/version/__init__.py
+++ b/mycroft/version/__init__.py
@@ -45,7 +45,7 @@ def get():
return json.load(f)
except Exception:
LOG.error("Failed to lo... |
saulpw__visidata-2020 | `v` for expanding lines doesn't work
**Small description**
When I press `V` to see lines expanded the latest vd from `develop` version gives me an error.
Stable version behaves properly.
**Expected result**
**Actual result with screenshot**
If you get an unexpected error, please include the full stack trac... | [
{
"content": "import collections\nimport itertools\nfrom copy import copy, deepcopy\nimport textwrap\n\nfrom visidata import VisiData, Extensible, globalCommand, ColumnAttr, ColumnItem, vd, ENTER, EscapeException, drawcache, drawcache_property, LazyChainMap, asyncthread, ExpectedException\nfrom visidata import ... | [
{
"content": "import collections\nimport itertools\nfrom copy import copy, deepcopy\nimport textwrap\n\nfrom visidata import VisiData, Extensible, globalCommand, ColumnAttr, ColumnItem, vd, ENTER, EscapeException, drawcache, drawcache_property, LazyChainMap, asyncthread, ExpectedException\nfrom visidata import ... | diff --git a/visidata/sheets.py b/visidata/sheets.py
index 2654b6004..c17261a44 100644
--- a/visidata/sheets.py
+++ b/visidata/sheets.py
@@ -23,8 +23,10 @@ def _splitcell(sheet, s, width=0):
return [s]
ret = []
- for L in s.splitlines():
- ret.extend(textwrap.wrap(L, width=width, break_long_wo... |
liberapay__liberapay.com-1314 | Bug during payment modification
I try to donate to this account: https://liberapay.com/lowtechlab/ after a previous promise on the twitter account.
lowtechlab created its account on the plateform but if I see that I donate to it, the actual number of mecene is still 0.
I tried to change the amount since I know th... | [
{
"content": "from __future__ import absolute_import, division, print_function, unicode_literals\n\nfrom collections import defaultdict, OrderedDict\nfrom decimal import Decimal, ROUND_DOWN, ROUND_HALF_UP, ROUND_UP\nfrom numbers import Number\nimport operator\n\nfrom mangopay.exceptions import CurrencyMismatch\... | [
{
"content": "from __future__ import absolute_import, division, print_function, unicode_literals\n\nfrom collections import defaultdict, OrderedDict\nfrom decimal import Decimal, ROUND_DOWN, ROUND_HALF_UP, ROUND_UP\nfrom numbers import Number\nimport operator\n\nfrom mangopay.exceptions import CurrencyMismatch\... | diff --git a/liberapay/utils/currencies.py b/liberapay/utils/currencies.py
index 62614bd8c9..f243e7d7b3 100644
--- a/liberapay/utils/currencies.py
+++ b/liberapay/utils/currencies.py
@@ -51,7 +51,7 @@ def _Money_init(self, amount=Decimal('0'), currency=None, rounding=None):
def _Money_eq(self, other):
if isinst... |
sopel-irc__sopel-948 | .ip socket.gaierror on Sopel 6.1.1 on python 3.5.0
OS X 11.10
``` python
WARNING:sopel.modules.ip:Downloading GeoIP database
Traceback (most recent call last):
File "/Users/thill/projects/python/orcabot/venv_orcabot/lib/python3.5/site-packages/sopel/bot.py", line 260, in call
exit_code = func(sopel, trigger)
F... | [
{
"content": "# coding=utf-8\n\"\"\"GeoIP lookup module\"\"\"\n# Copyright 2011, Dimitri Molenaars, TyRope.nl,\n# Copyright © 2013, Elad Alfassa <elad@fedoraproject.org>\n# Licensed under the Eiffel Forum License 2.\n\nfrom __future__ import unicode_literals, absolute_import, print_function, division\n\nimport ... | [
{
"content": "# coding=utf-8\n\"\"\"GeoIP lookup module\"\"\"\n# Copyright 2011, Dimitri Molenaars, TyRope.nl,\n# Copyright © 2013, Elad Alfassa <elad@fedoraproject.org>\n# Licensed under the Eiffel Forum License 2.\n\nfrom __future__ import unicode_literals, absolute_import, print_function, division\n\nimport ... | diff --git a/sopel/modules/ip.py b/sopel/modules/ip.py
index 75d6a85f2c..b2e28047f4 100644
--- a/sopel/modules/ip.py
+++ b/sopel/modules/ip.py
@@ -118,6 +118,8 @@ def ip(bot, trigger):
response += " | Location: %s" % gi_city.country_name_by_name(query)
except AttributeError:
response += ' | Locat... |
pystiche__pystiche-544 | Documentation theme
We are currently using the [ReadTheDocs `sphinx` theme](https://github.com/readthedocs/sphinx_rtd_theme):
https://github.com/pystiche/pystiche/blob/65f4d787e44b1ffbf7e5b6e48298ed8c7460e5a9/docs/source/conf.py#L85-L90
A lot of other projects in the PyData ecosystem have migrated to one common [... | [
{
"content": "import contextlib\nimport os\nimport re\nimport shutil\nimport warnings\nfrom datetime import datetime\nfrom distutils.util import strtobool\nfrom importlib_metadata import metadata as extract_metadata\nfrom os import path\nfrom unittest import mock\nfrom urllib.parse import urljoin\n\nfrom sphinx... | [
{
"content": "import contextlib\nimport os\nimport re\nimport shutil\nimport warnings\nfrom datetime import datetime\nfrom distutils.util import strtobool\nfrom importlib_metadata import metadata as extract_metadata\nfrom os import path\nfrom unittest import mock\nfrom urllib.parse import urljoin\n\nfrom sphinx... | diff --git a/docs/requirements-rtd.txt b/docs/requirements-rtd.txt
index d74a063e..864c552b 100644
--- a/docs/requirements-rtd.txt
+++ b/docs/requirements-rtd.txt
@@ -2,9 +2,9 @@ sphinx >= 3
importlib-metadata
sphinxcontrib-bibtex
sphinx_autodoc_typehints >= 1.11
-sphinx_rtd_theme
+pydata_sphinx_theme
sphinx-galler... |
pypa__pipenv-5299 | `pipenv lock` nondeterminism with environment markers (again)
I reported this bug about pipenv behaving non-deterministically a while ago: https://github.com/pypa/pipenv/issues/4967. [@matteius](https://github.com/pypa/pipenv/issues/4967#issuecomment-1104663451) and [I](https://github.com/pypa/pipenv/issues/4967#issuec... | [
{
"content": "import contextlib\nimport hashlib\nimport os\nimport subprocess\nimport sys\nimport warnings\nfrom functools import lru_cache\nfrom typing import Dict, List, Optional, Tuple, Union\n\nfrom pipenv import environments\nfrom pipenv.exceptions import RequirementError, ResolutionFailure\nfrom pipenv.pa... | [
{
"content": "import contextlib\nimport hashlib\nimport os\nimport subprocess\nimport sys\nimport warnings\nfrom functools import lru_cache\nfrom typing import Dict, List, Optional, Set, Tuple, Union\n\nfrom pipenv import environments\nfrom pipenv.exceptions import RequirementError, ResolutionFailure\nfrom pipe... | diff --git a/news/5299.bugfix.rst b/news/5299.bugfix.rst
new file mode 100644
index 0000000000..3e72429964
--- /dev/null
+++ b/news/5299.bugfix.rst
@@ -0,0 +1 @@
+Sorting ``constraints`` before resolving, which fixes ``pipenv lock`` generates nondeterminism environment markers.
diff --git a/pipenv/utils/resolver.py b/p... |
pyqtgraph__pyqtgraph-1487 | AttributeError: 'InfLineLabel' object has no attribute 'updateText'
When I'm setting the `InfLineLabel` visibility, an attribute error was raised.
It is the function of `InFlineLabel` `setVisible` Line 404, I solved this by comment
```
self.updateText()
self.updatePosition()
```
and use the already exist functi... | [
{
"content": "# -*- coding: utf-8 -*-\nfrom ..Qt import QtGui, QtCore\nfrom ..Point import Point\nfrom .GraphicsObject import GraphicsObject\nfrom .GraphicsItem import GraphicsItem\nfrom .TextItem import TextItem\nfrom .ViewBox import ViewBox\nfrom .. import functions as fn\nimport numpy as np\nimport weakref\n... | [
{
"content": "# -*- coding: utf-8 -*-\nfrom ..Qt import QtGui, QtCore\nfrom ..Point import Point\nfrom .GraphicsObject import GraphicsObject\nfrom .GraphicsItem import GraphicsItem\nfrom .TextItem import TextItem\nfrom .ViewBox import ViewBox\nfrom .. import functions as fn\nimport numpy as np\nimport weakref\n... | diff --git a/pyqtgraph/graphicsItems/InfiniteLine.py b/pyqtgraph/graphicsItems/InfiniteLine.py
index c5726031ca..b998e97e11 100644
--- a/pyqtgraph/graphicsItems/InfiniteLine.py
+++ b/pyqtgraph/graphicsItems/InfiniteLine.py
@@ -550,8 +550,7 @@ def updatePosition(self):
def setVisible(self, v):
TextItem.set... |
boto__boto-1895 | set_desired_capacity doesn't work if honor_cooldown parameter set to True.
Hi,
Function set_desired_capacity throws NameError exception if honor_cooldown is True:
> Traceback (most recent call last):
> File "./ag-desired-capacity.py", line 131, in <module>
> honor_cooldown = True)
> File "/usr/lib/python2.6/si... | [
{
"content": "# Copyright (c) 2009-2011 Reza Lotun http://reza.lotun.name/\n# Copyright (c) 2011 Jann Kleen\n# Copyright (c) 2012 Mitch Garnaat http://garnaat.org/\n# Copyright (c) 2012 Amazon.com, Inc. or its affiliates. All Rights Reserved\n#\n# Permission is hereby granted, free of charge, to any person obt... | [
{
"content": "# Copyright (c) 2009-2011 Reza Lotun http://reza.lotun.name/\n# Copyright (c) 2011 Jann Kleen\n# Copyright (c) 2012 Mitch Garnaat http://garnaat.org/\n# Copyright (c) 2012 Amazon.com, Inc. or its affiliates. All Rights Reserved\n#\n# Permission is hereby granted, free of charge, to any person obt... | diff --git a/boto/ec2/autoscale/__init__.py b/boto/ec2/autoscale/__init__.py
index 2a54adf15d..864b5dde04 100644
--- a/boto/ec2/autoscale/__init__.py
+++ b/boto/ec2/autoscale/__init__.py
@@ -785,7 +785,7 @@ def set_desired_capacity(self, group_name, desired_capacity, honor_cooldown=Fals
params = {'AutoScalingG... |
open-telemetry__opentelemetry-python-contrib-1313 | is_instrumented_by_opentelemetry is not set in _InstrumentedFastAPI class
**Steps to reproduce**
If `instrument_app` function is called for already instrumented object of `_InstrumentedFastAPI` then it will add Opentelemtery middleware again in the `user_middleware` list as `is_instrumented_by_opentelemetry` is not se... | [
{
"content": "# Copyright The OpenTelemetry Authors\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... | [
{
"content": "# Copyright The OpenTelemetry Authors\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... | diff --git a/CHANGELOG.md b/CHANGELOG.md
index 595da827bd..10d6d27c21 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -21,6 +21,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
([#1208](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1208))
- `opentelemetry-i... |
zulip__zulip-12231 | Open Graph og:url tags over-canonicalize all URLs back to the home page
Split from #12187:
> By the way, it turns out all our OpenGraph tags are [busted anyway](https://developers.facebook.com/tools/debug/sharing/?q=https%3A%2F%2Fchat.zulip.org%2Fapi%2Fincoming-webhooks-walkthrough) because we always set `og:url` to... | [
{
"content": "\nfrom typing import Any, Dict\nfrom django.http import HttpRequest\nfrom django.conf import settings\nfrom django.urls import reverse\n\nfrom zerver.models import UserProfile, get_realm, Realm\nfrom zproject.backends import (\n any_oauth_backend_enabled,\n password_auth_enabled,\n requir... | [
{
"content": "\nfrom typing import Any, Dict\nfrom django.http import HttpRequest\nfrom django.conf import settings\nfrom django.urls import reverse\n\nfrom zerver.models import UserProfile, get_realm, Realm\nfrom zproject.backends import (\n any_oauth_backend_enabled,\n password_auth_enabled,\n requir... | diff --git a/templates/zerver/meta_tags.html b/templates/zerver/meta_tags.html
index 5432e7e3fd639..0ccb1f8276d8f 100644
--- a/templates/zerver/meta_tags.html
+++ b/templates/zerver/meta_tags.html
@@ -6,7 +6,7 @@
{% endif %}
<!-- Open Graph / Facebook Meta Tags -->
-<meta property="og:url" content="{{ realm_uri }}"... |
ytdl-org__youtube-dl-18281 | Problem with joj.sk
## Please follow the guide below
- You will be asked some questions and requested to provide some information, please read them **carefully** and answer honestly
- Put an `x` into all the boxes [ ] relevant to your *issue* (like this: `[x]`)
- Use the *Preview* tab to see what your issue will a... | [
{
"content": "# coding: utf-8\r\nfrom __future__ import unicode_literals\r\n\r\nimport re\r\n\r\nfrom .common import InfoExtractor\r\nfrom ..compat import compat_str\r\nfrom ..utils import (\r\n int_or_none,\r\n js_to_json,\r\n try_get,\r\n)\r\n\r\n\r\nclass JojIE(InfoExtractor):\r\n _VALID_URL = r'... | [
{
"content": "# coding: utf-8\r\nfrom __future__ import unicode_literals\r\n\r\nimport re\r\n\r\nfrom .common import InfoExtractor\r\nfrom ..compat import compat_str\r\nfrom ..utils import (\r\n int_or_none,\r\n js_to_json,\r\n try_get,\r\n)\r\n\r\n\r\nclass JojIE(InfoExtractor):\r\n _VALID_URL = r'... | diff --git a/youtube_dl/extractor/joj.py b/youtube_dl/extractor/joj.py
index d9f8dbfd240..62b28e98098 100644
--- a/youtube_dl/extractor/joj.py
+++ b/youtube_dl/extractor/joj.py
@@ -61,7 +61,7 @@ def _real_extract(self, url):
bitrates = self._parse_json(
self._search_regex(
- r'... |
conan-io__conan-3402 | [SCM] Inability to export (and create) when using the `scm` feature while the conanfile is in a subfolder
(Working with conan 1.61 on both OS X and Windows)
This issue is following the second part of the problem described in #3069.
Our workflow relies on the *conanfile.py* `scm` feature for revision auto-deduction.... | [
{
"content": "import os\n\nimport re\nimport subprocess\nfrom six.moves.urllib.parse import urlparse, quote_plus\nfrom subprocess import CalledProcessError, PIPE, STDOUT\n\nfrom conans.client.tools.env import no_op, environment_append\nfrom conans.client.tools.files import chdir\nfrom conans.errors import Conan... | [
{
"content": "import os\n\nimport re\nimport subprocess\nfrom six.moves.urllib.parse import urlparse, quote_plus\nfrom subprocess import CalledProcessError, PIPE, STDOUT\n\nfrom conans.client.tools.env import no_op, environment_append\nfrom conans.client.tools.files import chdir\nfrom conans.errors import Conan... | diff --git a/conans/client/tools/scm.py b/conans/client/tools/scm.py
index 1b8a6b87782..9ed03409110 100644
--- a/conans/client/tools/scm.py
+++ b/conans/client/tools/scm.py
@@ -130,8 +130,10 @@ def get_commit(self):
get_revision = get_commit
def _check_git_repo(self):
- if not os.path.exists(os.path.... |
pytorch__text-145 | AttributeError: 'list' object has no attribute 'rstrip'
Hi all, previously torchtext works for me when I'm running anaconda python. However, now, when i uninstalled my anaconda python. It stops working.
It gives me the following error:
```
File "/Library/Python/2.7/site-packages/torchtext/data/example.py", lin... | [
{
"content": "import csv\nimport json\n\nimport six\n\n\nclass Example(object):\n \"\"\"Defines a single training or test example.\n\n Stores each column of the example as an attribute.\n \"\"\"\n\n @classmethod\n def fromJSON(cls, data, fields):\n return cls.fromdict(json.loads(data), fie... | [
{
"content": "import csv\nimport json\n\nimport six\n\n\nclass Example(object):\n \"\"\"Defines a single training or test example.\n\n Stores each column of the example as an attribute.\n \"\"\"\n\n @classmethod\n def fromJSON(cls, data, fields):\n return cls.fromdict(json.loads(data), fie... | diff --git a/torchtext/data/example.py b/torchtext/data/example.py
index 57e4521672..576b46f66d 100644
--- a/torchtext/data/example.py
+++ b/torchtext/data/example.py
@@ -56,7 +56,9 @@ def fromlist(cls, data, fields):
ex = cls()
for (name, field), val in zip(fields, data):
if field is not... |
SciTools__cartopy-169 | Remove ```GenericProjectionAxes``` ```from cartopy.mpl.geoaxes```
| [
{
"content": "# (C) British Crown Copyright 2011 - 2012, Met Office\n#\n# This file is part of cartopy.\n#\n# cartopy is free software: you can redistribute it and/or modify it under\n# the terms of the GNU Lesser General Public License as published by the\n# Free Software Foundation, either version 3 of the Li... | [
{
"content": "# (C) British Crown Copyright 2011 - 2012, Met Office\n#\n# This file is part of cartopy.\n#\n# cartopy is free software: you can redistribute it and/or modify it under\n# the terms of the GNU Lesser General Public License as published by the\n# Free Software Foundation, either version 3 of the Li... | diff --git a/lib/cartopy/mpl/geoaxes.py b/lib/cartopy/mpl/geoaxes.py
index 61d6232b8..d6e06022f 100644
--- a/lib/cartopy/mpl/geoaxes.py
+++ b/lib/cartopy/mpl/geoaxes.py
@@ -1293,11 +1293,6 @@ def _pcolor_patched(self, *args, **kwargs):
return collection
-# alias GeoAxes - NOTE: THIS WAS NOT IN v0.4.0rc1
-G... |
kubeflow__pipelines-4134 | allow output artifact store configuration (vs hard coded)
it seems like the output artifacts are always stored in a specific minio service, port, namespace, bucket, secrets, etc (`minio-service.kubeflow:9000`).
see: https://github.com/kubeflow/pipelines/blob/f40a22a3f4a8e06d20cf3e3f425b5058d5c87e0b/sdk/python/kfp/c... | [
{
"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 applicab... | [
{
"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 applicab... | diff --git a/samples/tutorials/gpu/gpu.ipynb b/samples/tutorials/gpu/gpu.ipynb
index 80053bab436..3aa6fad5295 100644
--- a/samples/tutorials/gpu/gpu.ipynb
+++ b/samples/tutorials/gpu/gpu.ipynb
@@ -163,7 +163,7 @@
" image='tensorflow/tensorflow:latest-gpu',\n",
" command=['sh', '-c'],\n",
" ... |
zenml-io__zenml-317 | Repeated Paragraph in the documentation for `core-concepts`
In the file `core-concepts.md`, the section on [`Pipeline`](https://github.com/zenml-io/zenml/blob/b94dff83f0e7c8ab29e99d6b42a0c906a3512b63/docs/book/introduction/core-concepts.md?plain=1#L27-L41) includes a repeated paragraph. The first paragraph in the the p... | [
{
"content": "# Copyright (c) ZenML GmbH 2021. All Rights Reserved.\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# https://www.apache.org/licenses/LICENSE-2.0\... | [
{
"content": "# Copyright (c) ZenML GmbH 2021. All Rights Reserved.\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# https://www.apache.org/licenses/LICENSE-2.0\... | diff --git a/docs/book/introduction/core-concepts.md b/docs/book/introduction/core-concepts.md
index 4f1703d8d38..290a63c6e3c 100644
--- a/docs/book/introduction/core-concepts.md
+++ b/docs/book/introduction/core-concepts.md
@@ -24,12 +24,6 @@ e.g., the active [Stack](guides/deploy\_to\_production.md) that you are usin... |
Mailu__Mailu-1910 | Rate limiting changes for 1.8
Copied from #1582. For 1.8 we will for now increase rate limiting value and disable rate limiting for the subnet.
- Rate limiting
- Document rate limiting
- Currently the subnet is included in the rate limiting. This means that a user who repeatly fails to login the webmail, blo... | [
{
"content": "import os\n\nfrom datetime import timedelta\nfrom socrate import system\n\nDEFAULT_CONFIG = {\n # Specific to the admin UI\n 'DOCKER_SOCKET': 'unix:///var/run/docker.sock',\n 'BABEL_DEFAULT_LOCALE': 'en',\n 'BABEL_DEFAULT_TIMEZONE': 'UTC',\n 'BOOTSTRAP_SERVE_LOCAL': True,\n 'RATE... | [
{
"content": "import os\n\nfrom datetime import timedelta\nfrom socrate import system\n\nDEFAULT_CONFIG = {\n # Specific to the admin UI\n 'DOCKER_SOCKET': 'unix:///var/run/docker.sock',\n 'BABEL_DEFAULT_LOCALE': 'en',\n 'BABEL_DEFAULT_TIMEZONE': 'UTC',\n 'BOOTSTRAP_SERVE_LOCAL': True,\n 'RATE... | diff --git a/core/admin/mailu/configuration.py b/core/admin/mailu/configuration.py
index 3d1b4fb51..d2d34d882 100644
--- a/core/admin/mailu/configuration.py
+++ b/core/admin/mailu/configuration.py
@@ -34,8 +34,8 @@
'POSTMASTER': 'postmaster',
'TLS_FLAVOR': 'cert',
'INBOUND_TLS_ENFORCE': False,
- 'AUTH... |
certbot__certbot-9802 | certbot-dns-ovh failed with Error adding TXT record: Expecting value: line 1 column 1 (char 0)
## My operating system is (include version):
MacoSX 13.6 using docker latest image : https://hub.docker.com/r/certbot/dns-ovh
## I installed Certbot with (snap, OS package manager, pip, certbot-auto, etc):
Docker
... | [
{
"content": "from setuptools import find_packages\nfrom setuptools import setup\n\nversion = '0.32.0.dev0'\n\ninstall_requires = [\n 'coverage',\n 'cryptography',\n 'importlib_resources>=1.3.1; python_version < \"3.9\"',\n 'pyopenssl',\n 'pytest',\n 'pytest-cov',\n # This version is needed... | [
{
"content": "from setuptools import find_packages\nfrom setuptools import setup\n\nversion = '0.32.0.dev0'\n\ninstall_requires = [\n 'coverage',\n 'cryptography',\n 'importlib_resources>=1.3.1; python_version < \"3.9\"',\n 'pyopenssl',\n 'pytest',\n 'pytest-cov',\n # This version is needed... | diff --git a/certbot-ci/certbot_integration_tests/utils/misc.py b/certbot-ci/certbot_integration_tests/utils/misc.py
index 8260ccf5e58..dfeda4cda5b 100644
--- a/certbot-ci/certbot_integration_tests/utils/misc.py
+++ b/certbot-ci/certbot_integration_tests/utils/misc.py
@@ -52,10 +52,10 @@ def _suppress_x509_verification... |
statsmodels__statsmodels-5648 | Missing \\\ in summary2 as_latex function
I found that the .as_latex() function failed when implemented, due to an issue coming from the line including \midline. It is a simple fix -- just required an extra \\\ before each \midline call, and it compiles.
| [
{
"content": "from statsmodels.compat.python import (lrange, iterkeys, iteritems, lzip,\n reduce, itervalues, zip, string_types,\n range)\n\nfrom collections import OrderedDict\nimport datetime\nimport re\nimport textwrap\n\nimport nump... | [
{
"content": "from statsmodels.compat.python import (lrange, iterkeys, iteritems, lzip,\n reduce, itervalues, zip, string_types,\n range)\n\nfrom collections import OrderedDict\nimport datetime\nimport re\nimport textwrap\n\nimport nump... | diff --git a/statsmodels/base/tests/test_penalized.py b/statsmodels/base/tests/test_penalized.py
index ee3f724270e..f519bc69abf 100644
--- a/statsmodels/base/tests/test_penalized.py
+++ b/statsmodels/base/tests/test_penalized.py
@@ -94,7 +94,10 @@ def test_summary(self):
@pytest.mark.smoke
def test_summary2... |
nilearn__nilearn-2248 | NiftiLabelsMasker.inverse_transform() appears to fail in current nilearn version
---------------------------------------------------------------------------
AttributeError Traceback (most recent call last)
<ipython-input-79-642858f1debf> in <module>
----> 1 masker.inverse_transform(labels_... | [
{
"content": "\"\"\"\nTransformer for computing ROI signals.\n\"\"\"\n\nimport numpy as np\n\nfrom nilearn._utils.compat import Memory\n\nfrom .. import _utils\nfrom .._utils import logger, CacheMixin, _compose_err_msg\nfrom .._utils.class_inspect import get_params\nfrom .._utils.niimg_conversions import _check... | [
{
"content": "\"\"\"\nTransformer for computing ROI signals.\n\"\"\"\n\nimport numpy as np\n\nfrom nilearn._utils.compat import Memory\n\nfrom .. import _utils\nfrom .._utils import logger, CacheMixin, _compose_err_msg\nfrom .._utils.class_inspect import get_params\nfrom .._utils.niimg_conversions import _check... | diff --git a/doc/whats_new.rst b/doc/whats_new.rst
index d0ecf7f749..ca9f0201a4 100644
--- a/doc/whats_new.rst
+++ b/doc/whats_new.rst
@@ -25,6 +25,8 @@ Fixes
- :func:`nilearn.image.new_img_like` no longer attempts to copy non-iterable headers. (PR #2212)
- Nilearn no longer raises ImportError for nose when Matplotli... |
getsentry__sentry-3393 | Source map lookups wrong when location is first position in state array
Failing test here: https://github.com/getsentry/sentry/commit/289e4e664769173b3b9ef7eb34c3e2576a2a543f
Source of bug in [sentry.lang.javascript.sourcemaps#L158](https://github.com/getsentry/sentry/blob/master/src/sentry/lang/javascript/sourcemaps.... | [
{
"content": "\"\"\"\nsentry.utils.sourcemaps\n~~~~~~~~~~~~~~~~~~~~~~~\n\nOriginally based on https://github.com/martine/python-sourcemap\n\n:copyright: (c) 2010-2014 by the Sentry Team, see AUTHORS for more details.\n:license: BSD, see LICENSE for more details.\n\"\"\"\nfrom __future__ import absolute_import\n... | [
{
"content": "\"\"\"\nsentry.utils.sourcemaps\n~~~~~~~~~~~~~~~~~~~~~~~\n\nOriginally based on https://github.com/martine/python-sourcemap\n\n:copyright: (c) 2010-2014 by the Sentry Team, see AUTHORS for more details.\n:license: BSD, see LICENSE for more details.\n\"\"\"\nfrom __future__ import absolute_import\n... | diff --git a/src/sentry/lang/javascript/sourcemaps.py b/src/sentry/lang/javascript/sourcemaps.py
index 8496b706a9ad15..cb5920f22b80ef 100644
--- a/src/sentry/lang/javascript/sourcemaps.py
+++ b/src/sentry/lang/javascript/sourcemaps.py
@@ -155,4 +155,5 @@ def sourcemap_to_index(sourcemap):
def find_source(indexed_sourc... |
googleapis__google-cloud-python-3517 | Broken link
Hello,
I found that the link at [https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/core/google/cloud/client.py#L33][1] is broken.
https://google-cloud-python.readthedocs.io/en/latest/google-cloud-auth.html
[1]: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/661... | [
{
"content": "# Copyright 2015 Google 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 applicab... | [
{
"content": "# Copyright 2015 Google 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 applicab... | diff --git a/core/google/cloud/client.py b/core/google/cloud/client.py
index e7e43faf1e45..9bdbf507d201 100644
--- a/core/google/cloud/client.py
+++ b/core/google/cloud/client.py
@@ -29,8 +29,8 @@
_GOOGLE_AUTH_CREDENTIALS_HELP = (
'This library only supports credentials from google-auth-library-python. '
- '... |
translate__pootle-4350 | Editor templates broken in non-debug mode
Since switching to Django 1.8 in master, the [scripts section of the editor templates](https://github.com/translate/pootle/blob/master/pootle/templates/editor/_scripts.html) doesn't render when `DEBUG = False`.
I might be doing something wrong, but I tried removing any templat... | [
{
"content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n#\n# Copyright (C) Pootle contributors.\n#\n# This file is a part of the Pootle project. It is distributed under the GPL3\n# or later license. See the LICENSE file for a copy of the license and the\n# AUTHORS file for copyright and authorship informa... | [
{
"content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n#\n# Copyright (C) Pootle contributors.\n#\n# This file is a part of the Pootle project. It is distributed under the GPL3\n# or later license. See the LICENSE file for a copy of the license and the\n# AUTHORS file for copyright and authorship informa... | diff --git a/pootle/apps/pootle_store/templatetags/store_tags.py b/pootle/apps/pootle_store/templatetags/store_tags.py
index a37b6e0687b..9996befb050 100644
--- a/pootle/apps/pootle_store/templatetags/store_tags.py
+++ b/pootle/apps/pootle_store/templatetags/store_tags.py
@@ -234,7 +234,8 @@ def do_include_raw(parser, ... |
facebookresearch__fairscale-221 | Fail on install - CUDA 11.1.0
## 🐛 Bug
Hi,
pip install on below environment throws an error. I'm happy to provide more info if it would be useful. Thanks!
fatal error: multi_tensor_apply.cuh: No such file or directory
## Environment (NVIDIA-Python Docker: 20.10)
Python: 3.6
PyTorch: 1.7.0
CUDA: 11.1.0
cu... | [
{
"content": "# Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.\n#\n# This source code is licensed under the BSD license found in the\n# LICENSE file in the root directory of this source tree.\n\n__version__ = \"0.1.0\"\n\n###################################################################... | [
{
"content": "# Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.\n#\n# This source code is licensed under the BSD license found in the\n# LICENSE file in the root directory of this source tree.\n\n__version__ = \"0.1.1\"\n\n###################################################################... | diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9cedc177a..e518464c7 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## [0.1.1] - 20... |
cocotb__cocotb-2677 | Make `cocotb.scheduler.create_task` a public API
By creating a top-level alias `cocotb.create_task`. This function will turn a coroutine into a Task, but will not schedule it. Later the user can schedule that Task using `cocotb.start_soon` or `cocotb.start`.
| [
{
"content": "# Copyright (c) 2013 Potential Ventures Ltd\n# Copyright (c) 2013 SolarFlare Communications Inc\n# All rights reserved.\n\n# Redistribution and use in source and binary forms, with or without\n# modification, are permitted provided that the following conditions are met:\n# * Redistributions of... | [
{
"content": "# Copyright (c) 2013 Potential Ventures Ltd\n# Copyright (c) 2013 SolarFlare Communications Inc\n# All rights reserved.\n\n# Redistribution and use in source and binary forms, with or without\n# modification, are permitted provided that the following conditions are met:\n# * Redistributions of... | diff --git a/cocotb/__init__.py b/cocotb/__init__.py
index 6413f2ba16..37eb7f6fb6 100644
--- a/cocotb/__init__.py
+++ b/cocotb/__init__.py
@@ -196,6 +196,18 @@ async def start(coro: Union[RunningTask, Coroutine]) -> RunningTask:
return task
+def create_task(coro: Union[RunningTask, Coroutine]) -> RunningTask:
... |
instadeepai__Mava-800 | [BUG] SMAC legal action masking
### Describe the bug
There is a bug with legal action masking on the SMAC tasks leading to runs failing. This is happening on big run sweeps for both recurrent and feedforward systems on the `25m` and `bane_vs_bane` tasks so far.
### To Reproduce
A note. I was not able to reproduc... | [
{
"content": "# python3\n# Copyright 2021 InstaDeep Ltd. All rights reserved.\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.... | [
{
"content": "# python3\n# Copyright 2021 InstaDeep Ltd. All rights reserved.\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.... | diff --git a/mava/wrappers/smac.py b/mava/wrappers/smac.py
index 623bb97c1..676e59c89 100644
--- a/mava/wrappers/smac.py
+++ b/mava/wrappers/smac.py
@@ -114,7 +114,7 @@ def step(self, actions: Dict[str, np.ndarray]) -> dm_env.TimeStep:
return self.reset()
# Convert dict of actions to list for SM... |
digitalfabrik__integreat-cms-832 | `UnboundLocalError` in imprint form
### Describe the Bug
<!-- A clear and concise description of what the bug is. -->
The imprint can only be created when it does not yet exist.
Once it exists, it cannot be changed anymore.
### Steps to Reproduce
1. Go to the imprint form
2. Create imprint
3. Change existing... | [
{
"content": "import logging\n\nfrom django.contrib import messages\nfrom django.contrib.auth.decorators import login_required\nfrom django.contrib.auth.mixins import PermissionRequiredMixin\nfrom django.shortcuts import render, redirect, get_object_or_404\nfrom django.urls import reverse\nfrom django.utils.dec... | [
{
"content": "import logging\n\nfrom django.contrib import messages\nfrom django.contrib.auth.decorators import login_required\nfrom django.contrib.auth.mixins import PermissionRequiredMixin\nfrom django.shortcuts import render, redirect, get_object_or_404\nfrom django.urls import reverse\nfrom django.utils.dec... | diff --git a/src/cms/views/imprint/imprint_view.py b/src/cms/views/imprint/imprint_view.py
index dcde7fbadb..fb66688f0f 100644
--- a/src/cms/views/imprint/imprint_view.py
+++ b/src/cms/views/imprint/imprint_view.py
@@ -220,8 +220,8 @@ def post(self, request, *args, **kwargs):
},
)
- ... |
mozmeao__basket-387 | Capture credit card type in MoFo donations
(MoFo work tracked [here](https://github.com/mozilla/donate-wagtail/issues/620))
We need to capture credit card type in donation opportunity records so that we can include it in emailed receipts to donors. It sounds like we need to
a.) add the `Credit_Card_Type_c` field ... | [
{
"content": "import json\nimport logging\nfrom copy import deepcopy\nfrom datetime import datetime, timedelta\nfrom email.utils import formatdate\nfrom functools import wraps\nfrom hashlib import sha256\nfrom time import mktime, time\nfrom urllib.parse import urlencode\n\nfrom django.conf import settings\nfrom... | [
{
"content": "import json\nimport logging\nfrom copy import deepcopy\nfrom datetime import datetime, timedelta\nfrom email.utils import formatdate\nfrom functools import wraps\nfrom hashlib import sha256\nfrom time import mktime, time\nfrom urllib.parse import urlencode\n\nfrom django.conf import settings\nfrom... | diff --git a/basket/news/tasks.py b/basket/news/tasks.py
index 17b28d1a8..d81075b18 100644
--- a/basket/news/tasks.py
+++ b/basket/news/tasks.py
@@ -1042,6 +1042,7 @@ def process_donation_event(data):
'Donation_Form_URL__c': 'donation_url',
'Project__c': 'project',
'PMT_Subscription_ID__c': 'subscription... |
rootpy__rootpy-723 | AttributeError when using root_open
I am pretty new to both root and rootpy. But this seams wrong Dont really know how to find the error. I am just trying to open a root file using rootpy and I get an AttributeError - No matter if the file exists or not.
I can open a root file using PyROOT though. Any thoughts
Ip... | [
{
"content": "# Copyright 2012 the rootpy developers\n# distributed under the terms of the GNU General Public License\n\"\"\"\n:py:mod:`rootpy.ROOT`\n=====================\n\nThis module is intended to be a drop-in replacement for ordinary\nPyROOT imports by mimicking PyROOT's interface. If you find a case wher... | [
{
"content": "# Copyright 2012 the rootpy developers\n# distributed under the terms of the GNU General Public License\n\"\"\"\n:py:mod:`rootpy.ROOT`\n=====================\n\nThis module is intended to be a drop-in replacement for ordinary\nPyROOT imports by mimicking PyROOT's interface. If you find a case wher... | diff --git a/rootpy/ROOT.py b/rootpy/ROOT.py
index 8f843c96..4553253f 100644
--- a/rootpy/ROOT.py
+++ b/rootpy/ROOT.py
@@ -114,8 +114,13 @@ def __getattr__(self, what):
'and rootpy does not contain the class `{0}`'.format(what))
return result
- # Memoize
- setattr(self,... |
celery__celery-6288 | stop loading pytest plugin by default
currently celery, by default, will add a set of fixtures and a mark, which can be confusing to new developers on a project when running `pytest --fixtures` and begin using them even through we've not yet opted into and started configuring them.
An alternative is to use an approa... | [
{
"content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\nimport codecs\nimport os\nimport re\nimport sys\n\nimport setuptools\nimport setuptools.command.test\n\ntry:\n from platform import python_implementation as _pyimp\nexcept (AttributeError, ImportError):\n def _pyimp():\n return 'Python (... | [
{
"content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\nimport codecs\nimport os\nimport re\nimport sys\n\nimport setuptools\nimport setuptools.command.test\n\ntry:\n from platform import python_implementation as _pyimp\nexcept (AttributeError, ImportError):\n def _pyimp():\n return 'Python (... | diff --git a/requirements/extras/pytest.txt b/requirements/extras/pytest.txt
new file mode 100644
index 00000000000..8e0e5f3471b
--- /dev/null
+++ b/requirements/extras/pytest.txt
@@ -0,0 +1 @@
+pytest-celery
diff --git a/requirements/test.txt b/requirements/test.txt
index 755905cbb55..fd0ba172f90 100644
--- a/requirem... |
sunpy__sunpy-3333 | [1.0.3] test_print_config_files fails with installed sunpy
<!-- This comments are hidden when you submit the issue so you do not need to remove them!
Please be sure to check out our contributing guidelines: https://github.com/sunpy/sunpy/blob/master/CONTRIBUTING.rst
Please be sure to check out our code of conduct:
h... | [
{
"content": "import os\nimport json\nimport pathlib\nimport warnings\nimport importlib\nimport tempfile\n\nimport pytest\n\nimport astropy\nimport astropy.config.paths\n\nimport sunpy.tests.helpers\nfrom sunpy.tests.hash import HASH_LIBRARY_NAME\nfrom sunpy.tests.helpers import new_hash_library, generate_figur... | [
{
"content": "import os\nimport json\nimport pathlib\nimport warnings\nimport importlib\nimport tempfile\n\nimport pytest\n\nimport astropy\nimport astropy.config.paths\n\nimport sunpy.tests.helpers\nfrom sunpy.tests.hash import HASH_LIBRARY_NAME\nfrom sunpy.tests.helpers import new_hash_library, generate_figur... | diff --git a/sunpy/conftest.py b/sunpy/conftest.py
index 60632d3a116..4dd35dfbb78 100644
--- a/sunpy/conftest.py
+++ b/sunpy/conftest.py
@@ -46,7 +46,7 @@ def tmp_config_dir(request):
"""
tmpdir = tempfile.TemporaryDirectory()
- os.environ["SUNPY_CONFIGDIR"] = str(pathlib.Path(__file__).parent / "data")
... |
cupy__cupy-5362 | Need housekeeping macros for HIP
According to an earlier discussion (https://github.com/cupy/cupy/pull/4367#discussion_r542051342), it's better to collect the macro redefinitions for functions that are not supported by HIP (ex: `__shfl*sync()`) in one place so that they are always correctly included when compiling on H... | [
{
"content": "import warnings\n\nimport cupy\n\nfrom cupy_backends.cuda.api import runtime\nfrom cupyx.jit import _cuda_types\nfrom cupyx.jit._internal_types import BuiltinFunc\nfrom cupyx.jit._internal_types import Data\nfrom cupyx.jit._internal_types import Constant\nfrom cupyx.jit._internal_types import Rang... | [
{
"content": "import warnings\n\nimport cupy\n\nfrom cupy_backends.cuda.api import runtime\nfrom cupyx.jit import _cuda_types\nfrom cupyx.jit._internal_types import BuiltinFunc\nfrom cupyx.jit._internal_types import Data\nfrom cupyx.jit._internal_types import Constant\nfrom cupyx.jit._internal_types import Rang... | diff --git a/cupy/_core/_routines_indexing.pyx b/cupy/_core/_routines_indexing.pyx
index 0661fe0211f..462c408fd83 100644
--- a/cupy/_core/_routines_indexing.pyx
+++ b/cupy/_core/_routines_indexing.pyx
@@ -429,12 +429,6 @@ cdef ndarray _simple_getitem(ndarray a, list slice_list):
return v
-_preamble = '' if not... |
getsentry__sentry-python-464 | logging breadcrumb collection time is incorrect
I found the breadcrumbs timestamp converted to the local time zone
datetime.datetime.fromtimestamp(record.created)
> ```python
> # /sentry_sdk/integra... | [
{
"content": "from __future__ import absolute_import\n\nimport logging\nimport datetime\n\nfrom sentry_sdk.hub import Hub\nfrom sentry_sdk.utils import (\n to_string,\n event_from_exception,\n current_stacktrace,\n capture_internal_exceptions,\n)\nfrom sentry_sdk.integrations import Integration\nfro... | [
{
"content": "from __future__ import absolute_import\n\nimport logging\nimport datetime\n\nfrom sentry_sdk.hub import Hub\nfrom sentry_sdk.utils import (\n to_string,\n event_from_exception,\n current_stacktrace,\n capture_internal_exceptions,\n)\nfrom sentry_sdk.integrations import Integration\nfro... | diff --git a/sentry_sdk/integrations/logging.py b/sentry_sdk/integrations/logging.py
index 512c3dada5..e0a1455313 100644
--- a/sentry_sdk/integrations/logging.py
+++ b/sentry_sdk/integrations/logging.py
@@ -96,7 +96,7 @@ def _breadcrumb_from_record(record):
"level": _logging_to_event_level(record.levelname),
... |
cal-itp__benefits-1229 | Investigate missing event properties
In #1057 we made some changes to the base `Event` type, to include an `eligibility_types` property on all events we send into Amplitude.
## OAuth events
Looking at the event reports over the last 14 days of production data, the [`started sign in` event](https://github.com/cal-... | [
{
"content": "\"\"\"\nThe eligibility application: analytics implementation.\n\"\"\"\nfrom benefits.core import analytics as core\n\n\nclass EligibilityEvent(core.Event):\n \"\"\"Base analytics event for eligibility verification.\"\"\"\n\n def __init__(self, request, event_type, eligibility_types):\n ... | [
{
"content": "\"\"\"\nThe eligibility application: analytics implementation.\n\"\"\"\nfrom benefits.core import analytics as core\n\n\nclass EligibilityEvent(core.Event):\n \"\"\"Base analytics event for eligibility verification.\"\"\"\n\n def __init__(self, request, event_type, eligibility_types):\n ... | diff --git a/benefits/eligibility/analytics.py b/benefits/eligibility/analytics.py
index e096c810cc..0dc03322da 100644
--- a/benefits/eligibility/analytics.py
+++ b/benefits/eligibility/analytics.py
@@ -11,6 +11,7 @@ def __init__(self, request, event_type, eligibility_types):
super().__init__(request, event_ty... |
RedHatInsights__insights-core-3043 | The dmsetup parser is raising ValueError exceptions in production
The DmsetupStatus parser is throwing a large number of the exception ValueError('not enough values to unpack (expected 2, got 1)',) in production.
| [
{
"content": "\"\"\"\ndmsetup commands - Command ``dmsetup``\n======================================\n\nParsers for parsing and extracting data from output of commands related to\n``dmsetup``.\nParsers contained in this module are:\n\nDmsetupInfo - command ``dmsetup info -C``\n----------------------------------... | [
{
"content": "\"\"\"\ndmsetup commands - Command ``dmsetup``\n======================================\n\nParsers for parsing and extracting data from output of commands related to\n``dmsetup``.\nParsers contained in this module are:\n\nDmsetupInfo - command ``dmsetup info -C``\n----------------------------------... | diff --git a/insights/parsers/dmsetup.py b/insights/parsers/dmsetup.py
index ba693bef2f..ae77e6da97 100644
--- a/insights/parsers/dmsetup.py
+++ b/insights/parsers/dmsetup.py
@@ -189,6 +189,9 @@ class DmsetupStatus(CommandParser, list):
def parse_content(self, content):
self.unparseable_lines = []
+ ... |
googleapis__google-cloud-python-5899 | Default max_bytes in pubsub seems wrong
https://github.com/GoogleCloudPlatform/google-cloud-python/blob/005ddd11770f8953643dac9b64a037524da2f49e/pubsub/google/cloud/pubsub_v1/types.py#L43
In my code I'm seeing this:
```
google.api_core.exceptions.InvalidArgument: 400 The value for 10159812 is too large. You passed... | [
{
"content": "# Copyright 2017, Google LLC All rights reserved.\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... | [
{
"content": "# Copyright 2017, Google LLC All rights reserved.\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... | diff --git a/pubsub/google/cloud/pubsub_v1/types.py b/pubsub/google/cloud/pubsub_v1/types.py
index 1ac99a96534b..1f5ca92174e2 100644
--- a/pubsub/google/cloud/pubsub_v1/types.py
+++ b/pubsub/google/cloud/pubsub_v1/types.py
@@ -40,7 +40,7 @@
['max_bytes', 'max_latency', 'max_messages'],
)
BatchSettings.__new__.__... |
oppia__oppia-11852 | FetchIssuesHandler should respond with a JSON object instead of an array
`FetchIssuesHandler` ([link](https://github.com/oppia/oppia/blob/84c00daefcda8174bf312e11106c31940b96fd4a/core/controllers/editor.py#L526)) currently responds to GET requests with a JSON array. This conflicts with HTTP best practices, and should b... | [
{
"content": "# coding: utf-8\n\n# Copyright 2014 The Oppia Authors. All Rights Reserved.\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/licens... | [
{
"content": "# coding: utf-8\n\n# Copyright 2014 The Oppia Authors. All Rights Reserved.\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/licens... | diff --git a/core/controllers/editor.py b/core/controllers/editor.py
index bbc6b763b8f9b..6cbcba1316ac6 100644
--- a/core/controllers/editor.py
+++ b/core/controllers/editor.py
@@ -558,7 +558,7 @@ def get(self, exp_id):
unresolved_issues.append(issue)
exp_issues.unresolved_issues = unresolved_... |
akvo__akvo-rsr-1622 | Small user interface enhancements
See https://github.com/akvo/akvo-product-design/issues/104
## Test plan
1. "Update list" on directory pages should display "Search"
2. On the project page, in the financial overview part, no cents should be displayed and the total amount funded should be displayed (only visible when do... | [
{
"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/static/styles-src/main.css b/akvo/rsr/static/styles-src/main.css
index 13790a3d7a..8d3b279cb2 100755
--- a/akvo/rsr/static/styles-src/main.css
+++ b/akvo/rsr/static/styles-src/main.css
@@ -533,6 +533,14 @@ nav.navbar-fixed-top {
background: rgba(32, 32, 36, 0.1) !important; }
.myProjectList ... |
iterative__dvc-4156 | DVC status fails after using add -R
Hey :)
I have a folder of files I added with
$$ dvc add -R raw_data
Then I've imported the folder in other git repo using
$$ dvc import -o data --rev raw-v1 https://...@bitbucket.org/.../raw_data_reg.git raw_data
Then when execute dvc status I get an error message
```
... | [
{
"content": "import os\n\nfrom voluptuous import Required\n\nfrom dvc.exceptions import OutputNotFoundError\nfrom dvc.path_info import PathInfo\n\nfrom .local import LocalDependency\n\n\nclass RepoDependency(LocalDependency):\n PARAM_REPO = \"repo\"\n PARAM_URL = \"url\"\n PARAM_REV = \"rev\"\n PAR... | [
{
"content": "import os\n\nfrom voluptuous import Required\n\nfrom dvc.exceptions import OutputNotFoundError\nfrom dvc.path_info import PathInfo\n\nfrom .local import LocalDependency\n\n\nclass RepoDependency(LocalDependency):\n PARAM_REPO = \"repo\"\n PARAM_URL = \"url\"\n PARAM_REV = \"rev\"\n PAR... | diff --git a/dvc/dependency/repo.py b/dvc/dependency/repo.py
index 8566c080b9..3ae2a77dfb 100644
--- a/dvc/dependency/repo.py
+++ b/dvc/dependency/repo.py
@@ -64,7 +64,7 @@ def _get_checksum(self, locked=True):
# We are polluting our repo cache with some dir listing here
if tree.isdi... |
pytorch__pytorch-2084 | Negative dimension behaviour in torch.stack
Support for using a negative dimension in `torch.stack` currently works as follows:
```python
if dim < 0:
dim += sequence[0].dim()
```
This is not consistent with the behaviour of `torch.unsqueeze`, which uses `dim += input.dim() + 1`. The unsqueeze behaviour is ... | [
{
"content": "import torch\nfrom ._utils import _range\nfrom operator import mul\nfrom functools import reduce\n\n__all__ = [\n 'split', 'chunk', 'stack', 'unbind', 'btriunpack', 'matmul',\n]\n\n\ndef split(tensor, split_size, dim=0):\n \"\"\"Splits the tensor into equally sized chunks (if possible).\n\n ... | [
{
"content": "import torch\nfrom ._utils import _range\nfrom operator import mul\nfrom functools import reduce\n\n__all__ = [\n 'split', 'chunk', 'stack', 'unbind', 'btriunpack', 'matmul',\n]\n\n\ndef split(tensor, split_size, dim=0):\n \"\"\"Splits the tensor into equally sized chunks (if possible).\n\n ... | diff --git a/test/test_torch.py b/test/test_torch.py
index e9bbb8e0c96165..ecd05a75ed0835 100644
--- a/test/test_torch.py
+++ b/test/test_torch.py
@@ -1644,7 +1644,9 @@ def test_stack(self):
z = torch.rand(2, 3, 4)
for dim in range(4):
res = torch.stack((x, y, z), dim)
+ res_ne... |
cloud-custodian__cloud-custodian-9163 | aws - glue connection has NoneType error when no VPC
### Describe the bug
When there is no VPC on the Glue connection resource, we get a `TypeError: 'NoneType' object is not iterable` error
### What did you expect to happen?
Succeed in this case.
### Cloud Provider
Amazon Web Services (AWS)
### Cloud Custodian ve... | [
{
"content": "# Copyright The Cloud Custodian Authors.\n# SPDX-License-Identifier: Apache-2.0\nimport importlib\nfrom functools import lru_cache\n\nfrom .core import ValueFilter, OPERATORS\nfrom c7n.query import ChildResourceQuery\nfrom c7n.utils import jmespath_search\n\n\nclass RelatedResourceFilter(ValueFilt... | [
{
"content": "# Copyright The Cloud Custodian Authors.\n# SPDX-License-Identifier: Apache-2.0\nimport importlib\nfrom functools import lru_cache\n\nfrom .core import ValueFilter, OPERATORS\nfrom c7n.query import ChildResourceQuery\nfrom c7n.utils import jmespath_search\n\n\nclass RelatedResourceFilter(ValueFilt... | diff --git a/c7n/filters/related.py b/c7n/filters/related.py
index 9fc6e2bfbd8..d0961f5d514 100644
--- a/c7n/filters/related.py
+++ b/c7n/filters/related.py
@@ -46,6 +46,10 @@ def get_related(self, resources):
related = resource_manager.get_resources(list(related_ids))
else:
related =... |
ansible__ansible-modules-extras-1529 | rabbitmq_parameter fails when passing dynamically generated json
##### Issue Type:
“Bug Report”
##### Ansible Version:
ansible 1.8.2
configured module search path = None
Tested also on ansible 1.9
ansible 1.9 (devel 8f06ba2bc1) last updated 2015/02/05 11:16:37 (GMT +200)
lib/ansible/modules/core: (detached HEAD ... | [
{
"content": "#!/usr/bin/python\n# -*- coding: utf-8 -*-\n\n# (c) 2013, Chatham Financial <oss@chathamfinancial.com>\n#\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 Softwa... | [
{
"content": "#!/usr/bin/python\n# -*- coding: utf-8 -*-\n\n# (c) 2013, Chatham Financial <oss@chathamfinancial.com>\n#\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 Softwa... | diff --git a/messaging/rabbitmq_parameter.py b/messaging/rabbitmq_parameter.py
index f2744ca2ae2..2f78bd4ee15 100644
--- a/messaging/rabbitmq_parameter.py
+++ b/messaging/rabbitmq_parameter.py
@@ -126,8 +126,6 @@ def main():
component = module.params['component']
name = module.params['name']
value = modu... |
facebookresearch__hydra-1685 | CI fails with UserWarning raised from importing nevergrad
example failure here https://app.circleci.com/pipelines/github/facebookresearch/hydra/10584/workflows/d4c57363-bb31-42f4-a7ee-29c28a577f67/jobs/95695
this can be reproduced by simply importing nevergrad
```
>>> import nevergrad as ng
/Users/jieru/opt/anaco... | [
{
"content": "# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved\n# type: ignore\nfrom pathlib import Path\n\nfrom read_version import read_version\nfrom setuptools import find_namespace_packages, setup\n\nsetup(\n name=\"hydra-nevergrad-sweeper\",\n version=read_version(\"hydra_plugin... | [
{
"content": "# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved\n# type: ignore\nfrom pathlib import Path\n\nfrom read_version import read_version\nfrom setuptools import find_namespace_packages, setup\n\nsetup(\n name=\"hydra-nevergrad-sweeper\",\n version=read_version(\"hydra_plugin... | diff --git a/plugins/hydra_nevergrad_sweeper/setup.py b/plugins/hydra_nevergrad_sweeper/setup.py
index 36fbfe12552..28954591ac3 100644
--- a/plugins/hydra_nevergrad_sweeper/setup.py
+++ b/plugins/hydra_nevergrad_sweeper/setup.py
@@ -27,6 +27,7 @@
install_requires=[
"hydra-core>=1.1.0.dev7",
"neve... |
sublimelsp__LSP-1699 | Getting error "list index out of range" when no command is defined
**Describe the bug**
LSP shows a cryptic error message when you want to use elixir-ls but the package settings don't define a default command similar to other clients. When you install ElixirLS on Manjaro the executable is named `elixir-ls`.
**To Re... | [
{
"content": "from .collections import DottedDict\nfrom .logging import debug, set_debug_logging\nfrom .protocol import TextDocumentSyncKindNone\nfrom .typing import Any, Optional, List, Dict, Generator, Callable, Iterable, Union, Set, Tuple, TypeVar\nfrom .url import filename_to_uri\nfrom .url import uri_to_fi... | [
{
"content": "from .collections import DottedDict\nfrom .logging import debug, set_debug_logging\nfrom .protocol import TextDocumentSyncKindNone\nfrom .typing import Any, Optional, List, Dict, Generator, Callable, Iterable, Union, Set, Tuple, TypeVar\nfrom .url import filename_to_uri\nfrom .url import uri_to_fi... | diff --git a/plugin/core/types.py b/plugin/core/types.py
index 8722fcb52..d333c9c5b 100644
--- a/plugin/core/types.py
+++ b/plugin/core/types.py
@@ -520,6 +520,8 @@ def __init__(
env: Dict[str, str],
listener_socket: Optional[socket.socket]
) -> None:
+ if not command and not tcp_port:
+ ... |
canonical__microk8s-3774 | microk8s.reset does not remove resources
<!--
Thank you for submitting an issue. Please fill in the template below
information about the bug you encountered.
-->
#### Summary
<!-- Please explain the bug in a few short sentences -->
#### What Should Happen Instead?
<!-- Please explain what the expected ... | [
{
"content": "#!/usr/bin/python3\nimport click\nimport os\nimport subprocess\nimport shutil\nimport sys\nimport time\n\nfrom common.utils import (\n get_available_addons,\n get_current_arch,\n get_status,\n snap_data,\n wait_for_ready,\n snap_common,\n is_cluster_locked,\n exit_if_no_per... | [
{
"content": "#!/usr/bin/python3\nimport click\nimport os\nimport subprocess\nimport shutil\nimport sys\nimport time\n\nfrom common.utils import (\n get_available_addons,\n get_current_arch,\n get_status,\n snap_data,\n wait_for_ready,\n snap_common,\n is_cluster_locked,\n exit_if_no_per... | diff --git a/scripts/wrappers/reset.py b/scripts/wrappers/reset.py
index b0b5f44c68..fd6ec252a0 100644
--- a/scripts/wrappers/reset.py
+++ b/scripts/wrappers/reset.py
@@ -232,7 +232,7 @@ def remove_extra_resources(ns_name):
for rs in extra_resources:
if rs.startswith("apiservices"):
continue
... |
internetarchive__openlibrary-7789 | Fix git SHA on website + status page (dupe?)
<!-- What problem are we solving? What does the experience look like today? What are the symptoms? -->
The footer + https://openlibrary.org/status should both show the website's git sha. Somewhere down the road we had a regression.
### Evidence / Screenshot (if possibl... | [
{
"content": "\"\"\"Generic utilities\"\"\"\n\nfrom enum import Enum\nimport re\nfrom subprocess import run\nfrom typing import TypeVar, Literal, Optional\nfrom collections.abc import Iterable, Callable\n\nto_drop = set(''';/?:@&=+$,<>#%\"{}|\\\\^[]`\\n\\r''')\n\n\ndef str_to_key(s: str) -> str:\n \"\"\"\n ... | [
{
"content": "\"\"\"Generic utilities\"\"\"\n\nfrom enum import Enum\nimport re\nfrom subprocess import run\nfrom typing import TypeVar, Literal, Optional\nfrom collections.abc import Iterable, Callable\n\nto_drop = set(''';/?:@&=+$,<>#%\"{}|\\\\^[]`\\n\\r''')\n\n\ndef str_to_key(s: str) -> str:\n \"\"\"\n ... | diff --git a/openlibrary/utils/__init__.py b/openlibrary/utils/__init__.py
index 632b8bdc752..23839c0b139 100644
--- a/openlibrary/utils/__init__.py
+++ b/openlibrary/utils/__init__.py
@@ -193,8 +193,11 @@ def is_number(s):
def get_software_version() -> str:
+ """
+ assert get_software_version() # Should ne... |
pytorch__pytorch-127219 | [DCP] `set_model_state_dict` errors on compiled module with non-persistent buffer
```
"""
torchrun --standalone --nproc_per_node=2 repro_dcp_compile.py
"""
import os
import torch
import torch.nn as nn
import torch.distributed as dist
from torch.distributed.checkpoint.state_dict import get_model_state_dict, set_... | [
{
"content": "import contextlib\nimport functools\nimport gc\nfrom dataclasses import asdict, dataclass, field\nfrom itertools import chain\nfrom typing import (\n Any,\n Callable,\n cast,\n Dict,\n Generator,\n Iterable,\n List,\n no_type_check,\n Optional,\n Set,\n Tuple,\n ... | [
{
"content": "import contextlib\nimport functools\nimport gc\nfrom dataclasses import asdict, dataclass, field\nfrom itertools import chain\nfrom typing import (\n Any,\n Callable,\n cast,\n Dict,\n Generator,\n Iterable,\n List,\n no_type_check,\n Optional,\n Set,\n Tuple,\n ... | diff --git a/test/distributed/checkpoint/test_state_dict.py b/test/distributed/checkpoint/test_state_dict.py
index ec8e80a2a3012a..ce13ad22e46da6 100644
--- a/test/distributed/checkpoint/test_state_dict.py
+++ b/test/distributed/checkpoint/test_state_dict.py
@@ -556,6 +556,17 @@ def _test_activation_ckpt_fqns_fsdp1(sel... |
python-telegram-bot__python-telegram-bot-2168 | mypy doesn't pick up type hints[BUG]
<!--
Thanks for reporting issues of python-telegram-bot!
Use this template to notify us if you found a bug.
To make it easier for us to help you please enter detailed information below.
Please note, we only support the latest version of python-telegram-bot and
master bran... | [
{
"content": "#!/usr/bin/env python\n\"\"\"The setup and build script for the python-telegram-bot library.\"\"\"\n\nimport codecs\nimport os\nimport sys\n\nfrom setuptools import setup, find_packages\n\n\ndef requirements():\n \"\"\"Build the requirements list for this project\"\"\"\n requirements_list = ... | [
{
"content": "#!/usr/bin/env python\n\"\"\"The setup and build script for the python-telegram-bot library.\"\"\"\n\nimport codecs\nimport os\nimport sys\n\nfrom setuptools import setup, find_packages\n\n\ndef requirements():\n \"\"\"Build the requirements list for this project\"\"\"\n requirements_list = ... | diff --git a/MANIFEST.in b/MANIFEST.in
index 2a6b5ab8a35..55bc61aca7b 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1 +1 @@
-include LICENSE LICENSE.lesser Makefile requirements.txt
+include LICENSE LICENSE.lesser Makefile requirements.txt py.typed
diff --git a/setup.py b/setup.py
index 08dfe8ef179..cb13e49178f 100644... |
adamchainz__django-cors-headers-715 | unhandled invalid HTTP_ORIGIN
### Understanding CORS
- [X] I have read the resources.
### Python Version
3.9.7
### Django Version
3.2.8
### Package Version
3.10.0
### Description
it seems that an unparsable, invalid `HTTP_ORIGIN` header is a trivial way to exception/mail spam a django instance:
```
Interna... | [
{
"content": "import re\nfrom typing import Any, Optional\nfrom urllib.parse import ParseResult, urlparse\n\nfrom django.http import HttpRequest, HttpResponse\nfrom django.utils.cache import patch_vary_headers\nfrom django.utils.deprecation import MiddlewareMixin\n\nfrom corsheaders.conf import conf\nfrom corsh... | [
{
"content": "import re\nfrom typing import Any, Optional\nfrom urllib.parse import ParseResult, urlparse\n\nfrom django.http import HttpRequest, HttpResponse\nfrom django.utils.cache import patch_vary_headers\nfrom django.utils.deprecation import MiddlewareMixin\n\nfrom corsheaders.conf import conf\nfrom corsh... | diff --git a/HISTORY.rst b/HISTORY.rst
index f29fed35..7dc52420 100644
--- a/HISTORY.rst
+++ b/HISTORY.rst
@@ -2,6 +2,10 @@
History
=======
+* Prevent a crash when an invalid ``Origin`` header is sent.
+
+ Thanks to minusf for the report in `Issue #701 <https://github.com/adamchainz/django-cors-headers/issues/701>... |
freedomofpress__securedrop-3709 | [functional testing] Fix staging CI job on tbb-0.9.0
We removed the application/functional test run from the staging environment in #3697. We should also update the testinfra test references and remove the application test run from CI, otherwise we get a few testinfra test failures due to pip deps, and an error when we... | [
{
"content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n\nimport datetime\nimport os\nimport sys\nimport argparse\nfrom sqlalchemy.exc import IntegrityError\n\nos.environ[\"SECUREDROP_ENV\"] = \"dev\" # noqa\nimport journalist_app\nfrom sdconfig import config\nfrom db import db\nfrom models import Journa... | [
{
"content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n\nimport datetime\nimport os\nimport sys\nimport argparse\nfrom sqlalchemy.exc import IntegrityError\n\nos.environ[\"SECUREDROP_ENV\"] = \"dev\" # noqa\nimport journalist_app\nfrom sdconfig import config\nfrom db import db\nfrom models import Journa... | diff --git a/molecule/aws/scripts/app-tests.sh b/molecule/aws/scripts/app-tests.sh
deleted file mode 100644
index 292a8b39ee..0000000000
--- a/molecule/aws/scripts/app-tests.sh
+++ /dev/null
@@ -1,13 +0,0 @@
-#!/bin/bash
-#
-#
-export DISPLAY=:1
-
-
-cd "$1" || exit 1
-
-# --page-layout are created for selected languag... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.